Return to vis.1 CVS log

Up to [local] / src / usr.bin / vis

Annotation of src/usr.bin/vis/vis.1, Revision 1.8

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