From: Michael Kerrisk Date: Fri, 8 Jun 2007 11:25:04 +0000 (+0000) Subject: Wrapped source lines at sentence boundaries. X-Git-Tag: man-pages-2.60~7 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ca7b3c180c14583f36bf24c7f31cc8ba342e23d8;p=thirdparty%2Fman-pages.git Wrapped source lines at sentence boundaries. --- diff --git a/man-pages-2.60.Announce b/man-pages-2.60.Announce index dbc8b71dd3..cff405483e 100644 --- a/man-pages-2.60.Announce +++ b/man-pages-2.60.Announce @@ -1,7 +1,7 @@ RELEASE The Linux man page maintainer proudly announces. . . - man-pages-2.59.tar.gz- man pages for Linux + man-pages-2.60.tar.gz- man pages for Linux Differences from the previous manual pages release are listed in the file "Changes". diff --git a/man-pages-2.60.lsm b/man-pages-2.60.lsm index 0274cbd800..aa813b7512 100644 --- a/man-pages-2.60.lsm +++ b/man-pages-2.60.lsm @@ -1,13 +1,13 @@ Begin3 Title: Section 2, 3, 4, 5 and 7 man pages for Linux -Version: 2.59 -Entered-date: 2007-06-25 +Version: 2.60 +Entered-date: 2007-??-?? Description: Linux and POSIX manual pages Keywords: man pages Author: several Maintained-by: Michael Kerrisk Primary-site: ftp://ftp.kernel.org/pub/linux/docs/manpages - 2610k man-pages-2.59.tar.gz + ????k man-pages-2.60.tar.gz Alternate-site: ftp://ftp.win.tue.nl/pub/linux-local/manpages Copying-policy: several; for the POSIX pages, see the file POSIX-COPYRIGHT; the other pages are all freely distributable as long as diff --git a/man1/intro.1 b/man1/intro.1 index 18f2371326..b369cae9cb 100644 --- a/man1/intro.1 +++ b/man1/intro.1 @@ -30,14 +30,17 @@ Linux (and FreeBSD and lots of other Unix-like systems). .LP Under Linux there are GUIs (graphical user interfaces), where you can point and click and drag, and hopefully get work done without -first reading lots of documentation. The traditional Unix environment +first reading lots of documentation. +The traditional Unix environment is a CLI (command line interface), where you type commands to -tell the computer what to do. That is faster and more powerful, +tell the computer what to do. +That is faster and more powerful, but requires finding out what the commands are. Below a bare minimum, to get started. .SS "Login" In order to start working, you probably first have to login, -that is, give your username and password. See also +that is, give your username and password. +See also .BR login (1). The program .I login @@ -45,13 +48,16 @@ now starts a .I shell (command interpreter) for you. In case of a graphical login, you get a screen with menus or icons -and a mouse click will start a shell in a window. See also +and a mouse click will start a shell in a window. +See also .BR xterm (1). .SS "The shell" One types commands to the .IR shell , -the command interpreter. It is not built-in, but is just a program -and you can change your shell. Everybody has her own favorite one. +the command interpreter. +It is not built-in, but is just a program +and you can change your shell. +Everybody has her own favorite one. The standard one is called .IR sh . See also @@ -110,7 +116,8 @@ and here typing Control-D ended the session. The .B "% " here was the command prompt \(em it is the shell's way of indicating -that it is ready for the next command. The prompt can be customized +that it is ready for the next command. +The prompt can be customized in lots of ways, and one might include stuff like user name, machine name, current directory, time, etc. An assignment PS1="What next, master? " @@ -125,7 +132,8 @@ We see that there are commands The command .I ls lists the contents of the current directory \(em it tells you what -files you have. With a \-l option it gives a long listing, +files you have. +With a \-l option it gives a long listing, that includes the owner and size and date of the file, and the permissions people have for reading and/or changing the file. For example, the file "tel" here is 37 bytes long, owned by aeb @@ -157,7 +165,8 @@ Here there was no output because there were no differences. The command .I rm (from "remove") deletes the file, and be careful! it is gone. -No wastepaper basket or anything. Deleted means lost. +No wastepaper basket or anything. +Deleted means lost. .LP The command .I grep @@ -168,10 +177,12 @@ Files live in a large tree, the file hierarchy. Each has a .I "pathname" describing the path from the root of the tree (which is called /) -to the file. For example, such a full pathname might be /home/aeb/tel. +to the file. +For example, such a full pathname might be /home/aeb/tel. Always using full pathnames would be inconvenient, and the name of a file in the current directory may be abbreviated by only giving -the last component. That is why "/home/aeb/tel" can be abbreviated +the last component. +That is why "/home/aeb/tel" can be abbreviated to "tel" when the current directory is "/home/aeb". .LP The command diff --git a/man1/ldd.1 b/man1/ldd.1 index adf37cd717..0415d299a4 100644 --- a/man1/ldd.1 +++ b/man1/ldd.1 @@ -45,7 +45,8 @@ The standard version of .B ldd comes with glibc2. Libc5 came with an older version, still present -on some systems. The long options are not supported by the libc5 version. +on some systems. +The long options are not supported by the libc5 version. On the other hand, the glibc2 version does not support .B \-V and only has the equivalent @@ -53,7 +54,8 @@ and only has the equivalent .LP The libc5 version of this program will use the name of a library given on the command line as-is when it contains a '/'; otherwise it -searches for the library in the standard locations. To run it +searches for the library in the standard locations. +To run it on a shared library in the current directory, prefix the name with "./". .SH BUGS .B ldd diff --git a/man1/time.1 b/man1/time.1 index a73f437c46..36de1b7323 100644 --- a/man1/time.1 +++ b/man1/time.1 @@ -53,7 +53,8 @@ where the number of decimals in the output for %f is unspecified but is sufficient to express the clock tick accuracy, and at least one. .SH ENVIRONMENT The variables LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, LC_NUMERIC, -NLSPATH and PATH are used. The last one to search for +NLSPATH and PATH are used. +The last one to search for .IR command . The remaining ones for the text and formatting of the output. .SH "EXIT STATUS" @@ -99,10 +100,12 @@ The format is interpreted in the usual printf-like way. Ordinary characters are directly copied, tab, newline and backslash are escaped using \et, \en and \e\e, a percent sign is represented by %%, and otherwise % -indicates a conversion. The program +indicates a conversion. +The program .B time will always add a trailing newline itself. -The conversions follow. All of those used by +The conversions follow. +All of those used by .BR tcsh (1) are supported. .LP @@ -230,7 +233,8 @@ Thus, it does not implement the POSIX requirements. The environment variable TIME was badly chosen. It is not unusual for systems like autoconf or make to use environment variables with the name of a utility to override -the utility to be used. Uses like MORE or TIME for options to programs +the utility to be used. +Uses like MORE or TIME for options to programs (instead of program pathnames) tend to lead to difficulties. .LP It seems unfortunate that \-o overwrites instead of appends. diff --git a/man3/cabs.3 b/man3/cabs.3 index c6876d998e..950893dc7a 100644 --- a/man3/cabs.3 +++ b/man3/cabs.3 @@ -17,8 +17,8 @@ Link with \fI-lm\fP. .SH DESCRIPTION The .BR cabs () -function returns the absolute value of the complex number z. The -result is a real number. +function returns the absolute value of the complex number z. +The result is a real number. .SH "CONFORMING TO" C99 .SH NOTES diff --git a/man3/expm1.3 b/man3/expm1.3 index 7513e3e799..d778174cb4 100644 --- a/man3/expm1.3 +++ b/man3/expm1.3 @@ -40,7 +40,8 @@ expm1, expm1f, expm1l \- exponential minus 1 Link with \fI-lm\fP. .SH DESCRIPTION .BI expm1( x ) -returns a value equivalent to `exp (\fIx\fP) \- 1'. It is +returns a value equivalent to `exp (\fIx\fP) \- 1'. +It is computed in a way that is accurate even if the value of \fIx\fP is near zero\(ema case where `exp (\fIx\fP) \- 1' would be inaccurate due to subtraction of two numbers that are nearly equal. diff --git a/man3/fts.3 b/man3/fts.3 index 66cf2b21f9..131e35d22e 100644 --- a/man3/fts.3 +++ b/man3/fts.3 @@ -745,7 +745,8 @@ The options were invalid. .Sh VERSIONS These functions are available in Linux since glibc2. .Sh "CONFORMING TO" -4.4BSD. The +4.4BSD. +The .Nm fts utility is expected to be included in a future .St -p1003.1-88 diff --git a/man3/grantpt.3 b/man3/grantpt.3 index 4a14bd65e1..b8d5847f4a 100644 --- a/man3/grantpt.3 +++ b/man3/grantpt.3 @@ -52,7 +52,8 @@ POSIX.1-2001 This is part of the Unix98 pty support, see .BR pts (4). Many systems implement this function via a set-user-ID helper binary -called "pt_chown". With Linux devpts no such helper binary is required. +called "pt_chown". +With Linux devpts no such helper binary is required. .SH "SEE ALSO" .BR open (2), .BR posix_openpt (3), diff --git a/man3/log1p.3 b/man3/log1p.3 index 8032d1200e..1c9d85faa4 100644 --- a/man3/log1p.3 +++ b/man3/log1p.3 @@ -39,7 +39,8 @@ log1p \- logarithm of 1 plus argument Compile with \fI\-std=c99\fP; link with \fI\-lm\fP. .SH DESCRIPTION .BI log1p( x ) -returns a value equivalent to `log (1 + \fIx\fP)'. It is computed in a way +returns a value equivalent to `log (1 + \fIx\fP)'. +It is computed in a way that is accurate even if the value of \fIx\fP is near zero. .SH "CONFORMING TO" BSD, C99. diff --git a/man3/memmem.3 b/man3/memmem.3 index cd742d29a3..664e5415ef 100644 --- a/man3/memmem.3 +++ b/man3/memmem.3 @@ -63,7 +63,8 @@ dangerous function to use. Both old and new libc's have the bug that if \fIneedle\fP is empty \fIhaystack\fP\-1 (instead of \fIhaystack\fP) is returned. And glibc 2.0 makes it worse, and returns a pointer to the -last byte of `haystack'. This is fixed in glibc 2.1. +last byte of `haystack'. +This is fixed in glibc 2.1. .SH "SEE ALSO" .BR strstr (3), .BR feature_test_macros (7) diff --git a/man7/mdoc.samples.7 b/man7/mdoc.samples.7 index 0fe3457dcb..da4c2d0686 100644 --- a/man7/mdoc.samples.7 +++ b/man7/mdoc.samples.7 @@ -1111,7 +1111,8 @@ and may be used with .Ql \&.Fa (function argument) -to get around the limitation. For example: +to get around the limitation. +For example: .Bd -literal -offset indent \&.Fo "int res_mkquery" \&.Fa "int op" @@ -1398,7 +1399,8 @@ macro is .Em not parsed and .Em not -callable. It accepts at most two arguments. +callable +It accepts at most two arguments. .Ss BSD Macro .Dl Usage: .Bx [Version/release] ... \*(Pu .Bl -tag -width ".Bx 4.3 ) ," -compact -offset 14n @@ -1426,7 +1428,8 @@ macro is .Em not parsed and .Em not -callable. It accepts at most two arguments. +callable +It accepts at most two arguments. .Ss UNIX Macro .Dl Usage: .Ux ... \*(Pu .Bl -tag -width ".Ux 4.3 ) ," -compact -offset 14n @@ -1481,7 +1484,8 @@ All handle punctuation properly, as long as it is presented one character at a time and separated by spaces. The quoting macros examine opening and closing punctuation to determine whether it comes before or after the -enclosing string. This makes some nesting possible. +enclosing string +This makes some nesting possible. .Bl -tag -width xxx,xxxx .It Li \&.Ec , \&.Eo These macros expect the first argument to be the @@ -1493,7 +1497,8 @@ than .Xr nroff . If formatted with .Xr nroff , -a quoted literal is always quoted. If formatted with +a quoted literal is always quoted. +If formatted with troff, an item is only quoted if the width of the item is less than three constant width characters. This is to make short strings more visible where the font change