]> git.saurik.com Git - apt.git/blobdiff - doc/apt.ent
FildFd: Introduce a Flush() function and call it from Close()
[apt.git] / doc / apt.ent
index fb1aa3c9133e48f35117dc1c6a3eebc24d07f4fd..6a3837b9553fb11b63dcc11fcc530b7d36a73a33 100644 (file)
-<!-- -*- mode: sgml; mode: fold -*- -->
-
-<!-- Some common paths.. -->
-<!ENTITY docdir "/usr/share/doc/apt/">
-<!ENTITY configureindex "<filename>&docdir;/examples/configure-index</>">
-<!ENTITY aptconfdir "<filename>/etc/apt.conf</>">
-<!ENTITY statedir "/var/lib/apt">
-<!ENTITY cachedir "/var/cache/apt">
-
-<!-- Cross references to other man pages -->
-<!ENTITY apt-conf "
-  <CiteRefEntry>
-    <RefEntryTitle><filename/apt.conf/</RefEntryTitle>
-    <ManVolNum/5/
-  </CiteRefEntry>
+<!ENTITY apt-author.team "
+   <author>
+    <othername>APT team</othername>
+    <contrib></contrib>
+   </author>
 ">
 
-<!ENTITY apt-get "
-  <CiteRefEntry>
-    <RefEntryTitle><command/apt-get/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY apt-qapage "
+       <para>
+               <ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>
+       </para>
 ">
 
-<!ENTITY apt-cdrom "
-  <CiteRefEntry>
-    <RefEntryTitle><command/apt-cdrom/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!-- Boiler plate Bug reporting section -->
+<!ENTITY manbugs "
+ <refsect1><title>Bugs</title>
+   <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.
+   If you wish to report a bug in APT, please see
+   <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
+   &reportbug; command.
+   </para>
+ </refsect1>
 ">
 
-<!ENTITY apt-cache "
-  <CiteRefEntry>
-    <RefEntryTitle><command/apt-cache/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!-- Boiler plate Author section -->
+<!ENTITY manauthor "
+ <refsect1><title>Author</title>
+   <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
+   </para>
+ </refsect1>
 ">
 
-<!ENTITY sources-list "
-  <CiteRefEntry>
-    <RefEntryTitle><filename/sources.list/</RefEntryTitle>
-    <ManVolNum/5/
-  </CiteRefEntry>
+<!-- Should be used within the option section of the text to
+     put in the blurb about -h, -v, -c and -o -->
+<!ENTITY apt-commonoptions "
+     <varlistentry><term><option>-h</option></term>
+     <term><option>--help</option></term>
+     <listitem><para>Show a short usage summary.
+     </para>
+     </listitem>
+     </varlistentry>
+     
+     <varlistentry>
+      <term><option>-v</option></term>
+      <term><option>--version</option></term>
+      <listitem><para>Show the program version.
+     </para>
+     </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><option>-c</option></term>
+      <term><option>--config-file</option></term>
+     <listitem><para>Configuration File; Specify a configuration file to use. 
+     The program will read the default configuration file and then this 
+     configuration file. If configuration settings need to be set before the
+     default configuration files are parsed specify a file with the <envar>APT_CONFIG</envar>
+     environment variable. See &apt-conf; for syntax information.
+     </para>
+     </listitem>
+     </varlistentry>
+     
+     <varlistentry>
+      <term><option>-o</option></term>
+      <term><option>--option</option></term>
+     <listitem><para>Set a Configuration Option; This will set an arbitrary
+      configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
+      <option>-o</option> and <option>--option</option> can be used multiple
+      times to set different options.
+     </para>
+     </listitem>
+     </varlistentry>
 ">
 
-<!ENTITY bug "
-  <CiteRefEntry>
-    <RefEntryTitle><command/bug/</RefEntryTitle>
-    <ManVolNum/1/
-  </CiteRefEntry>
+<!-- Should be used within the option section of the text to
+     put in the blurb about -h, -v, -c and -o -->
+<!ENTITY apt-cmdblurb "
+   <para>All command line options may be set using the configuration file, the
+   descriptions indicate the configuration option to set. For boolean
+   options you can override the config file by using something like 
+   <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
+   or several other variations.
+   </para>
 ">
 
-<!ENTITY dpkg "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dpkg/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY file-aptconf "
+     <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>
+     <listitem><para>APT configuration file.
+     Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>
+     <listitem><para>APT configuration file fragments.
+     Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem>
+     </varlistentry>
+">
+
+<!ENTITY file-cachearchives "
+     <varlistentry><term><filename>&cachedir;/archives/</filename></term>
+     <listitem><para>Storage area for retrieved package files.
+     Configuration Item: <literal>Dir::Cache::Archives</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>
+     <listitem><para>Storage area for package files in transit.
+     Configuration Item: <literal>Dir::Cache::Archives</literal> (<filename>partial</filename> will be implicitly appended)</para></listitem>
+     </varlistentry>
 ">
 
