Davin McCall
39c3047cf0
Doc: add note on resolution of relative paths in service descriptions
|
1 week ago | |
|---|---|---|
| .. | ||
| Makefile | 4 months ago | |
| README | 1 week ago | |
| dinit-monitor.8.m4 | 6 months ago | |
| dinit-service.5.m4 | 1 week ago | |
| dinit.8.m4 | 2 months ago | |
| dinitcheck.8.m4 | 11 months ago | |
| dinitctl.8.m4 | 3 months ago | |
| generate-html.sh | 2 years ago | |
| meson.build | 4 months ago | |
| shutdown.8.m4 | 3 months ago | |
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 (see groff_char(7)):
'\ ' - (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
` and ' (backtick / apostrophe) - use for opening/closing single quotes
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 (see groff_char(7)):
'\ ' - (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
` and ' (backtick / apostrophe) - use for opening/closing single quotes
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