Whitespace fixes, punctuation fix, NetBSD -> Nx.

This commit is contained in:
wiz 2001-06-05 13:25:57 +00:00
parent 2a65697aff
commit 8810d7f022
1 changed files with 21 additions and 21 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: vis.3,v 1.12 1999/11/25 16:52:29 wennmach Exp $
.\" $NetBSD: vis.3,v 1.13 2001/06/05 13:25:57 wiz Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@ -50,15 +50,15 @@
.Fd #include <vis.h>
.Ft char *
.Fn vis "char *dst" "int c" "int flag" "int nextc"
.Ft int
.Ft int
.Fn strvis "char *dst" "const char *src" "int flag"
.Ft int
.Ft int
.Fn strvisx "char *dst" "const char *src" "size_t len" "int flag"
.Ft char *
.Fn svis "char *dst" "int c" "int flag" "int nextc" "const char *extra"
.Ft int
.Ft int
.Fn strsvis "char *dst" "const char *src" "int flag" "const char *extra"
.Ft int
.Ft int
.Fn strsvisx "char *dst" "const char *src" "size_t len" "int flag" "const char *extra"
.Sh DESCRIPTION
The
@ -74,11 +74,11 @@ needs no encoding, it is copied in unaltered. The string is
null terminated, and a pointer to the end of the string is
returned. The maximum length of any encoding is four
characters (not including the trailing
.Dv NUL ) ;
.Dv NUL ) ;
thus, when
encoding a set of characters into a buffer, the size of the buffer should
be four times the number of characters encoded, plus one for the trailing
.Dv NUL .
.Dv NUL .
The flag parameter is used for altering the default range of
characters considered for encoding and for altering the visual
representation.
@ -103,7 +103,7 @@ function encodes characters from
.Fa src
up to the
first
.Dv NUL .
.Dv NUL .
The
.Fn strvisx
function encodes exactly
@ -112,7 +112,7 @@ characters from
.Fa src
(this
is useful for encoding a block of data that may contain
.Dv NUL Ns 's).
.Dv NUL Ns 's ) .
Both forms
.Dv NUL
terminate
@ -123,22 +123,22 @@ must be four times the number
of characters encoded from
.Fa src
(plus one for the
.Dv NUL ) .
.Dv NUL ) .
Both
forms return the number of characters in dst (not including
the trailing
.Dv NUL ) .
.Dv NUL ) .
.Pp
The functions
.Fn svis ,
.Fn strsvis ,
and
.Fn strsvisx
.Fn strsvisx
correspond to
.Fn vis ,
.Fn strvis ,
and
.Fn strvisx
.Fn strvisx
but have an additional argument
.Fa extra ,
pointing to a
@ -150,7 +150,7 @@ These functions are useful e. g. to remove the special meaning
of certain characters to shells.
.Pp
The encoding is a unique, invertible representation composed entirely of
graphic characters; it can be decoded back into the original form using
graphic characters; it can be decoded back into the original form using
the
.Xr unvis 3
or
@ -163,7 +163,7 @@ characters that are encoded (applies only to
.Fn strvis ,
and
.Fn strvisx ) ,
and the type of representation used.
and the type of representation used.
By default, all non-graphic characters,
except space, tab, and newline are encoded.
(See
@ -173,23 +173,23 @@ alter this:
.Bl -tag -width VIS_WHITEX
.It Dv VIS_SP
Also encode space.
.It Dv VIS_TAB
.It Dv VIS_TAB
Also encode tab.
.It Dv VIS_NL
Also encode newline.
.It Dv VIS_WHITE
.It Dv VIS_WHITE
Synonym for
.Dv VIS_SP
\&|
.Dv VIS_TAB
\&|
.Dv VIS_NL .
.It Dv VIS_SAFE
.It Dv VIS_SAFE
Only encode "unsafe" characters. Unsafe means control
characters which may cause common terminals to perform
unexpected functions. Currently this form allows space,
tab, newline, backspace, bell, and return - in addition
to all graphic characters - unencoded.
to all graphic characters - unencoded.
.El
.Pp
(The above flags have no effect for
@ -323,5 +323,5 @@ The
.Fa strsvis ,
and
.Fa strsvisx
functions appeared in NetBSD 1.5.
functions appeared in
.Nx 1.5 .