]> git.saurik.com Git - apt.git/blobdiff - doc/apt.ent
projects / apt.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
follow the recommendation of cppcheck to make some method methods (scnr)
[apt.git] / doc / apt.ent
diff --git a/doc/apt.ent b/doc/apt.ent
index 99fe443cfd650c58efaec04f3d76194b125bd8f7..fc745989f95a1767f7a6b8ab3445a6ac7d480c9b 100644 (file)
--- a/doc/apt.ent
+++ b/doc/apt.ent
@@ -1,216 +1,36 @@
 <!-- -*- mode: sgml; mode: fold -*- -->
 
 <!-- -*- mode: sgml; mode: fold -*- -->
 
-<!-- Some common paths.. -->
-<!ENTITY docdir "/usr/share/doc/apt/">
-<!ENTITY guidesdir "/usr/share/doc/apt-doc/">
-<!ENTITY configureindex "<filename>&docdir;examples/configure-index.gz</filename>">
-<!ENTITY aptconfdir "<filename>/etc/apt.conf</filename>">
-<!ENTITY statedir "/var/lib/apt">
-<!ENTITY cachedir "/var/cache/apt">
-
-<!-- Cross references to other man pages -->
-<!ENTITY apt-conf "<citerefentry>
-    <refentrytitle><filename>apt.conf</filename></refentrytitle>
-    <manvolnum>5</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY apt-get "<citerefentry>
-    <refentrytitle><command>apt-get</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY apt-config "<citerefentry>
-    <refentrytitle><command>apt-config</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY apt-cdrom "<citerefentry>
-    <refentrytitle><command>apt-cdrom</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY apt-cache "<citerefentry>
-    <refentrytitle><command>apt-cache</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY apt-preferences "<citerefentry>
-    <refentrytitle><command>apt_preferences</command></refentrytitle>
-    <manvolnum>5</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY apt-key "<citerefentry>
-    <refentrytitle><command>apt-key</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY apt-secure "<citerefentry>
-    <refentrytitle>apt-secure</refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY apt-archive "<citerefentry>
-    <refentrytitle><filename>apt-archive</filename></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-
-
-<!ENTITY sources-list "<citerefentry>
-    <refentrytitle><filename>sources.list</filename></refentrytitle>
-    <manvolnum>5</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY reportbug "<citerefentry>
-    <refentrytitle><command>reportbug</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY dpkg "<citerefentry>
-    <refentrytitle><command>dpkg</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY dpkg-buildpackage "<citerefentry>
-    <refentrytitle><command>dpkg-buildpackage</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY gzip "<citerefentry>
-    <refentrytitle><command>gzip</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY dpkg-scanpackages "<citerefentry>
-    <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY dpkg-scansources "<citerefentry>
-    <refentrytitle><command>dpkg-scansources</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY dselect "<citerefentry>
-    <refentrytitle><command>dselect</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY aptitude "<citerefentry>
-    <refentrytitle><command>aptitude</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY synaptic "<citerefentry>
-    <refentrytitle><command>synaptic</command></refentrytitle>
-    <manvolnum>8</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY debsign "<citerefentry>
-    <refentrytitle><command>debsign</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY debsig-verify "<citerefentry>
-    <refentrytitle><command>debsig-verify</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY gpg "<citerefentry>
-    <refentrytitle><command>gpg</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-    
 <!-- Boiler plate docinfo section -->
 <!ENTITY apt-docinfo "
  <refentryinfo>
    <address><email>apt@packages.debian.org</email></address>
 <!-- Boiler plate docinfo section -->
 <!ENTITY apt-docinfo "
  <refentryinfo>
    <address><email>apt@packages.debian.org</email></address>
-   <author><firstname>Jason</firstname> <surname>Gunthorpe</surname></author>
-   <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
-   <date>14 December 2003</date>
-   <productname>Linux</productname>
-
- </refentryinfo>
-"> 
-
-<!ENTITY apt-email "
-   <address>
-    <email>apt@packages.debian.org</email>
-   </address>
-">
-
-<!ENTITY apt-author.jgunthorpe "
    <author>
    <author>
-    <firstname>Jason</firstname>
-    <surname>Gunthorpe</surname>
+     <firstname>Jason</firstname> <surname>Gunthorpe</surname>
+     <contrib></contrib>
    </author>
    </author>
-">
-
-<!ENTITY apt-author.team "
-   <author>
-    <othername>APT team</othername>
-   </author>
-">
-
-<!ENTITY apt-product "
+   <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
+   <date>28 October 2008</date>
    <productname>Linux</productname>
    <productname>Linux</productname>
-">
-
-<!ENTITY apt-email "
-   <address>
-    <email>apt@packages.debian.org</email>
-   </address>
-">
-
-<!ENTITY apt-author.jgunthorpe "
-   <author>
-    <firstname>Jason</firstname>
-    <surname>Gunthorpe</surname>
-   </author>
+ </refentryinfo>
 ">
 
 <!ENTITY apt-author.team "
    <author>
     <othername>APT team</othername>
 ">
 
 <!ENTITY apt-author.team "
    <author>
     <othername>APT team</othername>
+    <contrib></contrib>
    </author>
 ">
 
    </author>
 ">
 
-<!ENTITY apt-copyright "
-    <copyright>
-     <holder>Jason Gunthorpe</holder>
-     <year>1998-2001</year>
-    </copyright>
-">
-
-<!ENTITY apt-product "
-   <productname>Linux</productname>
+<!ENTITY apt-qapage "
+       <para>
+               <ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>
+       </para>
 ">
 
 <!-- Boiler plate Bug reporting section -->
 <!ENTITY manbugs "
  <refsect1><title>Bugs</title>
 ">
 
 <!-- Boiler plate Bug reporting section -->
 <!ENTITY manbugs "
  <refsect1><title>Bugs</title>
-   <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>. 
+   <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.
    If you wish to report a bug in APT, please see
    <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
    &reportbug; command.
@@ -249,7 +69,9 @@
       <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 
       <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. See &apt-conf; for syntax information.     
+     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>
      </para>
      </listitem>
      </varlistentry>
@@ -257,8 +79,10 @@
      <varlistentry>
       <term><option>-o</option></term>
       <term><option>--option</option></term>
      <varlistentry>
       <term><option>-o</option></term>
       <term><option>--option</option></term>
-     <listitem><para>Set a Configuration Option; This will set an arbitary
+     <listitem><para>Set a Configuration Option; This will set an arbitrary
       configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
       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>
      </para>
      </listitem>
      </varlistentry>
@@ -275,3 +99,112 @@
    </para>
 ">
 
    </para>
 ">
 
+<!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> (implicit partial). </para></listitem>
+     </varlistentry>
+">
+
+<!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>
+
+     <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 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>
+
+     <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 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> (implicit partial).</para></listitem>
+     </varlistentry>
+">
+
+<!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>
+">
+
+<!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>
+">
+
+<!-- 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>.
+">
+
+<!-- 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.
+">
APT (for Cydia)