* doc/*.xml:
[ntk/apt.git] / doc / apt.ent
1 <!-- -*- mode: sgml; mode: fold -*- -->
2
3 <!-- Boiler plate docinfo section -->
4 <!ENTITY apt-docinfo "
5 <refentryinfo>
6 <address><email>apt@packages.debian.org</email></address>
7 <author>
8 <firstname>Jason</firstname> <surname>Gunthorpe</surname>
9 <contrib></contrib>
10 </author>
11 <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
12 <date>28 October 2008</date>
13 <productname>Linux</productname>
14 </refentryinfo>
15 ">
16
17 <!ENTITY apt-author.team "
18 <author>
19 <othername>APT team</othername>
20 <contrib></contrib>
21 </author>
22 ">
23
24 <!ENTITY apt-qapage "
25 <para>
26 <ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>
27 </para>
28 ">
29
30 <!-- Boiler plate Bug reporting section -->
31 <!ENTITY manbugs "
32 <refsect1><title>Bugs</title>
33 <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.
34 If you wish to report a bug in APT, please see
35 <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
36 &reportbug; command.
37 </para>
38 </refsect1>
39 ">
40
41 <!-- Boiler plate Author section -->
42 <!ENTITY manauthor "
43 <refsect1><title>Author</title>
44 <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
45 </para>
46 </refsect1>
47 ">
48
49 <!-- Should be used within the option section of the text to
50 put in the blurb about -h, -v, -c and -o -->
51 <!ENTITY apt-commonoptions "
52 <varlistentry><term><option>-h</option></term>
53 <term><option>--help</option></term>
54 <listitem><para>Show a short usage summary.
55 </para>
56 </listitem>
57 </varlistentry>
58
59 <varlistentry>
60 <term><option>-v</option></term>
61 <term><option>--version</option></term>
62 <listitem><para>Show the program version.
63 </para>
64 </listitem>
65 </varlistentry>
66
67 <varlistentry>
68 <term><option>-c</option></term>
69 <term><option>--config-file</option></term>
70 <listitem><para>Configuration File; Specify a configuration file to use.
71 The program will read the default configuration file and then this
72 configuration file. If configuration settings need to be set before the
73 default configuration files are parsed specify a file with the <envar>APT_CONFIG</envar>
74 environment variable. See &apt-conf; for syntax information.
75 </para>
76 </listitem>
77 </varlistentry>
78
79 <varlistentry>
80 <term><option>-o</option></term>
81 <term><option>--option</option></term>
82 <listitem><para>Set a Configuration Option; This will set an arbitrary
83 configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
84 <option>-o</option> and <option>--option</option> can be used multiple
85 times to set different options.
86 </para>
87 </listitem>
88 </varlistentry>
89 ">
90
91 <!-- Should be used within the option section of the text to
92 put in the blurb about -h, -v, -c and -o -->
93 <!ENTITY apt-cmdblurb "
94 <para>All command line options may be set using the configuration file, the
95 descriptions indicate the configuration option to set. For boolean
96 options you can override the config file by using something like
97 <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
98 or several other variations.
99 </para>
100 ">
101
102 <!ENTITY file-aptconf "
103 <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>
104 <listitem><para>APT configuration file.
105 Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem>
106 </varlistentry>
107
108 <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>
109 <listitem><para>APT configuration file fragments.
110 Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem>
111 </varlistentry>
112 ">
113
114 <!ENTITY file-cachearchives "
115 <varlistentry><term><filename>&cachedir;/archives/</filename></term>
116 <listitem><para>Storage area for retrieved package files.
117 Configuration Item: <literal>Dir::Cache::Archives</literal>.</para></listitem>
118 </varlistentry>
119
120 <varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>
121 <listitem><para>Storage area for package files in transit.
122 Configuration Item: <literal>Dir::Cache::Archives</literal> (<filename>partial</filename> will be implicitly appended). </para></listitem>
123 </varlistentry>
124 ">
125
126 <!ENTITY file-preferences "
127 <varlistentry><term><filename>/etc/apt/preferences</filename></term>
128 <listitem><para>Version preferences file.
129 This is where you would specify &quot;pinning&quot;,
130 i.e. a preference to get certain packages
131 from a separate source
132 or from a different version of a distribution.
133 Configuration Item: <literal>Dir::Etc::Preferences</literal>.</para></listitem>
134 </varlistentry>
135
136 <varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>
137 <listitem><para>File fragments for the version preferences.
138 Configuration Item: <literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>
139 </varlistentry>
140 ">
141
142 <!ENTITY file-sourceslist "
143 <varlistentry><term><filename>/etc/apt/sources.list</filename></term>
144 <listitem><para>Locations to fetch packages from.
145 Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem>
146 </varlistentry>
147
148 <varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>
149 <listitem><para>File fragments for locations to fetch packages from.
150 Configuration Item: <literal>Dir::Etc::SourceParts</literal>.</para></listitem>
151 </varlistentry>
152 ">
153
154 <!ENTITY file-statelists "
155 <varlistentry><term><filename>&statedir;/lists/</filename></term>
156 <listitem><para>Storage area for state information for each package resource specified in
157 &sources-list;
158 Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem>
159 </varlistentry>
160
161 <varlistentry><term><filename>&statedir;/lists/partial/</filename></term>
162 <listitem><para>Storage area for state information in transit.
163 Configuration Item: <literal>Dir::State::Lists</literal> (<filename>partial</filename> will be implicitly appended).</para></listitem>
164 </varlistentry>
165 ">
166
167 <!ENTITY file-trustedgpg "
168 <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>
169 <listitem><para>Keyring of local trusted keys, new keys will be added here.
170 Configuration Item: <literal>Dir::Etc::Trusted</literal>.</para></listitem>
171 </varlistentry>
172
173 <varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>
174 <listitem><para>File fragments for the trusted keys, additional keyrings can
175 be stored here (by other packages or the administrator).
176 Configuration Item <literal>Dir::Etc::TrustedParts</literal>.</para></listitem>
177 </varlistentry>
178 ">
179
180 <!ENTITY file-extended_states "
181 <varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>
182 <listitem><para>Status list of auto-installed packages.
183 Configuration Item: <literal>Dir::State::extended_states</literal>.
184 </para></listitem>
185 </varlistentry>
186 ">
187
188 <!-- TRANSLATOR: This is the section header for the following paragraphs - comparable
189 to the other headers like NAME and DESCRIPTION and should therefore be uppercase. -->
190 <!ENTITY translation-title "TRANSLATION">
191
192 <!-- TRANSLATOR: This is a placeholder. You should write here who has contributed
193 to the translation in the past, who is responsible now and maybe further information
194 specially related to your translation. -->
195 <!ENTITY translation-holder "
196 The english translation was done by John Doe <email>john@doe.org</email> in 2009,
197 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together with the
198 Debian Dummy l10n Team <email>debian-l10n-dummy@lists.debian.org</email>.
199 ">
200
201 <!-- TRANSLATOR: As a translation is allowed to have 20% of untranslated/fuzzy strings
202 in a shipped manpage newer/modified paragraphs will maybe appear in english in
203 the generated manpage. This sentence is therefore here to tell the reader that this
204 is not a mistake by the translator - obviously the target is that at least for stable
205 releases this sentence is not needed. :) -->
206 <!ENTITY translation-english "
207 Note that this translated document may contain untranslated parts.
208 This is done on purpose, to avoid losing content when the
209 translation is lagging behind the original content.
210 ">
211
212 <!-- TRANSLATOR: used as in -o=config_string e.g. -o=Debug::pkgProblemResolver=1 -->
213 <!ENTITY synopsis-config-string "config_string">
214
215 <!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf -->
216 <!ENTITY synopsis-config-file "config_file">
217
218 <!-- TRANSLATOR: used as in -t=target_release or pkg/target_release e.g. -t=squeeze apt/experimental -->
219 <!ENTITY synopsis-target-release "target_release">
220
221 <!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel -->
222 <!ENTITY synopsis-architecture "architecture">
223
224 <!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome -->
225 <!ENTITY synopsis-pkg "pkg">
226
227 <!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 -->
228 <!ENTITY synopsis-pkg-ver-number "pkg_version_number">
229
230 <!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache pkgnames apt -->
231 <!ENTITY synopsis-prefix "prefix">
232
233 <!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search awesome -->
234 <!ENTITY synopsis-regex "regex">
235
236 <!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom -d=/media/cdrom -->
237 <!ENTITY synopsis-cdrom-mount "cdrom_mount_point">
238
239 <!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory e.g. apt-extracttemplates -t=/tmp -->
240 <!ENTITY synopsis-tmp-directory "temporary_directory">
241
242 <!-- TRANSLATOR: used as in apt-extracttemplates filename -->
243 <!ENTITY synopsis-filename "filename">
244
245 <!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive packages path override-file pathprefix -->
246 <!ENTITY synopsis-path "path">
247
248 <!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive packages path override-file pathprefix -->
249 <!ENTITY synopsis-override "override-file">
250
251 <!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive packages path override-file pathprefix -->
252 <!ENTITY synopsis-pathprefix "pathprefix">
253
254 <!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive generate section -->
255 <!ENTITY synopsis-section "section">
256
257 <!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export 473041FA -->
258 <!ENTITY synopsis-keyid "keyid">
259