usr.bin/vis/vis.1

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