aboutsummaryrefslogtreecommitdiffstats
path: root/man7/man-pages.7
diff options
context:
space:
mode:
authorAlejandro Colomar <alx.manpages@gmail.com>2022-08-02 00:23:55 +0200
committerAlejandro Colomar <alx.manpages@gmail.com>2022-08-02 00:25:02 +0200
commit4e8858eb0c05e87ba956e065c766bec581fbfb14 (patch)
tree9766806daca1f75c68a758f368895dd2f9a60a1c /man7/man-pages.7
parent30eadebd24ecfa513c9586557701c82371f3e44c (diff)
downloadman-pages-4e8858eb0c05e87ba956e065c766bec581fbfb14.tar.gz
man-pages.7: ffix
Use tables to represent tables. Use .EX/.EE to represent a code example. Use \& to prevent .SS of being interpreted as man(7) source. an.tmac:man7/man-pages.7:900: style: 5 leading space(s) on input line an.tmac:man7/man-pages.7:901: style: 5 leading space(s) on input line an.tmac:man7/man-pages.7:902: style: 5 leading space(s) on input line an.tmac:man7/man-pages.7:903: style: 5 leading space(s) on input line an.tmac:man7/man-pages.7:965: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:966: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:967: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:968: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:969: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:970: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:978: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:979: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:980: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:981: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:982: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:983: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:984: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:985: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:986: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:987: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:988: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:989: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:990: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:991: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:992: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:993: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:994: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:995: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:996: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:997: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:1003: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:1004: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:1005: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:1006: style: 4 leading space(s) on input line an.tmac:man7/man-pages.7:1137: style: 4 leading space(s) on input line Reported-by: 'make lint-man' Reported-by: groff(1) Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Diffstat (limited to 'man7/man-pages.7')
-rw-r--r--man7/man-pages.794
1 files changed, 55 insertions, 39 deletions
diff --git a/man7/man-pages.7 b/man7/man-pages.7
index f1c381525e..86d990ec36 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -896,11 +896,14 @@ Unixes UNIX systems
Use the correct spelling and case for trademarks.
The following is a list of the correct spellings of various
relevant trademarks that are sometimes misspelled:
-.PP
- DG/UX
- HP-UX
- UNIX
- UnixWare
+.IP
+.TS
+l.
+DG/UX
+HP-UX
+UNIX
+UnixWare
+.TE
.SS NULL, NUL, null pointer, and null byte
A
.I null pointer
@@ -961,49 +964,58 @@ surrounding spaces.
.SS Hyphenation of attributive compounds
Compound terms should be hyphenated when used attributively
(i.e., to qualify a following noun). Some examples:
-.PP
- 32-bit value
- command-line argument
- floating-point number
- run-time check
- user-space function
- wide-character string
+.IP
+.TS
+l.
+32-bit value
+command-line argument
+floating-point number
+run-time check
+user-space function
+wide-character string
+.TE
.SS Hyphenation with multi, non, pre, re, sub, and so on
The general tendency in modern English is not to hyphenate
after prefixes such as "multi", "non", "pre", "re", "sub", and so on.
Manual pages should generally follow this rule when these prefixes are
used in natural English constructions with simple suffixes.
The following list gives some examples of the preferred forms:
-.PP
- interprocess
- multithreaded
- multiprocess
- nonblocking
- nondefault
- nonempty
- noninteractive
- nonnegative
- nonportable
- nonzero
- preallocated
- precreate
- prerecorded
- reestablished
- reinitialize
- rearm
- reread
- subcomponent
- subdirectory
- subsystem
+.IP
+.TS
+l.
+interprocess
+multithreaded
+multiprocess
+nonblocking
+nondefault
+nonempty
+noninteractive
+nonnegative
+nonportable
+nonzero
+preallocated
+precreate
+prerecorded
+reestablished
+reinitialize
+rearm
+reread
+subcomponent
+subdirectory
+subsystem
+.TE
.PP
Hyphens should be retained when the prefixes are used in nonstandard
English words, with trademarks, proper nouns, acronyms, or compound terms.
Some examples:
-.PP
- non-ASCII
- non-English
- non-NULL
- non-real-time
+.IP
+.TS
+l.
+non-ASCII
+non-English
+non-NULL
+non-real-time
+.TE
.PP
Finally, note that "re-create" and "recreate" are two different verbs,
and the former is probably what you want.
@@ -1134,7 +1146,11 @@ with a subsection heading
.IR "Program source" ,
as in:
.IP
- .SS Program source
+.in +4n
+.EX
+\&.SS Program source
+.EE
+.in
.IP
Always do this if the explanatory text includes a shell session log.
.PP