]> git.saurik.com Git - apt.git/blob - doc/apt.ent
- Modify the description for apt-utils to reflect the f...
[apt.git] / 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</>">
6 <!ENTITY aptconfdir "<filename>/etc/apt.conf</>">
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/</RefEntryTitle>
13 <ManVolNum/5/
14 </CiteRefEntry>">
15
16 <!ENTITY apt-get "<CiteRefEntry>
17 <RefEntryTitle><command/apt-get/</RefEntryTitle>
18 <ManVolNum/8/
19 </CiteRefEntry>">
20
21 <!ENTITY apt-config "<CiteRefEntry>
22 <RefEntryTitle><command/apt-config/</RefEntryTitle>
23 <ManVolNum/8/
24 </CiteRefEntry>">
25
26 <!ENTITY apt-cdrom "<CiteRefEntry>
27 <RefEntryTitle><command/apt-cdrom/</RefEntryTitle>
28 <ManVolNum/8/
29 </CiteRefEntry>">
30
31 <!ENTITY apt-cache "<CiteRefEntry>
32 <RefEntryTitle><command/apt-cache/</RefEntryTitle>
33 <ManVolNum/8/
34 </CiteRefEntry>">
35
36 <!ENTITY apt-preferences "<CiteRefEntry>
37 <RefEntryTitle><command/apt_preferences/</RefEntryTitle>
38 <ManVolNum/5/
39 </CiteRefEntry>">
40
41 <!ENTITY sources-list "<CiteRefEntry>
42 <RefEntryTitle><filename/sources.list/</RefEntryTitle>
43 <ManVolNum/5/
44 </CiteRefEntry>">
45
46 <!ENTITY reportbug "<CiteRefEntry>
47 <RefEntryTitle><command/reportbug/</RefEntryTitle>
48 <ManVolNum/1/
49 </CiteRefEntry>">
50
51 <!ENTITY dpkg "<CiteRefEntry>
52 <RefEntryTitle><command/dpkg/</RefEntryTitle>
53 <ManVolNum/8/
54 </CiteRefEntry>">
55
56 <!ENTITY dpkg-buildpackage "<CiteRefEntry>
57 <RefEntryTitle><command/dpkg-buildpackage/</RefEntryTitle>
58 <ManVolNum/1/
59 </CiteRefEntry>">
60
61 <!ENTITY gzip "<CiteRefEntry>
62 <RefEntryTitle><command/gzip/</RefEntryTitle>
63 <ManVolNum/1/
64 </CiteRefEntry>">
65
66 <!ENTITY dpkg-scanpackages "<CiteRefEntry>
67 <RefEntryTitle><command/dpkg-scanpackages/</RefEntryTitle>
68 <ManVolNum/8/
69 </CiteRefEntry>">
70
71 <!ENTITY dpkg-scansources "<CiteRefEntry>
72 <RefEntryTitle><command/dpkg-scansources/</RefEntryTitle>
73 <ManVolNum/8/
74 </CiteRefEntry>">
75
76 <!ENTITY dselect "<CiteRefEntry>
77 <RefEntryTitle><command/dselect/</RefEntryTitle>
78 <ManVolNum/8/
79 </CiteRefEntry>">
80
81 <!-- Boiler plate docinfo section -->
82 <!ENTITY apt-docinfo "
83 <docinfo>
84 <address><email>apt@packages.debian.org</></address>
85 <author><firstname>Jason</> <surname>Gunthorpe</></>
86 <copyright><year>1998-2001</> <holder>Jason Gunthorpe</></>
87 <date>12 March 2001</>
88 </docinfo>
89 ">
90
91 <!-- Boiler plate Bug reporting section -->
92 <!ENTITY manbugs "
93 <RefSect1><Title>Bugs</>
94 <para>
95 See the <ulink url='http://bugs.debian.org/apt'>APT bug page</>.
96 If you wish to report a bug in APT, please see
97 <filename>/usr/share/doc/debian/bug-reporting.txt</> or the &reportbug; command.
98 </RefSect1>
99 ">
100
101 <!-- Boiler plate Author section -->
102 <!ENTITY manauthor "
103 <RefSect1><Title>Author</>
104 <para>
105 APT was written by the APT team <email>apt@packages.debian.org</>.
106 </RefSect1>
107 ">
108
109 <!-- Should be used within the option section of the text to
110 put in the blurb about -h, -v, -c and -o -->
111 <!ENTITY apt-commonoptions "
112 <VarListEntry><term><option/-h/</><term><option/--help/</>
113 <ListItem><Para>
114 Show a short usage summary.
115 </VarListEntry>
116
117 <VarListEntry><term><option/-v/</><term><option/--version/</>
118 <ListItem><Para>
119 Show the program version.
120 </VarListEntry>
121
122 <VarListEntry><term><option/-c/</><term><option/--config-file/</>
123 <ListItem><Para>
124 Configuration File; Specify a configuration file to use.
125 The program will read the default configuration file and then this
126 configuration file. See &apt-conf; for syntax information.
127 </VarListEntry>
128
129 <VarListEntry><term><option/-o/</><term><option/--option/</>
130 <ListItem><Para>
131 Set a Configuration Option; This will set an arbitary configuration
132 option. The syntax is <option>-o Foo::Bar=bar</>.
133 </VarListEntry>
134 ">
135
136 <!-- Should be used within the option section of the text to
137 put in the blurb about -h, -v, -c and -o -->
138 <!ENTITY apt-cmdblurb "
139 <para>
140 All command line options may be set using the configuration file, the
141 descriptions indicate the configuration option to set. For boolean
142 options you can override the config file by using something like
143 <option/-f-/,<option/--no-f/, <option/-f=no/ or several other variations.
144 </para>
145 ">