mirrors/procps
0
0
Fork 0
mirror of https://gitlab.com/procps-ng/procps.git synced 2024-11-23 01:53:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

man/: Align TH calls with style recommendations

Browse Source 
* Stop quoting macro arguments that don't contain spaces.
* Stop defining content for the center header.
* Migrate procio(3) and top(1) to use ISO 8601 date format, like most of
  the other man pages in this project.
* Add the day of the month to procps(3)'s and top(1)'s revision dates.
* Replace procio(3)'s inside footer, "Linux Manpage", with "procps-ng".
* Migrate procps(3), procps_misc(3), procps_pids(3) to use "procps-ng"
  instead of "libproc2" as their inside footers, like all the other man
  pages in this project.

groff_man_style(7):

   Macro reference preliminaries
...
     If a macro accepts multiple arguments, those containing space
     characters must be double‐quoted to be interpreted correctly.
...
   Document structure macros
...
     .TH identifier section [footer‐middle [footer‐inside [header‐middle]]]
...
            identifier and section are positioned at the left and right
            in the header; the latter is set after the former, in
            parentheses and without space.  footer‐middle is centered in
            the footer.  By default, footer‐inside is positioned at the
            bottom left.  Use of the double‐sided layout option -rD1
            places footer‐inside at the bottom left on recto
            (odd‐numbered) pages, and the bottom right on verso
            (even‐numbered) pages.  By default, the outside footer is
            the page number.  Use of the continuous‐rendering option
            -rcR=1 replaces it with identifier and section, as in the
            header.  header‐middle is centered in the header.  If
            section is an integer between 1 and 9 (inclusive), there is
            no need to specify header‐middle; an.tmac supplies text for
            it.
...
            By convention, footer‐middle is the date of the most recent
            modification to the man page source document, and footer‐
            inside is the name and version or release of the project
            providing it.
This commit is contained in:
G. Branden Robinson 2024-10-24 12:04:16 -05:00
parent d0de4634c1
commit 39aab8c464
21 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/free.1
View File

@ -11,7 +11,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH FREE 1 "2023-05-02" "procps-ng" "User Commands"
.TH FREE 1 2023-05-02 procps-ng
.SH NAME
free \- Display amount of free and used memory in the system
.SH SYNOPSIS

2
man/hugetop.1
View File

@ -7,7 +7,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH HUGETOP "1" "2024-01-18" "procps-ng" "User Commands"
.TH HUGETOP 1 2024-01-18 procps-ng
.SH NAME
hugetop \- report huge page information
.SH SYNOPSIS

2
man/pgrep.1
View File

@ -10,7 +10,7 @@
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.TH PGREP "1" "2024-02-05" "procps-ng" "User Commands"
.TH PGREP 1 2024-02-05 procps-ng
.SH NAME
pgrep, pkill, pidwait \- look up, signal, or wait for processes based on name and other attributes
.SH SYNOPSIS

2
man/pidof.1
View File

@ -10,7 +10,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH PIDOF 1 "2023-01-16" "procps-ng" "User Commands"
.TH PIDOF 1 2023-01-16 procps-ng
.SH NAME
pidof \- find the process ID of a running program
.SH SYNOPSIS

2
man/pmap.1
View File

@ -16,7 +16,7 @@
.\" Licensed under version 2 of the GNU General Public License.
.\" Written by Albert Cahalan.
.\"
.TH PMAP "1" "2020-06-04" "procps-ng" "User Commands"
.TH PMAP 1 2020-06-04 procps-ng
.SH NAME
pmap \- report memory map of a process
.SH SYNOPSIS

2
man/procio.3
View File

@ -16,7 +16,7 @@
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH PROCIO 3 "16 January 2018" "Linux Manpage" "Linux Programmer's Manual"
.TH PROCIO 3 2018-01-16 procps-ng
.SH NAME
fprocopen \- stream open functions on files below /proc/##
.SH SYNOPSIS

2
man/procps.3
View File

@ -8,7 +8,7 @@
.\" version 2.1 of the License, or (at your option) any later version.
.\"
.\"
.TH PROCPS 3 "January 2024" "libproc2"
.TH PROCPS 3 2024-01-22 procps-ng
.\" Please adjust this date whenever revising the manpage.
.\"
.nh

2
man/procps_misc.3
View File

