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