Man page improvements
Dear Procps maintainers. the manpage-l10n project maintains a large number of translations of man pages both from a large variety of sources (including ProcPS) as well for a large variety of target languages.
During their work translators notice different possible issues in the original (english) man pages. Sometiems this is a straightforward typo, sometimes a hard to read sentence, sometimes this is a convention not held up and sometimes we simply do not understand the original.
We use several distributions as sources and update regularly (at least every 2 month). This means we are fairly recent (some distributions like archlinux also update frequently) but might miss the latest upstream version once a while, so the error might be already fixed. We apologize and ask you to close the issue immediately if this should be the case, but given the huge volume of projects and the very limited number of volunteers we are not able to double check each and every issue.
Secondly we translators see the manpages in the neutral po format, i.e. converted and harmonized, but not the original source (be it man, groff, xml or other). So we cannot provide a true patch (where possible), but only an approximation which you need to convert into your source format.
Finally the issues I'm reporting have accumulated over time and are not always discovered by me, so sometimes my description of the problem my be a bit limited - do not hesitate to ask so we can clarify them.
I'm now reporting the errors for your project. If future reports should use another channel, please let me know.
**
Man page: openproc.3 Issue: markup of function name
The B<openproc> function initializes a PROCTAB structure which can be used by iterated readproc calls to get information on current processes. Depending on I<flags>, openproc may need a second argument or a second and third argument (see below).
Man page: openproc.3 Issue: Full stop within markup
"B<closeproc> closes all files opened by B<openproc> and deallocates the " "memory allocated by B<openproc.>"
Man page: openproc.3 Issue: Missing full stop
"The PROCTAB structure is defined in I<Eproc/readproc.hE>"
Man page: openproc.3 Issue: Markup of opendir
"The behaviour of B is controlled by the following set of flags, " "which may be ORed together. There are three different kinds of flags. The " "first group of flags determins which information gets read from /proc/#pid " "for each process. The second group of flags (of which only one can be " "enacted for a opendir call) restricts which processes information is read " "for by providing a list of criteria. The third group of flags restricts this " "as well, but doesn't need arguments. These may be used together again."
Man page: openproc.3 Issue: threat → treat
"threat threads as if they were processes"
Man page: pgrep.1 Issue 1: markup of argument Issue 2: line → lines
"Only match processes whose names (or command line if -f is specified) " "B<exactly> match the I<pattern>."
Man page: pgrep.1 Issue: I<PID>'s → I<PID>s
"Read I<PID>'s from file. This option is perhaps more useful for B<pkill> " "than B<pgrep>."
Man page: pgrep.1 Issue: markup of arguments
"Fail if pidfile (see -F) not locked."
"Match processes that belong to the same namespaces. Required to run as root " "to match processes from other users. See --nslist for how to limit which " "namespaces to match."
"The process name used for matching is limited to the 15 characters present " "in the output of /proc/I/stat. Use the -f option to match against the " "complete command line, /proc/I/cmdline."
Man page: pidof.1 Issue: Superfluous full stop
"pidof -- find the process ID of a running program."
Man page: pidof.1 Issue: .. → …
"B [B<-s>] [B<-c>] [B<-x>] [B<-o> I<omitpid[,omitpid..]>] [B<-o> " "I<omitpid[,omitpid..]..>] [B<-S> I] B [B<program..>]"
Man page: pidof.1 Issue 1: markup of pidof Issue 2: I<-d> → B<-d>
"Use I as a separator put between pids. Used only when more than " "one pids are printed for the program. The I<-d> option is an alias for this " "option for sysvinit pidof compatibility."
Man page: pmap.1 Issue: markup of command name
"The pmap command reports the memory map of a process or processes."
"No standards apply, but pmap looks an awful lot like a SunOS command."
Man page: ps.1 Issue: I → B
"B displays information about a selection of the active processes. If " "you want a repetitive update of the selection and the displayed information, " "use I(1) instead."
Man page: ps.1 Issue: superfluous citations around formatted commands
"Note that "B<ps -aux>" is distinct from "B<ps\ aux>". The POSIX and " "UNIX standards require that "B<ps\ -aux>" print all processes owned by a " "user named "x", as well as printing all processes that would be selected " "by the B<-a> option. If the user named "x" does not exist, this B may " "interpret the command as "B<ps\ aux>" instead and print a warning. This " "behavior is intended to aid in transitioning old scripts and habits. It is " "fragile, subject to change, and thus should not be relied upon."
"Commands options such as B<ps -aux> are not recommended as it is a confusion " "of two different standards. According to the POSIX and UNIX standards, the " "above command asks to display all processes with a TTY (generally the " "commands users are running) plus all processes owned by a user named "x". " "If that user doesn't exist, then B will assume you really meant "B " "I"."
Man page: ps.1 Issue: markup of »section«
"Print a help message. The section argument can be one of Iimple, "
"Iist, Iutput, Ihreads, Iisc, or Ill. The argument can be "
"shortened to one of the underlined letters as in: s\^|\^l\^|\^o\^|\^t"
"\^|\^m\^|\^a."
"Print a help message. The section argument can be one of Iimple, "
"Iist, Iutput, Ihreads, Iisc or Ill. The argument can be "
"shortened to one of the underlined letters as in: s|l|o|t|m|a."
Man page: ps.1 Issue: missing markup of options
"If the length of the username is greater than the length of the display " "column, the username will be truncated. See the -o and -O formatting " "options to customize length."
"If the length of the username is greater than the length of the display " "column, the username will be truncated. See the -o and -O formatting options " "to customize length."
Man page: ps.1 Issue: Unnecessary hard line breaks
"processor utilization.\n" "Currently, this is the integer value of the percent usage over the\n" "lifetime of the process. (see\n" "B<%cpu>)."
"processor utilization. Currently, this is the integer value of the percent\n" "usage over the lifetime of the process. (see\n" "B<%cpu>)."
Man page: ps.1 Issue: B<args format keyword,> → B format keyword,
"command name (only the executable name). Modifications to the command name\n" "will not be shown. A process marked EdefunctE is partly dead, waiting to be\n" "fully destroyed by its parent. The output in this column may contain spaces.\n" "(alias\n" "B, B).\n" "See also the\n" "B<args format keyword,>\n" "the\n" "B<-f>\n" "option, and the\n" "B\n" "option.\n"
Man page: ps.1 Issue: Missing markup
"Unique inode number describing the namespace the process belongs to.\n" "See namespaces(7)."
"Unique inode number describing the namespace the process belongs to. See namespaces(7)."
Man page: ps.1 Issue: Markup of -1
"The node assocated with the most recently used processor.\n" "A -1 means that NUMA information is unavailable."
Man page: ps.1 Issue: Missing space at the end of the enumaration (list)
"time the command started. If the process was started less than 24 hours ago,\n" "the output format is "\ HH:MM", else it is " Mmm:SS" (where Mmm is the three\n" "letters of the month). See also\n" "B,B<\ start>,B<\ start_time>, andB<\ stime>."
Man page: ps.1 Issue: B<args format keyword,> → B format keyword,
"command name (only the executable name). Modifications to the command name\n" "will not be shown. A process marked EdefunctE is partly dead, waiting to be\n" "fully destroyed by its parent. The output in this column may contain spaces.\n" "(alias\n" "B,B<\ ucomm>).\n" "See also the\n" "B<args format keyword,>\n" "the\n" "B<-f>\n" "option, and the\n" "B\n" "option.\n"
Man page: pwdx.1 Issue: Missing markup for command name
"No standards apply, but pwdx looks an awful lot like a SunOS command."
Man page: slabtop.1 Issue: Missing markup for command name
"The sort criteria can also be changed while slabtop is running by pressing " "the associated character."
"The slabtop statistic header is tracking how many bytes of slabs are being " "used and is not a measure of physical memory. The 'Slab' field in the /proc/" "meminfo file is tracking information about used slab physical memory."
Man page: sysctl.8 Issue: Missing markup for minus sign
"Load in sysctl settings from the file specified or /etc/sysctl.conf if none " "given. Specifying - as filename means reading data from standard input. " "Using this option will mean arguments to B are files, which are read " "in the order they are specified. The file argument may be specified as " "regular expression."
Man page: sysctl.8 Issue: Missing markup for command name
"The B<base_reachable_time> and B<retrans_time> are deprecated. The sysctl " "command does not allow changing values of these parameters. Users who " "insist to use deprecated kernel interfaces should push values to /proc file " "system by other means. For example:"
Man page: sysctl.conf.5 Issue: Missing markup/quoting for # and ;
"Note that blank lines are ignored, and whitespace before and after a token " "or value is ignored, although a value can contain whitespace within. Lines " "which begin with a # or ; are considered comments and ignored."
Man page: sysctl.conf.5 Issue: Missing markup for command name
"The paths where sysctl preload files usually exist. See also sysctl option " "I<--system>."
Man page: tload.1 Issue: Missing markup for process name
"B prints a graph of the current system load average to the specified " "I (or the tty of the tload process if none is specified)."
Man page: vmstat.8 Issue: --unit → B<--unit>
"These are affected by the --unit option."
Man page: vmstat.8 Issue: Markup of options
"swpd: the amount of virtual memory used.\n" "free: the amount of idle memory.\n" "buff: the amount of memory used as buffers.\n" "cache: the amount of memory used as cache.\n" "inact: the amount of inactive memory. (-a option)\n" "active: the amount of active memory. (-a option)\n"
Man page: vmstat.8 Issue: Markup extends into space at end
"B does not require special permissions."
Man page: w.1 Issue: Missing markup for command name
"Ignores the username while figuring out the current process and cpu times. " "To demonstrate this, do a "su" and do a "w" and a "w -u"."
Man page: watch.1 Issue: The wording of the 2nd sentence is strance, almost incomprehensible
"Highlight the differences between successive updates. Option will read " "optional argument that changes highlight to be permanent, allowing to see " "what has changed at least once since first iteration."
Man page: watch.1 Issue: Missing markup for command name "Non-printing characters are stripped from program output. Use "cat -v" as " "part of the command pipeline if you want to see them."
w.procps.1 Issue: Missing markup for command nam and options (instead of quoting)
"Ignores the username while figuring out the current process and cpu times. " "To demonstrate this, do a "su" and do a "w" and a "w -u"."