- initial import of revision 374 from cnc
[apt.git] / contrib / apt-wrapper / 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 <!ENTITY apt-email "
108    <address>
109     <email>apt@packages.debian.org</email>
110    </address>
111 ">
112
113 <!ENTITY apt-author.jgunthorpe "
114    <author>
115     <firstname>Jason</firstname>
116     <surname>Gunthorpe</surname>
117    </author>
118 ">
119
120 <!ENTITY apt-author.team "
121    <author>
122     <othername>APT team</othername>
123    </author>
124 ">
125
126 <!ENTITY apt-product "
127    <productname>Linux</productname>
128 ">
129
130 <!ENTITY apt-email "
131    <address>
132     <email>apt@packages.debian.org</email>
133    </address>
134 ">
135
136 <!ENTITY apt-author.jgunthorpe "
137    <author>
138     <firstname>Jason</firstname>
139     <surname>Gunthorpe</surname>
140    </author>
141 ">
142
143 <!ENTITY apt-author.team "
144    <author>
145     <othername>APT team</othername>
146    </author>
147 ">
148
149 <!ENTITY apt-copyright "
150     <copyright>
151      <holder>Jason Gunthorpe</holder>
152      <year>1998-2001</year>
153     </copyright>
154 ">
155
156 <!ENTITY apt-product "
157    <productname>Linux</productname>
158 ">
159
160 <!-- Boiler plate Bug reporting section -->
161 <!ENTITY manbugs "
162  <refsect1><title>Bugs</title>
163    <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>. 
164    If you wish to report a bug in APT, please see
165    <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
166    &reportbug; command.
167    </para>
168  </refsect1>
169 ">
170
171 <!-- Boiler plate Author section -->
172 <!ENTITY manauthor "
173  <refsect1><title>Author</title>
174    <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
175    </para>
176  </refsect1>
177 ">
178
179 <!-- Should be used within the option section of the text to
180      put in the blurb about -h, -v, -c and -o -->
181 <!ENTITY apt-commonoptions "
182      <varlistentry><term><option>-h</option></term>
183      <term><option>--help</option></term>
184      <listitem><para>Show a short usage summary.
185      </para>
186      </listitem>
187      </varlistentry>
188      
189      <varlistentry>
190       <term><option>-v</option></term>
191       <term><option>--version</option></term>
192       <listitem><para>Show the program version.
193      </para>
194      </listitem>
195      </varlistentry>
196
197      <varlistentry>
198       <term><option>-c</option></term>
199       <term><option>--config-file</option></term>
200      <listitem><para>Configuration File; Specify a configuration file to use. 
201      The program will read the default configuration file and then this 
202      configuration file. See &apt-conf; for syntax information.     
203      </para>
204      </listitem>
205      </varlistentry>
206      
207      <varlistentry>
208       <term><option>-o</option></term>
209       <term><option>--option</option></term>
210      <listitem><para>Set a Configuration Option; This will set an arbitary
211       configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
212      </para>
213      </listitem>
214      </varlistentry>
215 ">
216
217 <!-- Should be used within the option section of the text to
218      put in the blurb about -h, -v, -c and -o -->
219 <!ENTITY apt-cmdblurb "
220    <para>All command line options may be set using the configuration file, the
221    descriptions indicate the configuration option to set. For boolean
222    options you can override the config file by using something like 
223    <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
224    or several other variations.
225    </para>
226 ">
227