From 433db533a91984b3a663fe67efbd82f209cc5a30 Mon Sep 17 00:00:00 2001 From: diego Date: Tue, 28 Oct 2003 11:17:10 +0000 Subject: [PATCH] alphabetical order How to handle -XXX and -noXXX. git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@11304 b3059339-0415-0410-9bf9-f77b7e298cf2 --- DOCS/tech/manpage.txt | 4 ++++ 1 file changed, 4 insertions(+) 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 ). - 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):