diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2007-06-23 07:56:56 +0000 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2007-06-23 07:56:56 +0000 |
| commit | f19a0f03eefac77a52687989582a5bcba2e109d3 (patch) | |
| tree | 3fed6b3b2dfd6230eda1c873b043bb68967a283b | |
| parent | 66ee0c7e89fe01348878638515edb8b2a51b9a2e (diff) | |
| download | man-pages-f19a0f03eefac77a52687989582a5bcba2e109d3.tar.gz | |
ffix
43 files changed, 306 insertions, 303 deletions
diff --git a/man3/clock_getres.3 b/man3/clock_getres.3 index bd14447477..998b5b194b 100644 --- a/man3/clock_getres.3 +++ b/man3/clock_getres.3 @@ -70,7 +70,7 @@ The and .I tp arguments are -.B timespec +.I timespec structs, as specified in .IR <time.h> : .sp diff --git a/man3/cmsg.3 b/man3/cmsg.3 index 4e46ed31b0..039efa36a8 100644 --- a/man3/cmsg.3 +++ b/man3/cmsg.3 @@ -52,22 +52,22 @@ This sequence should only be accessed using the macros described in this manual page and never directly. See the specific protocol man pages for the available control message types. The maximum ancillary buffer size allowed per socket can be set using the -.B net.core.optmem_max +.I net.core.optmem_max sysctl; see .BR socket (7). .PP .BR CMSG_FIRSTHDR () returns a pointer to the first -.B cmsghdr +.I cmsghdr in the ancillary data buffer associated with the passed -.BR msghdr . +.IR msghdr . .PP .BR CMSG_NXTHDR () returns the next valid -.B cmsghdr +.I cmsghdr after the passed -.BR cmsghdr . +.IR cmsghdr . It returns NULL when there isn't enough space left in the buffer. .PP .BR CMSG_ALIGN (), @@ -82,13 +82,13 @@ This is a constant expression. .PP .B CMSG_DATA returns a pointer to the data portion of a -.BR cmsghdr . +.IR cmsghdr . .PP .B CMSG_LEN returns the value to store in the .I cmsg_len member of the -.B cmsghdr +.I cmsghdr structure, taking into account any necessary alignment. It takes the data length as an argument. @@ -98,12 +98,12 @@ expression. To create ancillary data, first initialize the .I msg_controllen member of the -.B msghdr +.I msghdr with the length of the control message buffer. Use .BR CMSG_FIRSTHDR () on the -.B msghdr +.I msghdr to get the first control message and .B CMSG_NEXTHDR to get all subsequent ones. @@ -112,19 +112,19 @@ In each control message, initialize (with .BR CMSG_LEN ), the other -.B cmsghdr +.I cmsghdr header fields, and the data portion using .BR CMSG_DATA . Finally, the .I msg_controllen field of the -.B msghdr +.I msghdr should be set to the sum of the .BR CMSG_SPACE () of the length of all control messages in the buffer. For more information on the -.BR msghdr , +.IR msghdr , see .BR recvmsg (2). .PP @@ -133,7 +133,7 @@ When the control message buffer is too short to store all messages, the flag is set in the .I msg_flags member of the -.BR msghdr . +.IR msghdr . .SH "CONFORMING TO" This ancillary data model conforms to the POSIX.1g draft, 4.4BSD-Lite, the IPv6 advanced API described in RFC\ 2292 and the SUSv2. diff --git a/man3/ecvt.3 b/man3/ecvt.3 index 533ded2350..59fc0ac02b 100644 --- a/man3/ecvt.3 +++ b/man3/ecvt.3 @@ -89,7 +89,7 @@ is recommended. Linux libc4 and libc5 specified the type of .I ndigits as -.BR size_t . +.IR size_t . Not all locales use a point as the radix character (`decimal point'). .SH "SEE ALSO" .BR ecvt_r (3), diff --git a/man3/ecvt_r.3 b/man3/ecvt_r.3 index be943c2157..feac0ebd6c 100644 --- a/man3/ecvt_r.3 +++ b/man3/ecvt_r.3 @@ -52,11 +52,11 @@ The functions and .BR qfcvt_r () are identical to -.BR ecvt , -.BR fcvt , -.BR qecvt +.BR ecvt (), +.BR fcvt (), +.BR qecvt () and -.BR qfcvt , +.BR qfcvt (), respectively, except that they do not return their result in a static buffer, but instead use the supplied .I buf diff --git a/man3/fseek.3 b/man3/fseek.3 index 70c9fa6485..7b5ef6dfb4 100644 --- a/man3/fseek.3 +++ b/man3/fseek.3 @@ -111,7 +111,7 @@ setting and storing the current value of the file offset into or from the object referenced by .IR pos . On some non-UNIX systems an -.B fpos_t +.I fpos_t object may be a complex object and these routines may be the only way to portably reposition a text stream. .SH "RETURN VALUE" diff --git a/man3/ftok.3 b/man3/ftok.3 index 1622dfd15a..5fbba5c3d7 100644 --- a/man3/ftok.3 +++ b/man3/ftok.3 @@ -45,7 +45,7 @@ function uses the identity of the file named by the given and the least significant 8 bits of .I proj_id (which must be non-zero) to generate a -.B key_t +.I key_t type System V IPC key, suitable for use with .BR msgget (2), .BR semget (2), @@ -60,7 +60,7 @@ The value returned should be different when the (simultaneously existing) files or the project IDs differ. .SH "RETURN VALUE" On success the generated -.B key_t +.I key_t value is returned. On failure \-1 is returned, with .I errno @@ -86,7 +86,7 @@ that is why the behavior is said to be undefined when is zero. .LP Of course no guarantee can be given that the resulting -.B key_t +.I key_t is unique. Typically, a best effort attempt combines the given .I proj_id diff --git a/man3/getipnodebyname.3 b/man3/getipnodebyname.3 index 3cb009b412..5297af664a 100644 --- a/man3/getipnodebyname.3 +++ b/man3/getipnodebyname.3 @@ -81,8 +81,7 @@ functions can access multiple network address families. Unlike the .B gethostby functions, -these -functions return pointers to dynamically allocated memory. +these functions return pointers to dynamically allocated memory. The .BR freehostent (3) function is used to release the dynamically allocated memory diff --git a/man3/getopt.3 b/man3/getopt.3 index 534098f6c7..a70a4d56b2 100644 --- a/man3/getopt.3 +++ b/man3/getopt.3 @@ -287,11 +287,11 @@ argument is encountered. .SM .B _<PID>_GNU_nonoption_argv_flags_ This variable was used by -.B bash +.BR bash (1) 2.0 to communicate to GNU libc which arguments are the results of wildcard expansion and so should not be considered as options. This behavior was removed in -.B bash +.BR bash (1) version 2.01, but the support remains in GNU libc. .SH "CONFORMING TO" .TP diff --git a/man3/getrpcent.3 b/man3/getrpcent.3 index 78af0567ce..5fce9ffc7b 100644 --- a/man3/getrpcent.3 +++ b/man3/getrpcent.3 @@ -55,13 +55,13 @@ The members of this structure are: .RS .PD 0 .TP 20 -.B r_name +.I r_name The name of the server for this rpc program. .TP 20 -.B r_aliases +.I r_aliases A zero terminated list of alternate names for the rpc program. .TP 20 -.B r_number +.I r_number The rpc program number for this service. .PD .RE diff --git a/man3/gets.3 b/man3/gets.3 index e486d18f1d..8c99b8bf60 100644 --- a/man3/gets.3 +++ b/man3/gets.3 @@ -104,7 +104,7 @@ will be returned in reverse order; only one pushback is guaranteed. .PP Calls to the functions described here can be mixed with each other and with calls to other input functions from the -.B stdio +.I stdio library for the same input stream. .PP For non-locking counterparts, see @@ -156,7 +156,7 @@ Use instead. .PP It is not advisable to mix calls to input functions from the -.B stdio +.I stdio library with low-level calls to .BR read (2) for the file descriptor associated with the input stream; the results diff --git a/man3/glob.3 b/man3/glob.3 index 4bf68957a0..ee895ea3a2 100644 --- a/man3/glob.3 +++ b/man3/glob.3 @@ -62,7 +62,7 @@ The results of a call are stored in the structure pointed to by .IR pglob , which is a -.B glob_t +.I glob_t which is declared in .I <glob.h> and includes the following elements defined by POSIX.2 (more may be @@ -209,7 +209,7 @@ The structure elements and .I gl_offs are declared as -.BR size_t +.IR size_t in glibc 2.1, as they should according to POSIX.2, but are declared as .I int diff --git a/man3/inet_ntop.3 b/man3/inet_ntop.3 index 010f97ea51..43e4fe3e75 100644 --- a/man3/inet_ntop.3 +++ b/man3/inet_ntop.3 @@ -100,9 +100,12 @@ POSIX.1-2001. Note that RFC\ 2553 defines a prototype where the last parameter .I cnt is of type -.BR size_t . +.IR size_t . Many systems follow RFC\ 2553. -Glibc 2.0 and 2.1 have size_t, but 2.2 has socklen_t. +Glibc 2.0 and 2.1 have +.IR size_t , +but 2.2 has +.IR socklen_t . .\" 2.1.3: size_t, 2.1.91: socklen_t .SH BUGS .B AF_INET6 diff --git a/man3/netlink.3 b/man3/netlink.3 index ae3bc1060d..af7a82c062 100644 --- a/man3/netlink.3 +++ b/man3/netlink.3 @@ -43,7 +43,7 @@ NLMSG_LENGTH Given the payload length, .IR len , this macro returns the aligned length to store in the -.B nlmsg_len +.I nlmsg_len field of the .IR nlmsghdr . .TP @@ -77,7 +77,7 @@ Return the length of the payload associated with the These macros are non-standard Linux extensions. .SH NOTES It is often better to use netlink via -.B libnetlink +.I libnetlink than via the low level kernel interface. .SH "SEE ALSO" .BR netlink (7) diff --git a/man3/printf.3 b/man3/printf.3 index f124953aeb..15fe49938a 100644 --- a/man3/printf.3 +++ b/man3/printf.3 @@ -880,7 +880,7 @@ and instead (or .BR asprintf () and -.BR vasprintf ). +.BR vasprintf (). .PP Linux libc4.[45] does not have a .BR snprintf (), diff --git a/man3/puts.3 b/man3/puts.3 index 8a673262f4..2799f0cbde 100644 --- a/man3/puts.3 +++ b/man3/puts.3 @@ -74,7 +74,7 @@ to .PP Calls to the functions described here can be mixed with each other and with calls to other output functions from the -.B stdio +.I stdio library for the same output stream. .PP For non-locking counterparts, see @@ -102,7 +102,7 @@ on error. C89, C99 .SH BUGS It is not advisable to mix calls to output functions from the -.B stdio +.I stdio library with low-level calls to .BR write (2) for the file descriptor associated with the same output stream; the results diff --git a/man3/regex.3 b/man3/regex.3 index 6c70f67ccd..51f492885f 100644 --- a/man3/regex.3 +++ b/man3/regex.3 @@ -176,23 +176,19 @@ with substring match addresses. Any unused structure elements will contain the value \-1. The -.B regmatch_t +.I regmatch_t structure which is the type of .I pmatch is defined in .IR regex.h . .RS -.B typedef struct -.br -.B { -.br -.BI " regoff_t " rm_so ; -.br -.BI " regoff_t " rm_eo ; -.br -.B } -.B regmatch_t; +.nf +typedef struct { + regoff_t rm_so; + regoff_t rm_eo; +} regmatch_t; +.fi .RE Each diff --git a/man3/setnetgrent.3 b/man3/setnetgrent.3 index 96c0513f97..bb06f2d4ec 100644 --- a/man3/setnetgrent.3 +++ b/man3/setnetgrent.3 @@ -26,7 +26,7 @@ handle network group entries .in -12 .SH DESCRIPTION The -.B netgroup +.I netgroup is a SunOS invention. A netgroup database is a list of string triples .BR (hostname "," username "," domainname) diff --git a/man3/stdarg.3 b/man3/stdarg.3 index 4cec3d3c49..16ee5b5186 100644 --- a/man3/stdarg.3 +++ b/man3/stdarg.3 @@ -57,12 +57,12 @@ types. The include file .I <stdarg.h> declares a type -.B va_list +.I va_list and defines three macros for stepping through a list of arguments whose number and types are not known to the called function. .PP The called function must declare an object of type -.B va_list +.I va_list which is used by the macros .BR va_start (), .BR va_arg (), @@ -96,7 +96,7 @@ argument in the call. The parameter .I ap is the -.B va_list +.I va_list .I ap initialized by .BR va_start (). @@ -153,7 +153,7 @@ may be a macro or a function. .SS va_copy() .\" Proposal from clive@demon.net, 1997-02-28 An obvious implementation would have a -.B va_list +.I va_list be a pointer to the stack frame of the variadic function. In such a setup (by far the most common) there seems nothing against an assignment @@ -266,7 +266,7 @@ code to .B stdarg code, but it also creates difficulties for variadic functions that wish to pass all of their arguments on to a function that takes a -.B va_list +.I va_list argument, such as .BR vfprintf (3). .SH EXAMPLE diff --git a/man3/stdio.3 b/man3/stdio.3 index a2653ec697..b8796e2f50 100644 --- a/man3/stdio.3 +++ b/man3/stdio.3 @@ -126,7 +126,7 @@ the standard output before going off and computing so that the output will appear. .PP The -.B stdio +.I stdio library is a part of the library .B libc and routines are automatically loaded as needed by the compilers @@ -356,7 +356,7 @@ formatted output conversion input format conversion .SH "CONFORMING TO" The -.B stdio +.I stdio library conforms to C89. .SH "SEE ALSO" .BR close (2), diff --git a/man3/strptime.3 b/man3/strptime.3 index babaaf6c14..70e6ca8f07 100644 --- a/man3/strptime.3 +++ b/man3/strptime.3 @@ -44,7 +44,7 @@ function is the converse function to and converts the character string pointed to by .I s to values which are stored in the -.B tm +.I tm structure pointed to by .IR tm , using the format specified by diff --git a/man3/strtoimax.3 b/man3/strtoimax.3 index 7dbe9a6d66..f83a28a149 100644 --- a/man3/strtoimax.3 +++ b/man3/strtoimax.3 @@ -37,9 +37,9 @@ These functions are just like and .BR strtoul (3), except that they return a value of type -.B intmax_t +.I intmax_t and -.BR uintmax_t , +.IR uintmax_t , respectively. .SH "RETURN VALUE" On success, the converted value is returned. diff --git a/man3/strverscmp.3 b/man3/strverscmp.3 index 8bd0e7a3fa..8919fa1bad 100644 --- a/man3/strverscmp.3 +++ b/man3/strverscmp.3 @@ -35,12 +35,12 @@ strverscmp \- compare two version strings Often one has files .IR jan1 ", " jan2 ", ..., " jan9 ", " jan10 ", ..." and it feels wrong when -.B ls +.BR ls (1) orders them .IR jan1 ", " jan10 ", ..., " jan2 ", ..., " jan9 . .\" classical solution: "rename jan jan0 jan?" In order to rectify this, GNU introduced the -.B \-v +.I \-v option to .BR ls (1), which is implemented using diff --git a/man3/syslog.3 b/man3/syslog.3 index dfffa73d9f..a517cbe3d1 100644 --- a/man3/syslog.3 +++ b/man3/syslog.3 @@ -194,7 +194,7 @@ USENET news subsystem .TP .B LOG_SYSLOG messages generated internally by -.B syslogd +.BR syslogd (8) .TP .BR LOG_USER " (default)" generic user-level messages diff --git a/man3/sysv_signal.3 b/man3/sysv_signal.3 index 1745d27996..abfc388da6 100644 --- a/man3/sysv_signal.3 +++ b/man3/sysv_signal.3 @@ -76,7 +76,7 @@ provides reliable signal semantics; see for details. The use of -.B sighandler_t +.I sighandler_t is a GNU extension; this type is only defined if the diff --git a/man3/usleep.3 b/man3/usleep.3 index c264db1744..879e9284d4 100644 --- a/man3/usleep.3 +++ b/man3/usleep.3 @@ -75,7 +75,7 @@ Only the error return is documented by SUSv2. .SH NOTES The type -.B useconds_t +.I useconds_t is an unsigned integer type capable of holding integers in the range [0,1000000]. Programs will be more portable diff --git a/man3/wordexp.3 b/man3/wordexp.3 index 9de907f9c8..9baf00452e 100644 --- a/man3/wordexp.3 +++ b/man3/wordexp.3 @@ -37,7 +37,7 @@ performs a shell-like expansion of the string and returns the result in the structure pointed to by .IR p . The data type -.B wordexp_t +.I wordexp_t is a structure that at least has the fields .IR we_wordc , .IR we_wordv , @@ -46,18 +46,18 @@ and The field .I we_wordc is a -.B size_t +.I size_t that gives the number of words in the expansion of .IR s . The field .I we_wordv is a -.B char ** +.I char ** that points to the array of words found. The field .I we_offs of type -.B size_t +.I size_t is sometimes (depending on .IR flags , see below) used to indicate the number of initial elements in the diff --git a/man3/xdr.3 b/man3/xdr.3 index b7ae35b5b2..77d997ae9a 100644 --- a/man3/xdr.3 +++ b/man3/xdr.3 @@ -160,7 +160,7 @@ enum_t *ep; .ft R .IP A filter primitive that translates between C -.BR enum s +.IR enum s (actually integers) and their external representations. This routine returns one if it succeeds, zero otherwise. .br @@ -176,7 +176,7 @@ float *fp; .ft R .IP A filter primitive that translates between C -.BR float s +.IR float s and their external representations. This routine returns one if it succeeds, zero otherwise. .br @@ -567,7 +567,7 @@ short *sp; .ft R .IP A filter primitive that translates between C -.B short +.I short integers and their external representations. This routine returns one if it succeeds, zero otherwise. .br @@ -715,13 +715,13 @@ bool_t (*defaultarm) (); /* may equal \s-1NULL\s0 */ .ft R .IP A filter primitive that translates between a discriminated C -.B union +.I union and its corresponding external representation. It first translates the discriminant of the union located at .IR dscmp . This discriminant is always an -.BR enum_t . +.IR enum_t . Next the union located at .I unp is translated. @@ -253,26 +253,26 @@ Magnetic Tape operations for normal tape use: .PD 0 .IP MTBSF 14 Backward space over -.B mt_count +.I mt_count filemarks. .IP MTBSFM Backward space over -.B mt_count +.I mt_count filemarks. Reposition the tape to the EOT side of the last filemark. .IP MTBSR Backward space over -.B mt_count +.I mt_count records (tape blocks). .IP MTBSS Backward space over -.B mt_count +.I mt_count setmarks. .IP MTCOMPRESSION Enable compression of tape data within the drive if -.B mt_count +.I mt_count is non-zero and disable compression if -.B mt_count +.I mt_count is zero. This command uses the MODE page 15 supported by most DATs. .IP MTEOM @@ -284,27 +284,27 @@ argument is zero. Otherwise long erase (erase all) is done. .IP MTFSF Forward space over -.B mt_count +.I mt_count filemarks. .IP MTFSFM Forward space over -.B mt_count +.I mt_count filemarks. Reposition the tape to the BOT side of the last filemark. .IP MTFSR Forward space over -.B mt_count +.I mt_count records (tape blocks). .IP MTFSS Forward space over -.B mt_count +.I mt_count setmarks. .IP MTLOAD Execute the SCSI load command. A special case is available for some HP autoloaders. If -.B mt_count +.I mt_count is the constant MT_ST_HPLOADER_OFFSET plus a number, the number is sent to the drive to control the autoloader. .IP MTLOCK @@ -312,11 +312,11 @@ Lock the tape drive door. .IP MTMKPART Format the tape into one or two partitions. If -.B mt_count +.I mt_count is non-zero, it gives the size of the first partition and the second partition contains the rest of the tape. If -.B mt_count +.I mt_count is zero, the tape is formatted into one partition. This command is not allowed for a drive unless the partition support is enabled for the drive (see MT_ST_CAN_PARTITIONS below). @@ -333,7 +333,7 @@ Re-tension tape. Rewind. .IP MTSEEK Seek to the tape block number specified in -.BR mt_count . +.IR mt_count . This operation requires either a SCSI-2 drive that supports the \s-1LOCATE\s+1 command (device-specific address) or a Tandberg-compatible SCSI-1 drive (Tandberg, Archive @@ -342,16 +342,16 @@ The block number should be one that was previously returned by \s-1MTIOCPOS\s+1 if device-specific addresses are used. .IP MTSETBLK Set the drive's block length to the value specified in -.BR mt_count . +.IR mt_count . A block length of zero sets the drive to variable block size mode. .IP MTSETDENSITY Set the tape density to the code in -.BR mt_count . +.IR mt_count . The density codes supported by a drive can be found from the drive documentation. .IP MTSETPART The active partition is switched to -.BR mt_count . +.IR mt_count . The partitions are numbered from zero. This command is not allowed for a drive unless the partition support is enabled for the drive (see @@ -362,11 +362,11 @@ Execute the SCSI unload command (does not eject the tape). Unlock the tape drive door. .IP MTWEOF Write -.B mt_count +.I mt_count filemarks. .IP MTWSM Write -.B mt_count +.I mt_count setmarks. .PD .PP @@ -374,7 +374,7 @@ Magnetic Tape operations for setting of device options (by the superuser): .PD 0 .IP MTSETDRVBUFFER 8 Set various drive and driver options according to bits encoded in -.BR mt_count . +.IR mt_count . These consist of the drive's buffering mode, a set of Boolean driver options, the buffer write threshold, defaults for the block size and density, and timeouts (only in kernels >= 2.1). @@ -402,7 +402,7 @@ written to the medium. .RE .IP "" To control the write threshold the value in -.B mt_count +.I mt_count must include the constant \s-1MT_ST_WRITE_THRESHOLD\s+1 logically ORed with a block count in the low 28 bits. @@ -414,7 +414,7 @@ above). .IP To set and clear the Boolean options the value in -.B mt_count +.I mt_count must include one of the constants \s-1MT_ST_BOOLEANS\s+1, \s-1MT_ST_SETBOOLEANS\s+1, \s-1MT_ST_CLEARBOOLEANS\s+1, or \s-1MT_ST_DEFBOOLEANS\s+1 logically or'ed with @@ -621,22 +621,22 @@ struct mtget { daddr_t mt_blkno; }; .fi -.IP \fBmt_type\fP 11 +.IP \fImt_type\fP 11 The header file defines many values for -.BR mt_type , +.IR mt_type , but the current driver reports only the generic types \s-1MT_ISSCSI1\s+1 (Generic SCSI-1 tape) and \s-1MT_ISSCSI2\s+1 (Generic SCSI-2 tape). .PD 0 -.IP \fBmt_resid\fP +.IP \fImt_resid\fP contains the current tape partition number. -.IP \fBmt_dsreg\fP +.IP \fImt_dsreg\fP reports the drive's current settings for block size (in the low 24 bits) and density (in the high 8 bits). These fields are defined by \s-1MT_ST_BLKSIZE_SHIFT\s+1, \s-1MT_ST_BLKSIZE_MASK\s+1, \s-1MT_ST_DENSITY_SHIFT\s+1, and \s-1MT_ST_DENSITY_MASK\s+1. -.IP \fBmt_gstat\fP +.IP \fImt_gstat\fP reports generic (device independent) status information. The header file defines macros for testing these status bits: .RS @@ -688,20 +688,20 @@ the drive is set not to buffer data. The drive has requested cleaning. Implemented in kernels >= 2.4.19 and 2.5.43. .RE -.IP \fBmt_erreg\fP +.IP \fImt_erreg\fP The only field defined in -.B mt_erreg +.I mt_erreg is the recovered error count in the low 16 bits (as defined by \s-1MT_ST_SOFTERR_SHIFT\s+1 and \s-1MT_ST_SOFTERR_MASK\s+1). Due to inconsistencies in the way drives report recovered errors, this count is often not maintained (most drives do not by default report soft errors but this can be changed with a SCSI MODE SELECT command). -.IP \fBmt_fileno\fP +.IP \fImt_fileno\fP reports the current file number (zero-based). This value is set to \-1 when the file number is unknown (e.g., after \s-1MTBSS\s+1 or \s-1MTSEEK\s+1). -.IP \fBmt_blkno\fP +.IP \fImt_blkno\fP reports the block number (zero-based) within the current file. This value is set to \-1 when the block number is unknown (e.g., after \s-1MTBSF\s+1, @@ -713,7 +713,7 @@ This request takes an argument of type .I "(struct mtpos *)" and reports the drive's notion of the current tape block number, which is not the same as -.B mt_blkno +.I mt_blkno returned by \s-1MTIOCGET\s+1. This drive must be a SCSI-2 drive that supports the \s-1READ POSITION\s+1 command (device-specific address) @@ -234,12 +234,12 @@ For datagram sockets, IP options can be only set by the local user. Calling .BR getsockopt (2) with -.I IP_OPTIONS +.B IP_OPTIONS puts the current IP options used for sending into the supplied buffer. .TP .B IP_PKTINFO Pass an -.I IP_PKTINFO +.B IP_PKTINFO ancillary message that contains a .I pktinfo structure that supplies some information about the incoming packet. @@ -271,7 +271,7 @@ is the local address of the packet and .I ipi_addr is the destination address in the packet header. If -.I IP_PKTINFO +.B IP_PKTINFO is passed to .BR sendmsg (2) and @@ -288,7 +288,7 @@ for the routing table lookup. .TP .B IP_RECVTOS If enabled the -.I IP_TOS +.B IP_TOS ancillary message is passed with incoming packets. It contains a byte which specifies the Type of Service/Precedence field of the packet header. @@ -297,7 +297,7 @@ Expects a boolean integer flag. .B IP_RECVTTL When this flag is set pass a -.I IP_TTL +.B IP_TTL control message with the time to live field of the received packet as a byte. Not supported for @@ -306,17 +306,17 @@ sockets. .TP .B IP_RECVOPTS Pass all incoming IP options to the user in a -.I IP_OPTIONS +.B IP_OPTIONS control message. The routing header and other options are already filled in for the local host. Not supported for -.I SOCK_STREAM +.B SOCK_STREAM sockets. .TP .B IP_RETOPTS Identical to -.I IP_RECVOPTS +.B IP_RECVOPTS but returns raw unprocessed options with timestamp and route record options not filled in for this hop. .TP @@ -363,10 +363,10 @@ See .BR raw (7) for more information. When this flag is enabled the values set by -.IR IP_OPTIONS , -.I IP_TTL +.BR IP_OPTIONS , +.B IP_TTL and -.I IP_TOS +.B IP_TOS are ignored. .TP .BR IP_RECVERR " (defined in \fI<linux/errqueue.h>\fP)" @@ -384,7 +384,7 @@ The .I sock_extended_err structure describing the error will be passed in a ancillary message with the type -.I IP_RECVERR +.B IP_RECVERR and the level .BR IPPROTO_IP . .\" or SOL_IP on Linux @@ -393,7 +393,7 @@ The received data portion of the error queue contains the error packet. .IP The -.I IP_RECVERR +.B IP_RECVERR control message contains a .I sock_extended_err structure: @@ -468,7 +468,7 @@ macro. The .I sin_family field of the SO_EE_OFFENDER address is -.I AF_UNSPEC +.B AF_UNSPEC when the source was unknown. When the error originated from the network, all IP options .RI ( IP_OPTIONS ", " IP_TTL ", " @@ -480,7 +480,7 @@ causing the error is returned as normal payload. .\" On .\" .B SOCK_STREAM .\" sockets, -.\" .I IP_RECVERR +.\" .B IP_RECVERR .\" has slightly different semantics. Instead of .\" saving the errors for the next timeout, it passes all incoming .\" errors immediately to the user. @@ -502,12 +502,12 @@ returned by socket function return or only. .IP For raw sockets, -.I IP_RECVERR +.B IP_RECVERR enables passing of all received ICMP errors to the application, otherwise errors are only reported on connected sockets .IP It sets or retrieves an integer boolean flag. -.I IP_RECVERR +.B IP_RECVERR defaults to off. .TP .B IP_MTU_DISCOVER @@ -679,7 +679,7 @@ Argument is an or .I ip_mreq structure similar to -.IR IP_ADD_MEMBERSHIP . +.BR IP_ADD_MEMBERSHIP . .\" .TP .B IP_MULTICAST_IF @@ -689,7 +689,7 @@ Argument is an or .I ip_mreq structure similar to -.IR IP_ADD_MEMBERSHIP . +.BR IP_ADD_MEMBERSHIP . .IP When an invalid socket option is passed, .B ENOPROTOOPT @@ -745,7 +745,7 @@ Not documented. .BR ip_default_ttl " (integer; default: 64)" Set the default time-to-live value of outgoing packets. This can be changed per socket with the -.I IP_TTL +.B IP_TTL option. .\" .TP @@ -929,19 +929,19 @@ Other errors may be generated by the overlaying protocols; see and .BR socket (7). .SH VERSIONS -.IR IP_MTU , -.IR IP_MTU_DISCOVER , -.IR IP_PKTINFO , -.I IP_RECVERR +.BR IP_MTU , +.BR IP_MTU_DISCOVER , +.BR IP_PKTINFO , +.B IP_RECVERR and -.I IP_ROUTER_ALERT +.B IP_ROUTER_ALERT are new options in Linux 2.2. They are also all Linux specific and should not be used in programs intended to be portable. .PP .\" FIXME .\" To be confirmed that IP_PMTUDISC_PROBE makes it into kernel 2.6.22 -.I IP_PMTUDISC_PROBE +.B IP_PMTUDISC_PROBE is new in Linux 2.6.22. .PP .I struct ip_mreqn @@ -961,28 +961,28 @@ it is better to use a multicast group instead of broadcasting. Broadcasting is discouraged. .PP Some other BSD sockets implementations provide -.I IP_RCVDSTADDR +.B IP_RCVDSTADDR and -.I IP_RECVIF +.B IP_RECVIF socket options to get the destination address and the interface of received datagrams. Linux has the more general -.I IP_PKTINFO +.B IP_PKTINFO for the same task. .PP Some BSD sockets implementations also provide an -.I IP_RECVTTL +.B IP_RECVTTL option, but an ancillary message with type -.I IP_RECVTTL +.B IP_RECVTTL is passed with the incoming packet. This is different from the -.I IP_TTL +.B IP_TTL option used in Linux. .PP Using -.I SOL_IP +.B SOL_IP socket options level isn't portable, BSD-based stacks use -.I IPPROTO_IP +.B IPPROTO_IP level. .SS Compatibility For compatibility with Linux 2.0, the obsolete diff --git a/man7/ipv6.7 b/man7/ipv6.7 index 4ac72c60a0..ced663f5ea 100644 --- a/man7/ipv6.7 +++ b/man7/ipv6.7 @@ -31,9 +31,9 @@ v4 API. Only differences are described in this man page. .PP To bind an -.I AF_INET6 +.B AF_INET6 socket to any process the local address should be copied from the -.B in6addr_any +.I in6addr_any variable which has .I in6_addr type. @@ -43,7 +43,7 @@ may also be used, which expands to a constant expression. Both of them are in network order. .PP The IPv6 loopback address (::1) is available in the global -.B in6addr_loopback +.I in6addr_loopback variable. For initializations .B IN6ADDR_LOOPBACK_INIT @@ -78,19 +78,19 @@ struct in6_addr { .fi .RE .sp -.B sin6_family +.I sin6_family is always set to .BR AF_INET6 ; -.B sin6_port +.I sin6_port is the protocol port (see -.B sin_port +.I sin_port in .BR ip (7)); -.B sin6_flowinfo +.I sin6_flowinfo is the IPv6 flow identifier; -.B sin6_addr -is the 128bit IPv6 address. -.B sin6_scope_id +.I sin6_addr +is the 128-bit IPv6 address. +.I sin6_scope_id is an ID of depending of on the scope of the address. It is new in Linux 2.4. Linux only supports it for link scope addresses, in that case @@ -121,10 +121,10 @@ A boolean integer flag is zero when it is false, otherwise true. .TP .B IPV6_ADDRFORM Turn an -.I AF_INET6 +.B AF_INET6 socket into a socket of a different address family. Only -.I AF_INET +.B AF_INET is currently supported for that. It is only allowed for IPv6 sockets that are connected and bound to a v4-mapped-on-v6 address. @@ -156,7 +156,7 @@ Argument is a pointer to integer. .B IPV6_MTU_DISCOVER Control path mtu discovery on the socket. See -.I IP_MTU_DISCOVER +.B IP_MTU_DISCOVER in .BR ip (7) for details. @@ -172,9 +172,9 @@ between 0 and 255. Set the device for outgoing multicast packets on the socket. This is only allowed for -.I SOCK_DGRAM +.B SOCK_DGRAM and -.I SOCK_RAW +.B SOCK_RAW socket. The argument is an pointer to an interface index (see .BR netdevice (7)) @@ -200,17 +200,17 @@ Argument is a pointer to a boolean value in an integer. .hy Set delivery of control messages for incoming datagrams containing extension headers from the received packet. -.I IPV6_RTHDR +.B IPV6_RTHDR delivers the routing header, -.I IPV6_AUTHHDR +.B IPV6_AUTHHDR delivers the authentication header, -.I IPV6_DSTOPTS +.B IPV6_DSTOPTS delivers the destination options, -.I IPV6_HOPOPTS +.B IPV6_HOPOPTS delivers the hop options, -.I IPV6_FLOWINFO +.B IPV6_FLOWINFO delivers an integer containing the flow ID, -.I IPV6_HOPLIMIT +.B IPV6_HOPLIMIT delivers an integer containing the hop count of the packet. The control messages have the same type as the socket option. All these header options can also be set for outgoing packets @@ -226,7 +226,7 @@ Argument is a pointer to a boolean value. .B IPV6_RECVERR Control receiving of asynchronous error options. See -.I IP_RECVERR +.B IP_RECVERR in .BR ip (7) for details. @@ -250,19 +250,24 @@ The older libc5 based IPv6 API implementation for Linux is not described here and may vary in details. .PP -Linux 2.4 will break binary compatibility for the sockaddr_in6 for 64bit +Linux 2.4 will break binary compatibility for the +.I sockaddr_in6 +for 64-bit hosts by changing the alignment of .I in6_addr and adding an additional .I sin6_scope_id field. The kernel interfaces stay compatible, but a program including -sockaddr_in6 or in6_addr into other structures may not be. +.I sockaddr_in6 +or +.I in6_addr +into other structures may not be. This is not -a problem for 32bit hosts like i386. +a problem for 32-bit hosts like i386. .PP The -.B sin6_flowinfo +.I sin6_flowinfo field is new in Linux 2.4. It is transparently passed/read by the kernel when the passed address length contains it. @@ -272,7 +277,7 @@ check the outgoing address length may break. The .I sockaddr_in6 structure is bigger than the generic -.BR sockaddr . +.IR sockaddr . Programs that assume that all address types can be stored safely in a .I struct sockaddr need to be changed to use diff --git a/man7/netdevice.7 b/man7/netdevice.7 index 217fb1e207..65b802d9fa 100644 --- a/man7/netdevice.7 +++ b/man7/netdevice.7 @@ -24,7 +24,7 @@ Linux supports some standard ioctls to configure network devices. They can be used on any socket's file descriptor regardless of the family or type. They pass an -.B ifreq +.I ifreq structure: .nf @@ -57,7 +57,7 @@ struct ifconf { .fi Normally, the user specifies which device to affect by setting -.B ifr_name +.I ifr_name to the name of the interface. All other members of the structure may share memory. @@ -72,19 +72,19 @@ will be returned. .TP .B SIOCGIFNAME Given the -.BR ifr_ifindex , +.IR ifr_ifindex , return the name of the interface in -.BR ifr_name . +.IR ifr_name . This is the only ioctl which returns its result in -.BR ifr_name . +.IR ifr_name . .TP .B SIOCGIFINDEX Retrieve the interface index of the interface into -.BR ifr_ifindex . +.IR ifr_ifindex . .TP .BR SIOCGIFFLAGS ", " SIOCSIFFLAGS Get or set the active flag word of the device. -.B ifr_flags +.I ifr_flags contains a bitmask of the following values: .TS tab(:); @@ -115,23 +115,23 @@ process may read it. .TP .BR SIOCGIFMETRIC ", " SIOCSIFMETRIC Get or set the metric of the device using -.BR ifr_metric . +.IR ifr_metric . This is currently not implemented; it sets -.B ifr_metric +.I ifr_metric to 0 if you attempt to read it and returns .B EOPNOTSUPP if you attempt to set it. .TP .BR SIOCGIFMTU ", " SIOCSIFMTU Get or set the MTU (Maximum Transfer Unit) of a device using -.BR ifr_mtu . +.IR ifr_mtu . Setting the MTU is a privileged operation. Setting the MTU to too small values may cause kernel crashes. .TP .BR SIOCGIFHWADDR ", " SIOCSIFHWADDR Get or set the hardware address of a device using -.BR ifr_hwaddr . +.IR ifr_hwaddr . The hardware address is specified in a struct .IR sockaddr . .I sa_family @@ -142,12 +142,12 @@ Setting the hardware address is a privileged operation. .TP .B SIOCSIFHWBROADCAST Set the hardware broadcast address of a device from -.BR ifr_hwaddr . +.IR ifr_hwaddr . This is a privileged operation. .TP .BR SIOCGIFMAP ", " SIOCSIFMAP Get or set the interface's hardware parameters using -.BR ifr_map . +.IR ifr_map . Setting the parameters is a privileged operation. .nf @@ -167,7 +167,7 @@ and the architecture. .BR SIOCADDMULTI ", " SIOCDELMULTI Add an address to or delete an address from the device's link layer multicast filters using -.BR ifr_hwaddr . +.IR ifr_hwaddr . These are privileged operations. See also .BR packet (7) @@ -175,14 +175,14 @@ for an alternative. .TP .BR SIOCGIFTXQLEN ", " SIOCSIFTXQLEN Get or set the transmit queue length of a device using -.BR ifr_qlen . +.IR ifr_qlen . Setting the transmit queue length is a privileged operation. .TP .B SIOCSIFNAME Changes the name of the interface specified in -.BR ifr_name +.IR ifr_name to -.BR ifr_newname . +.IR ifr_newname . This is a privileged operation. It is only allowed when the interface is not up. @@ -194,14 +194,14 @@ means only addresses of the .B AF_INET (IPv4) family for compatibility. The user passes a -.B ifconf +.I ifconf structure as argument to the ioctl. It contains a pointer to an array of .I ifreq structures in -.B ifc_req +.I ifc_req and its length in bytes in -.BR ifc_len . +.IR ifc_len . The kernel fills the ifreqs with all current L3 interface addresses that are running: .I ifr_name @@ -222,7 +222,7 @@ Overflow is not an error. .\" .TP .\" .BR SIOCGIFSLAVE ", " SIOCSIFSLAVE .\" Get or set the slave device using -.\" .BR ifr_slave . +.\" .IR ifr_slave . .\" Setting the slave device is a privileged operation. .\" .PP .\" FIXME add amateur radio stuff. diff --git a/man7/netlink.7 b/man7/netlink.7 index cdfc4f5747..d9535e47bb 100644 --- a/man7/netlink.7 +++ b/man7/netlink.7 @@ -366,10 +366,10 @@ Linux 2.6.14. NETLINK_GENERIC and NETLINK_ISCSI appeared in Linux 2.6.15. .SH NOTES It is often better to use netlink via -.B libnetlink +.I libnetlink or -.B libnl -than via the low level kernel interface. +.I libnl +than via the low-level kernel interface. .SH BUGS This manual page is not complete. .SH EXAMPLE diff --git a/man7/packet.7 b/man7/packet.7 index fadb8cd1fe..8871f44aab 100644 --- a/man7/packet.7 +++ b/man7/packet.7 @@ -32,7 +32,7 @@ for raw packets including the link level header or for cooked packets with the link level header removed. The link level header information is available in a common format in a -.BR sockaddr_ll . +.IR sockaddr_ll . .I protocol is the IEEE 802.3 protocol number in network order. See the @@ -54,7 +54,7 @@ packets are passed to and from the device driver without any changes in the packet data. When receiving a packet, the address is still parsed and passed in a standard -.B sockaddr_ll +.I sockaddr_ll address structure. When transmitting a packet, the user supplied buffer should contain the physical layer header. @@ -74,7 +74,7 @@ Packets sent through a .B SOCK_DGRAM packet socket get a suitable physical layer header based on the information in the -.B sockaddr_ll +.I sockaddr_ll destination address before they are queued. By default all packets of the specified protocol type @@ -85,9 +85,9 @@ specifying an address in a .I struct sockaddr_ll to bind the packet socket to an interface. Only the -.B sll_protocol +.I sll_protocol and the -.B sll_ifindex +.I sll_ifindex address fields are used for purposes of binding. The @@ -119,22 +119,22 @@ struct sockaddr_ll { .fi .in -0.25i -.B sll_protocol +.I sll_protocol is the standard ethernet protocol type in network order as defined in the .I <linux/if_ether.h> include file. It defaults to the socket's protocol. -.B sll_ifindex +.I sll_ifindex is the interface index of the interface (see .BR netdevice (7)); 0 matches any interface (only legal for binding). -.B sll_hatype +.I sll_hatype is a ARP type as defined in the .I <linux/if_arp.h> include file. -.B sll_pkttype +.I sll_pkttype contains the packet type. Valid types are .B PACKET_HOST @@ -150,26 +150,26 @@ in promiscuous mode, and for a packet originated from the local host that is looped back to a packet socket. These types make only sense for receiving. -.B sll_addr +.I sll_addr and -.B sll_halen +.I sll_halen contain the physical layer (e.g., IEEE 802.3) address and its length. The exact interpretation depends on the device. When you send packets it is enough to specify -.BR sll_family , -.BR sll_addr , -.BR sll_halen , -.BR sll_ifindex . +.IR sll_family , +.IR sll_addr , +.IR sll_halen , +.IR sll_ifindex . The other fields should be 0. -.B sll_hatype +.I sll_hatype and -.B sll_pkttype +.I sll_pkttype are set on received packets for your information. For bind only -.B sll_protocol +.I sll_protocol and -.B sll_ifindex +.I sll_ifindex are used. .SS Socket Options Packet sockets can be used to configure physical layer multicasting @@ -343,14 +343,14 @@ struct sockaddr_pkt { .fi .in -0.25i -.B spkt_family +.I spkt_family contains the device type, -.B spkt_protocol +.I spkt_protocol is the IEEE 802.3 protocol type as defined in .I <sys/if_ether.h> and -.B spkt_device +.I spkt_device is the device name as a null terminated string, for example, eth0. This structure is obsolete and should not be used in new code. diff --git a/man7/raw.7 b/man7/raw.7 index d0e74c4847..9f05c64475 100644 --- a/man7/raw.7 +++ b/man7/raw.7 @@ -190,7 +190,7 @@ When this happens the application should decrease the packet size. Path MTU discovery can be also turned off using the .B IP_MTU_DISCOVER socket option or the -.B ip_no_pmtu_disc +.I ip_no_pmtu_disc sysctl, see .BR ip (7) for details. diff --git a/man7/rtnetlink.7 b/man7/rtnetlink.7 index 35505948ea..2ce0d82de9 100644 --- a/man7/rtnetlink.7 +++ b/man7/rtnetlink.7 @@ -56,9 +56,9 @@ Rtnetlink consists of these message types .BR RTM_NEWLINK ", " RTM_DELLINK ", " RTM_GETLINK Create, remove or get information about a specific network interface. These messages contain an -.B ifinfomsg +.I ifinfomsg structure followed by a series of -.B rtattr +.I rtattr structures. .nf @@ -72,12 +72,12 @@ struct ifinfomsg { .fi .\" FIXME ifi_type -.B ifi_flags +.I ifi_flags contains the device flags, see .BR netdevice (7); -.B ifi_index +.I ifi_index is the unique interface index, -.B ifi_change +.I ifi_change is reserved for future use and should be always set to 0xFFFFFFFF. .TS tab(:); @@ -108,9 +108,9 @@ this replaces the alias device concept in 2.0. In Linux 2.2 these messages support IPv4 and IPv6 addresses. They contain an -.B ifaddrmsg +.I ifaddrmsg structure, optionally followed by -.B rtaddr +.I rtaddr routing attributes. .nf @@ -123,19 +123,19 @@ struct ifaddrmsg { }; .fi -.B ifa_family +.I ifa_family is the address family type (currently .B AF_INET or .BR AF_INET6 ), -.B ifa_prefixlen +.I ifa_prefixlen is the length of the address mask of the address if defined for the family (like for IPv4), -.B ifa_scope +.I ifa_scope is the address scope, -.B ifa_index +.I ifa_index is the interface index of the interface the address is associated with. -.B ifa_flags +.I ifa_flags is a flag word of .B IFA_F_SECONDARY for secondary address (old alias interface), @@ -162,21 +162,21 @@ IFA_CACHEINFO:struct ifa_cacheinfo:Address information. .BR RTM_NEWROUTE ", " RTM_DELROUTE ", " RTM_GETROUTE Create, remove or receive information about a network route. These messages contain an -.B rtmsg +.I rtmsg structure with an optional sequence of -.B rtattr +.I rtattr structures following. For .B RTM_GETROUTE setting -.B rtm_dst_len +.I rtm_dst_len and -.B rtm_src_len +.I rtm_src_len to 0 means you get all entries for the specified routing table. For the other fields except -.B rtm_table +.I rtm_table and -.B rtm_protocol +.I rtm_protocol 0 is the wildcard. .nf @@ -244,7 +244,7 @@ See .IR <linux/rtnetlink.h> for the routing daemon identifiers which are already assigned. -.B rtm_scope +.I rtm_scope is the distance to the destination: .TS @@ -266,7 +266,7 @@ and are available to the user. The -.B rtm_flags +.I rtm_flags have the following meanings: .TS @@ -279,7 +279,7 @@ RTM_F_CLONED:route is cloned from another route RTM_F_EQUALIZE:a multicast equalizer (not yet implemented) .TE -.B rtm_table +.I rtm_table specifies the routing table .TS @@ -324,7 +324,7 @@ RTA_CACHEINFO:: Add, remove or receive information about a neighbor table entry (e.g., an ARP entry). The message contains an -.B ndmsg +.I ndmsg structure. .nf @@ -344,7 +344,7 @@ struct nda_cacheinfo { }; .fi -.B ndm_state +.I ndm_state is a bitmask of the following states: .TS @@ -361,7 +361,7 @@ NUD_PERMANENT:a static entry .TE Valid -.B ndm_flags +.I ndm_flags are: .TS @@ -374,9 +374,9 @@ NTF_ROUTER:an IPv6 router .B document the members of the struct better The -.B rtaddr +.I rtaddr struct has the following meanings for the -.B rta_type +.I rta_type field: .TS @@ -389,7 +389,7 @@ NDA_CACHEINFO:cache statistics. .TE If the -.B rta_type +.I rta_type field is .B NDA_CACHEINFO then a diff --git a/man7/socket.7 b/man7/socket.7 index e4c83d1a70..effcc6cf44 100644 --- a/man7/socket.7 +++ b/man7/socket.7 @@ -365,9 +365,9 @@ when it is set using and this doubled value is returned by .BR getsockopt (2). The default value is set by the -.B rmem_default +.I rmem_default sysctl and the maximum allowed value is set by the -.B rmem_max +.I rmem_max sysctl. The minimum (doubled) value for this option is 256. .TP @@ -377,7 +377,7 @@ Using this socket option, a privileged process can perform the same task as .BR SO_RCVBUF , but the -.B rmem_max +.I rmem_max limit can be overridden. .TP .BR SO_RCVLOWAT " and " SO_SNDLOWAT @@ -454,9 +454,9 @@ when it is set using and this doubled value is returned by .BR getsockopt (2). The default value is set by the -.B wmem_default +.I wmem_default sysctl and the maximum allowed value is set by the -.B wmem_max +.I wmem_max sysctl. The minimum (doubled) value for this option is 2048. .TP @@ -466,7 +466,7 @@ Using this socket option, a privileged process can perform the same task as .BR SO_SNDBUF , but the -.B wmem_max +.I wmem_max limit can be overridden. .TP .B SO_TIMESTAMP @@ -542,19 +542,19 @@ files or with the .BR sysctl (2) interface. .TP -.B rmem_default +.I rmem_default contains the default setting in bytes of the socket receive buffer. .TP -.B rmem_max +.I rmem_max contains the maximum socket receive buffer size in bytes which a user may set by using the .B SO_RCVBUF socket option. .TP -.B wmem_default +.I wmem_default contains the default setting in bytes of the socket send buffer. .TP -.B wmem_max +.I wmem_max contains the maximum socket send buffer size in bytes which a user may set by using the .B SO_SNDBUF @@ -564,10 +564,10 @@ socket option. configure the token bucket filter used to load limit warning messages caused by external network events. .TP -.B netdev_max_backlog +.I netdev_max_backlog Maximum number of packets in the global input queue. .TP -.B optmem_max +.I optmem_max Maximum length of ancillary data and user control data like the iovecs per socket. .\" netdev_fastroute is not documented because it is experimental @@ -614,7 +614,7 @@ signals to when an asynchronous I/O operation has finished or urgent data is available. The argument is a pointer to a -.BR pid_t . +.IR pid_t . If the argument is positive, send the signals to that process. If the argument is negative, send the signals to the process group with the ID diff --git a/man7/svipc.7 b/man7/svipc.7 index c3d5e9b184..6ba7b60b96 100644 --- a/man7/svipc.7 +++ b/man7/svipc.7 @@ -42,7 +42,7 @@ This manual page refers to the Linux implementation of the System V interprocess communication mechanisms: message queues, semaphore sets, and shared memory segments. In the following, the word -.B resource +.I resource means an instantiation of one among such mechanisms. .SS Resource Access Permissions For each resource, the system uses a common structure of type diff --git a/man7/tcp.7 b/man7/tcp.7 index d54c61d415..61c2787151 100644 --- a/man7/tcp.7 +++ b/man7/tcp.7 @@ -71,9 +71,9 @@ latency or bandwidth. To make use of them, the send and receive buffer sizes must be increased. They can be set globally with the -.B net.ipv4.tcp_wmem +.I net.ipv4.tcp_wmem and -.B net.ipv4.tcp_rmem +.I net.ipv4.tcp_rmem sysctl variables, or on individual sockets by using the .B SO_SNDBUF and @@ -87,9 +87,9 @@ The maximum sizes for socket buffers declared via the and .B SO_RCVBUF mechanisms are limited by the global -.B net.core.rmem_max +.I net.core.rmem_max and -.B net.core.wmem_max +.I net.core.wmem_max sysctls. Note that TCP actually allocates twice the size of the buffer requested in the @@ -210,7 +210,7 @@ The rest of the space is used as the "application" buffer, used to isolate the network from scheduling and application latencies. The -.BR tcp_adv_win_scale +.IR tcp_adv_win_scale default value of 2 implies that the space used for the application buffer is one fourth that of the total. @@ -357,7 +357,7 @@ depending on the memory in the system. If this number is exceeded, the socket is closed and a warning is printed. .TP -.BR tcp_mem +.IR tcp_mem This is a vector of 3 integers: [low, pressure, high]. These bounds are used by TCP to track its memory usage. The @@ -430,7 +430,7 @@ if a RST is received in TIME_WAIT state, we close the socket immediately without waiting for the end of the TIME_WAIT period. .TP -.BR tcp_rmem +.IR tcp_rmem This is a vector of 3 integers: [min, default, max]. These parameters are used by TCP to regulate receive @@ -457,7 +457,7 @@ on a socket. - the default size of the receive buffer for a TCP socket. This value overwrites the initial default buffer size from the generic global -.B net.core.rmem_default +.I net.core.rmem_default defined for all protocols. The default value is 87380 bytes, and is lowered to 43689 in low-memory systems. @@ -465,14 +465,14 @@ If larger receive buffer sizes are desired, this value should be increased (to affect all sockets). To employ large TCP windows, the -.B net.ipv4.tcp_window_scaling +.I net.ipv4.tcp_window_scaling must be enabled (default). .I max - the maximum size of the receive buffer used by each TCP socket. This value does not override the global -.BR net.core.rmem_max . +.IR net.core.rmem_max . This is not used to limit the size of the receive buffer declared using .B SO_RCVBUF @@ -519,10 +519,10 @@ It is not recommended as a tuning mechanism for heavily loaded servers to help with overloaded or misconfigured conditions. For recommended alternatives see -.BR tcp_max_syn_backlog , -.BR tcp_synack_retries , +.IR tcp_max_syn_backlog , +.IR tcp_synack_retries , and -.BR tcp_abort_on_overflow . +.IR tcp_abort_on_overflow . .TP .BR tcp_syn_retries " (integer; default: 5)" The maximum number of times initial SYNs for an active TCP @@ -560,7 +560,7 @@ windows are desired, applications can increase the size of their socket buffers and the window scaling option will be employed. If -.BR tcp_window_scaling +.IR tcp_window_scaling is disabled, TCP will not negotiate the use of window scaling with the other end during connection setup. .\" @@ -592,7 +592,7 @@ account the bandwidth used at the time congestion is experienced. TCP Westwood+ significantly increases fairness with respect to TCP Reno in wired networks and throughput over wireless links. .TP -.BR tcp_wmem +.IR tcp_wmem This is a vector of 3 integers: [min, default, max]. These parameters are used by TCP to regulate send buffer sizes. TCP dynamically adjusts the size of the send buffer from the @@ -614,20 +614,20 @@ on a socket. - the default size of the send buffer for a TCP socket. This value overwrites the initial default buffer size from the generic global -.B net.core.wmem_default +.I net.core.wmem_default defined for all protocols. The default value is 16K bytes. If larger send buffer sizes are desired, this value should be increased (to affect all sockets). To employ large TCP windows, the sysctl variable -.B net.ipv4.tcp_window_scaling +.I net.ipv4.tcp_window_scaling must be enabled (default). .I max - the maximum size of the send buffer used by each TCP socket. This value does not override the global -.BR net.core.wmem_max . +.IR net.core.wmem_max . This is not used to limit the size of the send buffer declared using .B SO_SNDBUF @@ -706,7 +706,7 @@ portable. .B TCP_LINGER2 The lifetime of orphaned FIN_WAIT2 state sockets. This option can be used to override the system wide sysctl -.B tcp_fin_timeout +.I tcp_fin_timeout on this socket. This is not to be confused with the .BR socket (7) @@ -891,7 +891,7 @@ pointer field by default. This violates RFC\ 1122, but is required for interoperability with other stacks. It can be changed by the -.B tcp_stdurg +.I tcp_stdurg sysctl. .SH BUGS Not all errors are documented. diff --git a/man7/udp.7 b/man7/udp.7 index c0a841e515..454a045c4e 100644 --- a/man7/udp.7 +++ b/man7/udp.7 @@ -79,7 +79,7 @@ When this happens the application should decrease the packet size. Path MTU discovery can be also turned off using the .B IP_MTU_DISCOVER socket option or the -.B ip_no_pmtu_disc +.I ip_no_pmtu_disc sysctl, see .BR ip (7) for details. @@ -89,7 +89,7 @@ However disabling it is not recommended for performance and reliability reasons. .SS "Address Format" UDP uses the IPv4 -.B sockaddr_in +.I sockaddr_in address format described in .BR ip (7). .SS "Error Handling" diff --git a/man7/unicode.7 b/man7/unicode.7 index 8bd0855734..ae13e0ab60 100644 --- a/man7/unicode.7 +++ b/man7/unicode.7 @@ -177,7 +177,7 @@ editing, sorting, comparing, normalizing, converting and displaying Unicode strings. .SS "Unicode Under Linux" Under GNU/Linux, the C type -.B wchar_t +.I wchar_t is a signed 32-bit integer type. Its values are always interpreted by the C library as @@ -194,7 +194,7 @@ variables in the ASCII compatible multi-byte encoding. To signal the use of UTF-8 as the character encoding to all applications, a suitable -.B locale +.I locale has to be selected via environment variables (e.g., "LANG=en_GB.UTF-8"). .PP @@ -274,7 +274,7 @@ Markus Kuhn: UTF-8 and Unicode FAQ for Unix/Linux. http://www.cl.cam.ac.uk/~mgk25/unicode.html Provides subscription information for the -.B linux-utf8 +.I linux-utf8 mailing list, which is the best place to look for advice on using Unicode under Linux. .RE diff --git a/man7/unix.7 b/man7/unix.7 index 23c4170b29..887c1d8eb8 100644 --- a/man7/unix.7 +++ b/man7/unix.7 @@ -73,19 +73,19 @@ struct sockaddr_un { .fi .in -0.25i -.B sun_family +.I sun_family always contains .BR AF_UNIX . -.B sun_path +.I sun_path contains the zero-terminated pathname of the socket in the file system. If -.B sun_path +.I sun_path starts with a null byte (''\0'), then it refers to the abstract namespace maintained by the Unix protocol module. The socket's address in this namespace is given by the rest of the bytes in -.BR sun_path . +.IR sun_path . Note that names in the abstract namespace are not zero-terminated. .SS Socket Options For historical reasons these socket options are specified with a @@ -147,13 +147,13 @@ type even though they are .B PF_UNIX specific. To send them set the -.B cmsg_level +.I cmsg_level field of the struct -.B cmsghdr +.I cmsghdr to .B SOL_SOCKET and the -.B cmsg_type +.I cmsg_type field to the type. For more information see .BR cmsg (3). diff --git a/man8/ld.so.8 b/man8/ld.so.8 index 9d73b20074..82a8176db8 100644 --- a/man8/ld.so.8 +++ b/man8/ld.so.8 @@ -24,7 +24,7 @@ Linux binaries require dynamic linking (linking at run time) unless the .B \-static option was given to -.B ld +.BR ld (1) during compilation. .LP The program diff --git a/man8/zic.8 b/man8/zic.8 index 0b3fcc291a..0431de3f45 100644 --- a/man8/zic.8 +++ b/man8/zic.8 @@ -123,10 +123,10 @@ Gives the (arbitrary) name of the set of rules this rule is part of. Gives the first year in which the rule applies. Any integer year can be supplied; the Gregorian calendar is assumed. The word -.B minimum +.I minimum (or an abbreviation) means the minimum year representable as an integer. The word -.B maximum +.I maximum (or an abbreviation) means the maximum year representable as an integer. Rules can describe times that are not representable as time values, with the unrepresentable times ignored; this allows rules to be portable @@ -135,12 +135,12 @@ among hosts with differing time value types. .B TO Gives the final year in which the rule applies. In addition to -.B minimum +.I minimum and -.B maximum +.I maximum (as above), the word -.B only +.I only (or an abbreviation) may be used to repeat the value of the .B FROM @@ -211,19 +211,19 @@ Recognized forms include: where hour 0 is midnight at the start of the day, and hour 24 is midnight at the end of the day. Any of these forms may be followed by the letter -.B w +.I w if the given time is local .q "wall clock" time, -.B s +.I s if the given time is local .q standard time, or -.B u +.I u (or -.B g +.I g or -.BR z ) +.IR z ) if the given time is universal time; in the absence of an indicator, wall clock time is assumed. @@ -235,9 +235,9 @@ This field has the same format as the .B AT field (although, of course, the -.B w +.I w and -.B s +.I s suffixes are not used). .TP .B LETTER/S |