X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/84823bbc56258951ea24c1906f9cd6fb42d85c4a..d1cb667bddf8d1c5c0721fc7ab642c22946baf1f:/docs/README.manpages?ds=sidebyside diff --git a/docs/README.manpages b/docs/README.manpages index 8c6516a5..ce9ac26e 100644 --- a/docs/README.manpages +++ b/docs/README.manpages @@ -2,7 +2,7 @@ NMH MANPAGE STYLE GUIDE nmh manpages should be in this general form: -.TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH COMP %manext1% "DATE" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -52,12 +52,31 @@ 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 + + January 2, 1904 + +not the unparseable + + 01/02/04 + + +Don't include a CONTEXT section if contexts don't directly apply to what the +manpage describes. + + In the FILES section, prefer the default .TP indent. The pathnames are 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,