git: cee8be2c78f1 - main - vis(1): Add EXAMPLES section

[Fernando Apesteguía]

The branch main has been updated by fernape (doc, ports committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=cee8be2c78f15bed6d2339d41e3f8c232d41bb33

commit cee8be2c78f15bed6d2339d41e3f8c232d41bb33
Author:     Fernando Apesteguía <fernape at FreeBSD.org>
AuthorDate: 2021-02-18 18:04:23 +0000
Commit:     Fernando Apesteguía <fernape at FreeBSD.org>
CommitDate: 2021-02-18 18:10:33 +0000

    vis(1): Add EXAMPLES section
    
    Add three examples showing the use of `-h`, `-l`, `-t`, `-w`
    
    christos at netbsd.org to be notified.
    
    Reviewed by: bcr@, gbe@, imp@
    Approved by: bcr@, gbe@ (mentor), imp@
    
    Differential Revision: https://reviews.freebsd.org/D25242
---
 contrib/vis/vis.1 | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/contrib/vis/vis.1 b/contrib/vis/vis.1
index 6f7c82ff7ab5..803d34eda5f9 100644
--- a/contrib/vis/vis.1
+++ b/contrib/vis/vis.1
@@ -155,6 +155,25 @@ instead.
 Specify the locale of the input data.
 Set to C if the input data locale is unknown.
 .El
+.Sh EXAMPLES
+Visualize characters encoding white spaces and tabs:
+.Bd -literal -offset indent
+$ echo -e "\\x10\\n\\t" | vis -w -t
+\\^P\\012\\011\\012
+.Ed
+.Pp
+Same as above but using `\\$' for newline followed by an actual newline:
+.Bd -literal -offset indent
+$ echo -e "\\x10\\n\\t" | vis -w -t -l
+\\^P\\$
+\\011\\$
+.Ed
+.Pp
+Visualize string using URI encoding:
+.Bd -literal -offset indent
+$ echo http://www.freebsd.org | vis -h
+http%3a%2f%2fwww.freebsd.org%0a
+.Ed
 .Sh SEE ALSO
 .Xr unvis 1 ,
 .Xr svis 3 ,