@ -8,7 +8,7 @@
.\" version 2.1 of the License, or (at your option) any later version.
.\"
.\"
.TH PROCPS_MISC 3 "2024-07-06" "libproc2"
.TH PROCPS_MISC 3 2024-07-06 procps-ng
.\" Please adjust this date whenever revising the manpage.
.\"
.nh

2
man/procps_pids.3
View File

@ -8,7 +8,7 @@
.\" version 2.1 of the License, or (at your option) any later version.
.\"
.\"
.TH PROCPS_PIDS 3 "September 2024" "libproc2"
.TH PROCPS_PIDS 3 2004-09-03 procps-ng
.\" Please adjust this date whenever revising the manpage.
.\"
.nh

2
man/ps.1
View File

@ -10,7 +10,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH PS "1" "2024-09-17" "procps-ng" "User Commands"
.TH PS 1 2024-09-17 procps-ng
.\"
.\" Ragged-right text.
.na

2
man/pwdx.1
View File

@ -9,7 +9,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH PWDX "1" "2020-06-04" "procps-ng" "User Commands"
.TH PWDX 1 2020-06-04 procps-ng
.SH NAME
pwdx \- report current working directory of a process
.SH SYNOPSIS

2
man/skill.1
View File

@ -9,7 +9,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH SKILL 1 "2024-08-01" "procps-ng" "User Commands"
.TH SKILL 1 2024-08-01 procps-ng
.SH NAME
skill, snice \- send a signal or report process status
.SH SYNOPSIS

2
man/slabtop.1
View File

@ -11,7 +11,7 @@
.\" License, or (at your option) any later version.
.\"
.\"
.TH SLABTOP "1" "2023-12-26" "procps-ng" "User Commands"
.TH SLABTOP 1 2023-12-26 procps-ng
.SH NAME
slabtop \- display kernel slab cache information in real time
.SH SYNOPSIS

2
man/sysctl.8
View File

@ -11,7 +11,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH SYSCTL "8" "2024-07-19" "procps-ng" "System Administration"
.TH SYSCTL 8 2024-07-19 procps-ng
.SH NAME
sysctl \- configure kernel parameters at runtime
.SH SYNOPSIS

2
man/sysctl.conf.5
View File

@ -10,7 +10,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH SYSCTL.CONF 5 2024-10-24 "File Formats"
.TH SYSCTL.CONF 5 2024-10-24 procps-ng
.SH NAME
sysctl.conf \- Kernel configuration parameters
.SH DESCRIPTION

2
man/tload.1
View File

@ -9,7 +9,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH TLOAD "1" "2020-06-04" "procps-ng" "User Commands"
.TH TLOAD 1 2020-06-04 procps-ng
.SH NAME
tload \- graphic representation of system load average
.SH SYNOPSIS

2
man/top.1
View File

@ -59,7 +59,7 @@ memory statistics and data for other users requires root privileges
.
.\" Document /////////////////////////////////////////////////////////////
.\" ----------------------------------------------------------------------
.TH TOP 1 "July 2024" "procps-ng" "User Commands"
.TH TOP 1 2024-07-04 procps-ng
.\" ----------------------------------------------------------------------
.nh

2
man/uptime.1
View File

@ -10,7 +10,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH UPTIME "1" "2024-02-08" "procps-ng" "User Commands"
.TH UPTIME 1 2024-02-08 procps-ng
.SH NAME
uptime \- Tell how long the system has been running.
.SH SYNOPSIS

2
man/vmstat.8
View File

@ -10,7 +10,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH VMSTAT 8 "2024-07-19" "procps-ng" "System Administration"
.TH VMSTAT 8 2024-07-19 procps-ng
.SH NAME
vmstat \- Report virtual memory statistics
.SH SYNOPSIS

2
man/w.1
View File

@ -11,7 +11,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH W "1" "2024-02-08" "procps-ng" "User Commands"
.TH W 1 2024-02-08 procps-ng
.SH NAME
w \- Show who is logged on and what they are doing.
.SH SYNOPSIS

2
man/watch.1
View File

@ -11,7 +11,7 @@
.\" (at your option) any later version.
.\"
.\"
.TH WATCH 1 "2024-07-19" "procps-ng" "User Commands"
.TH WATCH 1 2024-07-19 procps-ng
.SH NAME
watch \- execute a program periodically, showing output fullscreen
.SH SYNOPSIS