[ Martin Pitt ]
[ntk/apt.git] / doc / apt.ent
1 <!-- -*- mode: sgml; 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
151 <!-- Boiler plate docinfo section -->
152 <!ENTITY apt-docinfo "
153 <refentryinfo>
154 <address><email>apt@packages.debian.org</email></address>
155 <author>
156 <firstname>Jason</firstname> <surname>Gunthorpe</surname>
157 <contrib></contrib>
158 </author>
159 <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
160 <date>28 October 2008</date>
161 <productname>Linux</productname>
162
163 </refentryinfo>
164 ">
165
166 <!ENTITY apt-email "
167 <address>
168 <email>apt@packages.debian.org</email>
169 </address>
170 ">
171
172 <!ENTITY apt-author.jgunthorpe "
173 <author>
174 <firstname>Jason</firstname>
175 <surname>Gunthorpe</surname>
176 <contrib></contrib>
177 </author>
178 ">
179
180 <!ENTITY apt-author.moconnor "
181 <author>
182 <firstname>Mike</firstname>
183 <surname>O'Connor</surname>
184 <contrib></contrib>
185 </author>
186 ">
187
188 <!ENTITY apt-author.team "
189 <author>
190 <othername>APT team</othername>
191 <contrib></contrib>
192 </author>
193 ">
194
195 <!ENTITY apt-product "
196 <productname>Linux</productname>
197 ">
198
199 <!ENTITY apt-copyright "
200 <copyright>
201 <holder>Jason Gunthorpe</holder>
202 <year>1998-2001</year>
203 </copyright>
204 ">
205
206 <!ENTITY apt-product "
207 <productname>Linux</productname>
208 ">
209
210 <!ENTITY apt-qapage "
211 <para>
212 <ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>
213 </para>
214 ">
215
216 <!-- Boiler plate Bug reporting section -->
217 <!ENTITY manbugs "
218 <refsect1><title>Bugs</title>
219 <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.
220 If you wish to report a bug in APT, please see
221 <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
222 &reportbug; command.
223 </para>
224 </refsect1>
225 ">
226
227 <!-- Boiler plate Author section -->
228 <!ENTITY manauthor "
229 <refsect1><title>Author</title>
230 <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
231 </para>
232 </refsect1>
233 ">
234
235 <!-- Should be used within the option section of the text to
236 put in the blurb about -h, -v, -c and -o -->
237 <!ENTITY apt-commonoptions "
238 <varlistentry><term><option>-h</option></term>
239 <term><option>--help</option></term>
240 <listitem><para>Show a short usage summary.
241 </para>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry>
246 <term><option>-v</option></term>
247 <term><option>--version</option></term>
248 <listitem><para>Show the program version.
249 </para>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry>
254 <term><option>-c</option></term>
255 <term><option>--config-file</option></term>
256 <listitem><para>Configuration File; Specify a configuration file to use.
257 The program will read the default configuration file and then this
258 configuration file. If configuration settings need to be set before the
259 default configuration files are parsed specify a file with the <envar>APT_CONFIG</envar>
260 environment variable. See &apt-conf; for syntax information.
261 </para>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry>
266 <term><option>-o</option></term>
267 <term><option>--option</option></term>
268 <listitem><para>Set a Configuration Option; This will set an arbitrary
269 configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
270 <option>-o</option> and <option>--option</option> can be used multiple
271 times to set different options.
272 </para>
273 </listitem>
274 </varlistentry>
275 ">
276
277 <!-- Should be used within the option section of the text to
278 put in the blurb about -h, -v, -c and -o -->
279 <!ENTITY apt-cmdblurb "
280 <para>All command line options may be set using the configuration file, the
281 descriptions indicate the configuration option to set. For boolean
282 options you can override the config file by using something like
283 <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
284 or several other variations.
285 </para>
286 ">
287
288 <!ENTITY file-aptconf "
289 <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>
290 <listitem><para>APT configuration file.
291 Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem>
292 </varlistentry>
293
294 <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>
295 <listitem><para>APT configuration file fragments.
296 Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem>
297 </varlistentry>
298 ">
299
300 <!ENTITY file-cachearchives "
301 <varlistentry><term><filename>&cachedir;/archives/</filename></term>
302 <listitem><para>Storage area for retrieved package files.
303 Configuration Item: <literal>Dir::Cache::Archives</literal>.</para></listitem>
304 </varlistentry>
305
306 <varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>
307 <listitem><para>Storage area for package files in transit.
308 Configuration Item: <literal>Dir::Cache::Archives</literal> (implicit partial). </para></listitem>
309 </varlistentry>
310 ">
311
312 <!ENTITY file-preferences "
313 <varlistentry><term><filename>/etc/apt/preferences</filename></term>
314 <listitem><para>Version preferences file.
315 This is where you would specify &quot;pinning&quot;,
316 i.e. a preference to get certain packages
317 from a separate source
318 or from a different version of a distribution.
319 Configuration Item: <literal>Dir::Etc::Preferences</literal>.</para></listitem>
320 </varlistentry>
321
322 <varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>
323 <listitem><para>File fragments for the version preferences.
324 Configuration Item: <literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>
325 </varlistentry>
326 ">
327
328 <!ENTITY file-sourceslist "
329 <varlistentry><term><filename>/etc/apt/sources.list</filename></term>
330 <listitem><para>Locations to fetch packages from.
331 Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem>
332 </varlistentry>
333
334 <varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>
335 <listitem><para>File fragments for locations to fetch packages from.
336 Configuration Item: <literal>Dir::Etc::SourceParts</literal>.</para></listitem>
337 </varlistentry>
338 ">
339
340 <!ENTITY file-statelists "
341 <varlistentry><term><filename>&statedir;/lists/</filename></term>
342 <listitem><para>Storage area for state information for each package resource specified in
343 &sources-list;
344 Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem>
345 </varlistentry>
346
347 <varlistentry><term><filename>&statedir;/lists/partial/</filename></term>
348 <listitem><para>Storage area for state information in transit.
349 Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem>
350 </varlistentry>
351 ">
352
353 <!ENTITY file-trustedgpg "
354 <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>
355 <listitem><para>Keyring of local trusted keys, new keys will be added here.
356 Configuration Item: <literal>Dir::Etc::Trusted</literal>.</para></listitem>
357 </varlistentry>
358
359 <varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>
360 <listitem><para>File fragments for the trusted keys, additional keyrings can
361 be stored here (by other packages or the administrator).
362 Configuration Item <literal>Dir::Etc::TrustedParts</literal>.</para></listitem>
363 </varlistentry>
364 ">
365
366 <!ENTITY file-extended_states "
367 <varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>
368 <listitem><para>Status list of auto-installed packages.
369 Configuration Item: <literal>Dir::State::extended_states</literal>.
370 </para></listitem>
371 </varlistentry>
372 ">
373
374 <!-- TRANSLATOR: This is the section header for the following paragraphs - comparable
375 to the other headers like NAME and DESCRIPTION and should therefore be uppercase. -->
376 <!ENTITY translation-title "TRANSLATION">
377
378 <!-- TRANSLATOR: This is a placeholder. You should write here who has contributed
379 to the translation in the past, who is responsible now and maybe further information
380 specially related to your translation. -->
381 <!ENTITY translation-holder "
382 The english translation was done by John Doe <email>john@doe.org</email> in 2009,
383 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together with the
384 Debian Dummy l10n Team <email>debian-l10n-dummy@lists.debian.org</email>.
385 ">
386
387 <!-- TRANSLATOR: As a translation is allowed to have 20% of untranslated/fuzzy strings
388 in a shipped manpage newer/modified paragraphs will maybe appear in english in
389 the generated manpage. This sentence is therefore here to tell the reader that this
390 is not a mistake by the translator - obviously the target is that at least for stable
391 releases this sentence is not needed. :) -->
392 <!ENTITY translation-english "
393 Note that this translated document may contain untranslated parts.
394 This is done on purpose, to avoid losing content when the
395 translation is lagging behind the original content.
396 ">
397
398 <!ENTITY oldstable-codename "etch">
399 <!ENTITY stable-codename "lenny">
400 <!ENTITY testing-codename "squeeze">