]> git.saurik.com Git - apt.git/blobdiff - doc/apt.ent
prepare-release: declare the packages needed as source build deps.
[apt.git] / doc / apt.ent
index c23d906e2542b89b59f7522157d0dcef000283af..6a3837b9553fb11b63dcc11fcc530b7d36a73a33 100644 (file)
@@ -1,196 +1,3 @@
-<!-- -*- 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-ftparchive "<citerefentry>
-    <refentrytitle><filename>apt-ftparchive</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>1</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>1</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY dpkg-scansources "<citerefentry>
-    <refentrytitle><command>dpkg-scansources</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY dselect "<citerefentry>
-    <refentrytitle><command>dselect</command></refentrytitle>
-    <manvolnum>1</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>"
->
-
-<!ENTITY gnome-apt "<citerefentry>
-    <refentrytitle><command>gnome-apt</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-
-<!ENTITY wajig "<citerefentry>
-    <refentrytitle><command>wajig</command></refentrytitle>
-    <manvolnum>1</manvolnum>
-  </citerefentry>"
->
-<!-- Boiler plate docinfo section -->
-<!ENTITY apt-docinfo "
- <refentryinfo>
-   <address><email>apt@packages.debian.org</email></address>
-   <author>
-     <firstname>Jason</firstname> <surname>Gunthorpe</surname>
-     <contrib></contrib>
-   </author>
-   <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
-   <date>28 October 2008</date>
-   <productname>Linux</productname>
-
- </refentryinfo>
-"> 
-
-<!ENTITY apt-email "
-   <address>
-    <email>apt@packages.debian.org</email>
-   </address>
-">
-
-<!ENTITY apt-author.jgunthorpe "
-   <author>
-    <firstname>Jason</firstname>
-    <surname>Gunthorpe</surname>
-    <contrib></contrib>
-   </author>
-">
-
-<!ENTITY apt-author.moconnor "
-   <author>
-    <firstname>Mike</firstname>
-    <surname>O'Connor</surname>
-    <contrib></contrib>
-   </author>
-">
-
 <!ENTITY apt-author.team "
    <author>
     <othername>APT team</othername>
    </author>
 ">
 
-<!ENTITY apt-product "
-   <productname>Linux</productname>
-">
-
-<!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>
 <!-- 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.
       <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>
 
      <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>
+     Configuration Item: <literal>Dir::Cache::Archives</literal> (<filename>partial</filename> will be implicitly appended)</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>
+     Configuration Item: <literal>Dir::State::Lists</literal> (<filename>partial</filename> will be implicitly appended)</para></listitem>
      </varlistentry>
 ">
 
      </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 constributed
+<!-- 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 "
 ">
 
 <!-- TRANSLATOR: As a translation is allowed to have 20% of untranslated/fuzzy strings
-     in a shipped manpage will maybe appear english parts. -->
+     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">
+