From: Craig Small Date: Wed, 9 Sep 2020 10:56:14 +0000 (+1000) Subject: doc: Fix minor issues with man pages X-Git-Tag: v23.4rc1~11 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b64a67ff7fbd31807dc5f7d11d94989fd17e8e89;p=psmisc doc: Fix minor issues with man pages References: pstree/pstree#29 --- diff --git a/doc/fuser.1 b/doc/fuser.1 index 007bb04..d0858a2 100644 --- a/doc/fuser.1 +++ b/doc/fuser.1 @@ -1,12 +1,12 @@ .\" .\" Copyright 1993-2005 Werner Almesberger -.\" 2005-2016 Craig Small +.\" 2005-2020 Craig Small .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" -.TH FUSER 1 "2016-04-04" "psmisc" "User Commands" +.TH FUSER 1 "2020-09-09" "psmisc" "User Commands" .SH NAME fuser \- identify processes using files or sockets .SH SYNOPSIS @@ -78,7 +78,7 @@ corresponding name space has to be selected with the .B \-n option. By default .B fuser -will look in both IPv6 and IPv4 sockets. To change the default, +will look in both IPv6 and IPv4 sockets. To change the default behavior, use the .B \-4 and @@ -101,7 +101,7 @@ Show all files specified on the command line. By default, only files that are accessed by at least one process are shown. .TP .B \-c -Same as \-m option, used for POSIX compatibility. +Same as \fB\-m\fR option, used for POSIX compatibility. .TP .B \-f Silently ignored, used for POSIX compatibility. @@ -138,7 +138,7 @@ List all known signal names. .I NAME specifies a file on a mounted file system or a block device that is mounted. All processes accessing files on that file system are listed. -If a directory file is specified, it is automatically changed to +If a directory is specified, it is automatically changed to .IR NAME /. to use any file system that might be mounted on that directory. .TP @@ -156,7 +156,7 @@ ignored if .B \-k is not present too. .TP -.BI \-n " SPACE\fR, " "\-\-namespace " SPACE +.BI \-n " NAMESPACE\fR, " "\-\-namespace " NAMESPACE Select a different name space. The name spaces .B file (file names, the default), @@ -229,9 +229,9 @@ location of the proc file system .B fuser \-km /home kills all processes accessing the file system /home in any way. .TP -.BI "if fuser \-s /dev/ttyS1; then :; else " something "; fi" +.BI "if fuser \-s /dev/ttyS1; then :; else " command "; fi" invokes -.I something +.I command if no other process is using /dev/ttyS1. .TP .B fuser telnet/tcp @@ -280,12 +280,13 @@ option only works on processes. If the user is the kernel, will print an advice, but take no action beyond that. .SH BUGS .PP -fuser \-m /dev/sgX will show (or kill with the \-k flag) all processes, +.B fuser \-m /dev/sgX +will show (or kill with the \fB\-k\fR flag) all processes, even if you don't have that device configured. There may be other devices it does this for too. .PP -The mount \-m option will match any file within the same device as the -specified file, use the \-M option as well if you mean to specify only +The mount \fB\-m\fR option will match any file within the same device as the +specified file, use the \fB\-M\fR option as well if you mean to specify only the mount point. .SH "SEE ALSO" .BR kill (1), diff --git a/doc/killall.1 b/doc/killall.1 index 0f16fac..d63097c 100644 --- a/doc/killall.1 +++ b/doc/killall.1 @@ -1,12 +1,12 @@ .\" .\" Copyright 1993-2002 Werner Almesberger -.\" 2002-2018 Craig Small +.\" 2002-2020 Craig Small .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" -.TH KILLALL 1 "2018-05-06" "psmisc" "User Commands" +.TH KILLALL 1 "2020-09-09" "psmisc" "User Commands" .SH NAME killall \- kill processes by name .SH SYNOPSIS @@ -66,7 +66,7 @@ independent of their name. .B killall returns a zero return code if at least one process has been killed for each listed command, or no commands were listed and at least one -process matched the -u and -Z search criteria. +process matched the \fB\-u\fR and \fB\-Z\fR search criteria. .B killall returns non-zero otherwise. .PP @@ -89,7 +89,7 @@ prints a message for each skipped entry if .B \-v is specified in addition to -.BR \-e , +.BR \-e . .IP "\fB\-I\fP, \fB\-\-ignore\-case\fP" Do case insensitive process name match. .IP "\fB\-g\fP, \fB\-\-process\-group\fP" @@ -106,7 +106,7 @@ against all namespaces. .IP "\fB\-o\fP, \fB\-\-older\-than\fP" Match only processes that are older (started before) the time specified. The time is specified as a float then a unit. The units -are s,m,h,d,w,M,y for seconds, minutes, hours, days, weeks, Months and +are s,m,h,d,w,M,y for seconds, minutes, hours, days, weeks, months and years respectively. .IP "\fB\-q\fP, \fB\-\-quiet\fP" Do not complain if no processes were killed. @@ -164,7 +164,7 @@ may not be able to match them correctly. .PP .B killall has a limit of names that can be specified on the command line. This -figure is the size of an unsigned long multiplied by 8. For most 32 +figure is the size of an unsigned long integer multiplied by 8. For most 32 bit systems the limit is 32 and similarly for a 64 bit system the limit is usually 64. .SH "SEE ALSO" diff --git a/doc/peekfd.1 b/doc/peekfd.1 index a1dbddf..c7cda70 100644 --- a/doc/peekfd.1 +++ b/doc/peekfd.1 @@ -6,7 +6,7 @@ .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" -.TH PEEKFD 1 "2012-07-28" "psmisc" "User Commands" +.TH PEEKFD 1 "2020-09-09" "psmisc" "User Commands" .SH NAME peekfd \- peek at file descriptors of running processes .SH SYNOPSIS @@ -51,8 +51,8 @@ None. .SH DIAGNOSTICS The following diagnostics may be issued on stderr: .TP -.B Error attaching to pid ... -An unknown error occurred while attempted to attach to a process.. you +.B Error attaching to pid +An unknown error occurred while attempted to attach to a process, you may need to be root. .SH BUGS Probably lots. Don't be surprised if the process you are monitoring diff --git a/doc/prtstat.1 b/doc/prtstat.1 index 34b648b..f9fe32e 100644 --- a/doc/prtstat.1 +++ b/doc/prtstat.1 @@ -1,12 +1,12 @@ .\" -.\" Copyright 2009-2016 Craig Small +.\" Copyright 2009-2020 Craig Small .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" -.TH PRTSTAT 1 "2016-06-18" "psmisc" "User Commands" +.TH PRTSTAT 1 "2020-09-09" "psmisc" "User Commands" .SH NAME prtstat \- print statistics of a process .SH SYNOPSIS @@ -37,4 +37,4 @@ Show the version information for /proc//stat source of the information .B prtstat -uses +uses. diff --git a/doc/pslog.1 b/doc/pslog.1 index 5a09997..6122624 100644 --- a/doc/pslog.1 +++ b/doc/pslog.1 @@ -6,31 +6,35 @@ .\" Copyright 2015 Vito Mule’. .\" Based on the pwdx(1) man page by Nicholas Miell. .\" -.TH PSLOG 1 "September 12, 2015” "Linux" "Linux User's Manual" +.TH PSLOG 1 "2020-09-09"Linux" "Linux User's Manual" .SH NAME pslog\- report current logs path of a process - .SH SYNOPSIS -.nf -pslog pid... -pslog -V -.fi - +.ad l +.B pslog +.IR pid " \&...\&" +.br +.B pslog \-V +.ad b .SH DESCRIPTION -The pslog command reports the current working logs of a process. - -.SH "GENERAL OPTIONS" -.TS -l l l. --V show version Displays version of program. -.TE - +The +.B pslog +command reports the current working logs of a process. +.SH OPTIONS +.TP +.B \-V +Display version information. .SH "SEE ALSO" -ps(1) pgrep(1) pwdx(1) - -.SH STANDARDS -No standards apply. - +.BR pgrep (1), +.BR ps (1), +.BR pwdx (1). .SH AUTHOR -Vito Mule’ wrote pslog in 2015. Please send bug -reports to . +Vito Mule’ +.MT mulevito@gmail.com +.ME +wrote +.B pslog +in 2015. Please send bug reports to +.MT mulevito@gmail.com +.ME . + diff --git a/doc/pstree.1 b/doc/pstree.1 index fd2330a..82197f3 100644 --- a/doc/pstree.1 +++ b/doc/pstree.1 @@ -1,12 +1,12 @@ .\" .\" Copyright 1993-2002 Werner Almesberger -.\" 2002-2019 Craig Small +.\" 2002-2020 Craig Small .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" -.TH PSTREE 1 "2019-10-23" "psmisc" "User Commands" +.TH PSTREE 1 "2020-09-09" "psmisc" "User Commands" .SH NAME pstree \- display a tree of processes .SH SYNOPSIS @@ -80,7 +80,7 @@ will not return until that has happened. This is useful for when .B pstree is run in a xterminal. .PP -Certain kernel or mount parameters, such as the hidepid option for procfs, +Certain kernel or mount parameters, such as the \fIhidepid\fR option for procfs, will hide information for some processes. In these situations .B pstree will attempt to build the tree without this information, showing process @@ -129,7 +129,7 @@ Display long lines. By default, lines are truncated to either the COLUMNS environment variable or the display width. If neither of these methods work, the default of 132 columns is used. .IP \fB\-n\fP -Sort processes with the same ancestor by PID instead of by name. +Sort processes with the same parent by PID instead of by name. (Numeric sort.) .IP \fB\-N\fP Show individual trees for each namespace of the type specified. The @@ -144,7 +144,7 @@ implicitly disables compaction. .IP \fB\-s\fP Show parent processes of the specified process. .IP \fB\-S\fP -Show namespaces transitions. Like \-N, the output is limited when running +Show namespaces transitions. Like \fB\-N\fR, the output is limited when running as a regular user. .IP \fB\-t\fP Show full names for threads when available. @@ -159,12 +159,14 @@ Use UTF-8 (Unicode) line drawing characters. Under Linux 1.1-54 and above, UTF-8 mode is entered on the console with .B echo \-e '\\033%8' and left with -.B echo \-e '\\033%@' +.BR "echo \-e '\\033%@'" . .IP \fB\-V\fP Display version information. .IP \fB\-Z\fP (SELinux) Show security context for each process. This flag will only -work if pstree is compiled with SELinux support. +work if +.B pstree +is compiled with SELinux support. .SH FILES .TP /proc