Davin McCall dd0f23f25f Re-word service type descriptions again 1 year ago
..
Makefile a8b3602963 make, meson: Some configurable options in compile time 1 year ago
README a42b418741 Document log-type, log-buffer-size, consumer-of service settings 1 year ago
dinit-monitor.8.m4 8d5a977d02 Correction to dinit-monitor man page heading 2 years ago
dinit-service.5.m4 dd0f23f25f Re-word service type descriptions again 1 year ago
dinit.8.m4 3562556ae8 Attempt to open log file immediately when starting 1 year ago
dinitcheck.8.m4 497d3b30ed Add /run/dinit.d to the default service directories 1 year ago
dinitctl.8.m4 60e6c3ab7a man: document dinitctl --offline and -d options 1 year ago
generate-html.sh 1541bc2442 Add man page for dinit-monitor 2 years ago
meson.build a8b3602963 make, meson: Some configurable options in compile time 1 year ago
shutdown.8.m4 568c663dd5 Use SHUTDOWN_PREFIX when referring to shutdown etc in man pages 2 years 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 (shows 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
\- - non-breaking dash (avoid automatic line-splitting due to hyphen)
\(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); not really necessary since you can get
the same effect with a blank line in the source document.
.in - set or adjust indent (if given an argument). Argument should be "7m" for example (m = em's,
i = inches) i.e. ".in 7m"; "+7m" increases, "-7m" decreases current indent by specified amount.
Without argument is supposed to restore indent from before previous .in, but mandoc gets this wrong
and always just restores initial indent value. See also .RS/.RE which should normally be used in
preference.

... and macros (which behave like requests). Arguments can be quoted ("...") if they contain
spaces.

.TH