Davin McCall 969691202f Tweak documentation for shutdown (esp. soft-reboot) 4 maanden geleden
..
Makefile 071d80e1a8 add soft-reboot 4 maanden geleden
README 9870fcd8b2 doc: minor man page formatting cleanups 6 maanden geleden
dinit-monitor.8.m4 d9d7084285 Remove extraneous text from man page 6 maanden geleden
dinit-service.5.m4 3e9935280d doc: Document the new "restart = on-failure" 5 maanden geleden
dinit.8.m4 3fa13b7f4f doc: extended activation model description in dinit manpage 6 maanden geleden
dinitcheck.8.m4 c2ae495767 doc: update man page for dinitcheck 11 maanden geleden
dinitctl.8.m4 0ccb632faa doc: dinitctl: remove mention of dependency links 6 maanden geleden
generate-html.sh 1541bc2442 Add man page for dinit-monitor 2 jaren geleden
meson.build 071d80e1a8 add soft-reboot 4 maanden geleden
shutdown.8.m4 969691202f Tweak documentation for shutdown (esp. soft-reboot) 4 maanden geleden

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