From 9dedfb15f516695e8d42403a229874220cc6f526 Mon Sep 17 00:00:00 2001 From: Lyndon Nerenberg Date: Sat, 20 Oct 2012 16:51:01 -0700 Subject: [PATCH] Update the manpage style guide. --- docs/README.manpages | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/docs/README.manpages b/docs/README.manpages index ce9ac26..806e3c7 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, @@ -203,3 +197,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. -- 1.7.10.4