diff options
author | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-04-18 03:01:36 +0000 |
---|---|---|
committer | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-04-18 03:01:36 +0000 |
commit | c2d5d31832de35b48a0e487f90b9a58abeb3a8ea (patch) | |
tree | 3dcc33b96ac33fca8fde9f5dff0db0a5afbb6ae4 /lib/libc/gen | |
parent | b6a043747e2041e97decf4b4c5a3b51c3b40b722 (diff) |
Repairs, mostly removing hard sentence breaks.
Diffstat (limited to 'lib/libc/gen')
-rw-r--r-- | lib/libc/gen/basename.3 | 8 | ||||
-rw-r--r-- | lib/libc/gen/directory.3 | 10 | ||||
-rw-r--r-- | lib/libc/gen/dirname.3 | 5 | ||||
-rw-r--r-- | lib/libc/gen/exec.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/ftok.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/fts.3 | 4 | ||||
-rw-r--r-- | lib/libc/gen/getcap.3 | 89 | ||||
-rw-r--r-- | lib/libc/gen/getdiskbyname.3 | 7 | ||||
-rw-r--r-- | lib/libc/gen/getdomainname.3 | 12 | ||||
-rw-r--r-- | lib/libc/gen/getgrent.3 | 20 | ||||
-rw-r--r-- | lib/libc/gen/gethostname.3 | 12 | ||||
-rw-r--r-- | lib/libc/gen/getloadavg.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/getmntinfo.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/getpwent.3 | 9 | ||||
-rw-r--r-- | lib/libc/gen/getusershell.3 | 5 | ||||
-rw-r--r-- | lib/libc/gen/lockf.3 | 33 | ||||
-rw-r--r-- | lib/libc/gen/psignal.3 | 9 | ||||
-rw-r--r-- | lib/libc/gen/setjmp.3 | 9 | ||||
-rw-r--r-- | lib/libc/gen/signal.3 | 8 | ||||
-rw-r--r-- | lib/libc/gen/sleep.3 | 9 | ||||
-rw-r--r-- | lib/libc/gen/sysctl.3 | 14 | ||||
-rw-r--r-- | lib/libc/gen/timezone.3 | 6 | ||||
-rw-r--r-- | lib/libc/gen/tolower.3 | 5 | ||||
-rw-r--r-- | lib/libc/gen/toupper.3 | 5 | ||||
-rw-r--r-- | lib/libc/gen/ttyname.3 | 11 | ||||
-rw-r--r-- | lib/libc/gen/unvis.3 | 26 | ||||
-rw-r--r-- | lib/libc/gen/utime.3 | 5 | ||||
-rw-r--r-- | lib/libc/gen/vis.3 | 19 |
28 files changed, 209 insertions, 155 deletions
diff --git a/lib/libc/gen/basename.3 b/lib/libc/gen/basename.3 index 53e01067660..e5c74951f33 100644 --- a/lib/libc/gen/basename.3 +++ b/lib/libc/gen/basename.3 @@ -24,7 +24,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: basename.3,v 1.11 1999/06/04 01:30:10 aaron Exp $ +.\" $OpenBSD: basename.3,v 1.12 2000/04/18 03:01:25 aaron Exp $ .\" .Dd August 17, 1997 .Dt BASENAME 3 @@ -44,13 +44,15 @@ returns the last component from the pathname pointed to by .Ar path , deleting any trailing .Sq \&/ -characters. If +characters. +If .Ar path consists entirely of .Sq \&/ characters, a pointer to the string .Qq \&/ -is returned. If +is returned. +If .Ar path is a null pointer or the empty string, a pointer to the string .Qq \&. diff --git a/lib/libc/gen/directory.3 b/lib/libc/gen/directory.3 index a0b7e01b6af..1256e853de7 100644 --- a/lib/libc/gen/directory.3 +++ b/lib/libc/gen/directory.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: directory.3,v 1.12 2000/04/15 02:15:22 aaron Exp $ +.\" $OpenBSD: directory.3,v 1.13 2000/04/18 03:01:25 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -56,7 +56,7 @@ .Ft long .Fn telldir "const DIR *dirp" .Ft void -.Fn seekdir "DIR *dirp" "long loc" +.Fn seekdir "DIR *dirp" "long loc" .Ft void .Fn rewinddir "DIR *dirp" .Ft int @@ -74,7 +74,8 @@ with it and returns a pointer to be used to identify the directory stream -in subsequent operations. A null pointer is returned if +in subsequent operations. +A null pointer is returned if .Fa filename cannot be accessed, or if .Xr malloc 3 @@ -133,7 +134,8 @@ operation on the named directory stream The new position reverts to the one associated with the directory stream when the .Fn telldir -operation was performed. Values returned by +operation was performed. +Values returned by .Fn telldir are good only for the lifetime of the .Dv DIR diff --git a/lib/libc/gen/dirname.3 b/lib/libc/gen/dirname.3 index 4f3d7754562..1857849f5ab 100644 --- a/lib/libc/gen/dirname.3 +++ b/lib/libc/gen/dirname.3 @@ -24,7 +24,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: dirname.3,v 1.8 1999/07/17 09:32:30 downsj Exp $ +.\" $OpenBSD: dirname.3,v 1.9 2000/04/18 03:01:25 aaron Exp $ .\" .Dd August 17, 1997 .Dt DIRNAME 3 @@ -47,7 +47,8 @@ it returns a pointer to the parent directory of the pathname pointed to by Any trailing .Sq \&/ characters are not counted as part of the directory -name. If +name. +If .Ar path is a null pointer, the empty string, or contains no .Sq \&/ diff --git a/lib/libc/gen/exec.3 b/lib/libc/gen/exec.3 index 734da4d14af..bc5d7a48878 100644 --- a/lib/libc/gen/exec.3 +++ b/lib/libc/gen/exec.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: exec.3,v 1.9 1999/06/04 01:30:10 aaron Exp $ +.\" $OpenBSD: exec.3,v 1.10 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -52,7 +52,7 @@ .Ft int .Fn execle "const char *path" "const char *arg" ... "char *const envp[]" .Ft int -.Fn exect "const char *path" "char *const argv[]" "char *const envp[]" +.Fn exect "const char *path" "char *const argv[]" "char *const envp[]" .Ft int .Fn execv "const char *path" "char *const argv[]" .Ft int @@ -80,7 +80,7 @@ and .Fn execle functions can be thought of as .Fa arg0 , -.Fa arg1 , +.Fa arg1 , \&..., .Fa argn . Together they describe a list of one or more pointers to diff --git a/lib/libc/gen/ftok.3 b/lib/libc/gen/ftok.3 index c6a747da494..b5f4dfbcc34 100644 --- a/lib/libc/gen/ftok.3 +++ b/lib/libc/gen/ftok.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ftok.3,v 1.9 1999/09/23 04:12:00 alex Exp $ +.\" $OpenBSD: ftok.3,v 1.10 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1994 SigmaSoft, Th. Lockert <tholo@sigmasoft.com> .\" All rights reserved. @@ -52,8 +52,8 @@ of an existing file and a user-selectable The specified .Fa path must refer to an existing file that is accessible to the calling process -or the call will fail. Also, note that links to files will return the -same key, given the same +or the call will fail. +Also, note that links to files will return the same key, given the same .Fa id . Only the 8 least significant bits of .Fa id diff --git a/lib/libc/gen/fts.3 b/lib/libc/gen/fts.3 index 61df9e1ab2f..7e0957e3bc1 100644 --- a/lib/libc/gen/fts.3 +++ b/lib/libc/gen/fts.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fts.3,v 1.15 1999/10/03 19:22:22 millert Exp $ +.\" $OpenBSD: fts.3,v 1.16 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1989, 1991, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -141,7 +141,7 @@ With the exception of directories without errors all of these entries are terminal, that is, they will not be revisited, nor will any of their descendants be visited. -.Bl -tag -width FTS_DEFAULT +.Bl -tag -width FTS_DEFAULT .It Dv FTS_D A directory being visited in pre-order. .It Dv FTS_DC diff --git a/lib/libc/gen/getcap.3 b/lib/libc/gen/getcap.3 index 8bc3e98236b..2a40775d866 100644 --- a/lib/libc/gen/getcap.3 +++ b/lib/libc/gen/getcap.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getcap.3,v 1.18 2000/03/06 21:46:56 aaron Exp $ +.\" $OpenBSD: getcap.3,v 1.19 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1992, 1993 .\" The Regents of the University of California. All rights reserved. @@ -131,7 +131,8 @@ is .Dv NULL , the current entry is removed from the database. .Fn cgetset -must precede the database traversal. It must be called before +must precede the database traversal. +It must be called before .Fn cgetent . If a sequential access is being performed (see below), it must be called before the first sequential access call @@ -160,18 +161,21 @@ with type .Fa type . A .Fa type -is specified using any single character. If a colon +is specified using any single character. +If a colon .Pq Sq \&: is used, an untyped capability will be searched for (see below for explanation of -types). A pointer to the value of +types). +A pointer to the value of .Fa cap in .Fa buf is returned on success or .Dv NULL if the requested capability couldn't be -found. The end of the capability value is signaled by a +found. +The end of the capability value is signaled by a .Sq \&: or .Tn ASCII @@ -228,7 +232,8 @@ record returned by the previous .Fn cgetfirst or .Fn cgetnext -call. If there is no such previous call, the first record in the database is +call. +If there is no such previous call, the first record in the database is returned. Each record is returned in a .Xr malloc Ns \&'d @@ -238,7 +243,7 @@ copy pointed to by expansion is done (see .Ic tc= comments below). -Upon completion of the database 0 is returned, 1 is returned upon successful +Upon completion of the database 0 is returned, 1 is returned upon successful return of record with possibly more remaining (we haven't reached the end of the database yet), 2 is returned if the record contains an unresolved .Ic tc @@ -250,36 +255,43 @@ Upon completion of database (0 return) the database is closed. .Pp .Fn cgetclose closes the sequential access and frees any memory and file descriptors -being used. Note that it does not erase the buffer pushed by a call to +being used. +Note that it does not erase the buffer pushed by a call to .Fn cgetset . .Ss Capability database syntax Capability databases are normally .Tn ASCII and may be edited with standard -text editors. Blank lines and lines beginning with a +text editors. +Blank lines and lines beginning with a .Sq \&# are comments -and ignored. Lines ending with a +and ignored. +Lines ending with a .Sq \|\e indicate that the next line is a continuation of the current line; the .Sq \|\e and following newline -are ignored. Long lines are usually continued onto several physical +are ignored. +Long lines are usually continued onto several physical lines by ending each line except the last with a .Sq \|\e . .Pp Capability databases consist of a series of records, one per logical -line. Each record contains a variable number of -colon-separated fields -(capabilities). Empty fields consisting entirely of whitespace +line. +Each record contains a variable number of colon-separated fields +(capabilities). +Empty fields consisting entirely of whitespace characters (spaces and tabs) are ignored. .Pp The first capability of each record specifies its names, separated by .Sq \&| -characters. These names are used to reference records in the database. +characters. +These names are used to reference records in the database. By convention, the last name is usually a comment and is not intended as -a lookup tag. For example, the +a lookup tag. +For example, the .Dq vt100 record from the .Nm termcap @@ -304,8 +316,8 @@ has value does not exist .El .Pp -Names consist of one or more characters. Names may contain any character -except +Names consist of one or more characters. +Names may contain any character except .Sq \&: , but it's usually best to restrict them to the printable characters and avoid use of graphics like @@ -313,21 +325,22 @@ characters and avoid use of graphics like .Sq \&= , .Sq \&% , .Sq \&@ , -etc. Types -are single characters used to separate capability names from their -associated typed values. Types may be any character except a +etc. +Types are single characters used to separate capability names from their +associated typed values. +Types may be any character except a .Sq \&: . Typically, graphics like .Sq \&# , .Sq \&= , .Sq \&% , -etc. are used. Values may be any -number of characters and may contain any character except +etc. are used. +Values may be any number of characters and may contain any character except .Sq \&: . .Ss Capability database semantics -Capability records describe a set of (name, value) bindings. Names may -have multiple values bound to them. Different values for a name are -distinguished by their +Capability records describe a set of (name, value) bindings. +Names may have multiple values bound to them. +Different values for a name are distinguished by their .Fa types . .Fn cgetcap will return a pointer to a value of a name given the capability name and @@ -338,8 +351,8 @@ The types and .Sq \&= are conventionally used to denote numeric and -string typed values, but no restriction on those types is enforced. The -functions +string typed values, but no restriction on those types is enforced. +The functions .Fn cgetnum and .Fn cgetstr @@ -365,7 +378,8 @@ capabilities may interpolate records which also contain .Ic tc capabilities and more than one .Ic tc -capability may be used in a record. A +capability may be used in a record. +A .Ic tc expansion scope (i.e., where the argument is searched for) contains the file in which the @@ -373,7 +387,8 @@ file in which the is declared and all subsequent files in the file array. .Pp When a database is searched for a capability record, the first matching -record in the search is returned. When a record is scanned for a +record in the search is returned. +When a record is scanned for a capability, the first matching capability is returned; the capability .Ic :nameT@: will hide any following definition of a value of type @@ -429,7 +444,8 @@ Otherwise, if the number starts with a it is interpreted as an octal number. Otherwise the number is interpreted as a decimal number. .Pp -String capability values may contain any character. Non-printable +String capability values may contain any character. +Non-printable .Dv ASCII codes, new lines, and colons may be conveniently represented by the use of escape sequences: @@ -450,7 +466,8 @@ of escape sequences: A .Sq \|\e may be followed by up to three octal digits directly specifies -the numeric code for a character. The use of +the numeric code for a character. +The use of .Tn ASCII NULs, while easily encoded, causes all sorts of problems and must be used with care since @@ -471,8 +488,8 @@ The capability foo has two values bound to it (bar of type and blah of type .Sq \&^ ) -and any other value bindings are hidden. The capability abc -also has two values bound but only a value of type +and any other value bindings are hidden. +The capability abc also has two values bound but only a value of type .Sq \&$ is prevented from being defined in the capability record more. @@ -495,8 +512,8 @@ who-cares@ prevents the definition of any who-cares definitions in old from being seen, glork#200 is inherited from old, and blah and anything defined by the record extensions is added to those definitions in old. Note that the position of the fript=bar and who-cares@ definitions before -tc=old is important here. If they were after, the definitions in old -would take precedence. +tc=old is important here. +If they were after, the definitions in old would take precedence. .Sh DIAGNOSTICS .Fn cgetent , .Fn cgetset , diff --git a/lib/libc/gen/getdiskbyname.3 b/lib/libc/gen/getdiskbyname.3 index 170af443249..48769d8a2fc 100644 --- a/lib/libc/gen/getdiskbyname.3 +++ b/lib/libc/gen/getdiskbyname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getdiskbyname.3,v 1.5 1999/07/09 13:35:16 aaron Exp $ +.\" $OpenBSD: getdiskbyname.3,v 1.6 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -48,9 +48,8 @@ function takes a disk name (e.g., .Qq rm03 ) and returns a prototype disk label -describing its geometry information and the standard -disk partition tables. All information is obtained from -the +describing its geometry information and the standard disk partition tables. +All information is obtained from the .Xr disktab 5 file. .Sh SEE ALSO diff --git a/lib/libc/gen/getdomainname.3 b/lib/libc/gen/getdomainname.3 index a295a9f2d94..fc19c150225 100644 --- a/lib/libc/gen/getdomainname.3 +++ b/lib/libc/gen/getdomainname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getdomainname.3,v 1.16 2000/04/15 11:46:02 aaron Exp $ +.\" $OpenBSD: getdomainname.3,v 1.17 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -55,7 +55,8 @@ The parameter .Fa namelen specifies the size of the .Fa name -array. If insufficient space is provided, the returned name is truncated. +array. +If insufficient space is provided, the returned name is truncated. The returned name is always null terminated. .Pp .Fn setdomainname @@ -66,8 +67,8 @@ which has length This call is restricted to the superuser and is normally used only when the system is bootstrapped. .Sh RETURN VALUES -If the call succeeds a value of 0 is returned. If the call -fails, a value of \-1 is returned and an error code is +If the call succeeds a value of 0 is returned. +If the call fails, a value of \-1 is returned and an error code is placed in the global variable .Va errno . .Sh ERRORS @@ -95,7 +96,8 @@ Domain names are limited to .Dv MAXHOSTNAMELEN (from .Ao Pa sys/param.h Ac ) -characters, currently 256. This includes the terminating NUL character. +characters, currently 256. +This includes the terminating NUL character. .Pp If the buffer passed to .Fn getdomainname diff --git a/lib/libc/gen/getgrent.3 b/lib/libc/gen/getgrent.3 index 77f31a4a1de..f7a237c106e 100644 --- a/lib/libc/gen/getgrent.3 +++ b/lib/libc/gen/getgrent.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getgrent.3,v 1.8 2000/03/23 22:14:03 d Exp $ +.\" $OpenBSD: getgrent.3,v 1.9 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -94,8 +94,8 @@ search the group database for the given group name pointed to by .Fa name or the group ID pointed to by .Fa gid , -respectively, returning the first one encountered. Identical group -names or group GIDs may result in undefined behavior. +respectively, returning the first one encountered. +Identical group names or group GIDs may result in undefined behavior. .Pp .Fn getgrent sequentially reads the group database and is intended for programs @@ -104,12 +104,15 @@ that wish to step through the complete list of groups. All three routines will open the group file for reading, if necessary. .Pp .Fn setgroupent -opens the file, or rewinds it if it is already open. If +opens the file, or rewinds it if it is already open. +If .Fa stayopen is non-zero, file descriptors are left open, significantly speeding -subsequent function calls. This functionality is unnecessary for +subsequent function calls. +This functionality is unnecessary for .Fn getgrent -as it doesn't close its file descriptors by default. It should also +as it doesn't close its file descriptors by default. +It should also be noted that it is dangerous for long-running programs to use this functionality as the group file may be updated. .Pp @@ -208,9 +211,8 @@ The functions and .Fn setgrent leave their results in an internal static object and return -a pointer to that object. Subsequent calls to -the same function -will modify the same object. +a pointer to that object. +Subsequent calls to the same function will modify the same object. .Pp The functions .Fn getgrent , diff --git a/lib/libc/gen/gethostname.3 b/lib/libc/gen/gethostname.3 index d89aa0f7bd5..a10102b5943 100644 --- a/lib/libc/gen/gethostname.3 +++ b/lib/libc/gen/gethostname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gethostname.3,v 1.16 2000/04/15 11:46:02 aaron Exp $ +.\" $OpenBSD: gethostname.3,v 1.17 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -54,7 +54,8 @@ The parameter .Fa namelen specifies the size of the .Fa name -array. If insufficient space is provided, the returned name is truncated. +array. +If insufficient space is provided, the returned name is truncated. The returned name is always null terminated. .Pp .Fn sethostname @@ -65,8 +66,8 @@ which has length This call is restricted to the superuser and is normally used only when the system is bootstrapped. .Sh RETURN VALUES -If the call succeeds a value of 0 is returned. If the call -fails, a value of \-1 is returned and an error code is +If the call succeeds a value of 0 is returned. +If the call fails, a value of \-1 is returned and an error code is placed in the global variable .Va errno . .Sh ERRORS @@ -94,7 +95,8 @@ Host names are limited to .Dv MAXHOSTNAMELEN (from .Ao Pa sys/param.h Ac ) -characters, currently 256. This includes the terminating NUL character. +characters, currently 256. +This includes the terminating NUL character. .Pp If the buffer passed to .Fn gethostname diff --git a/lib/libc/gen/getloadavg.3 b/lib/libc/gen/getloadavg.3 index 933eaaeb637..8a65e0e05c8 100644 --- a/lib/libc/gen/getloadavg.3 +++ b/lib/libc/gen/getloadavg.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getloadavg.3,v 1.7 1999/06/03 10:03:21 aaron Exp $ +.\" $OpenBSD: getloadavg.3,v 1.8 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -53,8 +53,8 @@ samples are retrieved and assigned to successive elements of The system imposes a maximum of 3 samples, representing averages over the last 1, 5, and 15 minutes, respectively. .Sh RETURN VALUES -Upon successful completion, the number of samples retrieved is -returned. If an error occurs, \-1 is returned and the global variable +Upon successful completion, the number of samples retrieved is returned. +If an error occurs, \-1 is returned and the global variable .Va errno is set to indicate the error. .Sh ERRORS diff --git a/lib/libc/gen/getmntinfo.3 b/lib/libc/gen/getmntinfo.3 index 4467c1224de..10123bfebc3 100644 --- a/lib/libc/gen/getmntinfo.3 +++ b/lib/libc/gen/getmntinfo.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getmntinfo.3,v 1.7 1999/08/25 12:26:51 millert Exp $ +.\" $OpenBSD: getmntinfo.3,v 1.8 2000/04/18 03:01:26 aaron Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -97,8 +97,8 @@ function first appeared in The .Fn getmntinfo function writes the array of structures to an internal static object -and returns -a pointer to that object. Subsequent calls to +and returns a pointer to that object. +Subsequent calls to .Fn getmntinfo will modify the same object. .Pp diff --git a/lib/libc/gen/getpwent.3 b/lib/libc/gen/getpwent.3 index f736ae6b391..879c1a41739 100644 --- a/lib/libc/gen/getpwent.3 +++ b/lib/libc/gen/getpwent.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getpwent.3,v 1.10 2000/04/15 02:15:22 aaron Exp $ +.\" $OpenBSD: getpwent.3,v 1.11 2000/04/18 03:01:27 aaron Exp $ .\" .\" Copyright (c) 1988, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -52,7 +52,7 @@ .Ft struct passwd * .Fn getpwuid "uid_t uid" .Ft int -.Fn setpassent "int stayopen" +.Fn setpassent "int stayopen" .Ft void .Fn setpwent void .Ft void @@ -184,9 +184,8 @@ The functions and .Fn getpwuid leave their results in an internal static object and return -a pointer to that object. Subsequent calls to -any of these functions -will modify the same object. +a pointer to that object. +Subsequent calls to any of these functions will modify the same object. .Pp The routines .Fn getpwent , diff --git a/lib/libc/gen/getusershell.3 b/lib/libc/gen/getusershell.3 index a45d724cdc2..1d41eb1cc64 100644 --- a/lib/libc/gen/getusershell.3 +++ b/lib/libc/gen/getusershell.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getusershell.3,v 1.7 1999/07/09 13:35:17 aaron Exp $ +.\" $OpenBSD: getusershell.3,v 1.8 2000/04/18 03:01:27 aaron Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -93,6 +93,7 @@ function appeared in The .Fn getusershell function leaves its result in an internal static object and returns -a pointer to that object. Subsequent calls to +a pointer to that object. +Subsequent calls to .Fn getusershell will modify the same object. diff --git a/lib/libc/gen/lockf.3 b/lib/libc/gen/lockf.3 index 2aa2d8b2bd8..e7b0c7bae28 100644 --- a/lib/libc/gen/lockf.3 +++ b/lib/libc/gen/lockf.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lockf.3,v 1.8 1999/06/05 03:44:54 aaron Exp $ +.\" $OpenBSD: lockf.3,v 1.9 2000/04/18 03:01:27 aaron Exp $ .\" $NetBSD: lockf.3,v 1.1 1997/12/20 20:23:17 kleink Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -96,11 +96,12 @@ detects if a lock by another process is present on the specified section. .Pp The .Fa size -argument is the number of contiguous bytes to be locked or -unlocked. The section to be locked or unlocked starts at the current +argument is the number of contiguous bytes to be locked or unlocked. +The section to be locked or unlocked starts at the current offset in the file and extends forward for a positive size or backward for a negative size (the preceding bytes up to but not including the -current offset). However, it is not permitted to lock a section that +current offset). +However, it is not permitted to lock a section that starts or extends before the beginning of the file. If .Fa size @@ -113,9 +114,11 @@ The sections locked with or .Dv F_TLOCK may, in whole or in part, contain or be contained by a previously -locked section for the same process. When this occurs, or if adjacent +locked section for the same process. +When this occurs, or if adjacent locked sections would occur, the sections are combined into a single -locked section. If the request would cause the number of locks to +locked section. +If the request would cause the number of locks to exceed a system-imposed limit, the request will fail. .Pp The @@ -135,15 +138,19 @@ file descriptor for the file. .Pp .Dv F_ULOCK requests release (wholly or in part) of one or more locked sections -controlled by the process. Locked sections will be unlocked starting +controlled by the process. +Locked sections will be unlocked starting at the current file offset through .Fa size -bytes or to the end of the file if size is 0. When all of a locked section +bytes or to the end of the file if size is 0. +When all of a locked section is not released (that is, when the beginning or end of the area to be unlocked falls within a locked section), the remaining portions of -that section are still locked by the process. Releasing the center +that section are still locked by the process. +Releasing the center portion of a locked section will cause the remaining locked beginning -and end portions to become two separate locked sections. If the +and end portions to become two separate locked sections. +If the request would cause the number of locks in the system to exceed a system-imposed limit, the request will fail. .Pp @@ -155,13 +162,15 @@ the requested section is the maximum value for an object of type when the process has an existing lock in which size is 0 and which includes the last byte of the requested section, will be treated as a request to unlock from the start of the requested section with a -size equal to 0. Otherwise an +size equal to 0. +Otherwise an .Dv F_ULOCK request will attempt to unlock only the requested section. .Pp A potential for deadlock occurs if a process controlling a locked region is put to sleep by attempting to lock the locked region of -another process. This implementation detects that sleeping until a +another process. +This implementation detects that sleeping until a locked region is unlocked would cause a deadlock and fails with an .Er EDEADLK error. diff --git a/lib/libc/gen/psignal.3 b/lib/libc/gen/psignal.3 index 455965e3c4e..d247e95f285 100644 --- a/lib/libc/gen/psignal.3 +++ b/lib/libc/gen/psignal.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: psignal.3,v 1.7 1999/07/09 13:35:18 aaron Exp $ +.\" $OpenBSD: psignal.3,v 1.8 2000/04/18 03:01:27 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -68,11 +68,12 @@ is produced. .Pp The message strings can be accessed directly using the external array .Va sys_siglist , -indexed by recognized signal numbers. The external array +indexed by recognized signal numbers. +The external array .Va sys_signame is used similarly and contains short, upper-case abbreviations for signals -which are useful for recognizing signal names in user input. The defined -variable +which are useful for recognizing signal names in user input. +The defined variable .Dv NSIG contains a count of the strings in .Va sys_siglist diff --git a/lib/libc/gen/setjmp.3 b/lib/libc/gen/setjmp.3 index df0fc58d4f5..87e828a0a92 100644 --- a/lib/libc/gen/setjmp.3 +++ b/lib/libc/gen/setjmp.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: setjmp.3,v 1.9 1999/07/09 13:35:18 aaron Exp $ +.\" $OpenBSD: setjmp.3,v 1.10 2000/04/18 03:01:27 aaron Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -94,8 +94,8 @@ as well as .Fn setjmp and .Fn longjmp -combinations may be used in the same program. However, individual -calls may not \(em e.g., the +combinations may be used in the same program. +However, individual calls may not \(em e.g., the .Fa env argument to .Fn setjmp @@ -131,7 +131,8 @@ The function pairs save and restore the signal mask if the argument .Fa savemask -is non-zero. Otherwise, only the register set and the stack are saved. +is non-zero. +Otherwise, only the register set and the stack are saved. .Sh ERRORS If the contents of the .Fa env diff --git a/lib/libc/gen/signal.3 b/lib/libc/gen/signal.3 index 21f070bef6e..3566c7ed2ae 100644 --- a/lib/libc/gen/signal.3 +++ b/lib/libc/gen/signal.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: signal.3,v 1.12 1999/07/09 13:35:19 aaron Exp $ +.\" $OpenBSD: signal.3,v 1.13 2000/04/18 03:01:27 aaron Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -55,7 +55,8 @@ facility. .Pp Signals allow the manipulation of a process from outside its domain as well as allowing the process to manipulate itself or -copies of itself (children). There are two general types of signals: +copies of itself (children). +There are two general types of signals: those that cause termination of a process and those that do not. Signals which cause termination of a program might result from an irrecoverable error or might be the result of a user at a terminal @@ -150,7 +151,8 @@ To ignore the signal, should be .Dv SIG_IGN . This will cause subsequent instances of the signal to be ignored -and pending instances to be discarded. If +and pending instances to be discarded. +If .Dv SIG_IGN is not used, further occurrences of the signal are diff --git a/lib/libc/gen/sleep.3 b/lib/libc/gen/sleep.3 index b4aea47d790..bd51f899a72 100644 --- a/lib/libc/gen/sleep.3 +++ b/lib/libc/gen/sleep.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sleep.3,v 1.7 1999/08/31 16:52:34 aaron Exp $ +.\" $OpenBSD: sleep.3,v 1.8 2000/04/18 03:01:27 aaron Exp $ .\" .\" Copyright (c) 1986, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -48,8 +48,8 @@ function suspends execution of the calling process until either the number of seconds specified by .Fa seconds have elapsed or a signal is delivered to the calling process and its -action is to invoke a signal-catching function or to terminate the -process. The suspension time may be longer than requested due to the +action is to invoke a signal-catching function or to terminate the process. +The suspension time may be longer than requested due to the scheduling of other activity by the system. .Pp This function is implemented using @@ -67,7 +67,8 @@ interferes with interval timers anymore). If the .Fn sleep function returns because the requested time has elapsed, the value -returned will be zero. If the +returned will be zero. +If the .Fn sleep function returns due to the delivery of a signal, the value returned will be the unslept amount (the request time minus the time actually diff --git a/lib/libc/gen/sysctl.3 b/lib/libc/gen/sysctl.3 index b84fae29f33..528c1e2f8b9 100644 --- a/lib/libc/gen/sysctl.3 +++ b/lib/libc/gen/sysctl.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sysctl.3,v 1.41 2000/04/12 21:48:01 aaron Exp $ +.\" $OpenBSD: sysctl.3,v 1.42 2000/04/18 03:01:27 aaron Exp $ .\" .\" Copyright (c) 1993 .\" The Regents of the University of California. All rights reserved. @@ -198,7 +198,7 @@ level is detailed below. The changeable column shows whether a process with appropriate privileges may change the value. .Bl -column "Second level nameXXXXXX" integerXXX -offset indent -.It Sy Second level name Type Changeable +.It Sy Second level name Type Changeable .It Dv HW_MACHINE No " string no" .It Dv HW_MODEL No " string no" .It Dv HW_NCPU No " integer no" @@ -720,8 +720,8 @@ in seconds.) .It Li tcp.sack Returns 1 if RFC2018 Selective Acknowledgements are enabled. .It Li tcp.mssdflt -The maximum segment size that is used as default for non local -connections. The default value is 512. +The maximum segment size that is used as default for non-local connections. +The default value is 512. .It Li udp.checksum Returns 1 when .Tn UDP @@ -1009,9 +1009,9 @@ Return the system wide virtual memory statistics. The returned data consists of a .Li struct vmtotal . .It Dv VM_SWAPENCRYPT -Set to 1 to enable swap encryption for all processes. A 0 -disables swap encryption. Pages still on swap receive a -grandfather clause. +Set to 1 to enable swap encryption for all processes. +A 0 disables swap encryption. +Pages still on swap receive a grandfather clause. .El .Sh RETURN VALUES If the call to diff --git a/lib/libc/gen/timezone.3 b/lib/libc/gen/timezone.3 index 8c6df4144a0..23c64eec6a1 100644 --- a/lib/libc/gen/timezone.3 +++ b/lib/libc/gen/timezone.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: timezone.3,v 1.9 2000/03/31 00:04:14 millert Exp $ +.\" $OpenBSD: timezone.3,v 1.10 2000/04/18 03:01:28 aaron Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -64,8 +64,8 @@ and .Fa dst is non-zero if Daylight Saving Time is in effect. .Pp -This function is not used to set the system's time zone. The -default system time zone may be set by running +This function is not used to set the system's time zone. +The default system time zone may be set by running .Li Dq zic -l timezone as the superuser. .Sh SEE ALSO diff --git a/lib/libc/gen/tolower.3 b/lib/libc/gen/tolower.3 index bf67f324e80..2a80e804bc7 100644 --- a/lib/libc/gen/tolower.3 +++ b/lib/libc/gen/tolower.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tolower.3,v 1.8 1999/07/09 13:35:19 aaron Exp $ +.\" $OpenBSD: tolower.3,v 1.9 2000/04/18 03:01:28 aaron Exp $ .\" .\" Copyright (c) 1989, 1991 The Regents of the University of California. .\" All rights reserved. @@ -52,7 +52,8 @@ The .Fn tolower function converts an upper-case letter to the corresponding lower-case -letter. The +letter. +The .Fn _tolower function is identical to .Fn tolower diff --git a/lib/libc/gen/toupper.3 b/lib/libc/gen/toupper.3 index 8ce6d914384..c2abea2cd00 100644 --- a/lib/libc/gen/toupper.3 +++ b/lib/libc/gen/toupper.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: toupper.3,v 1.10 1999/07/09 13:35:19 aaron Exp $ +.\" $OpenBSD: toupper.3,v 1.11 2000/04/18 03:01:28 aaron Exp $ .\" .\" Copyright (c) 1989, 1991 The Regents of the University of California. .\" All rights reserved. @@ -52,7 +52,8 @@ The .Fn toupper function converts a lower-case letter to the corresponding -upper-case letter. The +upper-case letter. +The .Fn _toupper function is identical to .Fn toupper diff --git a/lib/libc/gen/ttyname.3 b/lib/libc/gen/ttyname.3 index 664662519ce..0dca816732b 100644 --- a/lib/libc/gen/ttyname.3 +++ b/lib/libc/gen/ttyname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ttyname.3,v 1.10 2000/01/22 12:00:42 aaron Exp $ +.\" $OpenBSD: ttyname.3,v 1.11 2000/04/18 03:01:28 aaron Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -52,7 +52,8 @@ .Fn ttyslot "void" .Sh DESCRIPTION These functions operate on the system file descriptors for terminal -type devices. These descriptors are not related to the standard +type devices. +These descriptors are not related to the standard .Tn I/O .Dv FILE typedef, but refer to the special device files found in @@ -93,7 +94,8 @@ in the character array referenced by The array is .Fa namesize characters long and should have space for the name and the terminating -NUL character. The maximum length of the terminal name is +NUL character. +The maximum length of the terminal name is .Dv TTY_NAME_MAX . .Pp The @@ -174,6 +176,7 @@ function appeared in the POSIX Threads Extension (1003.1c-1995). The .Fn ttyname function leaves its result in an internal static object and returns -a pointer to that object. Subsequent calls to +a pointer to that object. +Subsequent calls to .Fn ttyname will modify the same object. diff --git a/lib/libc/gen/unvis.3 b/lib/libc/gen/unvis.3 index a10e539324f..663b6f8331f 100644 --- a/lib/libc/gen/unvis.3 +++ b/lib/libc/gen/unvis.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: unvis.3,v 1.10 1999/08/11 03:06:06 deraadt Exp $ +.\" $OpenBSD: unvis.3,v 1.11 2000/04/18 03:01:28 aaron Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -80,7 +80,8 @@ decoding any escape sequences along the way, and returns the number of characters placed into .Fa dst , or \-1 if an -invalid escape sequence was detected. The size of +invalid escape sequence was detected. +The size of .Fa dst should be equal to the size of @@ -91,20 +92,22 @@ 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 +stream of bytes. +All state associated with the bytes being decoded is stored outside the .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 -to zero. Call +calls decoding different streams can be freely intermixed. +To start decoding a stream of bytes, first initialize an integer +to zero. +Call .Fn unvis with each successive byte, along with a pointer to this integer, and a pointer to a destination character. The .Fn unvis function -has several return codes that must be handled properly. They are: +has several return codes that must be handled properly. +They are: .Bl -tag -width UNVIS_VALIDPUSH .It Li \&0 (zero) Another character is necessary; nothing has been recognized yet. @@ -118,11 +121,12 @@ pointed to by .Fa cp ; however, the character currently passed in should be passed in again. .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. .It Dv UNVIS_SYNBAD An invalid escape sequence was detected, or the decoder is in an -unknown state. The decoder is placed into the starting state. +unknown state. +The decoder is placed into the starting state. .El .Pp When all bytes in the stream have been processed, call diff --git a/lib/libc/gen/utime.3 b/lib/libc/gen/utime.3 index 2615ddda57b..64144d2232e 100644 --- a/lib/libc/gen/utime.3 +++ b/lib/libc/gen/utime.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: utime.3,v 1.12 2000/04/15 11:46:02 aaron Exp $ +.\" $OpenBSD: utime.3,v 1.13 2000/04/18 03:01:28 aaron Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -80,7 +80,8 @@ The access time is set to the value of the member, and the modification time is set to the value of the .Fa modtime -member. The times are measured in +member. +The times are measured in seconds since 0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal Time (UTC). The calling process must be the owner of the file or be the superuser. diff --git a/lib/libc/gen/vis.3 b/lib/libc/gen/vis.3 index 49d8e7ea422..da260c7b0fd 100644 --- a/lib/libc/gen/vis.3 +++ b/lib/libc/gen/vis.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vis.3,v 1.9 1999/07/09 13:35:20 aaron Exp $ +.\" $OpenBSD: vis.3,v 1.10 2000/04/18 03:01:28 aaron Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -57,9 +57,10 @@ a string which represents the character .Fa c . If .Fa c -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 +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 NUL); thus, when encoding a set of characters into a buffer, the size of the buffer should @@ -145,9 +146,10 @@ Synonym for .It Dv VIS_SAFE Only encode .Dq unsafe -characters. These are control -characters which may cause common terminals to perform -unexpected functions. Currently this form allows space, +characters. +These are 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. .El @@ -235,7 +237,8 @@ If is an octal digit, the latter representation is used to avoid ambiguity. .It Dv VIS_OCTAL -Use a three digit octal sequence. The form is +Use a three digit octal sequence. +The form is .Ql \eddd where .Ar d |