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