blob: 134c8b086e45eaee077349b9e47d7408da088634 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;
]>
<refentry>
<refentryinfo>
&apt-author.jgunthorpe;
&apt-author.team;
&apt-email;
&apt-product;
<!-- The last update date -->
<date>2012-05-11T00:00:00Z</date>
</refentryinfo>
<refmeta>
<refentrytitle>apt-config</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="manual">APT</refmiscinfo>
</refmeta>
<!-- Man page title -->
<refnamediv>
<refname>apt-config</refname>
<refpurpose>APT Configuration Query program</refpurpose>
</refnamediv>
&synopsis-command-apt-config;
<refsect1><title>Description</title>
<para><command>apt-config</command> is an internal program used by various
portions of the APT suite to provide consistent configurability. It accesses
the main configuration file <filename>/etc/apt/apt.conf</filename> in a
manner that is easy to use by scripted applications.</para>
<para>Unless the <option>-h</option>, or <option>--help</option> option is
given, one of the commands below must be present.
</para>
<variablelist>
<varlistentry><term><option>shell</option></term>
<listitem><para>
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:
</para>
<informalexample><programlisting>
OPTS="-f"
RES=`apt-config shell OPTS MyApp::options`
eval $RES
</programlisting></informalexample>
<para>This will set the shell environment variable $OPTS to the value of
MyApp::options with a default of <option>-f</option>.</para>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry><term><option>dump</option></term>
<listitem><para>
Just show the contents of the configuration space.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>options</title>
&apt-cmdblurb;
<variablelist>
<varlistentry>
<term><option>--empty</option></term>
<listitem><para>Include options which have an empty value. This is the default, so
use --no-empty to remove them from the output.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--format '<replaceable>%f "%v";%n</replaceable>'</option></term>
<listitem><para>Defines the output of each config option. %t will be replaced with the name of the option,
%f with the complete optionname and %v with the value of the option.
Use uppercase letters and special characters in the value will be encoded to ensure that
it can e.g. be savely used in a quoted-string as defined by RFC822. Additionally
%n will be replaced by a newline, %N by a tab. A % can be
printed by using %%.</para></listitem>
</varlistentry>
&apt-commonoptions;
</variablelist>
</refsect1>
<refsect1><title>See Also</title>
<para>&apt-conf;
</para>
</refsect1>
<refsect1><title>Diagnostics</title>
<para><command>apt-config</command> returns zero on normal operation, decimal 100 on error.
</para>
</refsect1>
&manbugs;
</refentry>
|
