Annotation of src/usr.bin/vis/vis.1, Revision 1.6
1.6 ! aaron 1: .\" $OpenBSD: vis.1,v 1.5 1999/06/05 01:21:49 aaron Exp $
1.1 deraadt 2: .\" $NetBSD: vis.1,v 1.5 1994/11/17 07:56:00 jtc Exp $
3: .\"
4: .\" Copyright (c) 1989, 1991, 1993, 1994
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)vis.1 8.4 (Berkeley) 4/19/94
36: .\"
37: .Dd April 19, 1994
38: .Dt VIS 1
1.5 aaron 39: .Os
1.1 deraadt 40: .Sh NAME
41: .Nm vis
42: .Nd display non-printable characters in a visual format
43: .Sh SYNOPSIS
44: .Nm vis
45: .Op Fl cbflnostw
46: .Op Fl F Ar foldwidth
47: .Op Ar file ...
48: .Sh DESCRIPTION
1.6 ! aaron 49: .Nm
1.1 deraadt 50: is a filter for converting non-printable characters
1.6 ! aaron 51: into a visual representation.
! 52: It differs from
! 53: .Ic cat -v
1.1 deraadt 54: in that
1.6 ! aaron 55: the form is unique and invertible.
! 56: By default, all non-graphic
1.1 deraadt 57: characters except space, tab, and newline are encoded.
58: A detailed description of the
59: various visual formats is given in
60: .Xr vis 3 .
61: .Pp
62: The options are as follows:
63: .Bl -tag -width Ds
64: .It Fl b
65: Turns off prepending of backslash before up-arrow control sequences
1.6 ! aaron 66: and meta-characters, and disables the doubling of backslashes.
! 67: This produces output which is neither invertible nor precise, but does
! 68: represent a minimum of change to the input.
! 69: It is similar to
! 70: .Ic cat -v .
1.1 deraadt 71: .It Fl c
72: Request a format which displays a small subset of the
73: non-printable characters using C-style backslash sequences.
74: .It Fl F
75: Causes
1.6 ! aaron 76: .Nm
1.1 deraadt 77: to fold output lines to foldwidth columns (default 80), like
78: .Xr fold 1 ,
79: except
80: that a hidden newline sequence is used, (which is removed
81: when inverting the file back to its original form with
82: .Xr unvis 1 ) .
83: If the last character in the encoded file does not end in a newline,
84: a hidden newline sequence is appended to the output.
85: This makes
86: the output usable with various editors and other utilities which
87: typically don't work with partial lines.
88: .It Fl f
89: Same as
90: .Fl F .
91: .It Fl l
92: Mark newlines with the visible sequence
93: .Ql \e$ ,
94: followed by the newline.
95: .It Fl n
96: Turns off any encoding, except for the fact that backslashes are
97: still doubled and hidden newline sequences inserted if
98: .Fl f
99: or
100: .Fl F
1.6 ! aaron 101: is selected.
! 102: When combined with the
1.1 deraadt 103: .Fl f
104: flag,
1.6 ! aaron 105: .Nm
1.1 deraadt 106: becomes like
107: an invertible version of the
108: .Xr fold 1
1.6 ! aaron 109: utility.
! 110: That is, the output
1.4 aaron 111: can be unfolded by running the output through
112: .Xr unvis 1 .
1.1 deraadt 113: .It Fl o
114: Request a format which displays non-printable characters as
115: an octal number, \eddd.
116: .It Fl s
117: Only characters considered unsafe to send to a terminal are encoded.
118: This flag allows backspace, bell, and carriage return in addition
119: to the default space, tab and newline.
120: .It Fl t
121: Tabs are also encoded.
122: .It Fl w
123: White space (space-tab-newline) is also encoded.
124: .El
125: .Sh SEE ALSO
126: .Xr unvis 1 ,
127: .Xr vis 3
128: .Sh HISTORY
129: The
130: .Nm
1.3 aaron 131: command appeared in
1.1 deraadt 132: .Bx 4.4 .