]> git.saurik.com Git - apt.git/blame - doc/apt-verbatim.ent
merged from the debian-sid branch
[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
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 debsign "<citerefentry>
128 <refentrytitle><command>debsign</command></refentrytitle>
129 <manvolnum>1</manvolnum>
130 </citerefentry>"
131>
132
133<!ENTITY debsig-verify "<citerefentry>
134 <refentrytitle><command>debsig-verify</command></refentrytitle>
135 <manvolnum>1</manvolnum>
136 </citerefentry>"
137>
138
139<!ENTITY gpg "<citerefentry>
140 <refentrytitle><command>gpg</command></refentrytitle>
141 <manvolnum>1</manvolnum>
142 </citerefentry>"
143>
144
145<!ENTITY wajig "<citerefentry>
146 <refentrytitle><command>wajig</command></refentrytitle>
147 <manvolnum>1</manvolnum>
148 </citerefentry>"
149>
150
00c6e1a3
MV
151<!ENTITY wget "<citerefentry>
152 <refentrytitle><command>wget</command></refentrytitle>
153 <manvolnum>1</manvolnum>
154 </citerefentry>"
155>
156
aec22160
DK
157<!ENTITY apt-transport-debtorrent "<citerefentry>
158 <refentrytitle><package>apt-transport-debtorrent</package></refentrytitle>
159 <manvolnum>1</manvolnum>
160 </citerefentry>"
161>
162
163<!ENTITY regex "<citerefentry>
164 <refentrytitle><abbrev>regex</abbrev></refentrytitle>
165 <manvolnum>7</manvolnum>
166 </citerefentry>"
167>
168
44477002
JR
169<!ENTITY glob "<citerefentry>
170 <refentrytitle><abbrev>glob</abbrev></refentrytitle>
171 <manvolnum>7</manvolnum>
172 </citerefentry>"
173>
174
0c1a7101
DK
175<!-- Boiler plate docinfo section -->
176<!ENTITY apt-email "
177 <address>
178 <email>apt@packages.debian.org</email>
179 </address>
180">
181
182<!ENTITY apt-author.jgunthorpe "
183 <author>
184 <firstname>Jason</firstname>
185 <surname>Gunthorpe</surname>
186 <contrib></contrib>
187 </author>
188">
189
190<!ENTITY apt-author.moconnor "
191 <author>
192 <firstname>Mike</firstname>
193 <surname>O'Connor</surname>
194 <contrib></contrib>
195 </author>
196">
197
d5aa88bf
DK
198<!ENTITY apt-name.dburrows "
199 <firstname>Daniel</firstname>
200 <surname>Burrows</surname>
d5aa88bf
DK
201">
202
0c1a7101
DK
203<!ENTITY apt-copyright "
204 <copyright>
205 <holder>Jason Gunthorpe</holder>
206 <year>1998-2001</year>
207 </copyright>
208">
209
210<!ENTITY apt-product "
aa9de3cd
DK
211 <productname>APT</productname>
212 <releaseinfo role='version'>&apt-product-version;</releaseinfo>
0c1a7101
DK
213">
214
aa9de3cd 215<!-- this will be updated by 'prepare-release' -->
ee5505af 216<!ENTITY apt-product-version "0.9.7.7">
aa9de3cd 217
0c1a7101 218<!-- Codenames for debian releases -->
9bcfc818
DK
219<!ENTITY oldstable-codename "squeeze">
220<!ENTITY stable-codename "wheezy">
221<!ENTITY testing-codename "jessie">
222<!ENTITY stable-version "7.0">
44477002 223<!ENTITY ubuntu-codename "precise">
6e8b4572 224
75d9bdba
JR
225<!-- good and bad just refers to matching and not matching a pattern…
226 It is not a remark about the specific perl version.
227 There is no way perl could be clasified "good" (or "bad") in any version… -->
228<!ENTITY good-perl "5.10">
229<!ENTITY bad-perl "5.14">
6e8b4572
DK
230
231<!-- Arguments -->
232<!ENTITY synopsis-arg-option "<arg><option>-o=<replaceable>&synopsis-config-string;</replaceable></option></arg>">
233<!ENTITY synopsis-arg-config "<arg><option>-c=<filename><replaceable>&synopsis-config-file;</replaceable></filename></option></arg>">
234<!ENTITY synopsis-arg-target-release "<arg><option>-t=<replaceable>&synopsis-target-release;</replaceable></option></arg>">
235<!ENTITY synopsis-arg-architecture "<arg><option>-a=<replaceable>&synopsis-architecture;</replaceable></option></arg>">
236<!ENTITY synopsis-arg-pkgver "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable><arg><group choice='req'>
237 <arg choice='plain'>=<replaceable>&synopsis-pkg-ver-number;</replaceable></arg>
238 <arg choice='plain'>/<replaceable>&synopsis-target-release;</replaceable></arg>
239</group></arg></arg>">
240<!ENTITY synopsis-arg-pkg "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>">
241<!ENTITY synopsis-param-filename "<filename><replaceable>&synopsis-filename;</replaceable></filename>">
242<!ENTITY synopsis-help "<arg choice='plain'><group choice='req'><arg choice='plain'>-v</arg><arg choice='plain'>--version</arg></group></arg>
243 <arg choice='plain'><group choice='req'><arg choice='plain'>-h</arg><arg choice='plain'>--help</arg></group></arg>">
244<!ENTITY synopsis-command-apt-get "<refsynopsisdiv><cmdsynopsis>
245 <command>apt-get</command>
246 <arg><option>-asqdyfmubV</option></arg>
247 &synopsis-arg-option;
248 &synopsis-arg-config;
249 &synopsis-arg-target-release;
250 &synopsis-arg-architecture;
251 <group choice='req'>
252 <arg choice='plain'>update</arg>
253 <arg choice='plain'>upgrade</arg>
254 <arg choice='plain'>dselect-upgrade</arg>
255 <arg choice='plain'>dist-upgrade</arg>
256 <arg choice='plain'>install &synopsis-arg-pkgver;</arg>
257 <arg choice='plain'>remove &synopsis-arg-pkg;</arg>
258 <arg choice='plain'>purge &synopsis-arg-pkg;</arg>
259 <arg choice='plain'>source &synopsis-arg-pkgver;</arg>
260 <arg choice='plain'>build-dep &synopsis-arg-pkgver;</arg>
261 <arg choice='plain'>download &synopsis-arg-pkgver;</arg>
262 <arg choice='plain'>check</arg>
263 <arg choice='plain'>clean</arg>
264 <arg choice='plain'>autoclean</arg>
265 <arg choice='plain'>autoremove</arg>
266 &synopsis-help;
267 </group>
268</cmdsynopsis></refsynopsisdiv>">
269<!ENTITY synopsis-command-apt-cache "<refsynopsisdiv><cmdsynopsis>
270 <command>apt-cache</command>
271 <arg><option>-agipns</option></arg>
272 &synopsis-arg-option;
273 &synopsis-arg-config;
274 <group choice='req'>
275 <arg choice='plain'>gencaches</arg>
276 <arg choice='plain'>showpkg &synopsis-arg-pkg;</arg>
277 <arg choice='plain'>showsrc &synopsis-arg-pkg;</arg>
278 <arg choice='plain'>stats</arg>
279 <arg choice='plain'>dump</arg>
280 <arg choice='plain'>dumpavail</arg>
281 <arg choice='plain'>unmet</arg>
282 <arg choice='plain'>search <arg choice='plain' rep='repeat'><replaceable>&synopsis-regex;</replaceable></arg></arg>
283 <arg choice='plain'>show &synopsis-arg-pkgver;</arg>
284 <arg choice='plain'>depends &synopsis-arg-pkgver;</arg>
285 <arg choice='plain'>rdepends &synopsis-arg-pkgver;</arg>
c086ac18 286 <arg choice='plain'>pkgnames <arg><replaceable>&synopsis-prefix;</replaceable></arg></arg>
6e8b4572
DK
287 <arg choice='plain'>dotty &synopsis-arg-pkgver;</arg>
288 <arg choice='plain'>xvcg &synopsis-arg-pkgver;</arg>
c086ac18 289 <arg choice='plain'>policy <arg rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg></arg>
6e8b4572
DK
290 <arg choice='plain'>madison &synopsis-arg-pkg;</arg>
291 &synopsis-help;
292 </group>
293</cmdsynopsis></refsynopsisdiv>">
294<!ENTITY synopsis-command-apt-cdrom "<refsynopsisdiv><cmdsynopsis>
295 <command>apt-cdrom</command>
296 <arg><option>-rmfan</option></arg>
297 <arg><option>-d=<replaceable>&synopsis-cdrom-mount;</replaceable></option></arg>
298 &synopsis-arg-option;
299 &synopsis-arg-config;
300 <group choice='req'>
301 <arg choice='plain'>add</arg>
302 <arg choice='plain'>ident</arg>
303 &synopsis-help;
304 </group>
305</cmdsynopsis></refsynopsisdiv>">
a8813606 306<!--<arg><option>- -format '<replaceable>&#37;f \"&#37;v\";&#37;n</replaceable>'</option></arg>-->
6e8b4572
DK
307<!ENTITY synopsis-command-apt-config "<refsynopsisdiv><cmdsynopsis>
308 <command>apt-config</command>
a8813606
DK
309 <arg><option>--empty</option></arg>
310 <arg><option>--format '<replaceable>&percnt;f &#x0022;&percnt;v&#x0022;;&percnt;n</replaceable>'</option></arg>
6e8b4572
DK
311 &synopsis-arg-option;
312 &synopsis-arg-config;
313 <group choice='req'>
314 <arg choice='plain'>shell</arg>
315 <arg choice='plain'>dump</arg>
316 &synopsis-help;
317 </group>
318</cmdsynopsis></refsynopsisdiv>">
319<!ENTITY synopsis-command-apt-extracttemplates "<refsynopsisdiv><cmdsynopsis>
320 <command>apt-extracttemplates</command>
321 <arg><option>-t=<replaceable>&synopsis-tmp-directory;</replaceable></option></arg>
322 <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
323 &synopsis-help;
324</cmdsynopsis></refsynopsisdiv>">
325<!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>">
326<!ENTITY synopsis-command-apt-ftparchive "<refsynopsisdiv><cmdsynopsis>
327 <command>apt-ftparchive</command>
328 <arg><option>-dsq</option></arg>
329 <arg><option>--md5</option></arg>
330 <arg><option>--delink</option></arg>
331 <arg><option>--readonly</option></arg>
332 <arg><option>--contents</option></arg>
333 <arg><option>--arch <replaceable>architecture</replaceable></option></arg>
334 &synopsis-arg-option;
335 &synopsis-arg-config;
336 <group choice='req'>
337 <arg choice='plain'>packages &synopsis-arg-ftparchive;</arg>
338 <arg choice='plain'>sources &synopsis-arg-ftparchive;</arg>
339 <arg choice='plain'>contents <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
340 <arg choice='plain'>release <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
341 <arg choice='plain'>generate <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg> <arg choice='plain' rep='repeat'><replaceable>&synopsis-section;</replaceable></arg></arg>
342 <arg choice='plain'>clean <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg></arg>
343 &synopsis-help;
344 </group>
345</cmdsynopsis></refsynopsisdiv>">
346<!ENTITY synopsis-param-keyid "<replaceable>&synopsis-keyid;</replaceable>">
347<!ENTITY synopsis-command-apt-key "<refsynopsisdiv><cmdsynopsis>
348 <command>apt-key</command>
349 <arg><option>--keyring &synopsis-param-filename;</option></arg>
350 <group choice='req'>
351 <arg choice='plain'>add &synopsis-param-filename;</arg>
352 <arg choice='plain'>del &synopsis-param-keyid;</arg>
353 <arg choice='plain'>export &synopsis-param-keyid;</arg>
354 <arg choice='plain'>exportall</arg>
355 <arg choice='plain'>list</arg>
356 <arg choice='plain'>finger</arg>
357 <arg choice='plain'>adv</arg>
358 <arg choice='plain'>update</arg>
359 <arg choice='plain'>net-update</arg>
360 &synopsis-help;
361 </group>
362</cmdsynopsis></refsynopsisdiv>">
363<!ENTITY synopsis-command-apt-mark "<refsynopsisdiv><cmdsynopsis>
364 <command>apt-mark</command>
365 <arg><option>-f=&synopsis-param-filename;</option></arg>
366 <group choice='plain'>
367 <arg choice='plain'>
368 <group choice='req'>
369 <arg choice='plain'>auto</arg>
370 <arg choice='plain'>manual</arg>
371 <arg choice='plain'>showauto</arg>
372 <arg choice='plain'>showmanual</arg>
373 </group>
374 &synopsis-arg-pkg;
375 </arg>
376 &synopsis-help;
377 </group>
378</cmdsynopsis></refsynopsisdiv>">
379<!ENTITY synopsis-command-apt-sortpkgs "<refsynopsisdiv><cmdsynopsis>
380 <command>apt-sortpkgs</command>
381 <arg><option>-s</option></arg>
382 &synopsis-arg-option;
383 &synopsis-arg-config;
384 <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
385 &synopsis-help;
386</cmdsynopsis></refsynopsisdiv>">