From: Raoul Gunnar Borenius Date: Sat, 12 Jan 2019 09:23:59 +0000 (+0000) Subject: fix manpage errors X-Git-Tag: archive/raspbian/4.99.4+dfsg-2+rpi1~1^2^2^2^2^2~4 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=aef4f7a701495ff10da72a91f9cb921667963655;p=lsof.git fix manpage errors Reviewed-by: Nicholas Bamber Forwarded: no Last-Update: 2012-04-17 a lot of minus sign occurences in the lsof man page are missing the '\' escape sign and would therefore be interpreted as hyphens. This patch adds the escape signs where appropriate. =================================================================== Gbp-Pq: Name manpage --- diff --git a/lsof.8 b/lsof.8 index bc48e3b..bd91e2b 100644 --- a/lsof.8 +++ b/lsof.8 @@ -12,7 +12,7 @@ lsof \- list open files [ .B \-?abChlnNOPRtUvVX ] [ -.BI -A " A" +.BI \-A " A" ] [ .BI \-c " c" ] [ @@ -223,19 +223,19 @@ options, or it might represent the field identifier character following the .B \-F option. -When ambiguity is possible, start a new option with a `-' +When ambiguity is possible, start a new option with a `\-' character \- e.g., ``\fB\-F \-n\fP''. If the next option is a file name, follow the possibly ambiguous -option with ``--'' \- e.g., ``\fB\-F -- \fIname\fR''. +option with ``\-\-'' \- e.g., ``\fB\-F \-\- \fIname\fR''. .PP Either the `+' or the `\-' prefix may be applied to a group of options. Options that don't take on separate meanings for each prefix \- e.g., \fB\-i\fP \- may be grouped under either prefix. -Thus, for example, ``+M -i'' may be stated as ``+Mi'' and the group +Thus, for example, ``+M \-i'' may be stated as ``+Mi'' and the group means the same as the separate options. Be careful of prefix grouping when one or more options in the group does take on separate meanings under different prefixes \- -e.g., \fB+|\-M\fP; ``-iM'' is not the same request as ``\-i +M''. +e.g., \fB+|\-M\fP; ``\-iM'' is not the same request as ``\-i +M''. When in doubt, use separate options with appropriate prefixes. .TP \w'names'u+4 .B \-? \-h @@ -416,9 +416,9 @@ Mixed lists are not permitted. .IP A file descriptor number range may be in the set as long as neither member is empty, both members are numbers, and the ending -member is larger than the starting one \- e.g., ``0-7'' or ``3-10''. +member is larger than the starting one \- e.g., ``0\-7'' or ``3\-10''. Ranges may be specified for exclusion if they have the `^' prefix \- -e.g., ``^0-7'' excludes all file descriptors 0 through 7. +e.g., ``^0\-7'' excludes all file descriptors 0 through 7. .IP Multiple file descriptor numbers are joined in a single ORed set before participating in AND option selection. @@ -485,7 +485,7 @@ See the section and the sections that follow it for more information on this option. .IP -.B -D +.B \-D must be followed by a function letter; the function letter may optionally be followed by a path name. .I Lsof @@ -737,7 +737,7 @@ When .B \-f is specified by itself, all path name arguments will be taken to be simple files. -Thus, for example, the ``\fB\-f\fP\ -- /'' arguments direct lsof to search +Thus, for example, the ``\fB\-f\fP\ \-\- /'' arguments direct lsof to search for open files with a `/' path name, not all open files in the `/' (root) file system. .IP @@ -747,15 +747,15 @@ and .B \-f are properly terminated and aren't followed by a character (e.g., of the file or file system name) that might be taken as a parameter. -For example, use ``--'' after +For example, use ``\-\-'' after .B +f and .B \-f as in these examples. .IP .nf - $ lsof +f -- /file/system/name - $ lsof -f -- /file/name + $ lsof +f \-\- /file/system/name + $ lsof \-f \-\- /file/name .fi .IP The listing of information from kernel file structures, requested with the @@ -1015,7 +1015,7 @@ Here are some sample addresses: .nf .br - -i6 \- IPv6 only + \-i6 \- IPv6 only .br TCP:25 \- TCP and port 25 .br @@ -1028,10 +1028,10 @@ Here are some sample addresses: .br TCP@lsof.itap:513 \- TCP, port 513 and host name lsof.itap .br - tcp@foo:1-10,smtp,99 \- TCP, ports 1 through 10, + tcp@foo:1\-10,smtp,99 \- TCP, ports 1 through 10, service name \fIsmtp\fP, port 99, host name foo .br - tcp@bar:1-smtp \- TCP, ports 1 through \fIsmtp\fP, host bar + tcp@bar:1\-smtp \- TCP, ports 1 through \fIsmtp\fP, host bar .br :time \- either TCP, UDP or UDPLITE time service port .fi @@ -1086,7 +1086,7 @@ inhibits the conversion of user ID numbers to login names. It is also useful when login name lookup is working improperly or slowly. .TP \w'names'u+4 .BI +|\-L " [l]" -enables (`+') or disables (`-') the listing of file link +enables (`+') or disables (`\-') the listing of file link counts, where they are available \- e.g., they aren't available for sockets, or most FIFOs and pipes. .IP @@ -1300,9 +1300,9 @@ Thus, for example, to direct to display offset at all times with a decimal digit count of 10, use: .IP .nf - -o -o 10 + \-o \-o 10 or - -oo10 + \-oo10 .fi .IP The default number of digits allowed after ``0t'' is normally 8, @@ -1497,7 +1497,7 @@ Or, for example, to list network files with all UDP states except Idle, use: .IP .nf - \-iUDP -sUDP:Idle + \-iUDP \-sUDP:Idle .fi .IP State names vary with UNIX dialects, so it's not possible to @@ -1604,7 +1604,7 @@ selection characters \- the displaying of state is disabled by default, and it must be explicitly selected again in the characters following .BR \-T . (In effect, then, the default is equivalent to -.BR -Ts .) +.BR \-Ts .) For example, if queue lengths and state are desired, use .BR \-Tqs . .IP @@ -1715,14 +1715,14 @@ may not report that it failed to find a search item when an ANDed option or compile\-time option prevents the listing of the open file containing the located search item. .IP -For example, ``lsof -V -iTCP@foobar -a -d 999'' may not report a +For example, ``lsof \-V \-iTCP@foobar \-a \-d 999'' may not report a failure to locate open files at ``TCP@foobar'' and may not list any, if none have a file descriptor number of 999. A similar situation arises when HASSECURITY and HASNOSOCKSECURITY are defined at compile time and they prevent the listing of open files. .TP \w'names'u+4 .B +|\-w -Enables (\fB+\fP) or disables (\fB-\fP) the suppression of warning messages. +Enables (\fB+\fP) or disables (\fB\-\fP) the suppression of warning messages. .IP The .I lsof @@ -1752,13 +1752,13 @@ links and|or file system mount points encountered when scanning the directory (\fB+d\fP) or directory tree (\fB+D\fP). .IP If -.B -x +.B \-x is specified by itself without a following parameter, cross\-over processing of both symbolic links and file system mount points is enabled. Note that when .B \-x -is specified without a parameter, the next argument must begin with '-' +is specified without a parameter, the next argument must begin with '\-' or '+'. .IP The optional 'f' parameter enables file system mount point cross\-over @@ -1948,7 +1948,7 @@ option and before the start of the file names. These are path names of specific files to list. Symbolic links are resolved before use. The first name may be separated from the preceding options with -the ``--'' option. +the ``\-\-'' option. .IP If a .I name @@ -2390,10 +2390,10 @@ option. SECURITY\-CONTEXT is the SELinux security context. This column must be selected with the -.B -Z +.B \-Z option. Note that the -.B -Z +.B \-Z option is inhibited when SELinux is disabled in the running Linux kernel. .TP @@ -3008,7 +3008,7 @@ or the name of a character special or block special device; .IP or the local and remote Internet addresses of a network file; the local host name or IP number is followed by a colon (':'), the -port, ``->'', and the two\-part remote address; +port, ``\->'', and the two\-part remote address; IP addresses may be reported as numbers or names, depending on the .BR +|\-M , .BR \-n , @@ -3041,13 +3041,13 @@ or the local and remote mount point names of an NFS file; .IP or ``STR'', followed by the stream name; .IP -or a stream character device name, followed by ``->'' and the stream name -or a list of stream module names, separated by ``->''; +or a stream character device name, followed by ``\->'' and the stream name +or a list of stream module names, separated by ``\->''; .IP or ``STR:'' followed by the SCO OpenServer stream device and module -names, separated by ``->''; +names, separated by ``\->''; .IP -or system directory name, `` -- '', and as many components of the path +or system directory name, `` \-\- '', and as many components of the path name as .I lsof can find in the kernel's name cache for selected dialects @@ -3055,7 +3055,7 @@ can find in the kernel's name cache for selected dialects .B "KERNEL NAME CACHE" section for more information.); .IP -or ``PIPE->'', followed by a Solaris kernel pipe destination address; +or ``PIPE\->'', followed by a Solaris kernel pipe destination address; .IP or ``COMMON:'', followed by the vnode device information structure's device name, for a Solaris common vnode; @@ -3096,7 +3096,7 @@ by the transmit and receive queue sizes, and the connection state; .IP or ``dgram'' or ``stream'' for the type UnixWare 7.1.1 and above in\-kernel UNIX domain sockets, followed by a colon (':') and the local path name -when available, followed by ``->'' and the remote path name or kernel +when available, followed by ``\->'' and the remote path name or kernel socket address in hexadecimal when available; .IP or the association value, association index, endpoint value, local address, @@ -3110,9 +3110,9 @@ file to be attached to another with .I lsof will add ``(FA:)'' to the NAME column. and are hexadecimal vnode addresses. - will be ``<-'' if has been fattach'ed to + will be ``<\-'' if has been fattach'ed to this vnode whose address is ; -and ``->'' if , the vnode address of this vnode, has been +and ``\->'' if , the vnode address of this vnode, has been fattach'ed to . may be omitted if it already appears in the DEVICE column. .PP @@ -3593,7 +3593,7 @@ for file systems from its mount table, use this incantation to see if it reports any alternate device numbers: .PP .IP -lsof -b +lsof \-b .PP Look for standard error file warning messages that begin ``assuming "dev=xxxx" from ...''. @@ -3612,7 +3612,7 @@ reports the complete paths it finds in the NAME column. If .I lsof can't report all components in a path, it reports in the NAME column -the file system name, followed by a space, two `-' characters, another +the file system name, followed by a space, two `\-' characters, another space, and the name components it has located, separated by the `/' character. .PP @@ -4185,32 +4185,32 @@ lsof .PP To list all open Internet, x.25 (HP\-UX), and UNIX domain files, use: .IP -lsof -i -U +lsof \-i \-U .PP To list all open IPv4 network files in use by the process whose PID is 1234, use: .IP -lsof -i 4 -a -p 1234 +lsof \-i 4 \-a \-p 1234 .PP Presuming the UNIX dialect supports IPv6, to list only open IPv6 network files, use: .IP -lsof -i 6 +lsof \-i 6 .PP To list all files using any protocol on ports 513, 514, or 515 of host wonderland.cc.purdue.edu, use: .IP -lsof -i @wonderland.cc.purdue.edu:513-515 +lsof \-i @wonderland.cc.purdue.edu:513\-515 .PP To list all files using any protocol on any port of mace.cc.purdue.edu (cc.purdue.edu is the default domain), use: .IP -lsof -i @mace +lsof \-i @mace .PP To list all open files for login name ``abe'', or user ID 1234, or process 456, or process 123, or process 789, use: .IP -lsof -p 456,123,789 -u 1234,abe +lsof \-p 456,123,789 \-u 1234,abe .PP To list all open files on device /dev/hd4, use: .IP @@ -4222,7 +4222,7 @@ lsof /u/abe/foo .PP To send a SIGHUP to the processes that have /u/abe/bar open, use: .IP -kill -HUP `lsof -t /u/abe/bar` +kill \-HUP `lsof \-t /u/abe/bar` .PP To find any open file, including an open UNIX domain socket file, with the name @@ -4238,27 +4238,27 @@ the device number for .IR /nfs/mount/point , use: .IP -lsof -b /nfs/mount/point +lsof \-b /nfs/mount/point .PP To do the preceding search with warning messages suppressed, use: .IP -lsof -bw /nfs/mount/point +lsof \-bw /nfs/mount/point .PP To ignore the device cache file, use: .IP -lsof -Di +lsof \-Di .PP To obtain PID and command name field output for each process, file descriptor, file device number, and file inode number for each file of each process, use: .IP -lsof -FpcfDi +lsof \-FpcfDi .PP To list the files at descriptors 1 and 3 of every process running the .I lsof command for login ID ``abe'' every 10 seconds, use: .IP -lsof -c lsof -a -d 1 -d 3 -u abe -r10 +lsof \-c lsof \-a \-d 1 \-d 3 \-u abe \-r10 .PP To list the current working directory of processes running a command that is exactly four characters long and has an 'o' or 'O' in character three, @@ -4266,31 +4266,31 @@ use this regular expression form of the .BI \-c " c" option: .IP -lsof -c /^..o.$/i -a -d cwd +lsof \-c /^..o.$/i \-a \-d cwd .PP To find an IP version 4 socket file by its associated numeric dot\-form address, use: .IP -lsof -i@128.210.15.17 +lsof \-i@128.210.15.17 .PP To find an IP version 6 socket file (when the UNIX dialect supports IPv6) by its associated numeric colon\-form address, use: .IP -lsof -i@[0:1:2:3:4:5:6:7] +lsof \-i@[0:1:2:3:4:5:6:7] .PP To find an IP version 6 socket file (when the UNIX dialect supports IPv6) by an associated numeric colon\-form address that has a run of zeroes in it \- e.g., the loop\-back address \- use: .IP -lsof -i@[::1] +lsof \-i@[::1] .PP To obtain a repeat mode marker line that contains the current time, use: .IP -lsof -rm====%T==== +lsof \-rm====%T==== .PP To add spaces to the previous marker line, use: .IP -lsof -r "m==== %T ====" +lsof \-r "m==== %T ====" .SH BUGS Since .I lsof