changeset 11303:920b08da3091

alphabetical order How to handle -XXX and -noXXX.
author diego
date Tue, 28 Oct 2003 11:17:10 +0000
parents dc4db88fc4ff
children f89e212dd5b9
files DOCS/tech/manpage.txt
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- 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 <driver>).
     - 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):