From 62218dc0fd31ee51778252fa1cd04c9386fa130f Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Sun, 23 Dec 2007 08:20:39 +0000 Subject: [PATCH] Format SYNOPSIS consistently. --- man2/nfsservctl.2 | 5 +++-- man2/pciconfig_read.2 | 6 +++--- man3/bstring.3 | 4 +--- man3/cpow.3 | 5 ++++- man3/getipnodebyname.3 | 10 ++++------ man3/getpwnam.3 | 4 ++-- man3/getrpcent.3 | 2 +- man3/lsearch.3 | 8 ++------ man3/malloc_hook.3 | 19 ++++++++----------- man3/mpool.3 | 21 ++++++++++----------- man3/regex.3 | 28 +++++++++++++--------------- man3/stdin.3 | 6 +++--- man3/strtol.3 | 7 +++---- man3/strtoul.3 | 8 ++++---- man3/unlocked_stdio.3 | 4 ++-- man4/sd.4 | 4 ++-- man5/resolv.conf.5 | 2 +- man5/utmp.5 | 2 +- man7/futex.7 | 2 +- 19 files changed, 68 insertions(+), 79 deletions(-) diff --git a/man2/nfsservctl.2 b/man2/nfsservctl.2 index ea7de8856..dde0adff1 100644 --- a/man2/nfsservctl.2 +++ b/man2/nfsservctl.2 @@ -9,10 +9,11 @@ .SH NAME nfsservctl \- syscall interface to kernel nfs daemon .SH SYNOPSIS +.nf .B #include .sp -.BI "long nfsservctl(int " cmd ", struct nfsctl_arg *" argp \ -", union nfsctl_res *" resp ); +.BI "long nfsservctl(int " cmd ", struct nfsctl_arg *" argp , +.BI " union nfsctl_res *" resp ); .SH DESCRIPTION .nf /* diff --git a/man2/pciconfig_read.2 b/man2/pciconfig_read.2 index 8c5b64f80..ee0f31e90 100644 --- a/man2/pciconfig_read.2 +++ b/man2/pciconfig_read.2 @@ -10,11 +10,11 @@ pciconfig_read, pciconfig_write, pciconfig_iobase \- pci device information hand .B #include .sp .BI "int pciconfig_read(unsigned long " bus ", unsigned long " dfn , -.BI " unsigned long " off ", unsigned long " len ", void *" buf ); +.BI " unsigned long " off ", unsigned long " len ", void *" buf ); .BI "int pciconfig_write(unsigned long " bus ", unsigned long " dfn , -.BI " unsigned long " off ", unsigned long " len ", void *" buf ); +.BI " unsigned long " off ", unsigned long " len ", void *" buf ); .BI "int pciconfig_iobase(long " which ", unsigned long " bus , -.BI " unsigned long " devfn ); +.BI " unsigned long " devfn ); .fi .SH DESCRIPTION .PP diff --git a/man3/bstring.3 b/man3/bstring.3 index ab4560977..ea6298b24 100644 --- a/man3/bstring.3 +++ b/man3/bstring.3 @@ -52,9 +52,7 @@ memmove, memset \- byte string operations .BI "void *memfrob(void *" s ", size_t " n ); .sp .BI "void *memmem(const void *" needle ", size_t " needlelen , -.RS -.BI "const void *" haystack ", size_t " haystacklen ); -.RE +.BI " const void *" haystack ", size_t " haystacklen ); .sp .BI "void *memmove(void *" dest ", const void *" src ", size_t " n ); .sp diff --git a/man3/cpow.3 b/man3/cpow.3 index d6cda6ed3..637a12839 100644 --- a/man3/cpow.3 +++ b/man3/cpow.3 @@ -5,15 +5,18 @@ .SH NAME cpow, cpowf, cpowl \- complex power function .SH SYNOPSIS +.nf .B #include .sp .BI "double complex cpow(double complex " x ", complex double " z ");" .br .BI "float complex cpowf(float complex " x ", complex float " z ");" .br -.BI "long double complex cpowl(long double complex " x ", complex long double " z ");" +.BI "long double complex cpowl(long double complex " x , +.BI " complex long double " z ");" .sp Link with \fI\-lm\fP. +.fi .SH DESCRIPTION The function calculates .I x diff --git a/man3/getipnodebyname.3 b/man3/getipnodebyname.3 index 4a06be7f5..4270cc896 100644 --- a/man3/getipnodebyname.3 +++ b/man3/getipnodebyname.3 @@ -31,13 +31,11 @@ host names and addresses .B #include .B #include .sp -.BI "struct hostent *getipnodebyname(const char *" "name" , -.BI " int " "af" ", int " "flags" , -.BI " int *" "error_num" ); +.BI "struct hostent *getipnodebyname(const char *" name ", int " af , +.BI " int " flags ", int *" error_num ); .sp -.BI "struct hostent *getipnodebyaddr(const void *" "addr" , -.BI " size_t " "len" ", int " "af" , -.BI " int *" "error_num" ); +.BI "struct hostent *getipnodebyaddr(const void *" addr ", size_t " len , +.BR " int " af ", int *" "error_num" ); .sp .BI "void freehostent(struct hostent *" "ip" ); .fi diff --git a/man3/getpwnam.3 b/man3/getpwnam.3 index 7506a65d4..be98ec367 100644 --- a/man3/getpwnam.3 +++ b/man3/getpwnam.3 @@ -43,11 +43,11 @@ getpwnam, getpwnam_r, getpwuid, getpwuid_r \- get password file entry .sp .BI "int getpwnam_r(const char *" name ", struct passwd *" pwbuf , .br -.BI " char *" buf ", size_t " buflen ", struct passwd **" pwbufp ); +.BI " char *" buf ", size_t " buflen ", struct passwd **" pwbufp ); .sp .BI "int getpwuid_r(uid_t " uid ", struct passwd *" pwbuf , .br -.BI " char *" buf ", size_t " buflen ", struct passwd **" pwbufp ); +.BI " char *" buf ", size_t " buflen ", struct passwd **" pwbufp ); .fi .sp .in -4n diff --git a/man3/getrpcent.3 b/man3/getrpcent.3 index 25037a15f..c7a7fafe9 100644 --- a/man3/getrpcent.3 +++ b/man3/getrpcent.3 @@ -31,8 +31,8 @@ containing the broken-out fields of a line in the rpc program number data base, .IR /etc/rpc . .in +4n -.LP .nf + struct rpcent { char *r_name; /* name of server for this rpc program */ char **r_aliases; /* alias list */ diff --git a/man3/lsearch.3 b/man3/lsearch.3 index 2ad790fc8..41551d5cc 100644 --- a/man3/lsearch.3 +++ b/man3/lsearch.3 @@ -30,14 +30,10 @@ lfind, lsearch \- linear search of an array .B #include .sp .BI "void *lfind(const void *" key ", const void *" base ", size_t *" nmemb , -.RS -.BI "size_t " size ", int(*" compar ")(const void *, const void *));" -.RE +.BI " size_t " size ", int(*" compar ")(const void *, const void *));" .sp .BI "void *lsearch(const void *" key ", void *" base ", size_t *" nmemb , -.RS -.BI "size_t " size ", int(*" compar ")(const void *, const void *));" -.RE +.BI " size_t " size ", int(*" compar ")(const void *, const void *));" .fi .SH DESCRIPTION .BR lfind () diff --git a/man3/malloc_hook.3 b/man3/malloc_hook.3 index 2f9336f92..948ebda80 100644 --- a/man3/malloc_hook.3 +++ b/man3/malloc_hook.3 @@ -8,26 +8,23 @@ __malloc_hook, __malloc_initialize_hook, __memalign_hook, __free_hook, __realloc_hook, __after_morecore_hook \- malloc debugging variables .SH SYNOPSIS -.sp +.nf .B "#include " .sp -.BI "void *(*__malloc_hook)(size_t " size , -.BI "const void *" caller ); +.BI "void *(*__malloc_hook)(size_t " size ", const void *" caller ); .sp -.BI "void *(*__realloc_hook)(void *" ptr , -.BI "size_t " size , -.BI "const void *" caller ); +.BI "void *(*__realloc_hook)(void *" ptr ", size_t " size \ +", const void *" caller ); .sp -.BI "void *(*__memalign_hook)(size_t " alignment , -.BI "size_t " size , -.BI "const void *" caller ); +.BI "void *(*__memalign_hook)(size_t " alignment ", size_t " size , +.BI " const void *" caller ); .sp -.BI "void (*__free_hook)(void *" ptr , -.BI "const void *" caller ); +.BI "void (*__free_hook)(void *" ptr ", const void *" caller ); .sp .B "void (*__malloc_initialize_hook)(void);" .sp .B "void (*__after_morecore_hook)(void);" +.fi .SH DESCRIPTION The GNU C library lets you modify the behavior of .BR malloc (3), diff --git a/man3/mpool.3 b/man3/mpool.3 index c971ef9d9..d0e25c43d 100644 --- a/man3/mpool.3 +++ b/man3/mpool.3 @@ -40,23 +40,22 @@ mpool \- shared memory buffer pool .B #include .B #include .sp -.BI "MPOOL *mpool_open (DBT *" key ", int " fd ", pgno_t " pagesize " \ -, pgno_t " maxcache "); +.BI "MPOOL *mpool_open(DBT *" key ", int " fd ", pgno_t " pagesize \ +", pgno_t " maxcache "); .sp -.BI "void mpool_filter (MPOOL *" mp ", void (*pgin)(void *, " pgno_t " \ -, void *), -.BI " void (*" pgout ")(void *, " pgno_t ", void *) \ -, void *" pgcookie "); +.BI "void mpool_filter(MPOOL *" mp ", void (*pgin)(void *, pgno_t, void *)," +.BI " void (*" pgout ")(void *, pgno_t, void *)," +.BI " void *" pgcookie "); .sp -.BI "void *mpool_new (MPOOL *" mp ", pgno_t *" pgnoaddr "); +.BI "void *mpool_new(MPOOL *" mp ", pgno_t *" pgnoaddr "); .sp -.BI "void *mpool_get (MPOOL *" mp ", pgno_t " pgno ", u_int " flags "); +.BI "void *mpool_get(MPOOL *" mp ", pgno_t " pgno ", u_int " flags "); .sp -.BI "int mpool_put (MPOOL *" mp ", void *" pgaddr ", u_int " flags "); +.BI "int mpool_put(MPOOL *" mp ", void *" pgaddr ", u_int " flags "); .sp -.BI "int mpool_sync (MPOOL *" mp "); +.BI "int mpool_sync(MPOOL *" mp "); .sp -.BI "int mpool_close (MPOOL *" mp "); +.BI "int mpool_close(MPOOL *" mp "); .fi .SH DESCRIPTION .I Mpool diff --git a/man3/regex.3 b/man3/regex.3 index 0aa2fb022..399e6c0a0 100644 --- a/man3/regex.3 +++ b/man3/regex.3 @@ -33,23 +33,21 @@ .SH NAME regcomp, regexec, regerror, regfree \- POSIX regex functions .SH SYNOPSIS +.nf .B #include -.br .B #include -.sp -.xx \w'\fBint\ regcomp(\fR'u -.BI "int\ regcomp(regex_t *" preg ", const char *" regex , -.BI "int " cflags ); -.xx \w'\fBint\ regexec(\fR'u -.BI "int\ regexec(const regex_t *" preg ", const char *" string , -.BI "size_t " nmatch ", regmatch_t " pmatch[] , -.BI "int " eflags ); -.xx \w'\fBsize_t\ regerror(\fR'u -.BI "size_t\ regerror(int " errcode , -.BI "const regex_t *" preg ", char *" errbuf , -.BI "size_t " errbuf_size ); -.xx \w'\fBvoid\ regfree(\fR' -.BI "void\ regfree(regex_t *" preg ); + +.BI "int regcomp(regex_t *" preg ", const char *" regex ", int " cflags ); + +.BI "int regexec(const regex_t *" preg ", const char *" string \ +", size_t " nmatch , +.BI " regmatch_t " pmatch[] ", int " eflags ); + +.BI "size_t regerror(int " errcode ", const regex_t *" preg ", char *" errbuf , +.BI " size_t " errbuf_size ); + +.BI "void regfree(regex_t *" preg ); +.fi .SH DESCRIPTION .SS "POSIX Regex Compiling" .BR regcomp () diff --git a/man3/stdin.3 b/man3/stdin.3 index a3c6fa204..570827a74 100644 --- a/man3/stdin.3 +++ b/man3/stdin.3 @@ -13,9 +13,9 @@ stdin, stdout, stderr \- standard I/O streams .nf .B #include -.B extern FILE *stdin; -.B extern FILE *stdout; -.B extern FILE *stderr; +.BI "extern FILE *" stdin ; +.BI "extern FILE *" stdout ; +.BI "extern FILE *" stderr ; .fi .SH DESCRIPTION Under normal circumstances every Unix program has three streams opened diff --git a/man3/strtol.3 b/man3/strtol.3 index f029917cc..941e8cf95 100644 --- a/man3/strtol.3 +++ b/man3/strtol.3 @@ -33,11 +33,10 @@ strtol, strtoll, strtoq \- convert a string to a long integer .nf .B #include .sp -.B "long int" -.BI "strtol(const char *" nptr ", char **" endptr ", int " base ); +.BI "long int strtol(const char *" nptr ", char **" endptr ", int " base ); .sp -.B "long long int" -.BI "strtoll(const char *" nptr ", char **" endptr ", int " base ); +.BI "long long int strtoll(const char *" nptr ", char **" endptr \ +", int " base ); .fi .sp .in -4n diff --git a/man3/strtoul.3 b/man3/strtoul.3 index f011d8fdb..d0fdf6636 100644 --- a/man3/strtoul.3 +++ b/man3/strtoul.3 @@ -35,11 +35,11 @@ strtoul, strtoull, strtouq \- convert a string to an unsigned long integer .nf .B #include .sp -.B "unsigned long int" -.BI "strtoul(const char *" nptr ", char **" endptr ", int " base ); +.BI "unsigned long int strtoul(const char *" nptr ", char **" endptr \ +", int " base ); .sp -.B "unsigned long long int" -.BI "strtoull(const char *" nptr ", char **" endptr ", int " base ); +.BI "unsigned long long int strtoull(const char *" nptr ", char **" endptr , +.BI " int " base ); .fi .sp .in -4n diff --git a/man3/unlocked_stdio.3 b/man3/unlocked_stdio.3 index 4233d5fc8..42940534b 100644 --- a/man3/unlocked_stdio.3 +++ b/man3/unlocked_stdio.3 @@ -44,9 +44,9 @@ putchar_unlocked \- non-locking stdio functions .BI "int fgetc_unlocked(FILE *" stream ); .BI "int fputc_unlocked(int " c ", FILE *" stream ); .BI "size_t fread_unlocked(void *" ptr ", size_t " size ", size_t " n , -.BI " FILE *" stream ); +.BI " FILE *" stream ); .BI "size_t fwrite_unlocked(const void *" ptr ", size_t " size ", size_t " n , -.BI " FILE *" stream ); +.BI " FILE *" stream ); .sp .B #define _GNU_SOURCE .B #include diff --git a/man4/sd.4 b/man4/sd.4 index 37c853f64..452a01f0b 100644 --- a/man4/sd.4 +++ b/man4/sd.4 @@ -26,8 +26,8 @@ sd \- Driver for SCSI Disk Drives .SH SYNOPSIS .nf -#include /* for HDIO_GETGEO */ -#include /* for BLKGETSIZE and BLKRRPART */ +.BR "#include " "/* for HDIO_GETGEO */" +.BR "#include " "/* for BLKGETSIZE and BLKRRPART */" .fi .SH CONFIGURATION The block device name has the following form: diff --git a/man5/resolv.conf.5 b/man5/resolv.conf.5 index 962f1905a..82dda115d 100644 --- a/man5/resolv.conf.5 +++ b/man5/resolv.conf.5 @@ -23,7 +23,7 @@ .SH NAME resolv.conf \- resolver configuration file .SH SYNOPSIS -/etc/resolv.conf +.B /etc/resolv.conf .SH DESCRIPTION The .I resolver diff --git a/man5/utmp.5 b/man5/utmp.5 index c4dcc451c..dcbebd29e 100644 --- a/man5/utmp.5 +++ b/man5/utmp.5 @@ -29,7 +29,7 @@ .SH NAME utmp, wtmp \- login records .SH SYNOPSIS -#include +.B #include .SH DESCRIPTION The .I utmp diff --git a/man7/futex.7 b/man7/futex.7 index 741e4f365..c2dc803f8 100644 --- a/man7/futex.7 +++ b/man7/futex.7 @@ -10,7 +10,7 @@ futex \- Fast Userspace Locking .SH SYNOPSIS .nf -#include +.B #include .fi .SH DESCRIPTION .PP