]> git.saurik.com Git - apt.git/blob - doc/apt-verbatim.ent
edsp: optionally store a compressed copy of the last scenario
[apt.git] / doc / apt-verbatim.ent
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
42 <!ENTITY apt-mark "<citerefentry>
43 <refentrytitle><command>apt-mark</command></refentrytitle>
44 <manvolnum>8</manvolnum>
45 </citerefentry>"
46 >
47
48 <!ENTITY apt "<citerefentry>
49 <refentrytitle><command>apt</command></refentrytitle>
50 <manvolnum>8</manvolnum>
51 </citerefentry>"
52 >
53
54 <!ENTITY apt-preferences "<citerefentry>
55 <refentrytitle><filename>apt_preferences</filename></refentrytitle>
56 <manvolnum>5</manvolnum>
57 </citerefentry>"
58 >
59
60 <!ENTITY apt-key "<citerefentry>
61 <refentrytitle><command>apt-key</command></refentrytitle>
62 <manvolnum>8</manvolnum>
63 </citerefentry>"
64 >
65
66 <!ENTITY apt-secure "<citerefentry>
67 <refentrytitle>apt-secure</refentrytitle>
68 <manvolnum>8</manvolnum>
69 </citerefentry>"
70 >
71
72 <!ENTITY apt-ftparchive "<citerefentry>
73 <refentrytitle><command>apt-ftparchive</command></refentrytitle>
74 <manvolnum>1</manvolnum>
75 </citerefentry>"
76 >
77
78
79 <!ENTITY sources-list "<citerefentry>
80 <refentrytitle><filename>sources.list</filename></refentrytitle>
81 <manvolnum>5</manvolnum>
82 </citerefentry>"
83 >
84
85 <!ENTITY reportbug "<citerefentry>
86 <refentrytitle><command>reportbug</command></refentrytitle>
87 <manvolnum>1</manvolnum>
88 </citerefentry>"
89 >
90
91 <!ENTITY dpkg "<citerefentry>
92 <refentrytitle><command>dpkg</command></refentrytitle>
93 <manvolnum>1</manvolnum>
94 </citerefentry>"
95 >
96
97 <!ENTITY dpkg-buildpackage "<citerefentry>
98 <refentrytitle><command>dpkg-buildpackage</command></refentrytitle>
99 <manvolnum>1</manvolnum>
100 </citerefentry>"
101 >
102
103 <!ENTITY gzip "<citerefentry>
104 <refentrytitle><command>gzip</command></refentrytitle>
105 <manvolnum>1</manvolnum>
106 </citerefentry>"
107 >
108
109 <!ENTITY dpkg-scanpackages "<citerefentry>
110 <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
111 <manvolnum>1</manvolnum>
112 </citerefentry>"
113 >
114
115 <!ENTITY dpkg-scansources "<citerefentry>
116 <refentrytitle><command>dpkg-scansources</command></refentrytitle>
117 <manvolnum>1</manvolnum>
118 </citerefentry>"
119 >
120
121 <!ENTITY dselect "<citerefentry>
122 <refentrytitle><command>dselect</command></refentrytitle>
123 <manvolnum>1</manvolnum>
124 </citerefentry>"
125 >
126
127 <!ENTITY aptitude "<citerefentry>
128 <refentrytitle><command>aptitude</command></refentrytitle>
129 <manvolnum>8</manvolnum>
130 </citerefentry>"
131 >
132
133 <!ENTITY synaptic "<citerefentry>
134 <refentrytitle><command>synaptic</command></refentrytitle>
135 <manvolnum>8</manvolnum>
136 </citerefentry>"
137 >
138
139 <!ENTITY squid-deb-proxy-client "<citerefentry>
140 <refentrytitle><command>squid-deb-proxy-client</command></refentrytitle>
141 <manvolnum>1</manvolnum>
142 </citerefentry>"
143 >
144
145 <!ENTITY debsign "<citerefentry>
146 <refentrytitle><command>debsign</command></refentrytitle>
147 <manvolnum>1</manvolnum>
148 </citerefentry>"
149 >
150
151 <!ENTITY debsig-verify "<citerefentry>
152 <refentrytitle><command>debsig-verify</command></refentrytitle>
153 <manvolnum>1</manvolnum>
154 </citerefentry>"
155 >
156
157 <!ENTITY gpg "<citerefentry>
158 <refentrytitle><command>gpg</command></refentrytitle>
159 <manvolnum>1</manvolnum>
160 </citerefentry>"
161 >
162
163 <!ENTITY wajig "<citerefentry>
164 <refentrytitle><command>wajig</command></refentrytitle>
165 <manvolnum>1</manvolnum>
166 </citerefentry>"
167 >
168
169 <!ENTITY wget "<citerefentry>
170 <refentrytitle><command>wget</command></refentrytitle>
171 <manvolnum>1</manvolnum>
172 </citerefentry>"
173 >
174
175 <!ENTITY apt-transport-debtorrent "<citerefentry>
176 <refentrytitle><package>apt-transport-debtorrent</package></refentrytitle>
177 <manvolnum>1</manvolnum>
178 </citerefentry>"
179 >
180
181 <!ENTITY regex "<citerefentry>
182 <refentrytitle><abbrev>regex</abbrev></refentrytitle>
183 <manvolnum>7</manvolnum>
184 </citerefentry>"
185 >
186
187 <!ENTITY glob "<citerefentry>
188 <refentrytitle><abbrev>glob</abbrev></refentrytitle>
189 <manvolnum>7</manvolnum>
190 </citerefentry>"
191 >
192
193 <!ENTITY apt-file "<citerefentry>
194 <refentrytitle><command>apt-file</command></refentrytitle>
195 <manvolnum>1</manvolnum>
196 </citerefentry>"
197 >
198
199 <!ENTITY apt-acquire-additional-files "<literal><filename>/usr/share/doc/apt-doc/acquire-additional-files.txt</filename></literal>">
200
201 <!-- Boiler plate docinfo section -->
202 <!ENTITY apt-email "
203 <address>
204 <email>apt@packages.debian.org</email>
205 </address>
206 ">
207
208 <!ENTITY apt-author.jgunthorpe "
209 <author>
210 <firstname>Jason</firstname>
211 <surname>Gunthorpe</surname>
212 <contrib></contrib>
213 </author>
214 ">
215
216 <!ENTITY apt-author.moconnor "
217 <author>
218 <firstname>Mike</firstname>
219 <surname>O'Connor</surname>
220 <contrib></contrib>
221 </author>
222 ">
223
224 <!ENTITY apt-name.dburrows "
225 <firstname>Daniel</firstname>
226 <surname>Burrows</surname>
227 ">
228
229 <!ENTITY apt-copyright "
230 <copyright>
231 <holder>Jason Gunthorpe</holder>
232 <year>1998-2001</year>
233 </copyright>
234 ">
235
236 <!ENTITY apt-product "
237 <productname>APT</productname>
238 <releaseinfo role='version'>&apt-product-version;</releaseinfo>
239 ">
240
241 <!-- this will be updated by 'prepare-release' -->
242 <!ENTITY apt-product-version "1.3~exp1">
243
244 <!-- (Code)names for various things used all over the place -->
245 <!ENTITY debian-oldstable-codename "wheezy">
246 <!ENTITY debian-stable-codename "jessie">
247 <!ENTITY debian-testing-codename "stretch">
248 <!ENTITY debian-stable-version "8">
249 <!ENTITY ubuntu-codename "trusty">
250
251 <!-- good and bad just refers to matching and not matching a pattern…
252 It is not a remark about the specific perl version.
253 There is no way perl could be clasified "good" (or "bad") in any version… -->
254 <!ENTITY good-perl "5.10">
255 <!ENTITY bad-perl "5.14">
256
257 <!-- Arguments -->
258 <!ENTITY synopsis-arg-option "<arg><option>-o=<replaceable>&synopsis-config-string;</replaceable></option></arg>">
259 <!ENTITY synopsis-arg-config "<arg><option>-c=<filename><replaceable>&synopsis-config-file;</replaceable></filename></option></arg>">
260 <!ENTITY synopsis-arg-target-release "<arg><option>-t=<replaceable>&synopsis-target-release;</replaceable></option></arg>">
261 <!ENTITY synopsis-arg-architecture "<arg><option>-a=<replaceable>&synopsis-architecture;</replaceable></option></arg>">
262 <!ENTITY synopsis-arg-pkgver "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable><arg><group choice='req'>
263 <arg choice='plain'>=<replaceable>&synopsis-pkg-ver-number;</replaceable></arg>
264 <arg choice='plain'>/<replaceable>&synopsis-target-release;</replaceable></arg>
265 </group></arg></arg>">
266 <!ENTITY synopsis-arg-pkg "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>">
267 <!ENTITY synopsis-param-filename "<filename><replaceable>&synopsis-filename;</replaceable></filename>">
268 <!ENTITY synopsis-help "<arg choice='plain'><group choice='req'><arg choice='plain'>-v</arg><arg choice='plain'>--version</arg></group></arg>
269 <arg choice='plain'><group choice='req'><arg choice='plain'>-h</arg><arg choice='plain'>--help</arg></group></arg>">
270 <!ENTITY synopsis-command-apt "<refsynopsisdiv><cmdsynopsis>
271 <command>apt</command>
272 <arg><option>-h</option></arg>
273 &synopsis-arg-option;
274 &synopsis-arg-config;
275 &synopsis-arg-target-release;
276 &synopsis-arg-architecture;
277 <group choice='req'>
278 <arg choice='plain'>list</arg>
279 <arg choice='plain'>search</arg>
280 <arg choice='plain'>show</arg>
281 <arg choice='plain'>update</arg>
282 <arg choice='plain'>install &synopsis-arg-pkgver;</arg>
283 <arg choice='plain'>remove &synopsis-arg-pkg;</arg>
284 <arg choice='plain'>upgrade</arg>
285 <arg choice='plain'>full-upgrade</arg>
286 <arg choice='plain'>edit-sources</arg>
287 &synopsis-help;
288 </group>
289 </cmdsynopsis></refsynopsisdiv>">
290 <!ENTITY synopsis-command-apt-get "<refsynopsisdiv><cmdsynopsis>
291 <command>apt-get</command>
292 <arg><option>-asqdyfmubV</option></arg>
293 &synopsis-arg-option;
294 &synopsis-arg-config;
295 &synopsis-arg-target-release;
296 &synopsis-arg-architecture;
297 <group choice='req'>
298 <arg choice='plain'>update</arg>
299 <arg choice='plain'>upgrade</arg>
300 <arg choice='plain'>dselect-upgrade</arg>
301 <arg choice='plain'>dist-upgrade</arg>
302 <arg choice='plain'>install &synopsis-arg-pkgver;</arg>
303 <arg choice='plain'>remove &synopsis-arg-pkg;</arg>
304 <arg choice='plain'>purge &synopsis-arg-pkg;</arg>
305 <arg choice='plain'>source &synopsis-arg-pkgver;</arg>
306 <arg choice='plain'>build-dep &synopsis-arg-pkgver;</arg>
307 <arg choice='plain'>download &synopsis-arg-pkgver;</arg>
308 <arg choice='plain'>check</arg>
309 <arg choice='plain'>clean</arg>
310 <arg choice='plain'>autoclean</arg>
311 <arg choice='plain'>autoremove</arg>
312 &synopsis-help;
313 </group>
314 </cmdsynopsis></refsynopsisdiv>">
315 <!ENTITY synopsis-command-apt-cache "<refsynopsisdiv><cmdsynopsis>
316 <command>apt-cache</command>
317 <arg><option>-agipns</option></arg>
318 &synopsis-arg-option;
319 &synopsis-arg-config;
320 <group choice='req'>
321 <arg choice='plain'>gencaches</arg>
322 <arg choice='plain'>showpkg &synopsis-arg-pkg;</arg>
323 <arg choice='plain'>showsrc &synopsis-arg-pkg;</arg>
324 <arg choice='plain'>stats</arg>
325 <arg choice='plain'>dump</arg>
326 <arg choice='plain'>dumpavail</arg>
327 <arg choice='plain'>unmet</arg>
328 <arg choice='plain'>search <arg choice='plain' rep='repeat'><replaceable>&synopsis-regex;</replaceable></arg></arg>
329 <arg choice='plain'>show &synopsis-arg-pkgver;</arg>
330 <arg choice='plain'>depends &synopsis-arg-pkgver;</arg>
331 <arg choice='plain'>rdepends &synopsis-arg-pkgver;</arg>
332 <arg choice='plain'>pkgnames <arg><replaceable>&synopsis-prefix;</replaceable></arg></arg>
333 <arg choice='plain'>dotty &synopsis-arg-pkgver;</arg>
334 <arg choice='plain'>xvcg &synopsis-arg-pkgver;</arg>
335 <arg choice='plain'>policy <arg rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg></arg>
336 <arg choice='plain'>madison &synopsis-arg-pkg;</arg>
337 &synopsis-help;
338 </group>
339 </cmdsynopsis></refsynopsisdiv>">
340 <!ENTITY synopsis-command-apt-cdrom "<refsynopsisdiv><cmdsynopsis>
341 <command>apt-cdrom</command>
342 <arg><option>-rmfan</option></arg>
343 <arg><option>-d=<replaceable>&synopsis-cdrom-mount;</replaceable></option></arg>
344 &synopsis-arg-option;
345 &synopsis-arg-config;
346 <group choice='req'>
347 <arg choice='plain'>add</arg>
348 <arg choice='plain'>ident</arg>
349 &synopsis-help;
350 </group>
351 </cmdsynopsis></refsynopsisdiv>">
352 <!--<arg><option>- -format '<replaceable>&#37;f \"&#37;v\";&#37;n</replaceable>'</option></arg>-->
353 <!ENTITY synopsis-command-apt-config "<refsynopsisdiv><cmdsynopsis>
354 <command>apt-config</command>
355 <arg><option>--empty</option></arg>
356 <arg><option>--format '<replaceable>&percnt;f &#x0022;&percnt;v&#x0022;;&percnt;n</replaceable>'</option></arg>
357 &synopsis-arg-option;
358 &synopsis-arg-config;
359 <group choice='req'>
360 <arg choice='plain'>shell</arg>
361 <arg choice='plain'>dump</arg>
362 &synopsis-help;
363 </group>
364 </cmdsynopsis></refsynopsisdiv>">
365 <!ENTITY synopsis-command-apt-extracttemplates "<refsynopsisdiv><cmdsynopsis>
366 <command>apt-extracttemplates</command>
367 <arg><option>-t=<replaceable>&synopsis-tmp-directory;</replaceable></option></arg>
368 <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
369 &synopsis-help;
370 </cmdsynopsis></refsynopsisdiv>">
371 <!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>">
372 <!ENTITY synopsis-command-apt-ftparchive "<refsynopsisdiv><cmdsynopsis>
373 <command>apt-ftparchive</command>
374 <arg><option>-dsq</option></arg>
375 <arg><option>--md5</option></arg>
376 <arg><option>--delink</option></arg>
377 <arg><option>--readonly</option></arg>
378 <arg><option>--contents</option></arg>
379 <arg><option>--arch <replaceable>architecture</replaceable></option></arg>
380 &synopsis-arg-option;
381 &synopsis-arg-config;
382 <group choice='req'>
383 <arg choice='plain'>packages &synopsis-arg-ftparchive;</arg>
384 <arg choice='plain'>sources &synopsis-arg-ftparchive;</arg>
385 <arg choice='plain'>contents <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
386 <arg choice='plain'>release <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
387 <arg choice='plain'>generate <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg> <arg choice='plain' rep='repeat'><replaceable>&synopsis-section;</replaceable></arg></arg>
388 <arg choice='plain'>clean <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg></arg>
389 &synopsis-help;
390 </group>
391 </cmdsynopsis></refsynopsisdiv>">
392 <!ENTITY synopsis-param-keyid "<replaceable>&synopsis-keyid;</replaceable>">
393 <!ENTITY synopsis-command-apt-key "<refsynopsisdiv><cmdsynopsis>
394 <command>apt-key</command>
395 <arg><option>--keyring &synopsis-param-filename;</option></arg>
396 <group choice='req'>
397 <arg choice='plain'>add &synopsis-param-filename;</arg>
398 <arg choice='plain'>del &synopsis-param-keyid;</arg>
399 <arg choice='plain'>export &synopsis-param-keyid;</arg>
400 <arg choice='plain'>exportall</arg>
401 <arg choice='plain'>list</arg>
402 <arg choice='plain'>finger</arg>
403 <arg choice='plain'>adv</arg>
404 <arg choice='plain'>update</arg>
405 <arg choice='plain'>net-update</arg>
406 &synopsis-help;
407 </group>
408 </cmdsynopsis></refsynopsisdiv>">
409 <!ENTITY synopsis-command-apt-mark "<refsynopsisdiv><cmdsynopsis>
410 <command>apt-mark</command>
411 <group choice='plain'>
412 <group choice='req'>
413 <arg choice='plain'><option>-f=&synopsis-param-filename;</option></arg>
414 <arg choice='plain'>
415 <group choice='req'>
416 <arg choice='plain'>auto</arg>
417 <arg choice='plain'>manual</arg>
418 </group>
419 &synopsis-arg-pkg;
420 </arg>
421 <arg choice='plain'>
422 <group choice='req'>
423 <arg choice='plain'>showauto</arg>
424 <arg choice='plain'>showmanual</arg>
425 </group>
426 <arg choice='opt' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>
427 </arg>
428 </group>
429 &synopsis-help;
430 </group>
431 </cmdsynopsis><cmdsynopsis><command>apt-mark</command>
432 <group choice='plain'>
433 <arg choice='plain'>
434 <group choice='req'>
435 <arg choice='plain'>hold</arg>
436 <arg choice='plain'>unhold</arg>
437 <arg choice='plain'>install</arg>
438 <arg choice='plain'>remove</arg>
439 <arg choice='plain'>purge</arg>
440 </group>
441 &synopsis-arg-pkg;
442 </arg>
443 <arg choice='plain'>
444 <group choice='req'>
445 <arg choice='plain'>showhold</arg>
446 <arg choice='plain'>showinstall</arg>
447 <arg choice='plain'>showremove</arg>
448 <arg choice='plain'>showpurge</arg>
449 </group>
450 <arg choice='opt' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>
451 </arg>
452 </group>
453 </cmdsynopsis></refsynopsisdiv>">
454 <!ENTITY synopsis-command-apt-sortpkgs "<refsynopsisdiv><cmdsynopsis>
455 <command>apt-sortpkgs</command>
456 <arg><option>-s</option></arg>
457 &synopsis-arg-option;
458 &synopsis-arg-config;
459 <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
460 &synopsis-help;
461 </cmdsynopsis></refsynopsisdiv>">