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