Davin McCall 8ec5d62681 WIP 2 meses atrás
..
Makefile 071d80e1a8 add soft-reboot 4 meses atrás
README fc51898d0e man pages: Use (and document) more consistent formatting 3 meses atrás
dinit-monitor.8.m4 d9d7084285 Remove extraneous text from man page 6 meses atrás
dinit-service.5.m4 8ec5d62681 WIP 2 meses atrás
dinit.8.m4 cca31c4df9 dinit.8: List all user service description directories in FILES section 3 meses atrás
dinitcheck.8.m4 c2ae495767 doc: update man page for dinitcheck 11 meses atrás
dinitctl.8.m4 fc51898d0e man pages: Use (and document) more consistent formatting 3 meses atrás
generate-html.sh 1541bc2442 Add man page for dinit-monitor 2 anos atrás
meson.build 071d80e1a8 add soft-reboot 4 meses atrás
shutdown.8.m4 fc51898d0e man pages: Use (and document) more consistent formatting 3 meses atrás

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