[apt-legacy.git] / doc / apt-config.8

.\"     Title: apt\-config
.\"    Author: Jason Gunthorpe
.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
.\"      Date: 29 February 2004
.\"    Manual: 
.\"    Source: Linux
.\"
.TH "APT\-CONFIG" "8" "29 February 2004" "Linux" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
apt\-config \- APT Configuration Query program
.SH "SYNOPSIS"
.HP 11
\fBapt\-config\fR [\fB\-hv\fR] [\fB\-o=\fR\fB\fIconfig\ string\fR\fR] [\fB\-c=\fR\fB\fIfile\fR\fR] {[shell] | [dump]}
.SH "DESCRIPTION"
.PP
\fBapt\-config\fR
is an internal program used by various portions of the APT suite to provide consistent configurability. It accesses the main configuration file
\fI/etc/apt/apt.conf\fR
in a manner that is easy to use by scripted applications.
.PP
Unless the
\fB\-h\fR, or
\fB\-\-help\fR
option is given one of the commands below must be present.
.PP
shell
.RS 3n
shell is used to access the configuration information from a shell script. It is given pairs of arguments, the first being a shell variable and the second the configuration value to query. As output it lists a series of shell assignments commands for each present value. In a shell script it should be used like:
.sp
.RS 3n
.nf
OPTS="\-f"
RES=`apt\-config shell OPTS MyApp::options`
eval $RES
.fi
.RE
This will set the shell environment variable $OPTS to the value of MyApp::options with a default of
\fB\-f\fR.
.sp
The configuration item may be postfixed with a /[fdbi]. f returns file names, d returns directories, b returns true or false and i returns an integer. Each of the returns is normalized and verified internally.
.RE
.PP
dump
.RS 3n
Just show the contents of the configuration space.
.RE
.SH "OPTIONS"
.PP
All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like
\fB\-f\-\fR,\fB\-\-no\-f\fR,
\fB\-f=no\fR
or several other variations.
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 3n
Show a short usage summary.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 3n
Show the program version.
.RE
.PP
\fB\-c\fR, \fB\-\-config\-file\fR
.RS 3n
Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. See
\fBapt.conf\fR(5)
for syntax information.
.RE
.PP
\fB\-o\fR, \fB\-\-option\fR
.RS 3n
Set a Configuration Option; This will set an arbitary configuration option. The syntax is
\fB\-o Foo::Bar=bar\fR.
.RE
.SH "SEE ALSO"
.PP
\fBapt.conf\fR(5)
.SH "DIAGNOSTICS"
.PP
\fBapt\-config\fR
returns zero on normal operation, decimal 100 on error.
.SH "BUGS"
.PP
[1]\&\fIAPT bug page\fR. If you wish to report a bug in APT, please see
\fI/usr/share/doc/debian/bug\-reporting.txt\fR
or the
\fBreportbug\fR(1)
command.
.SH "AUTHORS"
.PP
\fBJason Gunthorpe\fR
.sp -1n
.IP "" 3n
Author.
.PP
\fBAPT team\fR
.sp -1n
.IP "" 3n
Author.
.SH "REFERENCES"
.TP 3
1.\ APT bug page
\%http://bugs.debian.org/src:apt
Commit	Line	Data
da6ee469 JF	1	.\" Title: apt\-config
	2	.\" Author: Jason Gunthorpe
	3	.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
	4	.\" Date: 29 February 2004
	5	.\" Manual:
	6	.\" Source: Linux
	7	.\"
	8	.TH "APT\-CONFIG" "8" "29 February 2004" "Linux" ""
	9	.\" disable hyphenation
	10	.nh
	11	.\" disable justification (adjust text to left margin only)
	12	.ad l
	13	.SH "NAME"
	14	apt\-config \- APT Configuration Query program
	15	.SH "SYNOPSIS"
	16	.HP 11
	17	\fBapt\-config\fR [\fB\-hv\fR] [\fB\-o=\fR\fB\fIconfig\ string\fR\fR] [\fB\-c=\fR\fB\fIfile\fR\fR] {[shell] \| [dump]}
	18	.SH "DESCRIPTION"
	19	.PP
	20	\fBapt\-config\fR
	21	is an internal program used by various portions of the APT suite to provide consistent configurability. It accesses the main configuration file
	22	\fI/etc/apt/apt.conf\fR
	23	in a manner that is easy to use by scripted applications.
	24	.PP
	25	Unless the
	26	\fB\-h\fR, or
	27	\fB\-\-help\fR
	28	option is given one of the commands below must be present.
	29	.PP
	30	shell
	31	.RS 3n
	32	shell is used to access the configuration information from a shell script. It is given pairs of arguments, the first being a shell variable and the second the configuration value to query. As output it lists a series of shell assignments commands for each present value. In a shell script it should be used like:
	33	.sp
	34	.RS 3n
	35	.nf
	36	OPTS="\-f"
	37	RES=`apt\-config shell OPTS MyApp::options`
	38	eval $RES
	39	.fi
	40	.RE
	41	This will set the shell environment variable $OPTS to the value of MyApp::options with a default of
	42	\fB\-f\fR.
	43	.sp
	44	The configuration item may be postfixed with a /[fdbi]. f returns file names, d returns directories, b returns true or false and i returns an integer. Each of the returns is normalized and verified internally.
	45	.RE
	46	.PP
	47	dump
	48	.RS 3n
	49	Just show the contents of the configuration space.
	50	.RE
	51	.SH "OPTIONS"
	52	.PP
	53	All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like
	54	\fB\-f\-\fR,\fB\-\-no\-f\fR,
	55	\fB\-f=no\fR
	56	or several other variations.
	57	.PP
	58	\fB\-h\fR, \fB\-\-help\fR
	59	.RS 3n
	60	Show a short usage summary.
	61	.RE
	62	.PP
	63	\fB\-v\fR, \fB\-\-version\fR
	64	.RS 3n
65	Show the program version.
66	.RE
67	.PP
68	\fB\-c\fR, \fB\-\-config\-file\fR
69	.RS 3n
70	Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. See
71	\fBapt.conf\fR(5)
72	for syntax information.
73	.RE
74	.PP
75	\fB\-o\fR, \fB\-\-option\fR
76	.RS 3n
77	Set a Configuration Option; This will set an arbitary configuration option. The syntax is
78	\fB\-o Foo::Bar=bar\fR.
79	.RE
80	.SH "SEE ALSO"
81	.PP
82	\fBapt.conf\fR(5)
83	.SH "DIAGNOSTICS"
84	.PP
85	\fBapt\-config\fR
86	returns zero on normal operation, decimal 100 on error.
87	.SH "BUGS"
88	.PP
89	[1]\&\fIAPT bug page\fR. If you wish to report a bug in APT, please see
90	\fI/usr/share/doc/debian/bug\-reporting.txt\fR
91	or the
92	\fBreportbug\fR(1)
93	command.
94	.SH "AUTHORS"
95	.PP
96	\fBJason Gunthorpe\fR
97	.sp -1n
98	.IP "" 3n
99	Author.
100	.PP
101	\fBAPT team\fR
102	.sp -1n
103	.IP "" 3n
104	Author.
105	.SH "REFERENCES"
106	.TP 3
107	1.\ APT bug page
108	\%http://bugs.debian.org/src:apt