X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/d1cb667bddf8d1c5c0721fc7ab642c22946baf1f..832f687b6c2afdb9dd09e0c5bbc249e1bf22f433:/docs/README.manpages?ds=inline diff --git a/docs/README.manpages b/docs/README.manpages index ce9ac26e..77584983 100644 --- a/docs/README.manpages +++ b/docs/README.manpages @@ -52,11 +52,10 @@ None .SH BUGS None ---------------------------------------------------------------------- - +--------------------------------------- The DATE in the .TH macro should reflect the most recent non-trivial update to the content of the manpage; formatting changes don't count. -Spell out the date in English prose: Month Day, Year +Spell out the date (no abbreviations or shortcuts): January 2, 1904 @@ -64,9 +63,7 @@ not the unparseable 01/02/04 - -Don't include a CONTEXT section if contexts don't directly apply to what the -manpage describes. +Don't abbreviate the month. In the FILES section, prefer the default .TP indent. The pathnames are @@ -74,9 +71,6 @@ variable and long, so any indentation value that works for you won't work for someone else. -The BUGS section goes last. - - Source files There should be no ".so" commands to source an external file, @@ -115,8 +109,7 @@ Program names .B comp .BR comp , - If this is a manpage reference (outside of the SEE ALSO - section, which just uses regular text), use: + If this is a manpage reference, use: .IR mh-draft (5) @@ -203,3 +196,17 @@ Pointer manpages .so man1/folder.1 Also, add this manpage to the appropriate section in Makefile.in + + +CONTEXT + Don't include a CONTEXT section when contexts are out of context. + + +AUTHOR and HISTORY sections + + These have no place in a manpage. If you want everlasting glory, + try the release notes. + +BUGS + + The BUGS section goes last.