Mercurial > mplayer.hg
annotate DOCS/tech/manpage.txt @ 11744:70b8047bc7df
sync, tested :-P
BTW, xml/pl fails to compile.
author | nauj27 |
---|---|
date | Mon, 05 Jan 2004 10:39:04 +0000 |
parents | 8fd848195f54 |
children | c04aca6c9161 |
rev | line source |
---|---|
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
1 ======================================== |
7286 | 2 A documentation about MPlayer's man page |
3 ======================================== | |
4 | |
5 | |
6 About the documentation | |
7 ----------------------- | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
8 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
9 Yes it's true: This is the documentation of the documentation (man page). |
7286 | 10 This guide should be used as a reference for questions about the man page |
11 structure. It's not a strict guide but we recommend following it to get a | |
12 uniform man page. | |
13 | |
14 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
15 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
16 What belongs in the man page? |
7286 | 17 ----------------------------- |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
18 |
7286 | 19 - option descriptions (all) |
11561 | 20 - usage (options, configuration files, controls) |
7286 | 21 - basic examples |
22 | |
23 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
24 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
25 What doesn't belong in the man page? |
7286 | 26 ------------------------------------ |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
27 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
28 - instructions for installation, encoding and similar processes |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
29 - detailed evaluations or hints |
7286 | 30 - tutorials, guides |
31 | |
32 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
33 |
7286 | 34 How should patches look like? |
35 ----------------------------- | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
36 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
37 Follow the rules in patches.txt, they apply to the man page, too. |
7286 | 38 Exceptions are: |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
39 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
40 - Cosmetic patches are allowed but should be done separately from the real |
7286 | 41 changes, be marked as cosmetic changes and shouldn't change the general |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
42 style without reasons/permissions. |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
43 - The same applies to spell checking. |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
44 |
7286 | 45 |
46 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
47 How do I create an HTML, text or other version of the man page? |
7741 | 48 --------------------------------------------------------------- |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
49 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
50 The man page was more or less designed for groff as it is the main tool for |
7286 | 51 it. Therefore only groff produces acceptable results without changes. |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
52 Additionally, the SS variable should be set to either very low or very high |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
53 values to produce a better groff HTML output (Due to a bug of groff2html?). |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
54 A setting of 4 should look readable. Here's an overview again: |
7289 | 55 |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
56 - groff: Groff is the "official" tool to convert man pages. |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
57 To get good results you need a recent version (1.18.2). |
11561 | 58 groff -m man -T html mplayer.1 > man_page.html |
59 groff -m man -T ascii -rLL=78n mplayer.1 | col -bx > man_page.txt | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
60 The groff man page lists other output formats to use with -T. |
11561 | 61 |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
62 - man2html: You can view it through a CGI script: |
7286 | 63 http://localhost/cgi-bin/man2html?mplayer |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
64 The output is unusable as the script doesn't seem to support |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
65 the macro definitions. Maybe manually changing all leads to |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
66 acceptable results. |
11561 | 67 |
68 - rman: rman -f html mplayer.1 > man_page.rman.html | |
7741 | 69 The output is ugly as rman doesn't understand many of the |
70 macros used. | |
11561 | 71 |
72 - troffcvt: troff2html -man mplayer.1 > man_page.tcvt.html | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
73 The (good) output is similar to groff but simplified... |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
74 |
7286 | 75 |
76 | |
77 The structure | |
78 ------------- | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
79 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
80 The option descriptions are divided into sections. Inside a section options are |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
81 alphabetically sorted. The sections are: |
7286 | 82 |
83 (Header) | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
84 Not visible, copyright and author information. |
7286 | 85 (Macro definitions) |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
86 Not visible, some macro definitions. |
7286 | 87 NAME |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
88 The man page is used for both mplayer and mencoder. |
7286 | 89 SYNOPSIS |
90 A description of MPlayer's playtree. | |
91 DESCRIPTION | |
92 A general description of MPlayer, MEncoder, GMPlayer and its features. | |
93 GENERAL NOTES | |
94 Some general notes about the options and a description of the config file | |
95 format. | |
10218
f82646fc1431
Moved video filters to a separate section, moved slave mode section to the
jonas
parents:
8699
diff
changeset
|
96 KEYBOARD CONTROL |
f82646fc1431
Moved video filters to a separate section, moved slave mode section to the
jonas
parents:
8699
diff
changeset
|
97 A description of MPlayer's input system and the default keyboard controls. |
7286 | 98 PLAYER OPTIONS (MPLAYER ONLY) |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
99 User interface option descriptions (MPlayer only). |
7286 | 100 DEMUXER/STREAM OPTIONS |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
101 Demuxer and stream layer option descriptions. |
7286 | 102 OSD/SUB OPTIONS |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
103 This section is special in that it contains all subtitle and OSD option |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
104 descriptions even if they might belong to one of the other sections. It was |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
105 created because of its size. |
7286 | 106 AUDIO OUTPUT OPTIONS (MPLAYER ONLY) |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
107 Audio output layer (ao) option descriptions (MPlayer only). |
7286 | 108 VIDEO OUTPUT OPTIONS (MPLAYER ONLY) |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
109 Video output layer (vo) option descriptions (MPlayer only). |
7286 | 110 DECODING/FILTERING OPTIONS |
10218
f82646fc1431
Moved video filters to a separate section, moved slave mode section to the
jonas
parents:
8699
diff
changeset
|
111 Decoding/Filtering layer options (ad, vd, pl). |
f82646fc1431
Moved video filters to a separate section, moved slave mode section to the
jonas
parents:
8699
diff
changeset
|
112 VIDEO FILTERS |
f82646fc1431
Moved video filters to a separate section, moved slave mode section to the
jonas
parents:
8699
diff
changeset
|
113 Video filter description (vf) |
10380
8627ec205af8
moved -af options to the filter section (should work with mencoder), split encoding options in general and codec specific part, some small (cosmetic) changes
jonas
parents:
10227
diff
changeset
|
114 GENERAL ENCODING OPTIONS (MENCODER ONLY) |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
115 Encoding option descriptions (ve) (MEncoder only). |
10380
8627ec205af8
moved -af options to the filter section (should work with mencoder), split encoding options in general and codec specific part, some small (cosmetic) changes
jonas
parents:
10227
diff
changeset
|
116 CODEC SPECIFIC ENCODING OPTIONS (MENCODER ONLY) |
8627ec205af8
moved -af options to the filter section (should work with mencoder), split encoding options in general and codec specific part, some small (cosmetic) changes
jonas
parents:
10227
diff
changeset
|
117 Codec specific option descriptions (lavc,divx4,xvid,lame) (MEncoder only). |
7286 | 118 FILES |
119 A list and description of all installed/used files/directories. | |
120 EXAMPLES | |
121 Basic examples. Again: no long descriptions/processes. | |
122 BUGS | |
123 AUTHORS | |
124 STANDARD DISCLAIMER | |
125 | |
126 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
127 |
7286 | 128 The man page/groff format |
129 ------------------------- | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
130 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
131 Just read this and RTFS: |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
132 |
11561 | 133 man 7 roff |
7286 | 134 http://www.tldp.org/HOWTO/mini/Man-Page.html |
135 man 7 man | |
136 man 7 groff | |
137 | |
138 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
139 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
140 "Style" guidelines |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
141 ------------------ |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
142 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
143 This section was kept simple but there are certain guidelines/rules to get a |
7286 | 144 uniform man page. The best way is to read (and understand) the source. |
145 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
146 |
7286 | 147 General: |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
148 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
149 - No line should contain more than 79 characters. |
7744
6d41f5e905e2
reversed some changes as they produced ugly html output
jonas
parents:
7742
diff
changeset
|
150 - Used commands: .TH, .SH, .TP, .IP, .PP, .[R]B, .I, .br, .RS, .RE, .na, |
6d41f5e905e2
reversed some changes as they produced ugly html output
jonas
parents:
7742
diff
changeset
|
151 .nh, .ad, .hy, macro definitions, comments and some more |
11099 | 152 - Don't forget the quotation marks around expressions, etc... |
153 - Each new sentence should start on a line of its own. | |
154 - Put a backslash before a '-' if it denotes a range (1\-10), an option | |
11116 | 155 (\-fs), stdin (\-) or a dash (mplayer \- Movie Player for Linux). |
156 Use just '-' if it is a hyphen (A-V) or a minus (-1). Please note that | |
157 it should be \-dvd-device and not \-dvd\-device. | |
7286 | 158 |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
159 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
160 Option descriptions: |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
161 |
11303 | 162 - Options should be in alphabetical order. |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
163 - Option and/or suboption parameters should be short, descriptive and put |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
164 in angular brackets (e.g. \-vo <driver>). |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
165 - If the option has a parameter in a certain range, specify it right after |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
166 the option (e.g. \-subpos <0\-100>). |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
167 - Optional things should be put in square brackets ([]). |
7286 | 168 - Obsolete options are followed by (OBSOLETE), beta options by |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
169 (BETA CODE), etc. |
7286 | 170 - MPlayer only options in a section which isn't marked this way |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
171 are followed by (MPLAYER only). |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
172 - Add references to other options if they belong to each other, e.g. |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
173 '(\-vo zr only)' or '(also see \-alang)' or are commonly used together. |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
174 - If a nontrivial default parameter exists, mention it, e.g. (default: 24). |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
175 - Put examples and notes at the end of the description (before suboptions). |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
176 - The end of the suboptions _always_ has to be followed by a paragraph |
7289 | 177 (BUG). |
11303 | 178 - For flag options just document the non-default one of -XXX and -noXXX, if |
179 the option is not a flag, describe both, one below the other (this is an | |
180 exception to the alphabetical order). | |
7286 | 181 |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
182 |
7286 | 183 Macro definitions (see beginning of man page): |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
184 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
185 - SS Starting value of the suboption column |
7286 | 186 - .IPs Add new suboption (we use .TP for normal options and .IP for |
187 the rest) | |
188 - .RSs Begin of suboptions, end with .RE | |
189 - .RSss Begin of suboptions in a suboption | |
190 - .REss End of suboptions in a suboption | |
191 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
192 |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
193 Options, suboptions, examples structure: |
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
194 |
7286 | 195 - Normal options (note the '<' and '>'): |
196 | |
197 [...] | |
198 .TP | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
199 .B \-option <parameter> |
7286 | 200 description |
201 [...] | |
202 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
203 - Long suboptions: |
7286 | 204 |
205 [...] | |
206 description. Available options are: | |
207 . | |
208 .RSs | |
209 .IPs "subopt1=<value>" | |
210 description1 | |
211 .IPs "subopt2=<value>" | |
212 description2 | |
213 [...] | |
214 .IPs "last subopt=<value>" | |
215 last description | |
216 .RE | |
217 . | |
218 [...] | |
219 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
220 - Short suboptions: |
7289 | 221 |
222 [...] | |
223 description. Available options are: | |
224 | |
10702 | 225 .PD 0 |
7289 | 226 .RSs |
227 .IPs "subopt1=<value>" | |
228 description1 | |
229 .IPs "subopt2=<value>" | |
230 description2 | |
231 [...] | |
232 .IPs "last subopt=<value>" | |
233 last description | |
234 .RE | |
10702 | 235 .PD 1 |
7289 | 236 . |
237 [...] | |
238 | |
8699
b3e78d22cae0
Spell checking, parts reworded for greater clarity, layout now uses
diego
parents:
8217
diff
changeset
|
239 - Suboptions in suboptions: |
7286 | 240 |
241 [...] | |
242 .IPs "subopt1=<value>" | |
243 description1 | |
244 .RSss | |
245 subsubopt1: description1 | |
246 .br | |
247 subsubopt2: description2 | |
248 [...] | |
249 .REss | |
250 [...] | |
251 | |
7741 | 252 - Examples: |
7286 | 253 |
254 [...] | |
255 | |
256 .I EXAMPLE: | |
257 .PD 0 | |
258 .RSs | |
259 .IP "-option used parameters" | |
260 description | |
261 [...] | |
262 .RE | |
263 .PD 1 | |
7289 | 264 . |
7286 | 265 [...] |