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