projects / unix-history / blobdiff
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
BSD 4_3_Net_2 release
[unix-history] / usr / src / lib / libc / gen / unvis.3
diff --git a/usr/src/lib/libc/gen/unvis.3 b/usr/src/lib/libc/gen/unvis.3
index 24d81db..4ef3d56 100644 (file)
--- a/usr/src/lib/libc/gen/unvis.3
+++ b/usr/src/lib/libc/gen/unvis.3
@@ -1,102 +1,135 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.\"    @(#)unvis.3     1.2 (Berkeley) 6/27/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" 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
+.\" SUCH DAMAGE.
 .\"
 .\"
-.TH UNVIS 3 "June 27, 1990"
-.UC 7
-.SH NAME
-unvis, strunvis - decode a visual representation of characters
-.SH SYNOPSIS
-.nf
-.ft B
-#include <vis.h>
-
-int unvis(cp, c, astate, flag)
-u_char *cp, c;
-int *astate, flag;
-
-int strunvis(dst, src)
-char *dst, *src;
-
-.ft R
-.fi
-.SH DESCRIPTION
-.I Unvis
+.\"     @(#)unvis.3    1.3 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt UNVIS 3
+.Os
+.Sh NAME
+.Nm unvis ,
+.Nm strunvis
+.Nd decode a visual representation of characters
+.Sh SYNOPSIS
+.Fd #include <vis.h>
+.Ft int 
+.Fn unvis "u_char *cp" "u_char c" "int *astate" "int flag"
+.Ft int 
+.Fn strunvis "char *dst" "char *src"
+.Sh DESCRIPTION
+The
+.Fn unvis
 and
 and
-.I strunvis
+.Fn strunvis
+functions
 are used to decode a visual representation of characters, as produced
 are used to decode a visual representation of characters, as produced
-by the vis(3) function, back into
-its original form.  Unvis is called with successive characters in c 
+by the
+.Xr vis 3
+function, back into
+the original form.  Unvis is called with successive characters in
+.Ar c 
 until a valid
 sequence is recognized, at which time the decoded character is
 until a valid
 sequence is recognized, at which time the decoded character is
-available at the character pointed to by cp.  Strunvis decodes the
-characters pointed to by src into the buffer pointed to by dst.
-.LP
-.I Strunvis
-simply copies src to dst, decoding any escape sequences along the way,
-and returns the number of characters placed into dst, or -1 if an
-invalid escape sequence was detected.  The size of dst should be
-equal to the size of src (that is, no expansion takes place during
+available at the character pointed to by
+.Ar cp .
+Strunvis decodes the
+characters pointed to by
+.Ar src
+into the buffer pointed to by
+.Ar dst .
+.Pp
+The
+.Fn strunvis
+function
+simply copies
+.Ar src
+to
+.Ar dst ,
+decoding any escape sequences along the way,
+and returns the number of characters placed into
+.Ar dst ,
+or \-1 if an
+invalid escape sequence was detected.  The size of
+.Ar dst
+should be
+equal to the size of
+.Ar src
+(that is, no expansion takes place during
 decoding).
 decoding).
-.LP
-.I Unvis
+.Pp
+The
+.Fn unvis
+function
 implements a state machine that can be used to decode an arbitrary
 stream of bytes.  All state associated with the bytes being decoded
 is stored outside the
 implements a state machine that can be used to decode an arbitrary
 stream of bytes.  All state associated with the bytes being decoded
 is stored outside the
-.I unvis
+.Fn unvis
 function (that is, a pointer to the state is passed in), so
 calls decoding different streams can be freely intermixed.  To
 start decoding a stream of bytes, first initialize an integer
 function (that is, a pointer to the state is passed in), so
 calls decoding different streams can be freely intermixed.  To
 start decoding a stream of bytes, first initialize an integer
-to zero.  Call unvis with each successive byte, along with a pointer
+to zero.  Call
+.Fn unvis
+with each successive byte, along with a pointer
 to this integer, and a pointer to an destination character.
 to this integer, and a pointer to an destination character.
-.I Vis
+The
+.Xr unvis
+function
 has several return codes that must be handled properly.  They are:
 has several return codes that must be handled properly.  They are:
-.TP 
-0 (zero)
+.Bl -tag -width UNVIS_VALIDPUSH
+.It Li \&0 (zero)
 Another character is necessary; nothing has been recognized yet.
 Another character is necessary; nothing has been recognized yet.
-.TP
-UNVIS_VALID    
+.It Dv  UNVIS_VALID    
 A valid character has been recognized and is available at the location
 pointed to by cp.
 A valid character has been recognized and is available at the location
 pointed to by cp.
-.TP
-UNVIS_VALIDPUSH
+.It Dv  UNVIS_VALIDPUSH
 A valid character has been recognized and is available at the location
 pointed to by cp; however, the character currently passed in should
 be passed in again.
 A valid character has been recognized and is available at the location
 pointed to by cp; however, the character currently passed in should
 be passed in again.
-.TP
-UNVIS_NOCHAR
+.It Dv  UNVIS_NOCHAR
 A valid sequence was detected, but no character was produced.  This
 return code is necessary to indicate a logical break between characters.
 A valid sequence was detected, but no character was produced.  This
 return code is necessary to indicate a logical break between characters.
-.TP
-UNVIS_SYNBAD
+.It Dv  UNVIS_SYNBAD
 An invalid esacpe sequence was detected, or the decoder is in an
 unknown state.  The decoder is placed into the starting state.
 An invalid esacpe sequence was detected, or the decoder is in an
 unknown state.  The decoder is placed into the starting state.
-.LP
+.El
+.Pp
 When all bytes in the stream have been processed, call
 When all bytes in the stream have been processed, call
-.I unvis
+.Fn unvis
 one more time with flag set to
 one more time with flag set to
-.B UNVIS_END
+.Dv UNVIS_END
 to extract any remaining character (the character passed in is ignored).
 to extract any remaining character (the character passed in is ignored).
-.LP
+.Pp
 The following code fragment illustrates a proper use of
 The following code fragment illustrates a proper use of
-.IR unvis .
-.PP
-.nf
+.Fn unvis .
+.Bd -literal -offset indent
 int state = 0;
 char out;
 
 int state = 0;
 char out;
 
@@ -114,11 +147,16 @@ again:
                goto again;
        case UNVIS_SYNBAD:
                (void)fprintf(stderr, "bad sequence!\n");
                goto again;
        case UNVIS_SYNBAD:
                (void)fprintf(stderr, "bad sequence!\n");
-               exit(1);
+       exit(1);
        }
 }
 if (unvis(&out, (char)0, &state, UNVIS_END) == UNVIS_VALID)
        (void) putchar(out);
        }
 }
 if (unvis(&out, (char)0, &state, UNVIS_END) == UNVIS_VALID)
        (void) putchar(out);
-.fi
-.SH "SEE ALSO"
-vis(1)
+.Ed
+.Sh SEE ALSO
+.Xr vis 1
+.Sh HISTORY
+The
+.Fn unvis
+function is
+.Ud .
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.