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