21120d16a870313c034de327ca4b6d253081efed
[apt.git] / doc / apt-config.8
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "APT-CONFIG" "8" "29 May 2006" "" ""
7
8 .SH NAME
9 apt-config \- APT Configuration Query program
10 .SH SYNOPSIS
11
12 \fBapt-config\fR [ \fB-hv\fR ] [ \fB-o=\fIconfig string\fB\fR ] [ \fB-c=\fIfile\fB\fR ] { \fBshell\fR | \fBdump\fR }
13
14 .SH "DESCRIPTION"
15 .PP
16 \fBapt-config\fR is an internal program used by various portions of
17 the APT suite to provide consistent configurability. It accesses the main 
18 configuration file \fI/etc/apt/apt.conf\fR in a manner that is 
19 easy to use by scripted applications.
20 .PP
21 Unless the \fB-h\fR, or \fB--help\fR option is given one of the
22 commands below must be present.
23 .TP
24 \fBshell\fR
25 shell is used to access the configuration information from a shell 
26 script. It is given pairs of arguments, the first being a shell 
27 variable and the second the configuration value to query. As output 
28 it lists a series of shell assignments commands for each present value. 
29 In a shell script it should be used like:
30
31
32 .nf
33 OPTS="-f"
34 RES=`apt-config shell OPTS MyApp::Options`
35 eval $RES
36 .fi
37
38 This will set the shell environment variable $OPTS to the value of
39 MyApp::Options with a default of \fB-f\fR\&.
40
41 The configuration item may be postfixed with a /[fdbi]. f returns file
42 names, d returns directories, b returns true or false and i returns an 
43 integer. Each of the returns is normalized and verified internally.
44 .TP
45 \fBdump\fR
46 Just show the contents of the configuration space.
47 .SH "OPTIONS"
48 .PP
49 All command line options may be set using the configuration file, the
50 descriptions indicate the configuration option to set. For boolean
51 options you can override the config file by using something like 
52 \fB-f-\fR,\fB--no-f\fR, \fB-f=no\fR or several other variations.
53 .TP
54 \fB-h\fR
55 .TP
56 \fB--help\fR
57 Show a short usage summary.
58 .TP
59 \fB-v\fR
60 .TP
61 \fB--version\fR
62 Show the program version.
63 .TP
64 \fB-c\fR
65 .TP
66 \fB--config-file\fR
67 Configuration File; Specify a configuration file to use. 
68 The program will read the default configuration file and then this 
69 configuration file. See \fB\fIapt.conf\fB\fR(5) for syntax information.     
70 .TP
71 \fB-o\fR
72 .TP
73 \fB--option\fR
74 Set a Configuration Option; This will set an arbitrary configuration 
75 option. The syntax is \fB-o Foo::Bar=bar\fR\&.
76 .SH "SEE ALSO"
77 .PP
78 \fB\fIapt.conf\fB\fR(5)
79 .SH "DIAGNOSTICS"
80 .PP
81 \fBapt-config\fR returns zero on normal operation, decimal 100 on error.
82 .SH "BUGS"
83 .PP
84 See the APT bug page <URL:http://bugs.debian.org/src:apt>\&.  
85 If you wish to report a bug in APT, please see
86 \fI/usr/share/doc/debian/bug-reporting.txt\fR or the \fBreportbug\fR(1) command.
87 .SH "AUTHOR"
88 .PP
89 APT was written by the APT team <apt@packages.debian.org>\&.