From a9a13a50574836d8b2a7f592dabe6cf39a0382f3 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Sun, 9 Dec 2007 08:08:53 +0000 Subject: [PATCH] Format include files consistently (".I <.*\.h>"). --- man2/sendfile.2 | 4 +++- man2/statfs.2 | 6 +++--- man3/basename.3 | 4 +++- man3/dbopen.3 | 8 ++++++-- man3/inet.3 | 4 +++- man3/perror.3 | 2 +- man3/recno.3 | 8 ++++++-- man3/regex.3 | 2 +- man3/stdarg.3 | 2 +- man3/tmpnam.3 | 2 +- man4/dsp56k.4 | 6 +++--- man7/man-pages.7 | 2 +- man7/netdevice.7 | 3 ++- man7/tcp.7 | 5 +++-- 14 files changed, 37 insertions(+), 21 deletions(-) diff --git a/man2/sendfile.2 b/man2/sendfile.2 index 23c4366fc..90e0bdd42 100644 --- a/man2/sendfile.2 +++ b/man2/sendfile.2 @@ -135,7 +135,9 @@ Insufficient memory to read from .SH VERSIONS .BR sendfile () is a new feature in Linux 2.2. -The include file is present since glibc 2.1. +The include file +.I +is present since glibc 2.1. .SH "CONFORMING TO" Not specified in POSIX.1-2001, or other standards. diff --git a/man2/statfs.2 b/man2/statfs.2 index b10ad8e5e..3a72cef6a 100644 --- a/man2/statfs.2 +++ b/man2/statfs.2 @@ -210,7 +210,7 @@ Solaris, Irix and POSIX have a system call that returns a .I "struct statvfs" (defined in -.IR "" ) +.IR ) containing an .I "unsigned long" .IR f_fsid . @@ -219,7 +219,7 @@ Linux, SunOS, HP-UX, 4.4BSD have a system call that returns a .I "struct statfs" (defined in -.IR "" ) +.IR ) containing a .I fsid_t .IR f_fsid , @@ -228,7 +228,7 @@ where is defined as .IR "struct { int val[2]; }" . The same holds for FreeBSD, except that it uses the include file -.IR "" . +.IR . The general idea is that .I f_fsid diff --git a/man3/basename.3 b/man3/basename.3 index 67102b3ab..bbb067753 100644 --- a/man3/basename.3 +++ b/man3/basename.3 @@ -142,7 +142,9 @@ There is no GNU version of .LP With glibc, one gets the POSIX version of .BR basename () -when is included, and the GNU version otherwise. +when +.I +is included, and the GNU version otherwise. .SH BUGS In the glibc implementation of the POSIX versions of these functions they modify their argument, and segfault when called with a static string diff --git a/man3/dbopen.3 b/man3/dbopen.3 index 1a6bc3bfb..c28938002 100644 --- a/man3/dbopen.3 +++ b/man3/dbopen.3 @@ -101,7 +101,9 @@ flags are meaningful. .PP The .I type -argument is of type DBTYPE (as defined in the include file) and +argument is of type DBTYPE (as defined in the +.I +include file) and may be set to DB_BTREE, DB_HASH or DB_RECNO. .PP The @@ -115,7 +117,9 @@ and the access method. .PP .BR dbopen () returns a pointer to a DB structure on success and NULL on error. -The DB structure is defined in the include file, and contains at +The DB structure is defined in the +.I +include file, and contains at least the following fields: .sp .nf diff --git a/man3/inet.3 b/man3/inet.3 index 49abab755..e655e98f2 100644 --- a/man3/inet.3 +++ b/man3/inet.3 @@ -133,7 +133,9 @@ The structure \fIin_addr\fP as used in .BR inet_lnaof () and .BR inet_netof () -is defined in \fInetinet/in.h\fP as: +is defined in +.I +as: .sp .RS .nf diff --git a/man3/perror.3 b/man3/perror.3 index 458237108..e66613083 100644 --- a/man3/perror.3 +++ b/man3/perror.3 @@ -89,7 +89,7 @@ variable .I errno to a value describing what went wrong. (These values can be found in -.IR "" .) +.IR .) Many library functions do likewise. The function .BR perror () diff --git a/man3/recno.3 b/man3/recno.3 index 901d13494..7870216dd 100644 --- a/man3/recno.3 +++ b/man3/recno.3 @@ -62,7 +62,9 @@ one record. .PP The recno access method specific data structure provided to .I dbopen -is defined in the include file as follows: +is defined in the +.I +include file as follows: .PP .nf typedef struct { @@ -166,7 +168,9 @@ The .I data field of the key should be a pointer to a memory location of type .IR recno_t , -as defined in the include file. +as defined in th +.I . .RS .nf diff --git a/man3/stdarg.3 b/man3/stdarg.3 index 3933e6b38..6e6b3c469 100644 --- a/man3/stdarg.3 +++ b/man3/stdarg.3 @@ -222,7 +222,7 @@ These macros are .I not compatible with the historic macros they replace. A backward compatible version can be found in the include file -.IR varargs.h . +.IR . .PP The historic setup is: .in +0.5i diff --git a/man3/tmpnam.3 b/man3/tmpnam.3 index 985acf690..febcb11da 100644 --- a/man3/tmpnam.3 +++ b/man3/tmpnam.3 @@ -135,7 +135,7 @@ define or .B _BSD_SOURCE before including -.IR "" . +.IR . .SH BUGS Never use this function. Use diff --git a/man4/dsp56k.4 b/man4/dsp56k.4 index 85f29098a..1232eb24b 100644 --- a/man4/dsp56k.4 +++ b/man4/dsp56k.4 @@ -111,7 +111,7 @@ user-defined command handled by the program running in the DSP56001. .\" Fredrik Noring , lars brinkhoff , .\" Tomas Berndtsson . .SH "SEE ALSO" -linux/include/asm-m68k/dsp56k.h, -linux/drivers/char/dsp56k.c, -http://dsp56k.nocrew.org/, +.IR linux/include/asm-m68k/dsp56k.h , +.IR linux/drivers/char/dsp56k.c , +.IR http://dsp56k.nocrew.org/ , DSP56000/DSP56001 Digital Signal Processor User's Manual diff --git a/man7/man-pages.7 b/man7/man-pages.7 index c407bb1da..17f8a7585 100644 --- a/man7/man-pages.7 +++ b/man7/man-pages.7 @@ -379,7 +379,7 @@ where the rest of the function is specified in bold: .RE .PP Filenames are always in italics (e.g., -.IR "/usr/include/stdio.h" ), +.IR /usr/include/stdio.h ), except in the SYNOPSIS section, where included files are in bold (e.g., .BR "#include " ). .PP diff --git a/man7/netdevice.7 b/man7/netdevice.7 index de7a721e2..65aa811a7 100644 --- a/man7/netdevice.7 +++ b/man7/netdevice.7 @@ -251,7 +251,8 @@ Local IPv6 IP addresses can be found via /proc/net or via .SH BUGS glibc 2.1 is missing the .I ifr_newname -macro in net/if.h. +macro in +.IR . Add the following to your program as a workaround: .sp .RS diff --git a/man7/tcp.7 b/man7/tcp.7 index 10622993e..365d654db 100644 --- a/man7/tcp.7 +++ b/man7/tcp.7 @@ -343,7 +343,8 @@ greater (>= 128Mb), and reduced to 128 for those systems with very low memory (<= 32Mb). It is recommended that if this needs to be increased above 1024, TCP_SYNQ_HSIZE in -include/net/tcp.h be modified to keep +.I include/net/tcp.h +be modified to keep TCP_SYNQ_HSIZE*16<=tcp_max_syn_backlog, and the kernel be recompiled. .TP @@ -681,7 +682,7 @@ code intended to be portable. .B TCP_INFO Used to collect information about this socket. The kernel returns a \fIstruct tcp_info\fP as defined in the file -/usr/include/linux/tcp.h. +.IR /usr/include/linux/tcp.h . This option should not be used in code intended to be portable. .TP .B TCP_KEEPCNT