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