]> git.saurik.com Git - apt.git/blame - doc/apt-verbatim.ent
use an enum instead of strings as IndexTarget::Option interface
[apt.git] / doc / apt-verbatim.ent
CommitLineData
0c1a7101
DK
1<!-- -*- mode: xml; mode: fold -*- -->
2
3<!-- Some common paths.. -->
4<!ENTITY docdir "/usr/share/doc/apt/">
5<!ENTITY guidesdir "/usr/share/doc/apt-doc/">
6<!ENTITY configureindex "<filename>&docdir;examples/configure-index.gz</filename>">
7<!ENTITY aptconfdir "<filename>/etc/apt.conf</filename>">
8<!ENTITY statedir "/var/lib/apt">
9<!ENTITY cachedir "/var/cache/apt">
10
11<!-- Cross references to other man pages -->
12<!ENTITY apt-conf "<citerefentry>
13 <refentrytitle><filename>apt.conf</filename></refentrytitle>
14 <manvolnum>5</manvolnum>
15 </citerefentry>"
16>
17
18<!ENTITY apt-get "<citerefentry>
19 <refentrytitle><command>apt-get</command></refentrytitle>
20 <manvolnum>8</manvolnum>
21 </citerefentry>"
22>
23
24<!ENTITY apt-config "<citerefentry>
25 <refentrytitle><command>apt-config</command></refentrytitle>
26 <manvolnum>8</manvolnum>
27 </citerefentry>"
28>
29
30<!ENTITY apt-cdrom "<citerefentry>
31 <refentrytitle><command>apt-cdrom</command></refentrytitle>
32 <manvolnum>8</manvolnum>
33 </citerefentry>"
34>
35
36<!ENTITY apt-cache "<citerefentry>
37 <refentrytitle><command>apt-cache</command></refentrytitle>
38 <manvolnum>8</manvolnum>
39 </citerefentry>"
40>
41
9a591666
MV
42<!ENTITY apt "<citerefentry>
43 <refentrytitle><command>apt</command></refentrytitle>
44 <manvolnum>8</manvolnum>
45 </citerefentry>"
46>
47
0c1a7101
DK
48<!ENTITY apt-preferences "<citerefentry>
49 <refentrytitle><command>apt_preferences</command></refentrytitle>
50 <manvolnum>5</manvolnum>
51 </citerefentry>"
52>
53
54<!ENTITY apt-key "<citerefentry>
55 <refentrytitle><command>apt-key</command></refentrytitle>
56 <manvolnum>8</manvolnum>
57 </citerefentry>"
58>
59
60<!ENTITY apt-secure "<citerefentry>
61 <refentrytitle>apt-secure</refentrytitle>
62 <manvolnum>8</manvolnum>
63 </citerefentry>"
64>
65
66<!ENTITY apt-ftparchive "<citerefentry>
67 <refentrytitle><filename>apt-ftparchive</filename></refentrytitle>
68 <manvolnum>1</manvolnum>
69 </citerefentry>"
70>
71
72
73<!ENTITY sources-list "<citerefentry>
74 <refentrytitle><filename>sources.list</filename></refentrytitle>
75 <manvolnum>5</manvolnum>
76 </citerefentry>"
77>
78
79<!ENTITY reportbug "<citerefentry>
80 <refentrytitle><command>reportbug</command></refentrytitle>
81 <manvolnum>1</manvolnum>
82 </citerefentry>"
83>
84
85<!ENTITY dpkg "<citerefentry>
86 <refentrytitle><command>dpkg</command></refentrytitle>
87 <manvolnum>1</manvolnum>
88 </citerefentry>"
89>
90
91<!ENTITY dpkg-buildpackage "<citerefentry>
92 <refentrytitle><command>dpkg-buildpackage</command></refentrytitle>
93 <manvolnum>1</manvolnum>
94 </citerefentry>"
95>
96
97<!ENTITY gzip "<citerefentry>
98 <refentrytitle><command>gzip</command></refentrytitle>
99 <manvolnum>1</manvolnum>
100 </citerefentry>"
101>
102
103<!ENTITY dpkg-scanpackages "<citerefentry>
104 <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
105 <manvolnum>1</manvolnum>
106 </citerefentry>"
107>
108
109<!ENTITY dpkg-scansources "<citerefentry>
110 <refentrytitle><command>dpkg-scansources</command></refentrytitle>
111 <manvolnum>1</manvolnum>
112 </citerefentry>"
113>
114
115<!ENTITY dselect "<citerefentry>
116 <refentrytitle><command>dselect</command></refentrytitle>
117 <manvolnum>1</manvolnum>
118 </citerefentry>"
119>
120
121<!ENTITY aptitude "<citerefentry>
122 <refentrytitle><command>aptitude</command></refentrytitle>
123 <manvolnum>8</manvolnum>
124 </citerefentry>"
125>
126
127<!ENTITY synaptic "<citerefentry>
128 <refentrytitle><command>synaptic</command></refentrytitle>
129 <manvolnum>8</manvolnum>
130 </citerefentry>"
131>
132
c08cf1dc
MV
133<!ENTITY squid-deb-proxy-client "<citerefentry>
134 <refentrytitle><command>squid-deb-proxy-client</command></refentrytitle>
135 <manvolnum>1</manvolnum>
136 </citerefentry>"
137>
138
0c1a7101
DK
139<!ENTITY debsign "<citerefentry>
140 <refentrytitle><command>debsign</command></refentrytitle>
141 <manvolnum>1</manvolnum>
142 </citerefentry>"
143>
144
145<!ENTITY debsig-verify "<citerefentry>
146 <refentrytitle><command>debsig-verify</command></refentrytitle>
147 <manvolnum>1</manvolnum>
148 </citerefentry>"
149>
150
151<!ENTITY gpg "<citerefentry>
152 <refentrytitle><command>gpg</command></refentrytitle>
153 <manvolnum>1</manvolnum>
154 </citerefentry>"
155>
156
157<!ENTITY wajig "<citerefentry>
158 <refentrytitle><command>wajig</command></refentrytitle>
159 <manvolnum>1</manvolnum>
160 </citerefentry>"
161>
162
00c6e1a3
MV
163<!ENTITY wget "<citerefentry>
164 <refentrytitle><command>wget</command></refentrytitle>
165 <manvolnum>1</manvolnum>
166 </citerefentry>"
167>
168
aec22160
DK
169<!ENTITY apt-transport-debtorrent "<citerefentry>
170 <refentrytitle><package>apt-transport-debtorrent</package></refentrytitle>
171 <manvolnum>1</manvolnum>
172 </citerefentry>"
173>
174
175<!ENTITY regex "<citerefentry>
176 <refentrytitle><abbrev>regex</abbrev></refentrytitle>
177 <manvolnum>7</manvolnum>
178 </citerefentry>"
179>
180
44477002
JR
181<!ENTITY glob "<citerefentry>
182 <refentrytitle><abbrev>glob</abbrev></refentrytitle>
183 <manvolnum>7</manvolnum>
184 </citerefentry>"
185>
186
0c1a7101
DK
187<!-- Boiler plate docinfo section -->
188<!ENTITY apt-email "
189 <address>
190 <email>apt@packages.debian.org</email>
191 </address>
192">
193
194<!ENTITY apt-author.jgunthorpe "
195 <author>
196 <firstname>Jason</firstname>
197 <surname>Gunthorpe</surname>
198 <contrib></contrib>
199 </author>
200">
201
202<!ENTITY apt-author.moconnor "
203 <author>
204 <firstname>Mike</firstname>
205 <surname>O'Connor</surname>
206 <contrib></contrib>
207 </author>
208">
209
d5aa88bf
DK
210<!ENTITY apt-name.dburrows "
211 <firstname>Daniel</firstname>
212 <surname>Burrows</surname>
d5aa88bf
DK
213">
214
0c1a7101
DK
215<!ENTITY apt-copyright "
216 <copyright>
217 <holder>Jason Gunthorpe</holder>
218 <year>1998-2001</year>
219 </copyright>
220">
221
222<!ENTITY apt-product "
aa9de3cd
DK
223 <productname>APT</productname>
224 <releaseinfo role='version'>&apt-product-version;</releaseinfo>
0c1a7101
DK
225">
226
aa9de3cd 227<!-- this will be updated by 'prepare-release' -->
ae37ab01 228<!ENTITY apt-product-version "1.0.9.8">
aa9de3cd 229
eef71f11 230<!-- (Code)names for various things used all over the place -->
d94082d5
DK
231<!ENTITY oldstable-codename "wheezy">
232<!ENTITY stable-codename "jessie">
233<!ENTITY testing-codename "stretch">
234<!ENTITY stable-version "8">
6de58cbf 235<!ENTITY ubuntu-codename "trusty">
6e8b4572 236
75d9bdba
JR
237<!-- good and bad just refers to matching and not matching a pattern…
238 It is not a remark about the specific perl version.
239 There is no way perl could be clasified "good" (or "bad") in any version… -->
240<!ENTITY good-perl "5.10">
241<!ENTITY bad-perl "5.14">
6e8b4572
DK
242
243<!-- Arguments -->
244<!ENTITY synopsis-arg-option "<arg><option>-o=<replaceable>&synopsis-config-string;</replaceable></option></arg>">
245<!ENTITY synopsis-arg-config "<arg><option>-c=<filename><replaceable>&synopsis-config-file;</replaceable></filename></option></arg>">
246<!ENTITY synopsis-arg-target-release "<arg><option>-t=<replaceable>&synopsis-target-release;</replaceable></option></arg>">
247<!ENTITY synopsis-arg-architecture "<arg><option>-a=<replaceable>&synopsis-architecture;</replaceable></option></arg>">
248<!ENTITY synopsis-arg-pkgver "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable><arg><group choice='req'>
249 <arg choice='plain'>=<replaceable>&synopsis-pkg-ver-number;</replaceable></arg>
250 <arg choice='plain'>/<replaceable>&synopsis-target-release;</replaceable></arg>
251</group></arg></arg>">
252<!ENTITY synopsis-arg-pkg "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>">
253<!ENTITY synopsis-param-filename "<filename><replaceable>&synopsis-filename;</replaceable></filename>">
254<!ENTITY synopsis-help "<arg choice='plain'><group choice='req'><arg choice='plain'>-v</arg><arg choice='plain'>--version</arg></group></arg>
255 <arg choice='plain'><group choice='req'><arg choice='plain'>-h</arg><arg choice='plain'>--help</arg></group></arg>">
81d18368
MV
256<!ENTITY synopsis-command-apt "<refsynopsisdiv><cmdsynopsis>
257 <command>apt</command>
258 <arg><option>-h</option></arg>
259 &synopsis-arg-option;
260 &synopsis-arg-config;
261 &synopsis-arg-target-release;
262 &synopsis-arg-architecture;
263 <group choice='req'>
264 <arg choice='plain'>list</arg>
265 <arg choice='plain'>search</arg>
266 <arg choice='plain'>show</arg>
267 <arg choice='plain'>update</arg>
81d18368
MV
268 <arg choice='plain'>install &synopsis-arg-pkgver;</arg>
269 <arg choice='plain'>remove &synopsis-arg-pkg;</arg>
9a591666
MV
270 <arg choice='plain'>upgrade</arg>
271 <arg choice='plain'>full-upgrade</arg>
272 <arg choice='plain'>edit-sources</arg>
81d18368
MV
273 &synopsis-help;
274 </group>
275</cmdsynopsis></refsynopsisdiv>">
6e8b4572
DK
276<!ENTITY synopsis-command-apt-get "<refsynopsisdiv><cmdsynopsis>
277 <command>apt-get</command>
278 <arg><option>-asqdyfmubV</option></arg>
279 &synopsis-arg-option;
280 &synopsis-arg-config;
281 &synopsis-arg-target-release;
282 &synopsis-arg-architecture;
283 <group choice='req'>
284 <arg choice='plain'>update</arg>
285 <arg choice='plain'>upgrade</arg>
286 <arg choice='plain'>dselect-upgrade</arg>
287 <arg choice='plain'>dist-upgrade</arg>
288 <arg choice='plain'>install &synopsis-arg-pkgver;</arg>
289 <arg choice='plain'>remove &synopsis-arg-pkg;</arg>
290 <arg choice='plain'>purge &synopsis-arg-pkg;</arg>
291 <arg choice='plain'>source &synopsis-arg-pkgver;</arg>
292 <arg choice='plain'>build-dep &synopsis-arg-pkgver;</arg>
293 <arg choice='plain'>download &synopsis-arg-pkgver;</arg>
294 <arg choice='plain'>check</arg>
295 <arg choice='plain'>clean</arg>
296 <arg choice='plain'>autoclean</arg>
297 <arg choice='plain'>autoremove</arg>
298 &synopsis-help;
299 </group>
300</cmdsynopsis></refsynopsisdiv>">
301<!ENTITY synopsis-command-apt-cache "<refsynopsisdiv><cmdsynopsis>
302 <command>apt-cache</command>
303 <arg><option>-agipns</option></arg>
304 &synopsis-arg-option;
305 &synopsis-arg-config;
306 <group choice='req'>
307 <arg choice='plain'>gencaches</arg>
308 <arg choice='plain'>showpkg &synopsis-arg-pkg;</arg>
309 <arg choice='plain'>showsrc &synopsis-arg-pkg;</arg>
310 <arg choice='plain'>stats</arg>
311 <arg choice='plain'>dump</arg>
312 <arg choice='plain'>dumpavail</arg>
313 <arg choice='plain'>unmet</arg>
314 <arg choice='plain'>search <arg choice='plain' rep='repeat'><replaceable>&synopsis-regex;</replaceable></arg></arg>
315 <arg choice='plain'>show &synopsis-arg-pkgver;</arg>
316 <arg choice='plain'>depends &synopsis-arg-pkgver;</arg>
317 <arg choice='plain'>rdepends &synopsis-arg-pkgver;</arg>
c086ac18 318 <arg choice='plain'>pkgnames <arg><replaceable>&synopsis-prefix;</replaceable></arg></arg>
6e8b4572
DK
319 <arg choice='plain'>dotty &synopsis-arg-pkgver;</arg>
320 <arg choice='plain'>xvcg &synopsis-arg-pkgver;</arg>
c086ac18 321 <arg choice='plain'>policy <arg rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg></arg>
6e8b4572
DK
322 <arg choice='plain'>madison &synopsis-arg-pkg;</arg>
323 &synopsis-help;
324 </group>
325</cmdsynopsis></refsynopsisdiv>">
326<!ENTITY synopsis-command-apt-cdrom "<refsynopsisdiv><cmdsynopsis>
327 <command>apt-cdrom</command>
328 <arg><option>-rmfan</option></arg>
329 <arg><option>-d=<replaceable>&synopsis-cdrom-mount;</replaceable></option></arg>
330 &synopsis-arg-option;
331 &synopsis-arg-config;
332 <group choice='req'>
333 <arg choice='plain'>add</arg>
334 <arg choice='plain'>ident</arg>
335 &synopsis-help;
336 </group>
337</cmdsynopsis></refsynopsisdiv>">
a8813606 338<!--<arg><option>- -format '<replaceable>&#37;f \"&#37;v\";&#37;n</replaceable>'</option></arg>-->
6e8b4572
DK
339<!ENTITY synopsis-command-apt-config "<refsynopsisdiv><cmdsynopsis>
340 <command>apt-config</command>
a8813606
DK
341 <arg><option>--empty</option></arg>
342 <arg><option>--format '<replaceable>&percnt;f &#x0022;&percnt;v&#x0022;;&percnt;n</replaceable>'</option></arg>
6e8b4572
DK
343 &synopsis-arg-option;
344 &synopsis-arg-config;
345 <group choice='req'>
346 <arg choice='plain'>shell</arg>
347 <arg choice='plain'>dump</arg>
348 &synopsis-help;
349 </group>
350</cmdsynopsis></refsynopsisdiv>">
351<!ENTITY synopsis-command-apt-extracttemplates "<refsynopsisdiv><cmdsynopsis>
352 <command>apt-extracttemplates</command>
353 <arg><option>-t=<replaceable>&synopsis-tmp-directory;</replaceable></option></arg>
354 <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
355 &synopsis-help;
356</cmdsynopsis></refsynopsisdiv>">
357<!ENTITY synopsis-arg-ftparchive "<arg choice='plain' rep='repeat'><replaceable>&synopsis-path;</replaceable></arg><arg><filename><replaceable>&synopsis-override;</replaceable></filename><arg><replaceable>&synopsis-pathprefix;</replaceable></arg></arg>">
358<!ENTITY synopsis-command-apt-ftparchive "<refsynopsisdiv><cmdsynopsis>
359 <command>apt-ftparchive</command>
360 <arg><option>-dsq</option></arg>
361 <arg><option>--md5</option></arg>
362 <arg><option>--delink</option></arg>
363 <arg><option>--readonly</option></arg>
364 <arg><option>--contents</option></arg>
365 <arg><option>--arch <replaceable>architecture</replaceable></option></arg>
366 &synopsis-arg-option;
367 &synopsis-arg-config;
368 <group choice='req'>
369 <arg choice='plain'>packages &synopsis-arg-ftparchive;</arg>
370 <arg choice='plain'>sources &synopsis-arg-ftparchive;</arg>
371 <arg choice='plain'>contents <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
372 <arg choice='plain'>release <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
373 <arg choice='plain'>generate <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg> <arg choice='plain' rep='repeat'><replaceable>&synopsis-section;</replaceable></arg></arg>
374 <arg choice='plain'>clean <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg></arg>
375 &synopsis-help;
376 </group>
377</cmdsynopsis></refsynopsisdiv>">
378<!ENTITY synopsis-param-keyid "<replaceable>&synopsis-keyid;</replaceable>">
379<!ENTITY synopsis-command-apt-key "<refsynopsisdiv><cmdsynopsis>
380 <command>apt-key</command>
381 <arg><option>--keyring &synopsis-param-filename;</option></arg>
382 <group choice='req'>
383 <arg choice='plain'>add &synopsis-param-filename;</arg>
384 <arg choice='plain'>del &synopsis-param-keyid;</arg>
385 <arg choice='plain'>export &synopsis-param-keyid;</arg>
386 <arg choice='plain'>exportall</arg>
387 <arg choice='plain'>list</arg>
388 <arg choice='plain'>finger</arg>
389 <arg choice='plain'>adv</arg>
390 <arg choice='plain'>update</arg>
391 <arg choice='plain'>net-update</arg>
392 &synopsis-help;
393 </group>
394</cmdsynopsis></refsynopsisdiv>">
395<!ENTITY synopsis-command-apt-mark "<refsynopsisdiv><cmdsynopsis>
396 <command>apt-mark</command>
397 <arg><option>-f=&synopsis-param-filename;</option></arg>
398 <group choice='plain'>
399 <arg choice='plain'>
400 <group choice='req'>
401 <arg choice='plain'>auto</arg>
402 <arg choice='plain'>manual</arg>
403 <arg choice='plain'>showauto</arg>
404 <arg choice='plain'>showmanual</arg>
405 </group>
406 &synopsis-arg-pkg;
407 </arg>
408 &synopsis-help;
409 </group>
410</cmdsynopsis></refsynopsisdiv>">
411<!ENTITY synopsis-command-apt-sortpkgs "<refsynopsisdiv><cmdsynopsis>
412 <command>apt-sortpkgs</command>
413 <arg><option>-s</option></arg>
414 &synopsis-arg-option;
415 &synopsis-arg-config;
416 <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
417 &synopsis-help;
418</cmdsynopsis></refsynopsisdiv>">