Commit Graph

4 Commits

Author SHA1 Message Date
G. Branden Robinson
39aab8c464 man/: Align TH calls with style recommendations
* 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.
2024-11-04 10:31:06 +00:00
G. Branden Robinson
649a04bfaf docs: Fix many man page style issues
* Fix grypo
* Fix groff warnings in ps(1)
* Fix style warnings in man pages
* Drop no-op calls of deprecated `PD` macro
* Make "EXIT STATUS" sections consistent
* Restyle tagged paragraph sequence (1/5)
* Restyle tagged paragraph sequence (2/5)
* Restyle tagged paragraph sequence (3/5)
* Restyle tagged paragraph sequence (4/5)
* Restyle tagged paragraph sequence (5/5)
* Stop shouting "Unix" in full capitals
* Fix misuse of `UR`/`UE` macros
* Fix bug report address formatting in free(1)
* Set lists more economically
* Fix vertical spacing problems (1/2)
* Fix vertical spacing problems (2/2)
* Revise "STANDARD FORMAT SPECIFIERS" table
* Drop superfluous `PP` macros before `SH`
* Migrate to idiot-proof quotation marks
* Use idiomatic ellipsis markup
* Make command synopses idiomatic, consistent
2024-01-29 07:56:54 +11:00
Craig Small
c1edb15259 misc: Update copyright of remaining man pages
Giving them all a standard format and using either the existing
header or the git logs to put the relevant authors in.
2023-02-08 18:28:55 +11:00
Craig Small
8e889ae682 build-sys: Rearrange the manual pages
All man pages are found in ./man
man-po -> po-man

References:
 https://www.freelists.org/post/procps/Next-for-newlib,3

Signed-off-by: Craig Small <csmall@dropbear.xyz>
2022-08-29 18:07:43 +10:00