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