Davin McCall
fc51898d0e
man pages: Use (and document) more consistent formatting
|
2 月之前 | |
|---|---|---|
| .. | ||
| Makefile | 3 月之前 | |
| README | 2 月之前 | |
| dinit-monitor.8.m4 | 4 月之前 | |
| dinit-service.5.m4 | 2 月之前 | |
| dinit.8.m4 | 2 月之前 | |
| dinitcheck.8.m4 | 10 月之前 | |
| dinitctl.8.m4 | 2 月之前 | |
| generate-html.sh | 2 年之前 | |
| meson.build | 3 月之前 | |
| shutdown.8.m4 | 2 月之前 | |
README
The manpages are generated by processing *.m4 files using m4.
Manpages are written in "roff", which is an ancient text formatting/markup system and language
with a lot of peculiarities. For the Dinit manpages we try to stick to the subset documented here.
Roff formatting guide:
Inline formatting ("escapes"):
\fB - set bold
\fI - set italic (may show as underlined when output on console)
\fR - set regular (i.e. unset bold & italic)
Special characters:
'\ ' - (backslash followed by space) - non-breaking space
\& - zero-width space
\- - literal hyphen (also suppresses line breaking through dash)
\(em - em-dash (GNU groff accepts "\[em]" as well but it may not be portable)
\(en - en-dash
\(bu - bullet point
Line commands ("requests"):
.\" - begins a comment line (may be used for spacing in source document without the effect that having a
line would)
.sp - vertical space (i.e. blank line without breaking paragraph)
... and macros (which behave like requests). Arguments can be quoted ("...") if they contain
spaces.
.TH
Manpages are written in "roff", which is an ancient text formatting/markup system and language
with a lot of peculiarities. For the Dinit manpages we try to stick to the subset documented here.
Roff formatting guide:
Inline formatting ("escapes"):
\fB - set bold
\fI - set italic (may show as underlined when output on console)
\fR - set regular (i.e. unset bold & italic)
Special characters:
'\ ' - (backslash followed by space) - non-breaking space
\& - zero-width space
\- - literal hyphen (also suppresses line breaking through dash)
\(em - em-dash (GNU groff accepts "\[em]" as well but it may not be portable)
\(en - en-dash
\(bu - bullet point
Line commands ("requests"):
.\" - begins a comment line (may be used for spacing in source document without the effect that having a
line would)
.sp - vertical space (i.e. blank line without breaking paragraph)
... and macros (which behave like requests). Arguments can be quoted ("...") if they contain
spaces.
.TH