File: apt-file.1.sgml

package info (click to toggle)
apt-file 2.0.3-7
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 112 kB
  • ctags: 6
  • sloc: perl: 299; makefile: 61
file content (399 lines) | stat: -rw-r--r-- 9,193 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry>
  <refentryinfo>
    <address>
      <email>sjg@debian.org</email>
    </address>
    <author>
      <firstname>Sebastien</firstname>
      <surname>Gross</surname>
      <othername>J.</othername>
    </author>
    <date>May 2003</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>apt-file</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>apt-file</refname>
    <refpurpose>
      APT package searching utility -- command-line interface
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>apt-file</command>
      <arg><option>options</option></arg>
      <arg>action</arg>
      <arg>pattern</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para><command>apt-file</command> is a command line tool for
      searching packages for the APT packaging system.</para>
    <para>Some actions are required to run the search:</para>

    <variablelist>
      <varlistentry>
	<term>update</term>
	<listitem>
	  <para>
	    Resynchronize the package contents from their sources. The
	    contents packages are fetched from the location(s)
	    specified in
	    <filename>/etc/apt/sources.list</filename>. This command
	    attempt to fetch the
	    <filename>Contents-&lt;ARCH&gt;.gz</filename> file from
	    remote source.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>search</term>
	<listitem>
	  <para>
	    Search in which package file is included. A list of all
	    package containing the <literal>pattern</literal> pattern
	    is returned.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>list</term>
	<listitem>
	  <para>
	    List the contents of a package matching the
	    <literal>pattern</literal> pattern. This action is very
	    close to the <command>dpkg -S</command> command except the
	    package does not need to be installed or fetched.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>purge</term>
	<listitem>
	  <para>
	    remove all <filename>Contents-&lt;ARCH&gt;.gz</filename>
	    files in cache directory.
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
	<term>
	  <option>--cache | -c</option> <literal>cache-directory</literal>
	</term>
	<listitem>
	  <para>
	    Sets the cache directory to
	    <literal>cache-directory</literal> instead of its default
	    value (<filename>/var/cache/apt</filename>) thus you can
	    use <command>apt-file</command> even if you do not have
	    administrator privileges.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--verbose | -v</option>
	</term>
	<listitem>
	  <para>
	    Run <command>apt-file</command> in verbose mode.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--cdrom-mount | -d</option> <literal>cdrom-mount-point</literal>
	</term>
	<listitem>
	  <para>
Use <literal>cdrom-mount-point</literal> instead of
<command>apt</command>'s.
</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--ignore-case | -i</option>
	</term>
	<listitem>
	  <para>Do not expand <literal>pattern</literal>.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--regexp | -x</option>
	</term>
	<listitem>
	  <para>
	    Treat <literal>pattern</literal> as a regular expression.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--version | -V</option>
	</term>
	<listitem>
	  <para>Show version number.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--architecture | -a</option>
	  architecture
	</term>
	<listitem>
	  <para>
	  Sets architecture to <literal>architecture</literal>. This
	  option is useful if you search a package for a different
	  architecture the one installed on your system.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--sources-list</option> | <option>-s</option>
	  sources.list
	</term>
	<listitem>
	  <para>
	    Sets the <filename>sources.list</filename> file to a
	    different value its default
	    <filename>/etc/apt/sources.list</filename>.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--package-only | -l</option>
	</term>
	<listitem>
	  <para>
	    Only display package name. Do not display file names.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>--fixed-string | -F</option>
	</term>
	<listitem>
	  <para>
	    Do not expand search pattern with generic characters at
	    pattern's start and end.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>--dummy | -y</option>
	</term>
	<listitem>
	  <para>
	    Run in dummy mode (no action).
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>--help | -h</option>
	</term>
	<listitem>
	  <para>Display a short help screen.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>CONFIGURATION FILE</title>
    <para>
      The <command>apt-file</command> configuration file
      (<filename>/etc/apt/apt-file.conf)</filename> changed from
      version 1 to version 2. Now only fetch backends are defined in
      the configuration file. Thus it is much easier to configure
      proxies.
    </para>
    <para>
      A string expension is done on severa value. See <literal>string
	expension</literal> section.
    </para>
    <variablelist>
      <varlistentry>
	<term>destination</term>
	<listitem>
	  <para>
	    This variable describes how cached files will be named.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>http | ftp | ssh | rsh | file | cdrom</term>
	<listitem>
	  <para>
	    Here are the commands used to fetch files.
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
    <refsect2>
      <title>String expension</title>
      <para>
	A <filename>sources.list</filename> entry is defined as:
	<screen>
	  deb uri dist componant1 componant2 ...
	</screen>
	an uri, is defined as:
	<screen>
	  proto:/[/][user[:password]@]host[:port][/path]
	</screen>
      </para>
      <variablelist>
	<varlistentry>
	  <term>&lt;host&gt;</term>
	  <listitem>
	    <para>replace with the hostname.</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>&lt;port&gt;</term>
	  <listitem>
	    <para>replace with the port number.</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>&lt;uri&gt;</term>
	  <listitem>
	    <para>replace with full uri</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>&lt;path&gt;</term>
	  <listitem>
	    <para>
	      replace with full path (relative to / on the host)
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>&lt;dist&gt;</term>
	  <listitem>
	    <para>replace with distribution name</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>&lt;comp&gt;</term>
	  <listitem>
	    <para>replace with component name</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>&lt;cache&gt;</term>
	  <listitem><para>replace with cache directory</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>&lt;dest&gt;</term>
	  <listitem>
	    <para>
	      replace with <literal>destination</literal> expended
	      value.
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>&lt;cdrom&gt;</term>
	  <listitem>
	    <para>
	      replace with <literal>cdrom-mount-point</literal>.
	    </para>
	  </listitem>
	</varlistentry>

      </variablelist>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>FILES</title>

    <variablelist>
      <varlistentry>
	<term><filename>/etc/apt/sources.list</filename></term>
	<listitem>
	  <para>Locations to fetch packages contents from.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><filename>/etc/apt/apt-file.conf</filename></term>
	<listitem>
	  <para>
	    Configuration file for <command></command>apt-file.
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <command>auto-apt</command>(1), <command>apt-cache</command>(8),
      <command>apt-cdrom</command>(8), <command>dpkg</command>(8),
      <command>dselect</command>(8),
      <filename>sources.list</filename>(5),
      <filename>apt.conf</filename>(5),
      <command>apt_preferences</command>(5).
    </para>
    <para>
      The APT users guide in
      <filename>/usr/share/doc/apt/</filename>
    </para>
  </refsect1>
  <refsect1>
    <title>BUGS</title>
    <para>cdrom backend haddn't been tested.</para>
    <para>
      Non-release line in sources.list is not handled by apt-file.
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>
      <command>apt-file</command> was written by Sebastien J. Gross
      <email>sjg@debian.org</email>.
    </para>
  </refsect1>
</refentry>