BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / vis / vis.1

diff --git a/usr/src/usr.bin/vis/vis.1 b/usr/src/usr.bin/vis/vis.1
index 1d39dbb..7b81528 100644 (file)
--- a/usr/src/usr.bin/vis/vis.1
+++ b/usr/src/usr.bin/vis/vis.1
@@ -1,79 +1,125 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)vis.1       1.2 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH VIS 1 ""
-.UC 7
-.SH NAME
-vis \- display non-printable characters in a visual format
-.SH SYNOPSIS
-.B vis
-[
-.B \-nwctsobfl
-] [
-.B \-F
-foldwidth
-] [ file ... ]
-.SH DESCRIPTION
-\fIVis\fP is a filter for converting non-printable characters
-into a visual representation.  It differs from cat -v in that
+.\"     @(#)vis.1      5.2 (Berkeley) 4/23/91
+.\"
+.Dd April 23, 1991
+.Dt VIS 1
+.Os
+.Sh NAME
+.Nm vis
+.Nd display non-printable characters in a visual format
+.Sh SYNOPSIS
+.Nm vis
+.Op Fl cbflnostw
+.Op Fl F Ar foldwidth
+.Op Ar file ...
+.Sh DESCRIPTION
+.Nm Vis
+is a filter for converting non-printable characters
+into a visual representation.  It differs from
+.Ql cat -v
+in that

 the form is unique and invertible.  By default, all non-graphic
 characters except space, tab, and newline are encoded.
 A detailed description of the
 the form is unique and invertible.  By default, all non-graphic
 characters except space, tab, and newline are encoded.
 A detailed description of the

-various visual formats is given in vis(3).
-.SH OPTIONS
-.IP -c
+various visual formats is given in
+.Xr vis 3 .
+.Pp
+Options supported by
+.Nm vis :
+.Bl -tag -width Ds
+.It Fl b
+Turns off prepending of backslash before up-arrow control sequences
+and meta characters, and disables the doubling of backslashes.  This
+produces output which is neither invertible or precise, but does
+represent a minimum of change to the input.  It is similar to
+.Dq Li cat -v .
+.It Fl c

 Request a format which displays a small subset of the
 non-printable characters using C-style backslash sequences.
 Request a format which displays a small subset of the
 non-printable characters using C-style backslash sequences.

-.IP -o
-Request a format which displays non-printable characters as
-an octal number, \\ddd.
-.IP -t
-Tabs are also encoded.
-.IP -w
-White space (space-tab-newline) is also encoded.
-.IP -s
-Only characters considered unsafe to send to a terminal are encoded.
-This flag allows backspace, bell, and carriage return in addition
-to the default space, tab and newline.
-.IP -f
-and
-.IP -F
+.It Fl F

 Causes
 Causes

-.B vis
-to fold output lines to foldwidth columns (default 80), like fold(1), except
+.Nm vis
+to fold output lines to foldwidth columns (default 80), like
+.Xr fold 1 ,
+except

 that a hidden newline sequence is used, (which is removed
 that a hidden newline sequence is used, (which is removed

-when inverting the file back to its original form with unvis(1)).
+when inverting the file back to its original form with
+.Xr unvis 1 ) .

 If the last character in the encoded file does not end in a newline,
 a hidden newline sequence is appended to the output.
 This makes
 the output usuable with various editors and other utilities which
 typically don't work with partial lines.
 If the last character in the encoded file does not end in a newline,
 a hidden newline sequence is appended to the output.
 This makes
 the output usuable with various editors and other utilities which
 typically don't work with partial lines.

-.IP -n
+.It Fl f
+Same as
+.Fl F .
+.It Fl l
+Mark newlines with the visable sequence
+.Ql \e$ ,
+followed by the newline.
+.It Fl n

 Turns off any encoding, except for the fact that backslashes are
 Turns off any encoding, except for the fact that backslashes are

-still doubled and hidden newline sequences inserted if -f or -F
-is selected.  When combined with the -f flag, vis becomes like
-an invertible version of the fold(1) utility.  That is, the output
-can be unfolded by running the output through unvis(1).
-.IP -b
-Turns off prepending of backslash before up-arrow control sequences
-and Meta characters, and disables the doubling of backslashes.  This
-produces output which is neither invertible or precise, but does
-represent a minimum of change to the input.  It is similar to cat -v.
-.IP -l
-Mark newlines with the visable sequence '\\$', followed by the newline.
-.SH "SEE ALSO
-unvis(1) vis(3)
+still doubled and hidden newline sequences inserted if
+.Fl f
+or
+.Fl F
+is selected.  When combined with the
+.Fl f
+flag,
+.Nm vis
+becomes like
+an invertible version of the
+.Xr fold 1
+utility.  That is, the output
+can be unfolded by running the output through
+.It Fl o
+Request a format which displays non-printable characters as
+an octal number, \eddd.
+.It Fl s
+Only characters considered unsafe to send to a terminal are encoded.
+This flag allows backspace, bell, and carriage return in addition
+to the default space, tab and newline.
+.Xr unvis 1 .
+.It Fl t
+Tabs are also encoded.
+.It Fl w
+White space (space-tab-newline) is also encoded.
+.El
+.Sh SEE ALSO
+.Xr unvis 1
+.Xr vis 3
+.Sh HISTORY
+The
+.Nm
+command is
+.Ud .