Changeset View
Changeset View
Standalone View
Standalone View
vis.1
.\" $NetBSD: vis.1,v 1.19 2013/03/14 19:17:23 njoly Exp $ | .\" $NetBSD: vis.1,v 1.23 2015/05/24 19:42:39 christos Exp $ | ||||
.\" | .\" | ||||
.\" Copyright (c) 1989, 1991, 1993, 1994 | .\" Copyright (c) 1989, 1991, 1993, 1994 | ||||
.\" The Regents of the University of California. All rights reserved. | .\" The Regents of the University of California. All rights reserved. | ||||
.\" | .\" | ||||
.\" Redistribution and use in source and binary forms, with or without | .\" Redistribution and use in source and binary forms, with or without | ||||
.\" modification, are permitted provided that the following conditions | .\" modification, are permitted provided that the following conditions | ||||
.\" are met: | .\" are met: | ||||
.\" 1. Redistributions of source code must retain the above copyright | .\" 1. Redistributions of source code must retain the above copyright | ||||
Show All 14 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" 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 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" @(#)vis.1 8.4 (Berkeley) 4/19/94 | .\" @(#)vis.1 8.4 (Berkeley) 4/19/94 | ||||
.\" | .\" | ||||
.Dd February 19, 2013 | .Dd May 24, 2015 | ||||
.Dt VIS 1 | .Dt VIS 1 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm vis | .Nm vis | ||||
.Nd display non-printable characters in a visual format | .Nd display non-printable characters in a visual format | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.Nm | .Nm | ||||
.Op Fl bcfhlmnostw | .Op Fl bcfhlMmNnoSstw | ||||
.Op Fl e Ar extra | .Op Fl e Ar extra | ||||
.Op Fl F Ar foldwidth | .Op Fl F Ar foldwidth | ||||
.Op Ar file ... | .Op Ar file ... | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
.Nm | .Nm | ||||
is a filter for converting non-printable characters | is a filter for converting non-printable characters | ||||
into a visual representation. | into a visual representation. | ||||
It differs from | It differs from | ||||
▲ Show 20 Lines • Show All 45 Lines • ▼ Show 20 Lines | |||||
.Fl F . | .Fl F . | ||||
.It Fl h | .It Fl h | ||||
Encode using the URI encoding from RFC 1808. | Encode using the URI encoding from RFC 1808. | ||||
.Pq Dv VIS_HTTPSTYLE | .Pq Dv VIS_HTTPSTYLE | ||||
.It Fl l | .It Fl l | ||||
Mark newlines with the visible sequence | Mark newlines with the visible sequence | ||||
.Ql \e$ , | .Ql \e$ , | ||||
followed by the newline. | followed by the newline. | ||||
.It Fl M | |||||
Encode all shell meta characters (implies | |||||
.Fl S , | |||||
.Fl w , | |||||
.Fl g ) | |||||
.Pq Dv VIS_META | |||||
.It Fl m | .It Fl m | ||||
Encode using the MIME Quoted-Printable encoding from RFC 2045. | Encode using the MIME Quoted-Printable encoding from RFC 2045. | ||||
.Pq Dv VIS_MIMESTYLE | .Pq Dv VIS_MIMESTYLE | ||||
.It Fl N | |||||
Turn on the | |||||
.Dv VIS_NOLOCALE | |||||
flag which encodes using the | |||||
.Dq C | |||||
locale, removing any encoding dependencies caused by the current | |||||
locale settings specified in the environment. | |||||
.It Fl n | .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 | still doubled and hidden newline sequences inserted if | ||||
.Fl f | .Fl f | ||||
or | or | ||||
.Fl F | .Fl F | ||||
is selected. | is selected. | ||||
When combined with the | When combined with the | ||||
.Fl f | .Fl f | ||||
flag, | flag, | ||||
.Nm | .Nm | ||||
becomes like | becomes like | ||||
an invertible version of the | an invertible version of the | ||||
.Xr fold 1 | .Xr fold 1 | ||||
utility. | utility. | ||||
That is, the output can be unfolded by running the output through | That is, the output can be unfolded by running the output through | ||||
.Xr unvis 1 . | .Xr unvis 1 . | ||||
.It Fl o | .It Fl o | ||||
Request a format which displays non-printable characters as | Request a format which displays non-printable characters as | ||||
an octal number, \eddd. | an octal number, \eddd. | ||||
.Pq Dv VIS_OCTAL | .Pq Dv VIS_OCTAL | ||||
.It Fl S | |||||
Encode shell meta-characters that are non-white space or glob. | |||||
bcr: s/non-white space/non-whitespace/
(I'm thinking we should add this to our word list here: https… | |||||
gbeAuthorUnsubmitted Done Inline ActionsThis is a vendor import. I would just wait to get this into -CURRENT and then fix the manpage towards to our standards. There is also a manpage update pending by @fernape that adds an example section to the manpage, which, should after the manpage update also been send upstream. gbe: This is a vendor import. I would just wait to get this into -CURRENT and then fix the manpage… | |||||
.Pq Dv VIS_SHELL | |||||
.It Fl s | .It Fl s | ||||
Only characters considered unsafe to send to a terminal are encoded. | Only characters considered unsafe to send to a terminal are encoded. | ||||
This flag allows backspace, bell, and carriage return in addition | This flag allows backspace, bell, and carriage return in addition | ||||
to the default space, tab and newline. | to the default space, tab and newline. | ||||
.Pq Dv VIS_SAFE | .Pq Dv VIS_SAFE | ||||
.It Fl t | .It Fl t | ||||
Tabs are also encoded. | Tabs are also encoded. | ||||
.Pq Dv VIS_TAB | .Pq Dv VIS_TAB | ||||
Show All 25 Lines | |||||
.Xr unvis 1 , | .Xr unvis 1 , | ||||
.Xr svis 3 , | .Xr svis 3 , | ||||
.Xr vis 3 | .Xr vis 3 | ||||
.Sh HISTORY | .Sh HISTORY | ||||
The | The | ||||
.Nm | .Nm | ||||
command appears in | command appears in | ||||
.Bx 4.4 . | .Bx 4.4 . | ||||
Myltibyte character support was added in | Multibyte character support was added in | ||||
.Nx 7.0 | .Nx 7.0 | ||||
and | and | ||||
.Fx 9.2 . | .Fx 9.2 . |
s/non-white space/non-whitespace/
(I'm thinking we should add this to our word list here: https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-word-list.html)