-<!ENTITY dpkg-buildpackage "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dpkg-buildpackage/</RefEntryTitle>
-    <ManVolNum/1/
-  </CiteRefEntry>
-">
+<!ENTITY file-preferences "
+     <varlistentry><term><filename>/etc/apt/preferences</filename></term>
+     <listitem><para>Version preferences file.
+     This is where you would specify &quot;pinning&quot;,
+     i.e. a preference to get certain packages
+     from a separate source
+     or from a different version of a distribution.
+     Configuration Item: <literal>Dir::Etc::Preferences</literal>.</para></listitem>
+     </varlistentry>
 
-<!ENTITY gzip "
-  <CiteRefEntry>
-    <RefEntryTitle><command/gzip/</RefEntryTitle>
-    <ManVolNum/1/
-  </CiteRefEntry>
+     <varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>
+     <listitem><para>File fragments for the version preferences.
+     Configuration Item: <literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>
+     </varlistentry>
 ">
 
-<!ENTITY dpkg-scanpackages "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dpkg-scanpackages/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
-">
+<!ENTITY file-sourceslist "
+     <varlistentry><term><filename>/etc/apt/sources.list</filename></term>
+     <listitem><para>Locations to fetch packages from.
+     Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem>
+     </varlistentry>
 
-<!ENTITY dpkg-scansources "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dpkg-scansources/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+     <varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>
+     <listitem><para>File fragments for locations to fetch packages from.
+     Configuration Item: <literal>Dir::Etc::SourceParts</literal>.</para></listitem>
+     </varlistentry>
 ">
 
-<!ENTITY dselect "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dselect/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY file-statelists "
+     <varlistentry><term><filename>&statedir;/lists/</filename></term>
+     <listitem><para>Storage area for state information for each package resource specified in
+     &sources-list;
+     Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>&statedir;/lists/partial/</filename></term>
+     <listitem><para>Storage area for state information in transit.
+     Configuration Item: <literal>Dir::State::Lists</literal> (<filename>partial</filename> will be implicitly appended)</para></listitem>
+     </varlistentry>
 ">
-    
-<!-- Boiler plate docinfo section -->
-<!ENTITY apt-docinfo "
- <docinfo>
-   <address><email>apt@packages.debian.org</></address>
-   <author><firstname>Jason</> <surname>Gunthorpe</></>
-   <copyright><year>1998-2000</> <holder>Jason Gunthorpe</></>
-   <date>20 September 2000</>
- </docinfo>
-"> 
 
-<!-- Boiler plate Bug reporting section -->
-<!ENTITY manbugs "
- <RefSect1><Title>Bugs</>
-   <para>
-   See the <ulink url='http://bugs.debian.org/apt'>APT bug page</>.  
-   If you wish to report a bug in APT, please see 
-   <filename>/usr/doc/debian/bug-reporting.txt</> or the &bug; command.
- </RefSect1>
+<!ENTITY file-trustedgpg "
+     <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>
+     <listitem><para>Keyring of local trusted keys, new keys will be added here.
+     Configuration Item: <literal>Dir::Etc::Trusted</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>
+     <listitem><para>File fragments for the trusted keys, additional keyrings can
+     be stored here (by other packages or the administrator).
+     Configuration Item <literal>Dir::Etc::TrustedParts</literal>.</para></listitem>
+     </varlistentry>
 ">
 
-<!-- Boiler plate Author section -->
-<!ENTITY manauthor "
- <RefSect1><Title>Author</>
-   <para>
-   APT was written by the APT team <email>apt@packages.debian.org</>.
</RefSect1>
+<!ENTITY file-extended_states "
+      <varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>
+      <listitem><para>Status list of auto-installed packages.
+      Configuration Item: <literal>Dir::State::extended_states</literal>.
+      </para></listitem>
     </varlistentry>
 ">
 
