|
7286
|
1 A documentation about MPlayer's man page
|
|
|
2 ========================================
|
|
|
3
|
|
|
4
|
|
|
5 About the documentation
|
|
|
6 -----------------------
|
|
7289
|
7 Yes it's true: This is the documentation about the documentation (man page).
|
|
7286
|
8 This guide should be used as a reference for questions about the man page
|
|
|
9 structure. It's not a strict guide but we recommend following it to get a
|
|
|
10 uniform man page.
|
|
|
11
|
|
|
12
|
|
|
13 What belongs to the man page?
|
|
|
14 -----------------------------
|
|
|
15 - option descriptions (all)
|
|
|
16 - usage (options, config files, controls, slave mode)
|
|
|
17 - basic examples
|
|
|
18
|
|
|
19
|
|
|
20 What doesn't belong to the man page?
|
|
|
21 ------------------------------------
|
|
|
22 - instructions of a process (installation, encoding, etc)
|
|
|
23 - detailed valuations or hints
|
|
|
24 - tutorials, guides
|
|
|
25
|
|
|
26
|
|
|
27 How should patches look like?
|
|
|
28 -----------------------------
|
|
|
29 Follow the rules in patches.txt, they apply to the man page too.
|
|
|
30 Exceptions are:
|
|
|
31 - Cosmetic patches are allowed but should be done seperately from the real
|
|
|
32 changes, be marked as cosmetic changes and shouldn't change the general
|
|
|
33 style without reasons/permissions
|
|
|
34 - The same applies for spellchecks
|
|
|
35
|
|
|
36
|
|
|
37 How do I create a html version of the man page?
|
|
|
38 -----------------------------------------------
|
|
|
39 The man pages was more or less designed for groff as it is the main tool for
|
|
|
40 it. Therefore only groff produces acceptable results without changes.
|
|
7289
|
41 Additionaly, the SS variable should be set to either very low or very high
|
|
|
42 values to produce a better groff html output (~18 looks nice for man).
|
|
|
43 Here's an overview again:
|
|
|
44
|
|
7286
|
45 - groff: groff -Thtml -m man mplayer.1 > manpage.groff.html
|
|
|
46 - man2html: You can view it over your cgi script:
|
|
|
47 http://localhost/cgi-bin/man2html?mplayer
|
|
|
48 The output is unuseable as the script doesn't seem to
|
|
|
49 support the macro definitions. Maybe a manual change of all
|
|
|
50 leads to acceptable results.
|
|
|
51 - rman: rman -f html mplayer.1 > manpage.rman.html
|
|
7289
|
52 The output is ugly, you need to remove the .PDs to produce
|
|
|
53 at least acceptable results.
|
|
7286
|
54
|
|
|
55
|
|
|
56 The structure
|
|
|
57 -------------
|
|
|
58 The options are divided into the the layer they belong to. The only exception
|
|
|
59 is the OSD/SUB section. Inside the section they're alphabetically ordered.
|
|
|
60
|
|
|
61 (Header)
|
|
|
62 Not visible, copyright and author informations.
|
|
|
63 (Macro definitions)
|
|
|
64 Not visible, some macro defintions.
|
|
|
65 NAME
|
|
|
66 The manpage is used for both: mplayer and mencoder.
|
|
|
67 SYNOPSIS
|
|
|
68 A description of MPlayer's playtree.
|
|
|
69 DESCRIPTION
|
|
|
70 A general description of MPlayer, MEncoder, GMPlayer and its features.
|
|
|
71 GENERAL NOTES
|
|
|
72 Some general notes about the options and a description of the config file
|
|
|
73 format.
|
|
|
74 PLAYER OPTIONS (MPLAYER ONLY)
|
|
|
75 Option descriptions about the user interface (mplayer only).
|
|
|
76 DEMUXER/STREAM OPTIONS
|
|
|
77 Option descriptions about the demuxer and stream layer.
|
|
|
78 OSD/SUB OPTIONS
|
|
|
79 This section is special: It contains all description about subtitles and
|
|
|
80 OSD. It is independent of the usual layer separation and was created
|
|
|
81 because of its size. The options may therefore come from any layer.
|
|
|
82 AUDIO OUTPUT OPTIONS (MPLAYER ONLY)
|
|
|
83 Option descriptions about the audio output layer (ao) (mplayer only).
|
|
|
84 VIDEO OUTPUT OPTIONS (MPLAYER ONLY)
|
|
|
85 Option descriptions about the video output layer (vo) (mplayer only).
|
|
|
86 DECODING/FILTERING OPTIONS
|
|
|
87 Options about the decoding and filter layer (ad,vd,vf,pl).
|
|
|
88 ENCODING OPTIONS (MENCODER ONLY)
|
|
|
89 Encoding option descriptions (ve) (mencoder only).
|
|
|
90 KEYBOARD CONTROL
|
|
|
91 A description of MPlayer's input system and the default keyboard controls.
|
|
|
92 SLAVE MODE PROTOCOL
|
|
|
93 A description about the slave mode protocol (-slave).
|
|
|
94 FILES
|
|
|
95 A list and description of all installed/used files/directories.
|
|
|
96 EXAMPLES
|
|
|
97 Basic examples. Again: no long descriptions/processes.
|
|
|
98 BUGS
|
|
|
99 AUTHORS
|
|
|
100 STANDARD DISCLAIMER
|
|
|
101
|
|
|
102
|
|
|
103 The man page/groff format
|
|
|
104 -------------------------
|
|
|
105 Just read this and rtfs:
|
|
|
106 http://www.tldp.org/HOWTO/mini/Man-Page.html
|
|
|
107 man 7 man
|
|
|
108 man 7 groff
|
|
|
109
|
|
|
110
|
|
|
111 Directives for the internal "style"
|
|
|
112 -----------------------------------
|
|
|
113 It was kept simple but there are still certain directives/rules to get a
|
|
|
114 uniform man page. The best way is to read (and understand) the source.
|
|
|
115
|
|
|
116 General:
|
|
|
117 - No line should contain more than 79 characters
|
|
|
118 - Used commands: .TH, .SH, .TP, .IP, .[R]B, .I, .br, .RS, .RE, macro
|
|
|
119 definitions, comments
|
|
|
120 - Don't forget the quotation marks around expressions or the backslash
|
|
|
121 before a '-' if it's needed.
|
|
|
122
|
|
|
123 Separations:
|
|
|
124 - Sections (.SH) 2 newlines before (3 visible because of .SH)
|
|
|
125 - Options not (it's done automatically over .TP)
|
|
|
126 - Sub options not (it's done automatically over .IP)
|
|
|
127 should be be separated over a comment (.) at the
|
|
|
128 beginning and the end to make the man page readable ;)
|
|
7289
|
129 - Examples, notes 1 newline before
|
|
7286
|
130 - Big parts better use .P (paragraph) or .br (equal to html's <BR>)
|
|
|
131 instead of newlines
|
|
|
132 - In general no newlines
|
|
|
133 never more than 2 spaces between anything
|
|
|
134
|
|
|
135 Option description:
|
|
|
136 - Option and/or suboption parameters should be short and descriptive.
|
|
|
137 - If the option is between a certain range, it should be specified at the
|
|
|
138 beginning (eg. <0\-100> or <\-100 \- 100>)
|
|
|
139 - All optional things are but between angular paranthesis ([])
|
|
|
140 - Obsolete options are followed by (OBSOLETE), beta options by
|
|
|
141 (BETA CODE), etc
|
|
|
142 - MPlayer only options in a section which isn't marked this way
|
|
|
143 are followed by (MPLAYER only)
|
|
|
144 - Add hints to other options if they belong to each other
|
|
|
145 eg. (\-vo zr only) or (see \-alang option too)
|
|
|
146 - If a non trivial default parameter exist, write it down
|
|
|
147 eg. (default: 24)
|
|
|
148 - Options inside a section are all alphabetically ordered
|
|
7289
|
149 - Examples and notes at the end of the description (before sub options)
|
|
|
150 - The end of the suboptions _always_ has to be followed by a paragraphs
|
|
|
151 (BUG).
|
|
7286
|
152
|
|
|
153 Macro definitions (see beginning of man page):
|
|
|
154 - SS SS is the starting value of the suboption column
|
|
|
155 - .IPs Add new suboption (we use .TP for normal options and .IP for
|
|
|
156 the rest)
|
|
|
157 - .RSs Begin of suboptions, end with .RE
|
|
|
158 - .RSss Begin of suboptions in a suboption
|
|
|
159 - .REss End of suboptions in a suboption
|
|
|
160
|
|
|
161 Options, sub options, examples structure:
|
|
|
162 - Normal options (note the '<' and '>'):
|
|
|
163
|
|
|
164 [...]
|
|
|
165 .TP
|
|
|
166 .B \-option <parameters>
|
|
|
167 description
|
|
|
168 [...]
|
|
|
169
|
|
7289
|
170 - Long sub options:
|
|
7286
|
171
|
|
|
172 [...]
|
|
|
173 description. Available options are:
|
|
|
174 .
|
|
|
175 .RSs
|
|
|
176 .IPs "subopt1=<value>"
|
|
|
177 description1
|
|
|
178 .IPs "subopt2=<value>"
|
|
|
179 description2
|
|
|
180 [...]
|
|
|
181 .IPs "last subopt=<value>"
|
|
|
182 last description
|
|
|
183 .RE
|
|
|
184 .
|
|
|
185 [...]
|
|
|
186
|
|
7289
|
187 - Short sub options:
|
|
|
188
|
|
|
189 [...]
|
|
|
190 description. Available options are:
|
|
|
191
|
|
|
192 .DP 0
|
|
|
193 .RSs
|
|
|
194 .IPs "subopt1=<value>"
|
|
|
195 description1
|
|
|
196 .IPs "subopt2=<value>"
|
|
|
197 description2
|
|
|
198 [...]
|
|
|
199 .IPs "last subopt=<value>"
|
|
|
200 last description
|
|
|
201 .RE
|
|
|
202 .DP 1
|
|
|
203 .
|
|
|
204 [...]
|
|
|
205
|
|
|
206
|
|
7286
|
207 - Sub options in sub options:
|
|
|
208
|
|
|
209 [...]
|
|
|
210 .IPs "subopt1=<value>"
|
|
|
211 description1
|
|
|
212 .RSss
|
|
|
213 subsubopt1: description1
|
|
|
214 .br
|
|
|
215 subsubopt2: description2
|
|
|
216 [...]
|
|
|
217 .REss
|
|
|
218 [...]
|
|
|
219
|
|
7289
|
220 - Examples (like sub options, note: newline before and ':' after
|
|
7286
|
221 .I EXAMPLE, .PD 0 before and .PD 1 after the examples):
|
|
|
222
|
|
|
223 [...]
|
|
|
224
|
|
|
225 .I EXAMPLE:
|
|
|
226 .PD 0
|
|
|
227 .RSs
|
|
|
228 .IP "-option used parameters"
|
|
|
229 description
|
|
|
230 [...]
|
|
|
231 .RE
|
|
|
232 .PD 1
|
|
7289
|
233 .
|
|
7286
|
234 [...]
|
