[MPlayer-DOCS] CVS: main/DOCS/tech manpage.txt,1.14,1.15
Diego Biurrun CVS
diego at mplayerhq.hu
Tue Oct 28 12:17:12 CET 2003
Update of /cvsroot/mplayer/main/DOCS/tech
In directory mail:/var/tmp.root/cvs-serv24059/DOCS/tech
Modified Files:
manpage.txt
Log Message:
alphabetical order
How to handle -XXX and -noXXX.
Index: manpage.txt
===================================================================
RCS file: /cvsroot/mplayer/main/DOCS/tech/manpage.txt,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- manpage.txt 14 Oct 2003 13:56:37 -0000 1.14
+++ manpage.txt 28 Oct 2003 11:17:10 -0000 1.15
@@ -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):
More information about the MPlayer-DOCS
mailing list