diff options
author | ru <ru@FreeBSD.org> | 2003-05-22 13:02:28 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2003-05-22 13:02:28 +0000 |
commit | 9bcac8799e0fa205ce0aab2815e1934c1c7fb3ad (patch) | |
tree | 9e88a547c7f774cc6533ee481e3c36d66be24d9d /lib/libc | |
parent | facfefd3157b88295a26cb3e98f18947c2ab4b78 (diff) | |
download | FreeBSD-src-9bcac8799e0fa205ce0aab2815e1934c1c7fb3ad.zip FreeBSD-src-9bcac8799e0fa205ce0aab2815e1934c1c7fb3ad.tar.gz |
Assorted mdoc(7) fixes.
Approved by: re (blanket)
Diffstat (limited to 'lib/libc')
-rw-r--r-- | lib/libc/gen/arc4random.3 | 5 | ||||
-rw-r--r-- | lib/libc/gen/getfsent.3 | 24 | ||||
-rw-r--r-- | lib/libc/gen/getpwent.3 | 3 | ||||
-rw-r--r-- | lib/libc/i386/sys/i386_vm86.2 | 15 | ||||
-rw-r--r-- | lib/libc/locale/setlocale.3 | 2 | ||||
-rw-r--r-- | lib/libc/locale/wcstod.3 | 11 | ||||
-rw-r--r-- | lib/libc/net/nsdispatch.3 | 37 | ||||
-rw-r--r-- | lib/libc/posix1e/mac.3 | 2 | ||||
-rw-r--r-- | lib/libc/stdio/fputws.3 | 2 | ||||
-rw-r--r-- | lib/libc/stdlib/strtod.3 | 11 | ||||
-rw-r--r-- | lib/libc/sys/jail.2 | 13 | ||||
-rw-r--r-- | lib/libc/sys/sendfile.2 | 26 | ||||
-rw-r--r-- | lib/libc/sys/stat.2 | 10 |
13 files changed, 85 insertions, 76 deletions
diff --git a/lib/libc/gen/arc4random.3 b/lib/libc/gen/arc4random.3 index bf1420e..42b40a6 100644 --- a/lib/libc/gen/arc4random.3 +++ b/lib/libc/gen/arc4random.3 @@ -57,7 +57,8 @@ The S-Boxes can be in about .if t 2\u\s71700\s10\d .if n (2**1700) -states. The +states. +The .Fn arc4random function returns pseudo-random numbers in the range of 0 to .if t 2\u\s731\s10\d\(mi1, @@ -87,7 +88,7 @@ and functions using .Fn arc4random : .Pp -.Dl #define foo4random() (arc4random() % ((unsigned)RAND_MAX + 1)) +.Dl "#define foo4random() (arc4random() % ((unsigned)RAND_MAX + 1))" .Sh SEE ALSO .Xr rand 3 , .Xr random 3 , diff --git a/lib/libc/gen/getfsent.3 b/lib/libc/gen/getfsent.3 index a973024..94069c9 100644 --- a/lib/libc/gen/getfsent.3 +++ b/lib/libc/gen/getfsent.3 @@ -46,11 +46,11 @@ .Lb libc .Sh SYNOPSIS .In fstab.h -.Ft struct fstab * +.Ft "struct fstab *" .Fn getfsent void -.Ft struct fstab * +.Ft "struct fstab *" .Fn getfsspec "const char *spec" -.Ft struct fstab * +.Ft "struct fstab *" .Fn getfsfile "const char *file" .Ft int .Fn setfsent void @@ -58,7 +58,7 @@ .Fn endfsent void .Ft void .Fn setfstab "const char *file" -.Ft const char * +.Ft "const char *" .Fn getfstab void .Sh DESCRIPTION The @@ -103,11 +103,11 @@ function sets the file to be used by subsequent operations. The value set by .Fn setfstab does not persist across calls to -.Fn endfsent +.Fn endfsent . .Pp The .Fn getfstab -function returns the name of the file that that will be used. +function returns the name of the file that will be used. .Pp The .Fn getfsspec @@ -145,17 +145,17 @@ The function returns nothing. .Sh ENVIRONMENT -.Bl -tag -width PATH_FSTAB -.It Pa PATH_FSTAB +.Bl -tag -width ".Ev PATH_FSTAB" +.It Ev PATH_FSTAB If the environment variable -.Pa PATH_FSTAB -is set all operations are performed against the specified file. -.Pa PATH_FSTAB +.Ev PATH_FSTAB +is set, all operations are performed against the specified file. +.Ev PATH_FSTAB will not be honored if the process environment or memory address space is considred .Dq tainted . (See -.Fn issetugid +.Xr issetugid 2 for more information.) .El .Sh FILES diff --git a/lib/libc/gen/getpwent.3 b/lib/libc/gen/getpwent.3 index d5eb9a1..3c08cd5 100644 --- a/lib/libc/gen/getpwent.3 +++ b/lib/libc/gen/getpwent.3 @@ -194,7 +194,8 @@ The functions and .Fn getpwuid_r return 0 if no error occurred, or an error number to indicate failure. -It is not an error if a matching entry is not found. (Thus, if +It is not an error if a matching entry is not found. +(Thus, if .Fa result is .Dv NULL diff --git a/lib/libc/i386/sys/i386_vm86.2 b/lib/libc/i386/sys/i386_vm86.2 index 241560d..03c1873 100644 --- a/lib/libc/i386/sys/i386_vm86.2 +++ b/lib/libc/i386/sys/i386_vm86.2 @@ -75,13 +75,14 @@ The .Fa int_map argument is a bitmap which determines whether vm86 interrupts should be handled -in vm86 mode, or reflected back to the process. If the +in vm86 mode, or reflected back to the process. +If the .Em Nth bit is set, the interrupt will be reflected to the process, otherwise it will be dispatched by the vm86 interrupt table. .It Dv VM86_INTCALL -This allows calls to be made to vm86 interrupt handlers by the process. It -effectively simulates an INT instruction. +This allows calls to be made to vm86 interrupt handlers by the process. +It effectively simulates an INT instruction. .Fa data should point to the following structure: .Bd -literal @@ -92,8 +93,8 @@ struct vm86_intcall_args { .Ed .Pp .Fa intnum -specifies the operand of INT for the simulated call. A value of 0x10, for -example, would often be used to call into the VGA BIOS. +specifies the operand of INT for the simulated call. +A value of 0x10, for example, would often be used to call into the VGA BIOS. .Fa vmf is used to initialize CPU registers according to the calling convention for the interrupt handler. @@ -117,7 +118,8 @@ vm86 mode is entered by calling .Xr sigreturn 2 with the correct machine context for vm86, and with the .Dv PSL_VM -bit set. Control returns to the process upon delivery of a signal. +bit set. +Control returns to the process upon delivery of a signal. .Sh RETURN VALUES .Rv -std i386_vm86 .Sh ERRORS @@ -132,6 +134,7 @@ The kernel does not have vm86 support, or an invalid function was specified. There is not enough memory to initialize the kernel data structures. .El .Sh AUTHORS +.An -nosplit This man page was written by .An Jonathan Lemon , and updated by diff --git a/lib/libc/locale/setlocale.3 b/lib/libc/locale/setlocale.3 index f221d26..3cc4c79 100644 --- a/lib/libc/locale/setlocale.3 +++ b/lib/libc/locale/setlocale.3 @@ -177,7 +177,7 @@ The individual fields have the following meanings: .Bl -tag -width mon_decimal_point .It Fa decimal_point The decimal point character, except for currency values, -can't be the empty string. +cannot be an empty string. .It Fa thousands_sep The separator between groups of digits before the decimal point, except for currency values. diff --git a/lib/libc/locale/wcstod.3 b/lib/libc/locale/wcstod.3 index 6d4c944..f8c5135 100644 --- a/lib/libc/locale/wcstod.3 +++ b/lib/libc/locale/wcstod.3 @@ -31,14 +31,17 @@ .Nm wcstof , .Nm wcstod , .Nm wcstold -.Nd "convert string to float, double or long double" +.Nd convert string to +.Vt float , double +or +.Vt "long double" .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In wchar.h .Ft float .Fn wcstof "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" -.Ft long double +.Ft "long double" .Fn wcstold "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" .Ft double .Fn wcstod "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" @@ -53,13 +56,13 @@ functions are the wide-character versions of the .Fn strtod and .Fn strtold -functios. +functions. Refer to .Xr strtod 3 for details. .Sh SEE ALSO .Xr strtod 3 , -.Xr wcstol 3 , +.Xr wcstol 3 .Sh STANDARDS The .Fn wcstof , diff --git a/lib/libc/net/nsdispatch.3 b/lib/libc/net/nsdispatch.3 index 714d8a5..09566dc 100644 --- a/lib/libc/net/nsdispatch.3 +++ b/lib/libc/net/nsdispatch.3 @@ -74,7 +74,8 @@ the caller of .Pp Each method has the function signature described by the typedef: .Pp -.Ft typedef "int \*(lp*nss_method\*(rp\*(lpvoid *retval, void *mdata, va_list *ap\*(rp" ; +.Ft typedef int +.Fn \*(lp*nss_method\*(rp "void *retval" "void *mdata" "va_list *ap" ; .Pp .Va dtab is an array of @@ -175,12 +176,12 @@ as a variable argument list of the type .Ss Valid source types While there is support for arbitrary sources, the following #defines for commonly implemented sources are available: -.Bl -column NS_COMPAT COMPAT -offset indent +.Bl -column NSSRC_COMPAT compat -offset indent .It Sy "#define value" -.It "NSSRC_FILES ""files""" -.It "NSSRC_DNS ""dns""" -.It "NSSRC_NIS ""nis""" -.It "NSSRC_COMPAT ""compat""" +.It Dv NSSRC_FILES Ta """files"" +.It Dv NSSRC_DNS Ta """dns"" +.It Dv NSSRC_NIS Ta """nis"" +.It Dv NSSRC_COMPAT Ta """compat"" .El .Pp Refer to @@ -192,13 +193,13 @@ The .Vt nss_method functions must return one of the following values depending upon status of the lookup: -.Bl -column "RETURN VALUE" "STATUS CODE" +.Bl -column "Return value" "Status code" .It Sy "Return value Status code" -.It "NS_SUCCESS success" -.It "NS_NOTFOUND notfound" -.It "NS_UNAVAIL unavail" -.It "NS_TRYAGAIN tryagain" -.It "NS_RETURN -none-" +.It Dv NS_SUCCESS Ta success +.It Dv NS_NOTFOUND Ta notfound +.It Dv NS_UNAVAIL Ta unavail +.It Dv NS_TRYAGAIN Ta tryagain +.It Dv NS_RETURN Ta -none- .El .Pp Refer to @@ -208,12 +209,14 @@ for a complete description of each status code. The .Fn nsdispatch function returns the value of the method that caused the dispatcher to -terminate, or NS_NOTFOUND otherwise. +terminate, or +.Dv NS_NOTFOUND +otherwise. .Sh SEE ALSO .Xr hesiod 3 , .Xr stdarg 3 , -.Xr yp 8 , -.Xr nsswitch.conf 5 +.Xr nsswitch.conf 5 , +.Xr yp 8 .Sh HISTORY The .Fn nsdispatch @@ -232,10 +235,10 @@ Luke Mewburn wrote this freely-distributable name-service switch implementation, using ideas from the .Tn ULTRIX -"svc.conf\*(lp5\*(rp" +svc.conf(5) and .Tn Solaris -"nsswitch.conf\*(lp4\*(rp" +nsswitch.conf(4) manual pages. The .Fx diff --git a/lib/libc/posix1e/mac.3 b/lib/libc/posix1e/mac.3 index 64fb425..7a25542 100644 --- a/lib/libc/posix1e/mac.3 +++ b/lib/libc/posix1e/mac.3 @@ -35,7 +35,7 @@ .Os .Sh NAME .Nm mac -.Nd Introduction to the MAC security API +.Nd introduction to the MAC security API .Sh LIBRARY .Lb libc .Sh SYNOPSIS diff --git a/lib/libc/stdio/fputws.3 b/lib/libc/stdio/fputws.3 index c1298e0..52bae96 100644 --- a/lib/libc/stdio/fputws.3 +++ b/lib/libc/stdio/fputws.3 @@ -63,10 +63,10 @@ The function returns 0 on success and \-1 on error. .Sh ERRORS -.Bl -tag -width Er The .Fn fputws function will fail if: +.Bl -tag -width Er .It Bq Er EBADF The .Fa fp diff --git a/lib/libc/stdlib/strtod.3 b/lib/libc/stdlib/strtod.3 index b7b8f37..0fd7003 100644 --- a/lib/libc/stdlib/strtod.3 +++ b/lib/libc/stdlib/strtod.3 @@ -52,7 +52,7 @@ string to floating point .Fn strtod "const char * restrict nptr" "char ** restrict endptr" .Ft float .Fn strtof "const char * restrict nptr" "char ** restrict endptr" -.Ft long double +.Ft "long double" .Fn strtold "const char * restrict nptr" "char ** restrict endptr" .Sh DESCRIPTION These conversion @@ -63,7 +63,7 @@ to .Vt double , .Vt float , and -.Vt long double +.Vt "long double" representation, respectively. .Pp The expected form of the string is an optional plus (``+'') or minus @@ -160,10 +160,10 @@ These routines do not recognize the C99 ``NaN(...)'' syntax. The author of this software is .An David M. Gay . .Pp +.Bd -literal Copyright (c) 1998 by Lucent Technologies -.br All Rights Reserved -.Pp + Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all @@ -173,7 +173,7 @@ documentation, and that the name of Lucent or any of its entities not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. -.Pp + LUCENT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL LUCENT OR ANY OF ITS ENTITIES BE LIABLE FOR ANY @@ -182,3 +182,4 @@ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.Ed diff --git a/lib/libc/sys/jail.2 b/lib/libc/sys/jail.2 index 288f30d..3e21627 100644 --- a/lib/libc/sys/jail.2 +++ b/lib/libc/sys/jail.2 @@ -12,7 +12,7 @@ .Dt JAIL 2 .Os .Sh NAME -.Nm jail +.Nm jail , jail_attach .Nd imprison current process and future decendants .Sh LIBRARY .Lb libc @@ -59,21 +59,16 @@ The .Fn jail_attach system call attaches the current process to an existing jail, identified by -.Va jid . +.Fa jid . .Sh RETURN VALUES If successful, .Fn jail returns a non-negative integer, termed the jail identifier (JID). -It returns -1 on failure, and sets +It returns \-1 on failure, and sets .Va errno to indicate the error. .Pp -If successful, -.Fn jail_attach -returns 0. -It returns -1 on failure, and sets -.Va errno -to indicate the error. +.Rv -std jail_attach .Sh PRISON? Once a process has been put in a prison, it and its decendants cannot escape the prison. diff --git a/lib/libc/sys/sendfile.2 b/lib/libc/sys/sendfile.2 index fac2577..96979ee 100644 --- a/lib/libc/sys/sendfile.2 +++ b/lib/libc/sys/sendfile.2 @@ -107,22 +107,22 @@ implementation of .Fn sendfile is "zero-copy", meaning that it has been optimized so that copying of the file data is avoided. .Sh TUNING -Internally this system call uses a special +Internally, this system call uses a special .Xr sendfile 2 buffer -.Pq Fa "struct sf_buf" +.Pq Vt "struct sf_buf" to handle sending file data to the client. If the sending socket is -blocking and there are not enough sendfile buffers available, +blocking, and there are not enough sendfile buffers available, .Xr sendfile 2 will block and report a state of -.Dq sfbufa . +.Dq Li sfbufa . If the sending socket is non-blocking and there are not enough sendfile buffers available, the call will block and wait for the necessary buffers to become available before finishing the call. .Pp The number of -.Fa sf_buf Ns 's +.Vt sf_buf Ns 's allocated should be proportional to the number of nmbclusters used to send data to a client via .Xr sendfile 2 . @@ -130,19 +130,21 @@ Tune accordingly to avoid blocking! Busy installations that make extensive use of .Xr sendfile 2 may want to increase these values to be inline with their -.Ar kern.ipc.nmbclusters -.Pq see Xr tuning 7 for details . +.Va kern.ipc.nmbclusters +(see +.Xr tuning 7 +for details). .Pp The number of .Xr sendfile 2 buffers in use is determined at boot time by either the -.Em kern.ipc.nsfbufs +.Va kern.ipc.nsfbufs .Xr loader.conf 5 variable or the -.Em NSFBUFS +.Dv NSFBUFS kernel configuration tunable. The number of sendfile buffers scales with -.Em kern.maxusers . +.Va kern.maxusers . .Sh RETURN VALUES .Rv -std sendfile .Sh ERRORS @@ -198,8 +200,8 @@ If specified, the number of bytes successfully sent will be returned in .Xr open 2 , .Xr send 2 , .Xr socket 2 , -.Xr tuning 7 , -.Xr writev 2 +.Xr writev 2 , +.Xr tuning 7 .Sh HISTORY The .Fn sendfile diff --git a/lib/libc/sys/stat.2 b/lib/libc/sys/stat.2 index 4ce1a0f..98b2367 100644 --- a/lib/libc/sys/stat.2 +++ b/lib/libc/sys/stat.2 @@ -90,8 +90,8 @@ and into which information is placed concerning the file. The time-related fields of .Fa struct stat are as follows: -.Bl -tag -width XXXst_mtime -.It st_atime +.Bl -tag -width ".Va st_birthtime" +.It Va st_atime Time when file data last accessed. Changed by the .Xr mknod 2 , @@ -99,7 +99,7 @@ Changed by the and .Xr read 2 system calls. -.It st_mtime +.It Va st_mtime Time when file data last modified. Changed by the .Xr mknod 2 , @@ -107,7 +107,7 @@ Changed by the and .Xr write 2 system calls. -.It st_ctime +.It Va st_ctime Time when file status was last changed (inode data modification). Changed by the .Xr chmod 2 , @@ -120,7 +120,7 @@ Changed by the and .Xr write 2 system calls. -.It st_birthtime +.It Va st_birthtime Time when the inode was created. .El .Pp |