-<!-- Should be used within the option section of the text to
-     put in the blurb about -h, -v, -c and -o -->
-<!ENTITY apt-commonoptions "
-     <VarListEntry><term><option/-h/</><term><option/--help/</>
-     <ListItem><Para>
-     Show a short usage summary.
-     </VarListEntry>
-     
-     <VarListEntry><term><option/-v/</><term><option/--version/</>
-     <ListItem><Para>
-     Show the program verison.
-     </VarListEntry>
-
-     <VarListEntry><term><option/-c/</><term><option/--config-file/</>
-     <ListItem><Para>
-     Configuration File; Specify a configuration file to use. 
-     The program will read the default configuration file and then this 
-     configuration file. See &apt-conf; for syntax information.     
-     </VarListEntry>
-     
-     <VarListEntry><term><option/-o/</><term><option/--option/</>
-     <ListItem><Para>
-     Set a Configuration Option; This will set an arbitary configuration 
-     option. The syntax is <option>-o Foo::Bar=bar</>.
-     </VarListEntry>
+<!-- TRANSLATOR: This is the section header for the following paragraphs - comparable
+     to the other headers like NAME and DESCRIPTION and should therefore be uppercase. -->
+<!ENTITY translation-title "TRANSLATION">
+
+<!-- TRANSLATOR: This is a placeholder. You should write here who has contributed
+     to the translation in the past, who is responsible now and maybe further information
+     specially related to your translation. -->
+<!ENTITY translation-holder "
+     The english translation was done by John Doe <email>john@doe.org</email> in 2009,
+     2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together with the
+     Debian Dummy l10n Team <email>debian-l10n-dummy@lists.debian.org</email>.
 ">
 
-<!-- Should be used within the option section of the text to
-     put in the blurb about -h, -v, -c and -o -->
-<!ENTITY apt-cmdblurb "
-   <para>
-   All command line options may be set using the configuration file, the
-   descriptions indicate the configuration option to set. For boolean
-   options you can override the config file by using something like 
-   <option/-f-/,<option/--no-f/, <option/-f=no/ or several other variations.
-   </para>
+<!-- TRANSLATOR: As a translation is allowed to have 20% of untranslated/fuzzy strings
+     in a shipped manpage newer/modified paragraphs will maybe appear in english in
+     the generated manpage. This sentence is therefore here to tell the reader that this
+     is not a mistake by the translator - obviously the target is that at least for stable
+     releases this sentence is not needed. :) -->
+<!ENTITY translation-english "
+     Note that this translated document may contain untranslated parts.
+     This is done on purpose, to avoid losing content when the
+     translation is lagging behind the original content.
 ">
+
+<!-- TRANSLATOR: used as in -o=config_string  e.g. -o=Debug::pkgProblemResolver=1 -->
+<!ENTITY synopsis-config-string "config_string">
+
+<!-- TRANSLATOR: used as in -c=config_file  e.g. -c=./apt.conf -->
+<!ENTITY synopsis-config-file "config_file">
+
+<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release  e.g. -t=squeeze apt/experimental -->
+<!ENTITY synopsis-target-release "target_release">
+
+<!-- TRANSLATOR: used as in -a=architecture  e.g. -a=armel -->
+<!ENTITY synopsis-architecture "architecture">
+
+<!-- TRANSLATOR: used as in apt-get install pkg  e.g. apt-get install awesome -->
+<!ENTITY synopsis-pkg "pkg">
+
+<!-- TRANSLATOR: used as in pkg=pkg_version_number  e.g. apt=0.8.15 -->
+<!ENTITY synopsis-pkg-ver-number "pkg_version_number">
+
+<!-- TRANSLATOR: used as in apt-cache pkgnames prefix  e.g. apt-cache pkgnames apt -->
+<!ENTITY synopsis-prefix "prefix">
+
+<!-- TRANSLATOR: used as in apt-cache search regex  e.g. apt-cache search awesome -->
+<!ENTITY synopsis-regex "regex">
+
+<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point  e.g. apt-cdrom -d=/media/cdrom -->
+<!ENTITY synopsis-cdrom-mount "cdrom_mount_point">
+
+<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory  e.g. apt-extracttemplates -t=/tmp -->
+<!ENTITY synopsis-tmp-directory "temporary_directory">
+
+<!-- TRANSLATOR: used as in apt-extracttemplates filename -->
+<!ENTITY synopsis-filename "filename">
+
+<!-- TRANSLATOR: used as parameter for apt-ftparchive  e.g. apt-ftparchive packages path override-file pathprefix -->
+<!ENTITY synopsis-path "path">
+
+<!-- TRANSLATOR: used as parameter for apt-ftparchive  e.g. apt-ftparchive packages path override-file pathprefix -->
+<!ENTITY synopsis-override "override-file">
+
+<!-- TRANSLATOR: used as parameter for apt-ftparchive  e.g. apt-ftparchive packages path override-file pathprefix -->
+<!ENTITY synopsis-pathprefix "pathprefix">
+
+<!-- TRANSLATOR: used as parameter for apt-ftparchive  e.g. apt-ftparchive generate section -->
+<!ENTITY synopsis-section "section">
+
+<!-- TRANSLATOR: used as in apt-key export keyid  e.g. apt-key export 473041FA -->
+<!ENTITY synopsis-keyid "keyid">
+