← Back to branch summary

~mvo/apt/dep8

« back to all changes in this revision

Viewing changes to doc/apt-config.8.yo

  • Committer: Arch Librarian
  • Date: 2004-09-20 16:56:32 UTC
  • Revision ID: Arch-1:apt@arch.ubuntu.com%apt--MAIN--0--patch-614
Join with aliencode
Author: jgg
Date: 2001-02-20 07:03:16 GMT
Join with aliencode

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/apt-config.8.yo
1
 
mailto(apt@packages.debian.org)
2
 
manpage(apt-config)(8)(14 Feb 1999)(apt)()
3
 
manpagename(apt-config)(APT Configuration Query program)
4
 
 
5
 
manpagesynopsis()
6
 
apt-config command
7
 
 
8
 
manpagedescription()
9
 
bf(apt-config) is an internal program used by various portions of the APT
10
 
suite to provide consistent configurability. It accesses the main configuarion
11
 
file /etc/apt/apt.conf in a manner that is easy to use by scripted
12
 
applications.
13
 
 
14
 
em(command) is one of:
15
 
itemize(
16
 
  it() shell
17
 
  it() dump
18
 
)
19
 
 
20
 
Unless the -h, or --help option is given one of the above commands
21
 
must be present.
22
 
 
23
 
startdit()
24
 
dit(bf(shell))
25
 
bf(shell) is used to access the configuration information from a shell script.
26
 
It is given pairs of arguments, the first being a shell variable and the
27
 
second the configuration value to query. As output it lists a series of shell
28
 
assignments commands for each present value. In a shell script it should be
29
 
used like:
30
 
 
31
 
verb(
32
 
OPTS="-f"
33
 
 
34
 
RES=`apt-config shell OPTS MyApp::Options`
35
 
 
36
 
eval $RES
37
 
)
38
 
 
39
 
This will set the shell environment variable $OPTS to the value of
40
 
MyApp::Options with a default of -f.
41
 
 
42
 
If the configuration item to retrieve is prefixed with a / then it will
43
 
be retrieved using filename mode which prepends base paths.
44
 
 
45
 
dit(bf(dump))
46
 
Just show the contents of the configuration space.
47
 
 
48
 
enddit()
49
 
 
50
 
manpageoptions()
51
 
All command line options may be set using the configuration file, the
52
 
descriptions indicate the configuration option to set. For boolean
53
 
options you can override the config file by using something like bf(-f-),
54
 
bf(--no-f), bf(-f=no) or several other variations.
55
 
 
56
 
startdit()
57
 
dit(bf(-h, --help))
58
 
Show a short usage summary.
59
 
 
60
 
dit(bf(-v, --version))
61
 
Show the program verison.
62
 
 
63
 
dit(bf(-c, --config-file))
64
 
Configuration File; Specify a configuration file to use. bf(apt-get) will
65
 
read the default configuration file and then this configuration file. See
66
 
bf(apt.conf(5)) for syntax information.
67
 
 
68
 
dit(bf(-o, --option))
69
 
Set a Configuration Option; This will set an arbitary configuration option.
70
 
The syntax is 
71
 
verb(-o Foo::Bar=bar)
72
 
enddit()
73
 
 
74
 
manpageseealso()
75
 
apt.conf(5)
76
 
 
77
 
manpagediagnostics()
78
 
apt-config returns zero on normal operation, decimal 100 on error.
79
 
 
80
 
manpagebugs()
81
 
See http://bugs.debian.org/apt.  If you wish to report a
82
 
bug in bf(apt-config), please see bf(/usr/doc/debian/bug-reporting.txt)
83
 
or the bf(bug(1)) command.
84
 
 
85
 
manpageauthor()
86
 
apt-get was written by the APT team <apt@packages.debian.org>.