From 354783996443ccca96b2b241194dcc479b8d36ea Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Wed, 27 Dec 2006 03:54:41 +0000 Subject: [PATCH] wrap long source lines --- man2/getsockopt.2 | 4 +- man2/io_cancel.2 | 6 +- man2/io_setup.2 | 3 +- man2/mknodat.2 | 3 +- man2/readlinkat.2 | 3 +- man2/select.2 | 3 +- man2/select_tut.2 | 8 +- man2/syslog.2 | 3 +- man3/ceil.3 | 3 +- man3/cmsg.3 | 5 +- man3/ctermid.3 | 4 +- man3/des_crypt.3 | 3 +- man3/div.3 | 12 +- man3/erf.3 | 3 +- man3/fgetwc.3 | 3 +- man3/getipnodebyname.3 | 3 +- man3/getw.3 | 4 +- man3/lround.3 | 3 +- man3/modf.3 | 4 +- man3/nextafter.3 | 3 +- man3/stdio_ext.3 | 3 +- man3/termios.3 | 8 +- man3/wcpncpy.3 | 3 +- man3/wcsncat.3 | 5 +- man3/wcsncmp.3 | 5 +- man3/wcsncpy.3 | 5 +- man3/wcsnrtombs.3 | 6 +- man3/wcsrtombs.3 | 12 +- man3/wcsspn.3 | 17 ++- man3/wcsstr.3 | 11 +- man3/wcstok.3 | 11 +- man3/wmemchr.3 | 5 +- man3/wmemcmp.3 | 5 +- man3/wmemcpy.3 | 5 +- man3/wmemset.3 | 5 +- man3/wprintf.3 | 19 ++-- man4/console_ioctl.4 | 15 +-- man4/sk98lin.4 | 253 ++++++++++++++++++++++++++++++++--------- man7/environ.7 | 3 +- man7/time.7 | 3 +- man7/unix.7 | 3 +- 41 files changed, 343 insertions(+), 142 deletions(-) diff --git a/man2/getsockopt.2 b/man2/getsockopt.2 index 817a7c78d..13985bf69 100644 --- a/man2/getsockopt.2 +++ b/man2/getsockopt.2 @@ -36,8 +36,8 @@ .\" Modified Tue Aug 27 10:52:51 1996 by Andries Brouwer (aeb@cwi.nl) .\" Modified Thu Jan 23 13:29:34 1997 by Andries Brouwer (aeb@cwi.nl) .\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer (aeb@cwi.nl) -.\" Modified 1999 by Andi Kleen . Removed most stuff because it is in socket.7 -.\" now. +.\" Modified 1999 by Andi Kleen . +.\" Removed most stuff because it is in socket.7 now. .\" .TH GETSOCKOPT 2 1999-05-24 "Linux Man Page" "Linux Programmer's Manual" .SH NAME diff --git a/man2/io_cancel.2 b/man2/io_cancel.2 index d21f4d35f..54e7b3a57 100644 --- a/man2/io_cancel.2 +++ b/man2/io_cancel.2 @@ -77,12 +77,14 @@ The asynchronous I/O system calls first appeared in Linux 2.5, August 2002. .SH "CONFORMING TO" .PP -\fBio_cancel\fR() is Linux specific and should not be used in programs that are intended to be portable. +\fBio_cancel\fR() is Linux specific and should not be used +in programs that are intended to be portable. .SH "SEE ALSO" .PP -\fBio_setup\fR(2), \fBio_destroy\fR(2), \fBio_getevents\fR(2), \fBio_submit\fR(2). +\fBio_setup\fR(2), \fBio_destroy\fR(2), \fBio_getevents\fR(2), +\fBio_submit\fR(2). .SH "NOTES" diff --git a/man2/io_setup.2 b/man2/io_setup.2 index ae3f3fcdc..fe55d0880 100644 --- a/man2/io_setup.2 +++ b/man2/io_setup.2 @@ -88,7 +88,8 @@ The asynchronous I/O system calls first appeared in Linux 2.5, August 2002. .SH "SEE ALSO" .PP -\fBio_destroy\fR(2), \fBio_getevents\fR(2), \fBio_submit\fR(2), \fBio_cancel\fR(2). +\fBio_destroy\fR(2), \fBio_getevents\fR(2), \fBio_submit\fR(2), +\fBio_cancel\fR(2). .SH "NOTES" diff --git a/man2/mknodat.2 b/man2/mknodat.2 index 827675302..6118972d1 100644 --- a/man2/mknodat.2 +++ b/man2/mknodat.2 @@ -25,7 +25,8 @@ .\" .TH MKNODAT 2 2006-04-06 "Linux 2.6.16" "Linux Programmer's Manual" .SH NAME -mknodat \- create a special or ordinary file relative to a directory file descriptor +mknodat \- create a special or ordinary file relative to a directory +file descriptor .SH SYNOPSIS .nf .B #include diff --git a/man2/readlinkat.2 b/man2/readlinkat.2 index 6ad97d03d..274508136 100644 --- a/man2/readlinkat.2 +++ b/man2/readlinkat.2 @@ -25,7 +25,8 @@ .\" .TH READLINKAT 2 2006-07-21 "Linux 2.6.16" "Linux Programmer's Manual" .SH NAME -readlinkat \- read value of a symbolic link relative to a directory file descriptor +readlinkat \- read value of a symbolic link relative to +a directory file descriptor .SH SYNOPSIS .nf .B #include diff --git a/man2/select.2 b/man2/select.2 index af6bf65b0..13f97d0be 100644 --- a/man2/select.2 +++ b/man2/select.2 @@ -37,7 +37,8 @@ .\" .TH SELECT 2 2006-03-11 "Linux 2.6.16" "Linux Programmer's Manual" .SH NAME -select, pselect, FD_CLR, FD_ISSET, FD_SET, FD_ZERO \- synchronous I/O multiplexing +select, pselect, FD_CLR, FD_ISSET, FD_SET, FD_ZERO \- +synchronous I/O multiplexing .SH SYNOPSIS .nf /* According to POSIX.1-2001 */ diff --git a/man2/select_tut.2 b/man2/select_tut.2 index 43c29affa..f308de9df 100644 --- a/man2/select_tut.2 +++ b/man2/select_tut.2 @@ -28,7 +28,8 @@ .\" .TH SELECT_TUT 2 2006-05-13 "Linux" "Linux Programmer's Manual" .SH NAME -select, pselect, FD_CLR, FD_ISSET, FD_SET, FD_ZERO \- synchronous I/O multiplexing +select, pselect, FD_CLR, FD_ISSET, FD_SET, FD_ZERO \- +synchronous I/O multiplexing .SH SYNOPSIS .B #include .br @@ -150,8 +151,9 @@ struct timespec { .RE .TP \fIsigmask\fP -This argument holds a set of signals to allow while performing a \fBpselect\fP() -call (see \fBsigaddset\fP(3) and \fBsigprocmask\fP(2)). It can be passed +This argument holds a set of signals to allow while performing a +\fBpselect\fP() call (see \fBsigaddset\fP(3) and \fBsigprocmask\fP(2)). +It can be passed as NULL, in which case it does not modify the set of allowed signals on entry and exit to the function. It will then behave just like \fBselect\fP(). .SH COMBINING SIGNAL AND DATA EVENTS diff --git a/man2/syslog.2 b/man2/syslog.2 index 7721040c0..95d4be93d 100644 --- a/man2/syslog.2 +++ b/man2/syslog.2 @@ -23,7 +23,8 @@ .\" Written 11 June 1995 by Andries Brouwer .TH SYSLOG 2 2001-11-25 "Linux 1.2.9" "Linux Programmer's Manual" .SH NAME -syslog, klogctl \- read and/or clear kernel message ring buffer; set console_loglevel +syslog, klogctl \- read and/or clear kernel message ring buffer; +set console_loglevel .SH SYNOPSIS .nf /* The glibc interface */ diff --git a/man3/ceil.3 b/man3/ceil.3 index a66b06fce..f51859123 100644 --- a/man3/ceil.3 +++ b/man3/ceil.3 @@ -22,7 +22,8 @@ .\" .TH CEIL 3 2001-05-31 "" "Linux Programmer's Manual" .SH NAME -ceil, ceilf, ceill \- ceiling function: smallest integral value not less than argument +ceil, ceilf, ceill \- ceiling function: smallest integral value not +less than argument .SH SYNOPSIS .nf .B #include diff --git a/man3/cmsg.3 b/man3/cmsg.3 index 0046cb4e2..3d073897f 100644 --- a/man3/cmsg.3 +++ b/man3/cmsg.3 @@ -76,8 +76,9 @@ given a length, returns it including the required alignment. This is a constant expression. .PP .BR CMSG_SPACE () -returns the number of bytes an ancillary element with payload of the passed data length -occupies. This is a constant expression. +returns the number of bytes an ancillary element with payload of the +passed data length occupies. +This is a constant expression. .PP .B CMSG_DATA returns a pointer to the data portion of a diff --git a/man3/ctermid.3 b/man3/ctermid.3 index 929edcb5e..11804f042 100644 --- a/man3/ctermid.3 +++ b/man3/ctermid.3 @@ -32,8 +32,8 @@ ctermid \- get controlling terminal name .fi .SH DESCRIPTION .BR ctermid () -returns a string which is the pathname for the current controlling terminal for this -process. +returns a string which is the pathname for the current +controlling terminal for this process. If .I s is NULL, diff --git a/man3/des_crypt.3 b/man3/des_crypt.3 index c4a5f2292..fa5d83752 100644 --- a/man3/des_crypt.3 +++ b/man3/des_crypt.3 @@ -9,7 +9,8 @@ .\" .TH DES_CRYPT 3 "6 October 1987" .SH NAME -des_crypt, ecb_crypt, cbc_crypt, des_setparity, DES_FAILED \- fast DES encryption +des_crypt, ecb_crypt, cbc_crypt, des_setparity, DES_FAILED \- fast +DES encryption .SH SYNOPSIS .nf .\" Sun version diff --git a/man3/div.3 b/man3/div.3 index b51143f1e..2e431b992 100644 --- a/man3/div.3 +++ b/man3/div.3 @@ -31,7 +31,8 @@ .\" .TH DIV 3 2003-11-01 "" "Linux Programmer's Manual" .SH NAME -div, ldiv, lldiv, imaxdiv \- compute quotient and remainder of an integer division +div, ldiv, lldiv, imaxdiv \- compute quotient and remainder of +an integer division .SH SYNOPSIS .nf .B #include @@ -47,14 +48,17 @@ div, ldiv, lldiv, imaxdiv \- compute quotient and remainder of an integer divisi .BI "imaxdiv_t imaxdiv(intmax_t " numerator ", intmax_t " denominator ); .fi .SH DESCRIPTION -The \fBdiv\fP() function computes the value \fInumerator\fP/\fIdenominator\fP and -returns the quotient and remainder in a structure named \fIdiv_t\fP that contains +The \fBdiv\fP() function computes the value +\fInumerator\fP/\fIdenominator\fP and +returns the quotient and remainder in a structure +named \fIdiv_t\fP that contains two integer members (in unspecified order) named \fIquot\fP and \fIrem\fP. The quotient is rounded towards zero. The result satisfies \fIquot\fP*\fIdenominator\fP+\fIrem\fP = \fInumerator\fP. .LP The \fBldiv\fP() and \fBlldiv\fP() and \fBimaxdiv\fP() functions do the same, -dividing numbers of the indicated type and returning the result in a structure +dividing numbers of the indicated type and +returning the result in a structure of the indicated name, in all cases with fields \fIquot\fP and \fIrem\fP of the same type as the function arguments. .SH "RETURN VALUE" diff --git a/man3/erf.3 b/man3/erf.3 index 944eabed8..46e37c864 100644 --- a/man3/erf.3 +++ b/man3/erf.3 @@ -30,7 +30,8 @@ .\" .TH ERF 3 2002-07-27 "BSD" "Linux Programmer's Manual" .SH NAME -erf, erff, erfl, erfc, erfcf, erfcl \- error function and complementary error function +erf, erff, erfl, erfc, erfcf, erfcl \- error function and +complementary error function .SH SYNOPSIS .nf .B #include diff --git a/man3/fgetwc.3 b/man3/fgetwc.3 index a995d0500..dbf3469ca 100644 --- a/man3/fgetwc.3 +++ b/man3/fgetwc.3 @@ -56,7 +56,8 @@ current locale. In the absence of additional information passed to the .BR fopen () call, it is -reasonable to expect that \fBfgetwc\fP() will actually read a multibyte sequence +reasonable to expect that \fBfgetwc\fP() +will actually read a multibyte sequence from the stream and then convert it to a wide character. .SH "SEE ALSO" .BR fgetws (3), diff --git a/man3/getipnodebyname.3 b/man3/getipnodebyname.3 index e2e760a8c..b6d0512bb 100644 --- a/man3/getipnodebyname.3 +++ b/man3/getipnodebyname.3 @@ -23,7 +23,8 @@ .\" References: RFC 2553 .TH getipnodebyname 3 2002-04-03 "Linux Man Page" "Linux Programmer's Manual" .SH NAME -getipnodebyname, getipnodebyaddr, freehostent \- get network host names and addresses +getipnodebyname, getipnodebyaddr, freehostent \- get network +host names and addresses .SH SYNOPSIS .nf .B #include diff --git a/man3/getw.3 b/man3/getw.3 index d13dfd4c1..a50e5f125 100644 --- a/man3/getw.3 +++ b/man3/getw.3 @@ -36,8 +36,8 @@ getw, putw \- input and output of words (ints) provided for compatibility with SVr4. We recommend you use \fBfread\fP(3) instead. .P -\fBputw\fP() writes the word \fIw\fP (that is, an \fIint\fP) to \fIstream\fP. It -is provided for compatibility with SVr4, but we recommend you use +\fBputw\fP() writes the word \fIw\fP (that is, an \fIint\fP) to \fIstream\fP. +It is provided for compatibility with SVr4, but we recommend you use \fBfwrite\fP(3) instead. .SH "RETURN VALUE" Normally, \fBgetw\fP() returns the word read, and \fBputw\fP() returns 0. diff --git a/man3/lround.3 b/man3/lround.3 index 60e249a5a..60b0f74f4 100644 --- a/man3/lround.3 +++ b/man3/lround.3 @@ -22,7 +22,8 @@ .\" .TH LROUND 3 2001-05-31 "" "Linux Programmer's Manual" .SH NAME -lround, lroundf, lroundl, llround, llroundf, llroundl \- round to nearest integer, away from zero +lround, lroundf, lroundl, llround, llroundf, llroundl \- round to +nearest integer, away from zero .SH SYNOPSIS .nf .B #include diff --git a/man3/modf.3 b/man3/modf.3 index b610d6dc7..64fb10f2b 100644 --- a/man3/modf.3 +++ b/man3/modf.3 @@ -30,8 +30,8 @@ .\" .TH MODF 3 2002-07-27 "" "Linux Programmer's Manual" .SH NAME -modf, modff, modfl \- extract signed integral and fractional values from floating-point -number +modf, modff, modfl \- extract signed integral and fractional values from +floating-point number .SH SYNOPSIS .nf .B #include diff --git a/man3/nextafter.3 b/man3/nextafter.3 index 3a23ceabf..7aef1d735 100644 --- a/man3/nextafter.3 +++ b/man3/nextafter.3 @@ -3,7 +3,8 @@ .\" Based on glibc infopages .TH NEXTAFTER 3 2002-08-10 "GNU" "libc math functions" .SH NAME -nextafter, nextafterf, nextafterl, nexttoward, nexttowardf, nexttowardl \- floating point number manipulation +nextafter, nextafterf, nextafterl, nexttoward, nexttowardf, nexttowardl \- +floating point number manipulation .SH SYNOPSIS .B #include .sp diff --git a/man3/stdio_ext.3 b/man3/stdio_ext.3 index ef2024375..b9ecfff4a 100644 --- a/man3/stdio_ext.3 +++ b/man3/stdio_ext.3 @@ -22,7 +22,8 @@ .\" .TH STDIO_EXT 3 2001-12-16 "" "Linux Programmer's Manual" .SH NAME -__fbufsize, __flbf, __fpending, __fpurge, __freadable, __freading, __fsetlocking, __fwritable, __fwriting, _flushlbf \- interfaces to stdio FILE structure +__fbufsize, __flbf, __fpending, __fpurge, __freadable, +__freading, __fsetlocking, __fwritable, __fwriting, _flushlbf \- interfaces to stdio FILE structure .SH SYNOPSIS .B #include .br diff --git a/man3/termios.3 b/man3/termios.3 index 91dd57ed7..857ada52c 100644 --- a/man3/termios.3 +++ b/man3/termios.3 @@ -538,11 +538,11 @@ suspends output. .IP \fBTCOON\fP restarts suspended output. .IP \fBTCIOFF\fP -transmits a STOP character, which stops the terminal device from transmitting data to the -system. +transmits a STOP character, which stops the terminal device from +transmitting data to the system. .IP \fBTCION\fP -transmits a START character, which starts the terminal device transmitting data to the -system. +transmits a START character, which starts the terminal device +transmitting data to the system. .LP The default on open of a terminal file is that neither its input nor its output is suspended. diff --git a/man3/wcpncpy.3 b/man3/wcpncpy.3 index d0c615a06..ac208aa30 100644 --- a/man3/wcpncpy.3 +++ b/man3/wcpncpy.3 @@ -12,7 +12,8 @@ .\" .TH WCPNCPY 3 2003-11-01 "GNU" "Linux Programmer's Manual" .SH NAME -wcpncpy \- copy a fixed-size string of wide characters, returning a pointer to its end +wcpncpy \- copy a fixed-size string of wide characters, +returning a pointer to its end .SH SYNOPSIS .nf .B #define _GNU_SOURCE diff --git a/man3/wcsncat.3 b/man3/wcsncat.3 index 532493209..60a9056e8 100644 --- a/man3/wcsncat.3 +++ b/man3/wcsncat.3 @@ -21,8 +21,9 @@ wcsncat \- concatenate two wide-character strings .BI "wchar_t *wcsncat(wchar_t *" dest ", const wchar_t *" src ", size_t " n ); .fi .SH DESCRIPTION -The \fBwcsncat\fP() function is the wide-character equivalent of the \fBstrncat\fP() -function. It copies at most \fIn\fP wide characters from the wide-character +The \fBwcsncat\fP() function is the wide-character equivalent of the +\fBstrncat\fP() function. +It copies at most \fIn\fP wide characters from the wide-character string pointed to by \fIsrc\fP to the end of the wide-character string pointed to by \fIdest\fP, and adds a terminating L'\\0' character. .PP diff --git a/man3/wcsncmp.3 b/man3/wcsncmp.3 index cf78ad43c..4c3335deb 100644 --- a/man3/wcsncmp.3 +++ b/man3/wcsncmp.3 @@ -21,8 +21,9 @@ wcsncmp \- compare two fixed-size wide-character strings .BI "int wcsncmp(const wchar_t *" s1 ", const wchar_t *" s2 ", size_t " n ); .fi .SH DESCRIPTION -The \fBwcsncmp\fP() function is the wide-character equivalent of the \fBstrncmp\fP() -function. It compares the wide-character string pointed to by \fIs1\fP and the +The \fBwcsncmp\fP() function is the wide-character equivalent of the +\fBstrncmp\fP() function. +It compares the wide-character string pointed to by \fIs1\fP and the wide-character string pointed to by \fIs2\fP, but at most \fIn\fP wide characters from each string. In each string, the comparison extends only up to the first occurrence of a L'\\0' character, if any. diff --git a/man3/wcsncpy.3 b/man3/wcsncpy.3 index 3f5b78c4a..f372352a6 100644 --- a/man3/wcsncpy.3 +++ b/man3/wcsncpy.3 @@ -21,8 +21,9 @@ wcsncpy \- copy a fixed-size string of wide characters .BI "wchar_t *wcsncpy(wchar_t *" dest ", const wchar_t *" src ", size_t " n ); .fi .SH DESCRIPTION -The \fBwcsncpy\fP() function is the wide-character equivalent of the \fBstrncpy\fP() -function. It copies at most \fIn\fP wide characters from the wide-character +The \fBwcsncpy\fP() function is the wide-character equivalent of the +\fBstrncpy\fP() function. +It copies at most \fIn\fP wide characters from the wide-character string pointed to by \fIsrc\fP, including the terminating L'\\0' character, to the array pointed to by \fIdest\fP. Exactly \fIn\fP wide characters are written at \fIdest\fP. If the length \fIwcslen(src)\fP is smaller than \fIn\fP, diff --git a/man3/wcsnrtombs.3 b/man3/wcsnrtombs.3 index ddfe80b9f..539298f0b 100644 --- a/man3/wcsnrtombs.3 +++ b/man3/wcsnrtombs.3 @@ -21,9 +21,9 @@ wcsnrtombs \- convert a wide character string to a multibyte string .BI " size_t " len ", mbstate_t *" ps ); .fi .SH DESCRIPTION -The \fBwcsnrtombs\fP() function is like the \fBwcsrtombs\fP() function, except that -the number of wide characters to be converted, starting at \fI*src\fP, is -limited to \fInwc\fP. +The \fBwcsnrtombs\fP() function is like the \fBwcsrtombs\fP() function, +except that the number of wide characters to be converted, +starting at \fI*src\fP, is limited to \fInwc\fP. .PP If \fIdest\fP is not a NULL pointer, the \fBwcsnrtombs\fP() function converts at most \fInwc\fP wide characters from diff --git a/man3/wcsrtombs.3 b/man3/wcsrtombs.3 index 2a35e580f..67ef2ece6 100644 --- a/man3/wcsrtombs.3 +++ b/man3/wcsrtombs.3 @@ -24,11 +24,15 @@ wcsrtombs \- convert a wide character string to a multibyte string .SH DESCRIPTION If \fIdest\fP is not a NULL pointer, the \fBwcsrtombs\fP() function converts the wide-character string \fI*src\fP to a multibyte string starting at -\fIdest\fP. At most \fIlen\fP bytes are written to \fIdest\fP. The shift state -\fI*ps\fP is updated. The conversion is effectively performed by repeatedly -calling wcrtomb(\fIdest\fP,\fI*src\fP,\fIps\fP), as long as this call succeeds, +\fIdest\fP. At most \fIlen\fP bytes are written to \fIdest\fP. +The shift state +\fI*ps\fP is updated. +The conversion is effectively performed by repeatedly +calling wcrtomb(\fIdest\fP,\fI*src\fP,\fIps\fP), +as long as this call succeeds, and then incrementing \fIdest\fP by the number of bytes written and \fI*src\fP -by one. The conversion can stop for three reasons: +by one. +The conversion can stop for three reasons: .PP 1. A wide character has been encountered that can not be represented as a multibyte sequence (according to the current locale). In this case \fI*src\fP diff --git a/man3/wcsspn.3 b/man3/wcsspn.3 index 527f75497..773d2c951 100644 --- a/man3/wcsspn.3 +++ b/man3/wcsspn.3 @@ -13,7 +13,8 @@ .\" .TH WCSSPN 3 1999-07-25 "GNU" "Linux Programmer's Manual" .SH NAME -wcsspn \- advance in a wide-character string, skipping any of a set of wide characters +wcsspn \- advance in a wide-character string, skipping +any of a set of wide characters .SH SYNOPSIS .nf .B #include @@ -21,16 +22,20 @@ wcsspn \- advance in a wide-character string, skipping any of a set of wide char .BI "wcsspn(const wchar_t *" wcs ", const wchar_t *" accept ); .fi .SH DESCRIPTION -The \fBwcsspn\fP() function is the wide-character equivalent of the \fBstrspn\fP() -function. It determines the length of the longest initial segment of \fIwcs\fP -which consists entirely of wide-characters listed in \fIaccept\fP. In other +The \fBwcsspn\fP() function is the wide-character equivalent of the +\fBstrspn\fP() function. +It determines the length of the longest initial segment of \fIwcs\fP +which consists entirely of wide-characters listed in \fIaccept\fP. +In other words, it searches for the first occurrence in the wide-character string \fIwcs\fP of a wide-character not contained in the wide-character string \fIaccept\fP. .SH "RETURN VALUE" -The \fBwcsspn\fP() function returns the number of wide characters in the longest +The \fBwcsspn\fP() function returns the number of +wide characters in the longest initial segment of \fIwcs\fP which consists entirely of wide-characters listed -in \fIaccept\fP. In other words, it returns the position of the first +in \fIaccept\fP. +In other words, it returns the position of the first occurrence in the wide-character string \fIwcs\fP of a wide-character not contained in the wide-character string \fIaccept\fP, or \fIwcslen(wcs)\fP if there is none. diff --git a/man3/wcsstr.3 b/man3/wcsstr.3 index 3086655f4..8e3c339be 100644 --- a/man3/wcsstr.3 +++ b/man3/wcsstr.3 @@ -21,16 +21,19 @@ wcsstr \- locate a substring in a wide-character string .BI "wchar_t *wcsstr(const wchar_t *" haystack ", const wchar_t *" needle ); .fi .SH DESCRIPTION -The \fBwcsstr\fP() function is the wide-character equivalent of the \fBstrstr\fP() -function. It searches for the first occurrence of the wide-character string +The \fBwcsstr\fP() function is the wide-character equivalent of the +\fBstrstr\fP() function. +It searches for the first occurrence of the wide-character string \fIneedle\fP (without its terminating L'\\0' character) as a substring in the wide-character string \fIhaystack\fP. .SH "RETURN VALUE" The \fBwcsstr\fP() function returns a pointer to the first occurrence of -\fIneedle\fP in \fIhaystack\fP. It returns NULL if \fIneedle\fP does not occur +\fIneedle\fP in \fIhaystack\fP. +It returns NULL if \fIneedle\fP does not occur as a substring in \fIhaystack\fP. .PP -Note the special case: If \fIneedle\fP is the empty wide-character string, +Note the special case: +If \fIneedle\fP is the empty wide-character string, the return value is always \fIhaystack\fP itself. .SH "CONFORMING TO" C99. diff --git a/man3/wcstok.3 b/man3/wcstok.3 index ed5137491..05d743299 100644 --- a/man3/wcstok.3 +++ b/man3/wcstok.3 @@ -21,8 +21,10 @@ wcstok \- split wide-character string into tokens .BI "wchar_t *wcstok(wchar_t *" wcs ", const wchar_t *" delim ", wchar_t **" ptr ); .fi .SH DESCRIPTION -The \fBwcstok\fP() function is the wide-character equivalent of the \fBstrtok\fP() -function, with an added argument to make it multithread-safe. It can be used +The \fBwcstok\fP() function is the wide-character equivalent of the +\fBstrtok\fP() function, +with an added argument to make it multithread-safe. +It can be used to split a wide-character string \fIwcs\fP into tokens, where a token is defined as a substring not containing any wide-characters from \fIdelim\fP. .PP @@ -31,8 +33,9 @@ The search starts at \fIwcs\fP, if \fIwcs\fP is not NULL, or at \fI*ptr\fP, if pointer is advanced beyond any wide-characters which occur in \fIdelim\fP. If the end of the wide-character string is now reached, \fBwcstok\fP() returns NULL, to indicate that no tokens were found, and stores an appropriate value -in \fI*ptr\fP, so that subsequent calls to \fBwcstok\fP() will continue to return -NULL. Otherwise, the \fBwcstok\fP() function recognizes the beginning of a token +in \fI*ptr\fP, +so that subsequent calls to \fBwcstok\fP() will continue to return NULL. +Otherwise, the \fBwcstok\fP() function recognizes the beginning of a token and returns a pointer to it, but before doing that, it zero-terminates the token by replacing the next wide-character which occurs in \fIdelim\fP with a L'\\0' character, and it updates \fI*ptr\fP so that subsequent calls will diff --git a/man3/wmemchr.3 b/man3/wmemchr.3 index 23807d27e..66e0cf7ec 100644 --- a/man3/wmemchr.3 +++ b/man3/wmemchr.3 @@ -21,8 +21,9 @@ wmemchr \- search a wide character in a wide-character array .BI "wchar_t *wmemchr(const wchar_t *" s ", wchar_t " c ", size_t " n ); .fi .SH DESCRIPTION -The \fBwmemchr\fP() function is the wide-character equivalent of the \fBmemchr\fP() -function. It searches the \fIn\fP wide characters starting at \fIs\fP for +The \fBwmemchr\fP() function is the wide-character equivalent of the +\fBmemchr\fP() function. +It searches the \fIn\fP wide characters starting at \fIs\fP for the first occurrence of the wide character \fIc\fP. .SH "RETURN VALUE" The \fBwmemchr\fP() function returns a pointer to the first occurrence of \fIc\fP diff --git a/man3/wmemcmp.3 b/man3/wmemcmp.3 index 1f0a44d2b..e52cf2e9e 100644 --- a/man3/wmemcmp.3 +++ b/man3/wmemcmp.3 @@ -20,8 +20,9 @@ wmemcmp \- compare two arrays of wide-characters .BI "int wmemcmp(const wchar_t *" s1 ", const wchar_t *" s2 ", size_t " n ); .fi .SH DESCRIPTION -The \fBwmemcmp\fP() function is the wide-character equivalent of the \fBmemcmp\fP() -function. It compares the \fIn\fP wide-characters starting at \fIs1\fP and the +The \fBwmemcmp\fP() function is the wide-character equivalent of the +\fBmemcmp\fP() function. +It compares the \fIn\fP wide-characters starting at \fIs1\fP and the \fIn\fP wide-characters starting at \fIs2\fP. .SH "RETURN VALUE" The \fBwmemcmp\fP() function returns zero if the wide-character arrays of size diff --git a/man3/wmemcpy.3 b/man3/wmemcpy.3 index a52658562..aad0c9454 100644 --- a/man3/wmemcpy.3 +++ b/man3/wmemcpy.3 @@ -21,8 +21,9 @@ wmemcpy \- copy an array of wide-characters .BI "wchar_t *wmemcpy(wchar_t *" dest ", const wchar_t *" src ", size_t " n ); .fi .SH DESCRIPTION -The \fBwmemcpy\fP() function is the wide-character equivalent of the \fBmemcpy\fP() -function. It copies \fIn\fP wide characters from the array starting at +The \fBwmemcpy\fP() function is the wide-character equivalent of the +\fBmemcpy\fP() function. +It copies \fIn\fP wide characters from the array starting at \fIsrc\fP to the array starting at \fIdest\fP. .PP The arrays may not overlap; use \fBwmemmove\fP(3) to copy between overlapping diff --git a/man3/wmemset.3 b/man3/wmemset.3 index 9db12e255..92a50ba8d 100644 --- a/man3/wmemset.3 +++ b/man3/wmemset.3 @@ -21,8 +21,9 @@ wmemset \- fill an array of wide-characters with a constant wide character .BI "wchar_t *wmemset(wchar_t *" wcs ", wchar_t " wc ", size_t " n ); .fi .SH DESCRIPTION -The \fBwmemset\fP() function is the wide-character equivalent of the \fBmemset\fP() -function. It fills the array of \fIn\fP wide-characters starting at \fIwcs\fP +The \fBwmemset\fP() function is the wide-character equivalent of the +\fBmemset\fP() function. +It fills the array of \fIn\fP wide-characters starting at \fIwcs\fP with \fIn\fP copies of the wide character \fIwc\fP. .SH "RETURN VALUE" \fBwmemset\fP() returns \fIwcs\fP. diff --git a/man3/wprintf.3 b/man3/wprintf.3 index 2d5434cc9..0d86c2a10 100644 --- a/man3/wprintf.3 +++ b/man3/wprintf.3 @@ -13,7 +13,8 @@ .\" .TH WPRINTF 3 1999-11-20 "GNU" "Linux Programmer's Manual" .SH NAME -wprintf, fwprintf, swprintf, vwprintf, vfwprintf, vswprintf \- formatted wide character output conversion +wprintf, fwprintf, swprintf, vwprintf, vfwprintf, vswprintf \- formatted +wide character output conversion .SH SYNOPSIS .nf .B #include @@ -36,15 +37,18 @@ The \fBwprintf\fP() family of functions is the wide-character equivalent of the \fBprintf\fP() family of functions. It performs formatted output of wide characters. .PP -The \fBwprintf\fP() and \fBvwprintf\fP() functions perform wide character output -to \fBstdout\fP. \fBstdout\fP must not be byte oriented; see function +The \fBwprintf\fP() and \fBvwprintf\fP() functions +perform wide character output to \fBstdout\fP. +\fBstdout\fP must not be byte oriented; see function \fBfwide\fP() for more information. .PP -The \fBfwprintf\fP() and \fBvfwprintf\fP() functions perform wide character output -to \fIstream\fP. \fIstream\fP must not be byte oriented; see function +The \fBfwprintf\fP() and \fBvfwprintf\fP() functions +perform wide character output to \fIstream\fP. +\fIstream\fP must not be byte oriented; see function \fBfwide\fP() for more information. .PP -The \fBswprintf\fP() and \fBvswprintf\fP() functions perform wide character output +The \fBswprintf\fP() and \fBvswprintf\fP() functions +perform wide character output to an array of wide characters. The programmer must ensure that there is room for at least \fImaxlen\fP wide characters at \fIwcs\fP. @@ -61,7 +65,8 @@ The output consists of wide characters, not bytes. .TP .B \(bu \fBswprintf\fP() and \fBvswprintf\fP() take a \fImaxlen\fP argument, -\fBsprintf\fP() and \fBvsprintf\fP() do not. (\fBsnprintf\fP() and \fBvsnprintf\fP() +\fBsprintf\fP() and \fBvsprintf\fP() do not. +(\fBsnprintf\fP() and \fBvsnprintf\fP() take a \fImaxlen\fP argument, but these functions do not return \-1 upon buffer overflow on Linux.) .PP diff --git a/man4/console_ioctl.4 b/man4/console_ioctl.4 index 68b4be6aa..201f708bc 100644 --- a/man4/console_ioctl.4 +++ b/man4/console_ioctl.4 @@ -406,12 +406,12 @@ points to a .nf struct vt_consize { - ushort \fIv_rows\fP; /* number of rows */ - ushort \fIv_cols\fP; /* number of columns */ - ushort \fIv_vlin\fP; /* number of pixel rows on screen */ - ushort \fIv_clin\fP; /* number of pixel rows per character */ - ushort \fIv_vcol\fP; /* number of pixel columns on screen */ - ushort \fIv_ccol\fP; /* number of pixel columns per character */ + ushort \fIv_rows\fP; /* number of rows */ + ushort \fIv_cols\fP; /* number of columns */ + ushort \fIv_vlin\fP; /* number of pixel rows on screen */ + ushort \fIv_clin\fP; /* number of pixel rows per character */ + ushort \fIv_vcol\fP; /* number of pixel columns on screen */ + ushort \fIv_ccol\fP; /* number of pixel columns per character */ }; .fi @@ -493,7 +493,8 @@ screen blanking does: \fI1\fP: The current video adapter register settings are saved, then the controller is programmed to turn off -the vertical synchronization pulses. This puts the monitor into "standby" mode. +the vertical synchronization pulses. +This puts the monitor into "standby" mode. If your monitor has an Off_Mode timer, then it will eventually power down by itself. diff --git a/man4/sk98lin.4 b/man4/sk98lin.4 index d16a23479..f8fb7d99d 100644 --- a/man4/sk98lin.4 +++ b/man4/sk98lin.4 @@ -60,9 +60,14 @@ sk98lin \- Marvell/SysKonnect Gigabit Ethernet driver v6.21 .SH DESCRIPTION .B sk98lin is the Gigabit Ethernet driver for Marvell and SysKonnect network adapter cards. -It supports SysKonnect SK-98xx/SK-95xx compliant Gigabit Ethernet Adapter and any Yukon compliant chipset. +It supports SysKonnect SK-98xx/SK-95xx compliant Gigabit Ethernet Adapter and +any Yukon compliant chipset. -When loading the driver using insmod, parameters for the network adapter cards might be stated as a sequence of comma separated commands. If for instance two network adapters are installed and AutoNegotiation on Port A of the first adapter should be ON, but on the Port A of the second adapter switched OFF, one must enter: +When loading the driver using insmod, parameters for the network adapter cards +might be stated as a sequence of comma separated commands. +If for instance two network adapters are installed and AutoNegotiation on +Port A of the first adapter should be ON, +but on the Port A of the second adapter switched OFF, one must enter: insmod sk98lin.o AutoNeg_A=On,Off @@ -70,25 +75,41 @@ After .B sk98lin is bound to one or more adapter cards and the .IR /proc -filesystem is mounted on your system, a dedicated statistics file will be created in folder +filesystem is mounted on your system, a dedicated statistics file +will be created in folder .IR /proc/net/sk98lin -for all ports of the installed network adapter cards. Those files are named +for all ports of the installed network adapter cards. +Those files are named .IR eth[x] whereas .IR x -is the number of the interface that has been assigned to a dedicated port by the system. +is the number of the interface that has been assigned to a +dedicated port by the system. -If loading is finished, any desired IP address can be assigned to the respective +If loading is finished, any desired IP address can be +assigned to the respective .IR eth[x] interface using the .BR ifconfig (8) -command. This causes the adapter to connect to the Ethernet and to display a status message on the console saying "ethx: network connection up using port y" followed by the configured or detected connection parameters. +command. +This causes the adapter to connect to the Ethernet and to display a status +message on the console saying "ethx: network connection up using port y" +followed by the configured or detected connection parameters. The .B sk98lin -also supports large frames (also called jumbo frames). Using jumbo frames can improve throughput tremendously when transferring large amounts of data. To enable large frames, the MTU (maximum transfer unit) size for an interface is to be set to a high value. The default MTU size is 1500 and can be changed up to 9000 (bytes). Setting the MTU size can be done when assigning the IP address to the interface or later by using the +also supports large frames (also called jumbo frames). +Using jumbo frames can improve throughput tremendously when +transferring large amounts of data. +To enable large frames, the MTU (maximum transfer unit) size +for an interface is to be set to a high value. +The default MTU size is 1500 and can be changed up to 9000 (bytes). +Setting the MTU size can be done when assigning the IP address +to the interface or later by using the .BR ifconfig (8) -command with the mtu parameter. If for instance eth0 needs an IP address and a large frame MTU size, the following two commands might be used: +command with the mtu parameter. If for instance eth0 needs an IP +address and a large frame MTU size, +the following two commands might be used: ifconfig eth0 10.1.1.1 ifconfig eth0 mtu 9000 @@ -97,7 +118,18 @@ Those two commands might even be combined into one: ifconfig eth0 10.1.1.1 mtu 9000 -Note that large frames can only be used if your network infrastructure allows to do so. This means, that any switch being used in your Ethernet must also support large frames. Quite some switches support large frames, but need to be configured to do so. Most of the times, their default setting is to support only standard frames with an MTU size of 1500 (bytes). In addition to the switches inside the network, all network adapters that are to be used must also be enabled regarding jumbo frames. If an adapter is not set to receive large frames it will simply drop them. +Note that large frames can only be used if your network infrastructure +allows to do so. +This means, that any switch being used in your Ethernet must +also support large frames. +Quite some switches support large frames, +but need to be configured to do so. +Most of the times, their default setting is to support only +standard frames with an MTU size of 1500 (bytes). +In addition to the switches inside the network, +all network adapters that are to be used must also be +enabled regarding jumbo frames. +If an adapter is not set to receive large frames it will simply drop them. Switching back to the standard Ethernet frame size can be done by using the .BR ifconfig (8) @@ -105,7 +137,11 @@ command again: ifconfig eth0 mtu 1500 -The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to support VLAN and Link Aggregation according to IEEE standards 802.1, 802.1q, and 802.3ad. Those features are only available after installation of open source modules which can be found on the Internet: +The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to +support VLAN and Link Aggregation according to +IEEE standards 802.1, 802.1q, and 802.3ad. +Those features are only available after installation of open source modules +which can be found on the Internet: .IR VLAN \c : http://www.candelatech.com/~greear/vlan.html @@ -115,11 +151,16 @@ The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to support VLAN : http://www.st.rim.or.jp/~yumo .br -Note that Marvell/SysKonnect does not offer any support for these open source modules and does not take the responsibility for any kind of failures or problems arising when using these modules. +Note that Marvell/SysKonnect does not offer any support for these +open source modules and does not take the responsibility for any +kind of failures or problems arising when using these modules. .SH PARAMETERS .TP .BI Speed_A= i,j,... -This parameter is used to set the speed capabilities of port A of an adapter card. It is only valid for Yukon copper adapters. Possible values are: +This parameter is used to set the speed capabilities of port A of an +adapter card. +It is only valid for Yukon copper adapters. +Possible values are: .IR 10 , .IR 100 , .IR 1000 @@ -127,10 +168,16 @@ or .IR Auto whereas .IR Auto -is the default. Usually, the speed is negotiated between the two ports during link establishment. If this fails, a port can be forced to a specific setting with this parameter. +is the default. +Usually, the speed is negotiated between the two ports +during link establishment. +If this fails, a port can be forced to a specific setting with this parameter. .TP .BI Speed_B= i,j,... -This parameter is used to set the speed capabilities of port B of an adapter card. It is only valid for Yukon copper adapters. Possible values are: +This parameter is used to set the speed capabilities of port B of +an adapter card. +It is only valid for Yukon copper adapters. +Possible values are: .IR 10 , .IR 100 , .IR 1000 @@ -138,10 +185,14 @@ or .IR Auto whereas .IR Auto -is the default. Usually, the speed is negotiated between the two ports during link establishment. If this fails, a port can be forced to a specific setting with this parameter. +is the default. +Usually, the speed is negotiated between the two ports during link +establishment. +If this fails, a port can be forced to a specific setting with this parameter. .TP .BI AutoNeg_A= i,j,... -Enables or disables the use of autonegotiation of port A of an adapter card. Possible values are: +Enables or disables the use of autonegotiation of port A of an adapter card. +Possible values are: .IR On , .IR Off or @@ -150,10 +201,12 @@ whereas .IR On is the default. The .IR Sense -mode automatically detects whether the link partner supports auto-negotiation or not. +mode automatically detects whether the link partner supports +auto-negotiation or not. .TP .BI AutoNeg_B= i,j,... -Enables or disables the use of autonegotiation of port B of an adapter card. Possible values are: +Enables or disables the use of autonegotiation of port B of an adapter card. +Possible values are: .IR On , .IR Off or @@ -162,10 +215,13 @@ whereas .IR On is the default. The .IR Sense -mode automatically detects whether the link partner supports auto-negotiation or not. +mode automatically detects whether the link partner supports +auto-negotiation or not. .TP .BI DupCap_A= i,j,... -This parameter indicates the duplex mode to be used for port A of an adapter card. Possible values are: +This parameter indicates the duplex mode to be used for port A +of an adapter card. +Possible values are: .IR Half , .IR Full or @@ -188,17 +244,22 @@ only DupCap_A values .IR Full and .IR Half -are allowed. This DupCap_A parameter is useful if your link partner does not support all possible duplex combinations. +are allowed. +This DupCap_A parameter is useful if your link partner does not +support all possible duplex combinations. .TP .BI DupCap_B= i,j,... -This parameter indicates the duplex mode to be used for port B of an adapter card. Possible values are: +This parameter indicates the duplex mode to be used for port B +of an adapter card. +Possible values are: .IR Half , .IR Full or .IR Both whereas .IR Both -is the default. This parameter is only relevant if AutoNeg_B of port B is not set to +is the default. +This parameter is only relevant if AutoNeg_B of port B is not set to .IR Sense . If AutoNeg_B is set to .IR On , @@ -213,10 +274,14 @@ only DupCap_B values .IR Full and .IR Half -are allowed. This DupCap_B parameter is useful if your link partner does not support all possible duplex combinations. +are allowed. +This DupCap_B parameter is useful if your link partner does not +support all possible duplex combinations. .TP .BI FlowCtrl_A= i,j,... -This parameter can be used to set the flow control capabilities the port reports during auto-negotiation. Possible values are: +This parameter can be used to set the flow control capabilities the +port reports during auto-negotiation. +Possible values are: .IR Sym , .IR SymOrRem , .IR LocSend @@ -247,7 +312,9 @@ Note that this parameter is ignored if AutoNeg_A is set to .IR Off . .TP .BI FlowCtrl_B= i,j,... -This parameter can be used to set the flow control capabilities the port reports during auto-negotiation. Possible values are: +This parameter can be used to set the flow control capabilities the +port reports during auto-negotiation. +Possible values are: .IR Sym , .IR SymOrRem , .IR LocSend @@ -278,27 +345,47 @@ Note that this parameter is ignored if AutoNeg_B is set to .IR Off . .TP .BI Role_A= i,j,... -This parameter is only valid for 1000Base-T adapter cards. For two 1000Base-T ports to communicate, one must take the role of the master (providing timing information), while the other must be the slave. Possible values are: +This parameter is only valid for 1000Base-T adapter cards. +For two 1000Base-T ports to communicate, +one must take the role of the master (providing timing information), +while the other must be the slave. +Possible values are: .IR Auto , .IR Master or .IR Slave whereas .IR Auto -is the default. Usually, the role of a port is negotiated between two ports during link establishment, but if that fails the port A of an adapter card can be forced to a specific setting with this parameter. +is the default. +Usually, the role of a port is negotiated between two ports during +link establishment, but if that fails the port A of an adapter card +can be forced to a specific setting with this parameter. .TP .BI Role_B= i,j,... -This parameter is only valid for 1000Base-T adapter cards. For two 1000Base-T ports to communicate, one must take the role of the master (providing timing information), while the other must be the slave. Possible values are: +This parameter is only valid for 1000Base-T adapter cards. +For two 1000Base-T ports to communicate, one must take +the role of the master (providing timing information), +while the other must be the slave. +Possible values are: .IR Auto , .IR Master or .IR Slave whereas .IR Auto -is the default. Usually, the role of a port is negotiated between two ports during link establishment, but if that fails the port B of an adapter card can be forced to a specific setting with this parameter. +is the default. +Usually, the role of a port is negotiated between +two ports during link establishment, but if that fails +the port B of an adapter card can be forced to a +specific setting with this parameter. .TP .BI ConType= i,j,... -This parameter is a combination of all five per-port parameters within one single parameter. This simplifies the configuration of both ports of an adapter card. The different values of this variable reflect the most meaningful combinations of port parameters. Possible values and their corresponding combination of per-port parameters: +This parameter is a combination of all five per-port parameters +within one single parameter. +This simplifies the configuration of both ports of an adapter card. +The different values of this variable reflect the +most meaningful combinations of port parameters. +Possible values and their corresponding combination of per-port parameters: .br .ad l @@ -323,14 +410,19 @@ ConType | DupCap AutoNeg FlowCtrl Role Speed .ad b Stating any other port parameter together with this .IR ConType -parameter will result in a merged configuration of those settings. This is due to +parameter will result in a merged configuration of those settings. +This is due to the fact, that the per-port parameters (e.g. .IR Speed_A ) have a higher priority than the combined variable .IR ConType . .TP .BI Moderation= i,j,... -Interrupt moderation is employed to limit the maximum number of interrupts the driver has to serve. That is, one or more interrupts (which indicate any transmit or receive packet to be processed) are queued until the driver processes them. When queued interrupts are to be served, is determined by the +Interrupt moderation is employed to limit the maximum number of interrupts +the driver has to serve. +That is, one or more interrupts (which indicate any transmit or +receive packet to be processed) are queued until the driver processes them. +When queued interrupts are to be served, is determined by the .IR IntsPerSec parameter, which is explained later below. Possible moderation modes are: .IR None , @@ -342,33 +434,59 @@ whereas is the default. The different modes have the following meaning: .IR None -No interrupt moderation is applied on the adapter card. Therefore, each transmit or receive interrupt is served immediately as soon as it appears on the interrupt line of the adapter card. +No interrupt moderation is applied on the adapter card. +Therefore, each transmit or receive interrupt is served immediately +as soon as it appears on the interrupt line of the adapter card. .br .IR Static -Interrupt moderation is applied on the adapter card. All transmit and receive interrupts are queued until a complete moderation interval ends. If such a moderation interval ends, all queued interrupts are processed in one big bunch without any delay. The term +Interrupt moderation is applied on the adapter card. +All transmit and receive interrupts are queued until +a complete moderation interval ends. +If such a moderation interval ends, all queued interrupts +are processed in one big bunch without any delay. +The term .IR Static -reflects the fact, that interrupt moderation is always enabled, regardless how much network load is currently passing via a particular interface. In addition, the duration of the moderation interval has a fixed length that never changes while the driver is operational. +reflects the fact, that interrupt moderation is always enabled, +regardless how much network load is currently passing via a +particular interface. +In addition, the duration of the moderation interval has a fixed +length that never changes while the driver is operational. .br .IR Dynamic -Interrupt moderation might be applied on the adapter card, depending on the load of the system. If the driver detects that the system load is too high, the driver tries to shield the system against too much network load by enabling interrupt moderation. If \(em at a later time \(em the CPU utilization decreases again (or if the network load is negligible) the interrupt moderation will automatically be disabled. +Interrupt moderation might be applied on the adapter card, +depending on the load of the system. +If the driver detects that the system load is too high, +the driver tries to shield the system against too much network +load by enabling interrupt moderation. +If \(em at a later time \(em the CPU utilization decreases +again (or if the network load is negligible) the interrupt +moderation will automatically be disabled. -Interrupt moderation should be used when the driver has to handle one or more interfaces with a high network load, which \(em as a consequence \(em leads also to a high CPU utilization. When moderation is applied in such high network load situations, CPU load might be reduced by 20-30% on slow computers. +Interrupt moderation should be used when the driver has to +handle one or more interfaces with a high network load, +which \(em as a consequence \(em leads also to a high CPU utilization. +When moderation is applied in such high network load situations, +CPU load might be reduced by 20-30% on slow computers. -Note that the drawback of using interrupt moderation is an increase of the round-trip-time (RTT), due to the queuing and serving of interrupts at dedicated -moderation times. +Note that the drawback of using interrupt moderation is an increase of +the round-trip-time (RTT), due to the queuing and serving of +interrupts at dedicated moderation times. .TP .BI IntsPerSec= i,j,... This parameter determines the length of any interrupt moderation interval. Assuming that static interrupt moderation is to be used, an .IR IntsPerSec parameter value of 2000 will lead to an interrupt moderation interval of -500 microseconds. Possible values for this parameter are in the range of 30...40000 (interrupts per second). The default value is 2000. +500 microseconds. +Possible values for this parameter are in the range of +30...40000 (interrupts per second). +The default value is 2000. This parameter is only used, if either static or dynamic interrupt moderation -is enabled on a network adapter card. This parameter is ignored if no moderation is -applied. +is enabled on a network adapter card. +This parameter is ignored if no moderation is applied. Note that the duration of the moderation interval is to be chosen with care. At first glance, selecting a very long duration (e.g. only 100 interrupts per @@ -377,7 +495,11 @@ is tremendous. On the other hand, selecting a very short moderation time might compensate the use of any moderation being applied. .TP .BI PrefPort= i,j,... -This parameter is used to force the preferred port to A or B (on dual-port network adapters). The preferred port is the one that is used if both ports A and B are detected as fully functional. Possible values are: +This parameter is used to force the preferred port to +A or B (on dual-port network adapters). +The preferred port is the one that is used if both ports A and B are +detected as fully functional. +Possible values are: .IR A or .IR B @@ -386,7 +508,12 @@ whereas is the default. .TP .BI RlmtMode= i,j,... -RLMT monitors the status of the port. If the link of the active port fails, RLMT switches immediately to the standby link. The virtual link is maintained as long as at least one 'physical' link is up. This parameters states how RLMT should monitor both ports. Possible values are: +RLMT monitors the status of the port. +If the link of the active port fails, +RLMT switches immediately to the standby link. +The virtual link is maintained as long as at least one 'physical' link is up. +This parameters states how RLMT should monitor both ports. +Possible values are: .IR CheckLinkState , .IR CheckLocalPort , .IR CheckSeg @@ -397,19 +524,31 @@ whereas is the default. The different modes have the following meaning: .IR CheckLinkState -Check link state only: RLMT uses the link state reported by the adapter hardware for each individual port to determine whether a port can be used for all network traffic or not. +Check link state only: RLMT uses the link state reported by the adapter +hardware for each individual port to determine whether a port can be used +for all network traffic or not. .br .IR CheckLocalPort -In this mode, RLMT monitors the network path between the two ports of an adapter by regularly exchanging packets between them. This mode requires a network configuration in which the two ports are able to "see" each other (i.e. there must not be any router between the ports). +In this mode, RLMT monitors the network path between the two +ports of an adapter by regularly exchanging packets between them. +This mode requires a network configuration in which the +two ports are able to "see" each other (i.e. there +must not be any router between the ports). .br .IR CheckSeg -Check local port and segmentation: This mode supports the same functions as the CheckLocalPort mode and additionally checks network segmentation between the ports. Therefore, this mode is only to be used if Gigabit Ethernet switches are installed on the network that have been configured to use the Spanning Tree protocol. +Check local port and segmentation: +This mode supports the same functions as the CheckLocalPort +mode and additionally checks network segmentation between the ports. +Therefore, this mode is only to be used if Gigabit Ethernet +switches are installed on the network that have been +configured to use the Spanning Tree protocol. .br .IR DualNet -In this mode, ports A and B are used as separate devices. If you have a dual port adapter, port A will be configured as +In this mode, ports A and B are used as separate devices. +If you have a dual port adapter, port A will be configured as .IR eth[x] and port B as .IR eth[x+1] . Both ports can be used independently with distinct IP addresses. @@ -419,12 +558,17 @@ Note that RLMT modes .IR CheckLocalPort and .IR CheckLinkState -are designed to operate in configurations where a network path between the ports on one adapter exists. Moreover, they are not designed to work where adapters are connected back-to-back. +are designed to operate in configurations where a +network path between the ports on one adapter exists. +Moreover, they are not designed to work where adapters are +connected back-to-back. .SH FILES .TP .I /proc/net/sk98lin/eth[x] .br -The statistics file of a particular interface of an adapter card. It contains generic information about the adapter card plus a detailed summary of all transmit and receive counters. +The statistics file of a particular interface of an adapter card. +It contains generic information about the adapter card plus a detailed +summary of all transmit and receive counters. .TP .I /usr/src/linux/Documentation/network/sk98lin.txt .br @@ -432,7 +576,10 @@ This is the .IR README file of the .IR sk98lin -driver. It contains a detailed installation HOWTO and describes all parameters of the driver. It denotes also common problems and provides the solution to them. +driver. +It contains a detailed installation HOWTO and describes all parameters +of the driver. +It denotes also common problems and provides the solution to them. .SH BUGS Report any bugs to linux@syskonnect.de .SH AUTHORS diff --git a/man7/environ.7 b/man7/environ.7 index 1218d20b5..7066c0a28 100644 --- a/man7/environ.7 +++ b/man7/environ.7 @@ -122,7 +122,8 @@ influenced by the presence or value of certain environment variables. A random collection: .LP The variables -.BR LANG ", " LANGUAGE ", " NLSPATH ", " LOCPATH ", " LC_ALL ", " LC_MESSAGES ", " +.BR LANG ", " LANGUAGE ", " NLSPATH ", " LOCPATH ", " +.BR LC_ALL ", " LC_MESSAGES ", " etc. influence locale handling, cf. .BR locale (5). .LP diff --git a/man7/time.7 b/man7/time.7 index 470c04a23..8361f1f82 100644 --- a/man7/time.7 +++ b/man7/time.7 @@ -108,7 +108,8 @@ string representations of the time are described in and .BR strptime (3). .SS "Sleeping and Setting Timers" -Various system calls and functions allow a program to sleep (suspend execution) for a specified period of time; see +Various system calls and functions allow a program to sleep +(suspend execution) for a specified period of time; see .BR nanosleep (2) and .BR sleep (3). diff --git a/man7/unix.7 b/man7/unix.7 index d817155b8..d733c31ca 100644 --- a/man7/unix.7 +++ b/man7/unix.7 @@ -11,7 +11,8 @@ .\" .TH UNIX 7 2004-05-27 "Linux Man Page" "Linux Programmer's Manual" .SH NAME -unix, PF_UNIX, AF_UNIX, PF_LOCAL, AF_LOCAL \- Sockets for local interprocess communication +unix, PF_UNIX, AF_UNIX, PF_LOCAL, AF_LOCAL \- Sockets for local +interprocess communication .SH SYNOPSIS .B #include .br