summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authordiego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2>2003-10-28 11:17:10 +0000
committerdiego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2>2003-10-28 11:17:10 +0000
commit433db533a91984b3a663fe67efbd82f209cc5a30 (patch)
tree39c8c2389858a6d8325b16a79a7ccb3350f7b21d /DOCS
parent41a616b6696ac99cd3d4436feaae029bcf88b26a (diff)
downloadmpv-433db533a91984b3a663fe67efbd82f209cc5a30.tar.bz2
mpv-433db533a91984b3a663fe67efbd82f209cc5a30.tar.xz
alphabetical order
How to handle -XXX and -noXXX. git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@11304 b3059339-0415-0410-9bf9-f77b7e298cf2
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/tech/manpage.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/DOCS/tech/manpage.txt b/DOCS/tech/manpage.txt
index 1529866817..64d5ba25c7 100644
--- a/DOCS/tech/manpage.txt
+++ b/DOCS/tech/manpage.txt
@@ -155,6 +155,7 @@ General:
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 @@ Option descriptions:
- 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):