diff options
author | Aaron Campbell <aaron@cvs.openbsd.org> | 1999-07-05 06:08:06 +0000 |
---|---|---|
committer | Aaron Campbell <aaron@cvs.openbsd.org> | 1999-07-05 06:08:06 +0000 |
commit | 71672410c5bae7791485c70db7ed12c51f9ec0f4 (patch) | |
tree | fd55d371de3939731974a4a4483294a587568c67 /lib/libc | |
parent | 4f34f217849a15233c45b3dfdc12e3b279e485cf (diff) |
use .Li to refer to data types
Diffstat (limited to 'lib/libc')
-rw-r--r-- | lib/libc/net/iso_addr.3 | 5 | ||||
-rw-r--r-- | lib/libc/rpc/xdr.3 | 54 | ||||
-rw-r--r-- | lib/libc/sys/fcntl.2 | 4 | ||||
-rw-r--r-- | lib/libc/sys/getsockopt.2 | 12 | ||||
-rw-r--r-- | lib/libc/sys/mount.2 | 34 | ||||
-rw-r--r-- | lib/libc/sys/quotactl.2 | 23 | ||||
-rw-r--r-- | lib/libc/sys/stat.2 | 6 | ||||
-rw-r--r-- | lib/libc/sys/swapctl.2 | 6 |
8 files changed, 75 insertions, 69 deletions
diff --git a/lib/libc/net/iso_addr.3 b/lib/libc/net/iso_addr.3 index e5b3f0fbdf5..8655a63973d 100644 --- a/lib/libc/net/iso_addr.3 +++ b/lib/libc/net/iso_addr.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: iso_addr.3,v 1.3 1999/07/05 04:40:59 aaron Exp $ +.\" $OpenBSD: iso_addr.3,v 1.4 1999/07/05 06:08:05 aaron Exp $ .\" .\" Copyright (c) 1993 .\" The Regents of the University of California. All rights reserved. @@ -88,7 +88,8 @@ to have its higher order bits filled with zeros. .Fn iso_ntoa always returns a null terminated string. .Fn iso_addr -always returns a pointer to a struct iso_addr. +always returns a pointer to a +.Li struct iso_addr . (See .Sx BUGS . ) .Sh SEE ALSO diff --git a/lib/libc/rpc/xdr.3 b/lib/libc/rpc/xdr.3 index 1a486547040..ce2ff42b6ff 100644 --- a/lib/libc/rpc/xdr.3 +++ b/lib/libc/rpc/xdr.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: xdr.3,v 1.10 1999/05/25 21:16:25 aaron Exp $ +.\" $OpenBSD: xdr.3,v 1.11 1999/07/05 06:08:05 aaron Exp $ .\" Mostly converted to mandoc by Theo de Raadt, Tue Feb 24 04:04:46 MST 1998 .\" .Dd February 16, 1988 @@ -41,7 +41,7 @@ .Nd library routines for external data representation .Sh SYNOPSIS .Fd #include <sys/types.h> -.Fd #include <xdr.h> +.Fd #include <rpc/xdr.h> .Ft int .Fn xdr_array "XDR *xdrs" "char **arrp" "u_int *sizep" "u_int maxsize" "u_int elsize" "xdrproc_t elproc" .Ft int @@ -178,19 +178,19 @@ is undefined. .Pp .Fn xdr_double is a filter primitive that translates between C -.Ft double +.Li double precision numbers and their external representations. This routine returns one if it succeeds, zero otherwise. .Pp .Fn xdr_enum is a filter primitive that translates between the C -.Ft enum +.Li enum type (actually an integer) and its external representations. This routine returns one if it succeeds, zero otherwise. .Pp .Fn xdr_float is a filter primitive that translates between the C -.Ft float +.Li float type and its external representations. This routine returns one if it succeeds, zero otherwise. .Pp @@ -229,11 +229,11 @@ to a contiguous piece of the stream's buffer; .Fa len is the byte length of the desired buffer. Note: pointer is cast to -.Ft "long *" . +.Li long * . Warning: .Fn xdr_inline may return -.Tn NULL +.Dv NULL if it cannot allocate a contiguous piece of a buffer. Therefore the behavior may vary among stream instances; it exists for the sake of efficiency. @@ -245,7 +245,7 @@ This routine returns one if it succeeds, zero otherwise. .Pp .Fn xdr_long is a filter primitive that translates between C -.Ft long +.Li long integers and their external representations. This routine returns one if it succeeds, zero otherwise. .Pp @@ -265,10 +265,10 @@ determines the direction of the .Tn XDR stream (either -.Tn XDR_ENCODE , -.Tn XDR_DECODE , +.Dv XDR_ENCODE , +.Dv XDR_DECODE , or -.Tn XDR_FREE Ns ). +.Dv XDR_FREE Ns ). .Pp .Fn xdr_opaque is a filter primitive that translates between fixed size opaque @@ -285,7 +285,7 @@ This routine returns one if it succeeds, zero otherwise. is like .Fn xdr_reference execpt that it serializes -.Tn NULL +.Dv NULL pointers, whereas .Fn xdr_reference does not. Thus, @@ -373,7 +373,7 @@ procedure that filters the structure between its C form and its external representation. This routine returns one if it succeeds, zero otherwise. Warning: this routine does not understand -.Tn NULL +.Dv NULL pointers. Use .Fn xdr_pointer instead. @@ -398,7 +398,7 @@ type of stream and succeed with another. .Pp .Fn xdr_short is a filter primitive that translates between C -.Ft short +.Li short integers and their external representations. This routine returns one if it succeeds, zero otherwise. .Pp @@ -417,10 +417,10 @@ The parameter determines the direction of the .Tn XDR stream (either -.Tn XDR_ENCODE , -.Tn XDR_DECODE , +.Dv XDR_ENCODE , +.Dv XDR_DECODE , or -.Tn XDR_FREE Ns ). +.Dv XDR_FREE Ns ). Warning: the destroy routine associated with such .Tn XDR streams calls @@ -441,42 +441,42 @@ This routine returns one if it succeeds, zero otherwise. .Pp .Fn xdr_u_char is a filter primitive that translates between -.Ft unsigned +.Li unsigned C characters and their external representations. This routine returns one if it succeeds, zero otherwise. .Pp .Fn xdr_u_int is a filter primitive that translates between C -.Ft unsigned +.Li unsigned integers and their external representations. This routine returns one if it succeeds, zero otherwise. .Pp .Fn xdr_u_long is a filter primitive that translates between C -.Ft "unsigned long" +.Li unsigned long integers and their external representations. This routine returns one if it succeeds, zero otherwise. .Pp .Fn xdr_u_short is a filter primitive that translates between C -.Ft "unsigned short" +.Li unsigned short integers and their external representations. This routine returns one if it succeeds, zero otherwise. .Pp .Fn xdr_union is a filter primitive that translates between a discriminated C -.Ft union +.Li union and its corresponding external representation. It first translates the discriminant of the union located at .Fa dscmp . This discriminant is always an -.Ft enum_t . +.Li enum_t . Next the union located at .Fa unp is translated. The parameter .Fa choices is a pointer to an array of -.Ft struct xdr_discrim +.Li struct xdr_discrim structures. Each structure contains an ordered pair of .Ft [ value , proc ]. If the union's discriminant is equal to the associated @@ -484,15 +484,15 @@ If the union's discriminant is equal to the associated then the .Fa proc is called to translate the union. The end of the -.Fa struct xdr_discrim +.Li struct xdr_discrim structure array is denoted by a routine of value -.Tn NULL . +.Dv NULL . If the discriminant is not found in the .Fa choices array, then the .Fn (*defaultarm) procedure is called (if it is not -.Tn NULL Ns ). +.Dv NULL Ns ). Returns one if it succeeds, zero otherwise. .Pp .Fn xdr_vector diff --git a/lib/libc/sys/fcntl.2 b/lib/libc/sys/fcntl.2 index 16bb09733c3..1e3d1b54b51 100644 --- a/lib/libc/sys/fcntl.2 +++ b/lib/libc/sys/fcntl.2 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fcntl.2,v 1.16 1999/07/04 18:59:43 aaron Exp $ +.\" $OpenBSD: fcntl.2,v 1.17 1999/07/05 06:08:05 aaron Exp $ .\" $NetBSD: fcntl.2,v 1.6 1995/02/27 12:32:29 cgd Exp $ .\" .\" Copyright (c) 1983, 1993 @@ -60,7 +60,7 @@ and is technically a pointer to but is interpreted as an .Li int by some commands, a pointer to a -.Fa struct flock +.Li struct flock by others (see below), and ignored by the rest. .Pp The commands are: diff --git a/lib/libc/sys/getsockopt.2 b/lib/libc/sys/getsockopt.2 index 474655230f1..503d200ec1f 100644 --- a/lib/libc/sys/getsockopt.2 +++ b/lib/libc/sys/getsockopt.2 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getsockopt.2,v 1.12 1999/06/29 14:23:29 aaron Exp $ +.\" $OpenBSD: getsockopt.2,v 1.13 1999/07/05 06:08:05 aaron Exp $ .\" $NetBSD: getsockopt.2,v 1.7 1995/02/27 12:33:29 cgd Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -121,16 +121,16 @@ the parameter should be non-zero to enable a boolean option, or zero if the option is to be disabled. .Dv SO_LINGER uses a -.Fa struct linger +.Li struct linger parameter, defined in -.Ao Pa sys/socket.h Ac , +.Aq Pa sys/socket.h , which specifies the desired state of the option and the linger interval (see below). .Dv SO_SNDTIMEO and .Dv SO_RCVTIMEO use a -.Fa struct timeval +.Li struct timeval parameter, defined in .Ao Pa sys/time.h Ac . .Pp @@ -270,7 +270,7 @@ is different than that returned. .Dv SO_SNDTIMEO is an option to set a timeout value for output operations. It accepts a -.Fa struct timeval +.Li struct timeval parameter with the number of seconds and microseconds used to limit waits for output operations to complete. If a send operation has blocked for this much time, @@ -285,7 +285,7 @@ from the low water mark to the high water mark for output. .Dv SO_RCVTIMEO is an option to set a timeout value for input operations. It accepts a -.Fa struct timeval +.Li struct timeval parameter with the number of seconds and microseconds used to limit waits for input operations to complete. In the current implementation, this timer is restarted each time additional diff --git a/lib/libc/sys/mount.2 b/lib/libc/sys/mount.2 index be13f3d3968..d0f32d3c429 100644 --- a/lib/libc/sys/mount.2 +++ b/lib/libc/sys/mount.2 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount.2,v 1.15 1999/06/29 14:10:08 aaron Exp $ +.\" $OpenBSD: mount.2,v 1.16 1999/07/05 06:08:05 aaron Exp $ .\" $NetBSD: mount.2,v 1.12 1996/02/29 23:47:48 jtc Exp $ .\" .\" Copyright (c) 1980, 1989, 1993 @@ -54,28 +54,28 @@ The function grafts a filesystem object onto the system file tree at the point -.Ar dir . +.Fa dir . The argument -.Ar data +.Fa data describes the filesystem object to be mounted. The argument -.Ar type +.Fa type tells the kernel how to interpret -.Ar data +.Fa data (See -.Ar type +.Fa type below). The contents of the filesystem become available through the new mount point -.Ar dir . +.Fa dir . Any files in -.Ar dir +.Fa dir at the time of a successful mount are swept under the carpet so to speak, and are unavailable until the filesystem is unmounted. .Pp The following -.Ar flags +.Fa flags may be specified to suppress default semantics which affect filesystem access. .Bl -tag -width MNT_SYNCHRONOUS @@ -231,23 +231,23 @@ is not supported by the kernel. .El .Pp The following errors can occur for a -.Em ufs +.Dq ufs filesystem mount: .Bl -tag -width [ENOTBLK] .It Bq Er ENODEV A component of ufs_args -.Ar fspec +.Fa fspec does not exist. .It Bq Er ENOTBLK -.Ar Fspec +.Fa fspec is not a block device. .It Bq Er ENXIO The major device number of -.Ar fspec +.Fa fspec is out of range (this indicates no device driver exists for the associated hardware). .It Bq Er EBUSY -.Ar Fspec +.Fa fspec is already mounted. .It Bq Er EMFILE No space remains in the mount table. @@ -261,7 +261,7 @@ group information for the filesystem. An I/O error occurred while reading the super block or cylinder group information. .It Bq Er EFAULT -.Ar Fspec +.Fa fspec points outside the process's allocated address space. .El .Pp @@ -327,9 +327,9 @@ points outside the process's allocated address space. .El .Pp A -.Em ufs +.Dq ufs or -.Em mfs +.Dq mfs mount can also fail if the maximum number of filesystems are currently mounted. .Sh SEE ALSO diff --git a/lib/libc/sys/quotactl.2 b/lib/libc/sys/quotactl.2 index 19f02da48e2..836eccb4622 100644 --- a/lib/libc/sys/quotactl.2 +++ b/lib/libc/sys/quotactl.2 @@ -1,4 +1,4 @@ -.\" $OpenBSD: quotactl.2,v 1.5 1999/06/29 14:10:14 aaron Exp $ +.\" $OpenBSD: quotactl.2,v 1.6 1999/07/05 06:08:05 aaron Exp $ .\" $NetBSD: quotactl.2,v 1.8 1995/02/27 12:35:43 cgd Exp $ .\" .\" Copyright (c) 1983, 1990, 1991, 1993 @@ -64,14 +64,19 @@ The address of an optional command specific data structure, may be given; its interpretation is discussed below with each command. .Pp -Currently quotas are supported only for the ``ffs'' filesystem. -For ``ffs'', +Currently quotas are supported only for the +.Dq ffs +filesystem. +For +.Dq ffs , a command is composed of a primary command (see below) and a command type used to interpret the .Fa id . Types are supported for interpretation of user identifiers and group identifiers. -The ``ffs'' specific commands are: +The +.Dq ffs +specific commands are: .Bl -tag -width Q_QUOTAON .It Dv Q_QUOTAON Enable disk quotas for the filesystem specified by @@ -104,7 +109,7 @@ Get disk quota limits and current usage for the user or group .Fa id . .Fa addr is a pointer to a -.Fa struct dqblk +.Li struct dqblk structure. .It Dv Q_SETQUOTA Set disk quota limits for the user or group @@ -112,10 +117,10 @@ Set disk quota limits for the user or group .Fa id . .Fa addr is a pointer to a -.Fa struct dqblk +.Li struct dqblk structure. -The usage fields of the -.Fa dqblk +The usage fields of +.Li struct dqblk structure are ignored. This call is restricted to the super-user. .It Dv Q_SETUSE @@ -124,7 +129,7 @@ Set disk usage limits for the user or group .Fa id . .Fa addr is a pointer to a -.Fa struct dqblk +.Li struct dqblk structure. Only the usage fields are used. This call is restricted to the super-user. diff --git a/lib/libc/sys/stat.2 b/lib/libc/sys/stat.2 index eabd4bb2bbb..47ba2850cd4 100644 --- a/lib/libc/sys/stat.2 +++ b/lib/libc/sys/stat.2 @@ -1,4 +1,4 @@ -.\" $OpenBSD: stat.2,v 1.9 1999/06/29 14:10:24 aaron Exp $ +.\" $OpenBSD: stat.2,v 1.10 1999/07/05 06:08:05 aaron Exp $ .\" .\" Copyright (c) 1980, 1991, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -114,7 +114,7 @@ struct stat { .Ed .Pp The time-related fields of -.Fa struct stat +.Li struct stat are as follows: .Bl -tag -width XXXst_mtime .It st_atime @@ -149,7 +149,7 @@ system calls. .El .Pp The size-related fields of the -.Fa struct stat +.Li struct stat are as follows: .Bl -tag -width XXXst_blksize .It st_blksize diff --git a/lib/libc/sys/swapctl.2 b/lib/libc/sys/swapctl.2 index bb24923f484..5c49e7bbdc4 100644 --- a/lib/libc/sys/swapctl.2 +++ b/lib/libc/sys/swapctl.2 @@ -45,7 +45,7 @@ .Fn swapctl "int cmd" "const void *arg" "int misc" .Sh DESCRIPTION The -.Nm +.Fn swapctl function is used to add and delete swap devices, and modify their configuration. .Pp @@ -221,8 +221,8 @@ function call appeared in The .Fa se_path member was added to -.Va struct swapent +.Li struct swapent in .Nx 1.4 , when the header file was also moved from -.Pa <vm/vm_swap.h> . +.Aq Pa vm/vm_swap.h . |