doc/apt.ent

   1 <!-- -*- mode: sgml; mode: fold -*- -->
   2
   3 <!-- Some common paths.. -->
   4 <!ENTITY docdir "/usr/share/doc/apt/">
   5 <!ENTITY configureindex "<filename>&docdir;examples/configure-index.gz</filename>">
   6 <!ENTITY aptconfdir "<filename>/etc/apt.conf</filename>">
   7 <!ENTITY statedir "/var/lib/apt">
   8 <!ENTITY cachedir "/var/cache/apt">
   9
  10 <!-- Cross references to other man pages -->
  11 <!ENTITY apt-conf "<citerefentry>
  12     <refentrytitle><filename>apt.conf</filename></refentrytitle>
  13     <manvolnum>5</manvolnum>
  14   </citerefentry>"
  15 >
  16
  17 <!ENTITY apt-get "<citerefentry>
  18     <refentrytitle><command>apt-get</command></refentrytitle>
  19     <manvolnum>8</manvolnum>
  20   </citerefentry>"
  21 >
  22
  23 <!ENTITY apt-config "<citerefentry>
  24     <refentrytitle><command>apt-config</command></refentrytitle>
  25     <manvolnum>8</manvolnum>
  26   </citerefentry>"
  27 >
  28
  29 <!ENTITY apt-cdrom "<citerefentry>
  30     <refentrytitle><command>apt-cdrom</command></refentrytitle>
  31     <manvolnum>8</manvolnum>
  32   </citerefentry>"
  33 >
  34
  35 <!ENTITY apt-cache "<citerefentry>
  36     <refentrytitle><command>apt-cache</command></refentrytitle>
  37     <manvolnum>8</manvolnum>
  38   </citerefentry>"
  39 >
  40
  41 <!ENTITY apt-preferences "<citerefentry>
  42     <refentrytitle><command>apt_preferences</command></refentrytitle>
  43     <manvolnum>5</manvolnum>
  44   </citerefentry>"
  45 >
  46
  47 <!ENTITY sources-list "<citerefentry>
  48     <refentrytitle><filename>sources.list</filename></refentrytitle>
  49     <manvolnum>5</manvolnum>
  50   </citerefentry>"
  51 >
  52
  53 <!ENTITY reportbug "<citerefentry>
  54     <refentrytitle><command>reportbug</command></refentrytitle>
  55     <manvolnum>1</manvolnum>
  56   </citerefentry>"
  57 >
  58
  59 <!ENTITY dpkg "<citerefentry>
  60     <refentrytitle><command>dpkg</command></refentrytitle>
  61     <manvolnum>8</manvolnum>
  62   </citerefentry>"
  63 >
  64
  65 <!ENTITY dpkg-buildpackage "<citerefentry>
  66     <refentrytitle><command>dpkg-buildpackage</command></refentrytitle>
  67     <manvolnum>1</manvolnum>
  68   </citerefentry>"
  69 >
  70
  71 <!ENTITY gzip "<citerefentry>
  72     <refentrytitle><command>gzip</command></refentrytitle>
  73     <manvolnum>1</manvolnum>
  74   </citerefentry>"
  75 >
  76
  77 <!ENTITY dpkg-scanpackages "<citerefentry>
  78     <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
  79     <manvolnum>8</manvolnum>
  80   </citerefentry>"
  81 >
  82
  83 <!ENTITY dpkg-scansources "<citerefentry>
  84     <refentrytitle><command>dpkg-scansources</command></refentrytitle>
  85     <manvolnum>8</manvolnum>
  86   </citerefentry>"
  87 >
  88
  89 <!ENTITY dselect "<citerefentry>
  90     <refentrytitle><command>dselect</command></refentrytitle>
  91     <manvolnum>8</manvolnum>
  92   </citerefentry>"
  93 >
  94
  95 <!-- Boiler plate docinfo section -->
  96 <!ENTITY apt-docinfo "
  97  <refentryinfo>
  98    <address><email>apt@packages.debian.org</email></address>
  99    <author><firstname>Jason</firstname> <surname>Gunthorpe</surname></author>
 100    <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
 101    <date>14 December 2003</date>
 102    <productname>Linux</productname>
 103
 104  </refentryinfo>
 105 ">
 106
 107 <!-- Boiler plate Bug reporting section -->
 108 <!ENTITY manbugs "
 109  <refsect1><title>Bugs</title>
 110    <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.
 111    If you wish to report a bug in APT, please see
 112    <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
 113    &reportbug; command.
 114    </para>
 115  </refsect1>
 116 ">
 117
 118 <!-- Boiler plate Author section -->
 119 <!ENTITY manauthor "
 120  <refsect1><title>Author</title>
 121    <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
 122    </para>
 123  </refsect1>
 124 ">
 125
 126 <!-- Should be used in every man page to get the date bottom center of
 127      the man page -->
 128 <!ENTITY apt-preamble "
 129   <refentryinfo>
 130     <date>14 December 2003</date>
 131     <productname>Linux</productname>
 132   </refentryinfo>
 133 ">
 134
 135 <!-- Should be used within the option section of the text to
 136      put in the blurb about -h, -v, -c and -o -->
 137 <!ENTITY apt-commonoptions "
 138      <varlistentry><term><option>-h</option></term>
 139      <term><option>--help</option></term>
 140      <listitem><para>Show a short usage summary.
 141      </para>
 142      </listitem>
 143      </varlistentry>
 144
 145      <varlistentry>
 146       <term><option>-v</option></term>
 147       <term><option>--version</option></term>
 148       <listitem><para>Show the program version.
 149      </para>
 150      </listitem>
 151      </varlistentry>
 152
 153      <varlistentry>
 154       <term><option>-c</option></term>
 155       <term><option>--config-file</option></term>
 156      <listitem><para>Configuration File; Specify a configuration file to use.
 157      The program will read the default configuration file and then this
 158      configuration file. See &apt-conf; for syntax information.
 159      </para>
 160      </listitem>
 161      </varlistentry>
 162
 163      <varlistentry>
 164       <term><option>-o</option></term>
 165       <term><option>--option</option></term>
 166      <listitem><para>Set a Configuration Option; This will set an arbitary
 167       configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
 168      </para>
 169      </listitem>
 170      </varlistentry>
 171 ">
 172
 173 <!-- Should be used within the option section of the text to
 174      put in the blurb about -h, -v, -c and -o -->
 175 <!ENTITY apt-cmdblurb "
 176    <para>All command line options may be set using the configuration file, the
 177    descriptions indicate the configuration option to set. For boolean
 178    options you can override the config file by using something like
 179    <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
 180    or several other variations.
 181    </para>
 182 ">
 183