summaryrefslogtreecommitdiffstats
path: root/lib/libc/gen/unvis.3
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2002-12-18 13:33:04 +0000
committerru <ru@FreeBSD.org>2002-12-18 13:33:04 +0000
commit863465c1ab2c58349d7f1f859822ef564e592280 (patch)
tree6086e75984c3472fb331e2598243ce260e65581f /lib/libc/gen/unvis.3
parent8746d263e1451855025dc83dde5176cc9f1fbe3f (diff)
downloadFreeBSD-src-863465c1ab2c58349d7f1f859822ef564e592280.zip
FreeBSD-src-863465c1ab2c58349d7f1f859822ef564e592280.tar.gz
mdoc(7) police: Fixed abuses of the .Ar and .Em macros.
Diffstat (limited to 'lib/libc/gen/unvis.3')
-rw-r--r--lib/libc/gen/unvis.324
1 files changed, 12 insertions, 12 deletions
diff --git a/lib/libc/gen/unvis.3 b/lib/libc/gen/unvis.3
index 9f044b9..59cd85e 100644
--- a/lib/libc/gen/unvis.3
+++ b/lib/libc/gen/unvis.3
@@ -61,33 +61,33 @@ by the
.Xr vis 3
function, back into
the original form. Unvis is called with successive characters in
-.Ar c
+.Fa c
until a valid
sequence is recognized, at which time the decoded character is
available at the character pointed to by
-.Ar cp .
+.Fa cp .
Strunvis decodes the
characters pointed to by
-.Ar src
+.Fa src
into the buffer pointed to by
-.Ar dst .
+.Fa dst .
.Pp
The
.Fn strunvis
function
simply copies
-.Ar src
+.Fa src
to
-.Ar dst ,
+.Fa dst ,
decoding any escape sequences along the way,
and returns the number of characters placed into
-.Ar dst ,
+.Fa dst ,
or \-1 if an
invalid escape sequence was detected. The size of
-.Ar dst
+.Fa dst
should be
equal to the size of
-.Ar src
+.Fa src
(that is, no expansion takes place during
decoding).
.Pp
@@ -97,7 +97,7 @@ function does the same as the
.Fn strunvis
function,
but it allows you to add a flag that specifies the style the string
-.Ar src
+.Fa src
is encoded with.
Currently, the only supported flag is
.Dv VIS_HTTPSTYLE .
@@ -141,13 +141,13 @@ unknown state. The decoder is placed into the starting state.
When all bytes in the stream have been processed, call
.Fn unvis
one more time with
-.Ar flag
+.Fa flag
set to
.Dv UNVIS_END
to extract any remaining character (the character passed in is ignored).
.Pp
The
-.Ar flag
+.Fa flag
argument is also used to specify the encoding style of the source.
If set to
.Dv VIS_HTTPSTYLE ,
OpenPOWER on IntegriCloud