# HG changeset patch # User diego # Date 1067339830 0 # Node ID 920b08da3091552bf52788dddab708ca0e8c39d5 # Parent dc4db88fc4fffa5d2c89908bb9b5a5152e48218c alphabetical order How to handle -XXX and -noXXX. diff -r dc4db88fc4ff -r 920b08da3091 DOCS/tech/manpage.txt --- a/DOCS/tech/manpage.txt Tue Oct 28 11:15:37 2003 +0000 +++ b/DOCS/tech/manpage.txt Tue Oct 28 11:17:10 2003 +0000 @@ -155,6 +155,7 @@ Option descriptions: + - Options should be in alphabetical order. - Option and/or suboption parameters should be short, descriptive and put in angular brackets (e.g. \-vo ). - If the option has a parameter in a certain range, specify it right after @@ -170,6 +171,9 @@ - Put examples and notes at the end of the description (before suboptions). - The end of the suboptions _always_ has to be followed by a paragraph (BUG). + - For flag options just document the non-default one of -XXX and -noXXX, if + the option is not a flag, describe both, one below the other (this is an + exception to the alphabetical order). Macro definitions (see beginning of man page):