1/pod/urpmi.cfg.5.pod

=head1 NAME

urpmi.cfg - urpmi option and media configuration file format

=head1 DESCRIPTION

The urpmi.cfg file is divided in multiple sections: one section to set
global options, and one section per media.

=head1 GLOBAL OPTIONS

Some global options can be activated by default. The following sample
shows how to disable signature checking and avoid transaction splits :

    {
        no-verify-rpm
        split-length: 0
    }

The following options can be written in this section :

=over

=item B<allow-force>

Same as specifying B<--allow-force> for urpmi. Disabled by default.

=item B<allow-nodeps>

Same as specifying B<--allow-nodeps> for urpmi. Disabled by default.

=item B<xml-info>

For remote media, specify when files.xml.lzma, changelog.xml.lzma and info.xml.lzma are downloaded:

=over

=item B<never>

=item B<on-demand>

(This is the default).

The specific xml info file is downloaded when urpmq/urpmf/rpmdrake ask for it.
urpmi.update will remove outdated xml info file.

nb: if urpmq/urpmf/rpmdrake is not run by root, the xml info file is downloaded into /tmp/.urpmi-<uid>/

=item B<update-only>

urpmi.update will update xml info files already required at least once by urpmq/urpmf/rpmdrake.

nb: with B<update-only>, urpmi.update will not update /tmp/.urpmi-<uid>/ xml info files

=item B<always>

all xml info files are downloaded when doing urpmi.addmedia and urpmi.update

=back

=item B<no-suggests>

Same as specifying B<--no-suggests> for urpmi. Disabled by default.

=item B<auto>

Same as specifying B<--auto> for urpmi. Disabled by default.

=item B<compress>

Deprecated (use rsync-options)

=item B<curl-options>

Additional options to pass to B<curl>'s command line when downloading files.

=item B<default-media>

A comma-separated list of media names. By default, only those media will
be taken into account (that is, when you don't specify an alternate list
of media via the B<--media> command-line option.)

=item B<disable-certificate-check>

Disables checking of certificates when connecting to a https medium. By
default the certificates are checked and the connection will fail if
the certificate is invalid. This option shouldn't be used for maximum
security.

=item B<downloader>

Specify which download program to use: B<wget> or B<curl>.

=item B<excludedocs>

Same as specifying B<--excludedocs> for urpmi. Disabled by default.

=item B<excludepath>

Same as B<--excludepath> for urpmi. This options allows to give a comma
separated list of paths to be excluded on installation. There is no path
exclusion by default.

=item B<fuzzy>

Same as B<--fuzzy> for urpmi or urpmq. Enable or disable fuzzy
search. Disabled by default. Enabling it can be written in various ways :
C<fuzzy> or C<fuzzy: yes> or C<fuzzy: on> or C<fuzzy: 1>.

=item B<keep>

Same as B<--keep> for urpmi or urpmq.

=item B<key-ids>

This option is not available on the command line. It allows to use a comma
separated list of key ids to be globally accepted (keys still need to be
authorized by B<rpm>) for any medium unless a specific B<key-ids> option
for this medium is given. There is no default (even Mandriva public key id
70771ff3 is not included by default).

=item B<ignoresize>

Don't check file systems for sufficient disk space before installation.
Same as specifying B<--ignoresize> for urpmi. Disabled by default.

=item B<limit-rate>

Same as B<--limit-rate> for all tools. This option allows to control
download speed; there is no limitation by default. The number is given in
bytes per second, unless a suffix C<K> or C<M> is added.

=item B<max-round-robin-tries>

For mirrorlist, the maximum number of mirrors to try before giving up. (since
sometimes all mirrors have the same problem and it is useless to try more).

=item B<days-between-mirrorlist-update>

After a number of days, urpmi.update will update the list of mirrors (to get
potential new mirrors).

=item B<nopubkey>

Don't import pubkeys when updating media.

=item B<norebuild>

Obsolete. Enabled by default.

=item B<pre-clean, post-clean, clean>

Control cache management for urpmi, default is only activated as
B<post-clean>.

=item B<priority-upgrade>

A comma-separated list of package names that must be installed first,
and that trigger an urpmi restart.

=item B<prohibit-remove>

A comma-separated list of package names that must never be removed (just
like B<basesystem> dependencies).

=item B<prozilla-options>

Same as B<--prozilla-options> for urpmi, urpmq or urpmi.addmedia.
Additional options to pass to B<prozilla> when downloading files.

=item B<repackage>

Same as specifying B<--repackage> for urpmi. Disabled by default.
Ignored when it's set globally by urpmi.recover.

=item B<resume>

Same as specifying B<--resume> for urpmi. Resume transfer of partially-downloaded files.

=item B<retry>

Specify how many times the downloader should retry in case of non-permanent
errors.

=item B<rsync-options>

Additional options to pass to B<rsync> when downloading files.
Note that the rsync options will also be used for ssh media.

=item B<split-length>

Same as B<--split-length> for urpmi. This option allows to control the
minimal length of splitted transactions. The default value is 8. 
Setting this value to 0 disables the splitting of
transactions.

=item B<split-level>

Same as B<--split-level> for urpmi. This option allows to control if
transactions should be splitted depending of the number of packages to
upgrade. The default value is 1.

=item B<strict-arch>

Same as B<--strict-arch> for urpmi. Boolean option, enabled by
default, meaning that packages can not be upgraded with versions for another
architecture.

=item B<verify-rpm>

Same as B<--verify-rpm> for urpmi. Enable or disable signature checking
(it's enabled by default). Disabling it can be written in various ways (as
for all the other boolean options) : C<no-verify-rpm> or C<verify-rpm: no>
or C<verify-rpm: off> or C<verify-rpm: 0>.

=item B<wget-options>

Additional options to pass to B<wget>'s command line when downloading files.

=back

=head1 MEDIUM DESCRIPTION

A medium is described as follows :

    name url {
        ... list of options, one per line ...
    }

where B<name> is the medium name (space characters must be prefixed by a
backslash) and where B<url> is the medium URL.

Most other options like B<list>, B<media_info_dir>, 
B<synthesis>, B<removable>, B<virtual> are for internal use and should be
changed only by experienced users.

Options like B<update>, B<ignore> or B<key-ids> can be modified by users
to respectively mark mediums as update sources, to have them being
ignored, or to specify the allowed GPG key ids for packages from the
medium for verification (unless of course signature checking has been
disabled globally). It's also possible to override B<verify-rpm> and
B<downloader> in a medium description.

The B<noreconfigure> flag can be added to specify that the media should
not be reconfigured (by a reconfiguration file present on the mirror).

Media can be marked as B<static>: this means that they will never get
updated by urpmi.update or other means. This is useful for read-only media
such as CDs.

Please note that B<key-ids> is automatically set by urpmi.update or
urpmi.addmedia if a remote pubkey file is available on the mirror. This
file contains all the GPG armor keys that may be used.

=head1 BUGS

A C<{> should finish a line, as well as a C<}> should start it when used.
This means the construction C<{ no-verify-rpm }> on a single line is
invalid.

=head1 AUTHOR

Pascal Rigaux <pixel@mandriva.com> (original author and current maintainer), 
FranE<ccedil>ois Pons, Rafael Garcia-Suarez 

=head1 SEE ALSO

urpmi(8), urpmi.files(5).
1	=head1 NAME
2
3	urpmi.cfg - urpmi option and media configuration file format
4
5	=head1 DESCRIPTION
6
7	The urpmi.cfg file is divided in multiple sections: one section to set
8	global options, and one section per media.
9
10	=head1 GLOBAL OPTIONS
11
12	Some global options can be activated by default. The following sample
13	shows how to disable signature checking and avoid transaction splits :
14
15	{
16	no-verify-rpm
17	split-length: 0
18	}
19
20	The following options can be written in this section :
21
22	=over
23
24	=item B<allow-force>
25
26	Same as specifying B<--allow-force> for urpmi. Disabled by default.
27
28	=item B<allow-nodeps>
29
30	Same as specifying B<--allow-nodeps> for urpmi. Disabled by default.
31
32	=item B<xml-info>
33
34	For remote media, specify when files.xml.lzma, changelog.xml.lzma and info.xml.lzma are downloaded:
35
36	=over
37
38	=item B<never>
39
40	=item B<on-demand>
41
42	(This is the default).
43
44	The specific xml info file is downloaded when urpmq/urpmf/rpmdrake ask for it.
45	urpmi.update will remove outdated xml info file.
46
47	nb: if urpmq/urpmf/rpmdrake is not run by root, the xml info file is downloaded into /tmp/.urpmi-<uid>/
48
49	=item B<update-only>
50
51	urpmi.update will update xml info files already required at least once by urpmq/urpmf/rpmdrake.
52
53	nb: with B<update-only>, urpmi.update will not update /tmp/.urpmi-<uid>/ xml info files
54
55	=item B<always>
56
57	all xml info files are downloaded when doing urpmi.addmedia and urpmi.update
58
59	=back
60
61	=item B<no-suggests>
62
63	Same as specifying B<--no-suggests> for urpmi. Disabled by default.
64
65	=item B<auto>
66
67	Same as specifying B<--auto> for urpmi. Disabled by default.
68
69	=item B<compress>
70
71	Deprecated (use rsync-options)
72
73	=item B<curl-options>
74
75	Additional options to pass to B<curl>'s command line when downloading files.
76
77	=item B<default-media>
78
79	A comma-separated list of media names. By default, only those media will
80	be taken into account (that is, when you don't specify an alternate list
81	of media via the B<--media> command-line option.)
82
83	=item B<disable-certificate-check>
84
85	Disables checking of certificates when connecting to a https medium. By
86	default the certificates are checked and the connection will fail if
87	the certificate is invalid. This option shouldn't be used for maximum
88	security.
89
90	=item B<downloader>
91
92	Specify which download program to use: B<wget> or B<curl>.
93
94	=item B<excludedocs>
95
96	Same as specifying B<--excludedocs> for urpmi. Disabled by default.
97
98	=item B<excludepath>
99
100	Same as B<--excludepath> for urpmi. This options allows to give a comma
101	separated list of paths to be excluded on installation. There is no path
102	exclusion by default.
103
104	=item B<fuzzy>
105
106	Same as B<--fuzzy> for urpmi or urpmq. Enable or disable fuzzy
107	search. Disabled by default. Enabling it can be written in various ways :
108	C<fuzzy> or C<fuzzy: yes> or C<fuzzy: on> or C<fuzzy: 1>.
109
110	=item B<keep>
111
112	Same as B<--keep> for urpmi or urpmq.
113
114	=item B<key-ids>
115
116	This option is not available on the command line. It allows to use a comma
117	separated list of key ids to be globally accepted (keys still need to be
118	authorized by B<rpm>) for any medium unless a specific B<key-ids> option
119	for this medium is given. There is no default (even Mandriva public key id
120	70771ff3 is not included by default).
121
122	=item B<ignoresize>
123
124	Don't check file systems for sufficient disk space before installation.
125	Same as specifying B<--ignoresize> for urpmi. Disabled by default.
126
127	=item B<limit-rate>
128
129	Same as B<--limit-rate> for all tools. This option allows to control
130	download speed; there is no limitation by default. The number is given in
131	bytes per second, unless a suffix C<K> or C<M> is added.
132
133	=item B<max-round-robin-tries>
134
135	For mirrorlist, the maximum number of mirrors to try before giving up. (since
136	sometimes all mirrors have the same problem and it is useless to try more).
137
138	=item B<days-between-mirrorlist-update>
139
140	After a number of days, urpmi.update will update the list of mirrors (to get
141	potential new mirrors).
142
143	=item B<nopubkey>
144
145	Don't import pubkeys when updating media.
146
147	=item B<norebuild>
148
149	Obsolete. Enabled by default.
150
151	=item B<pre-clean, post-clean, clean>
152
153	Control cache management for urpmi, default is only activated as
154	B<post-clean>.
155
156	=item B<priority-upgrade>
157
158	A comma-separated list of package names that must be installed first,
159	and that trigger an urpmi restart.
160
161	=item B<prohibit-remove>
162
163	A comma-separated list of package names that must never be removed (just
164	like B<basesystem> dependencies).
165
166	=item B<prozilla-options>
167
168	Same as B<--prozilla-options> for urpmi, urpmq or urpmi.addmedia.
169	Additional options to pass to B<prozilla> when downloading files.
170
171	=item B<repackage>
172
173	Same as specifying B<--repackage> for urpmi. Disabled by default.
174	Ignored when it's set globally by urpmi.recover.
175
176	=item B<resume>
177
178	Same as specifying B<--resume> for urpmi. Resume transfer of partially-downloaded files.
179
180	=item B<retry>
181
182	Specify how many times the downloader should retry in case of non-permanent
183	errors.
184
185	=item B<rsync-options>
186
187	Additional options to pass to B<rsync> when downloading files.
188	Note that the rsync options will also be used for ssh media.
189
190	=item B<split-length>
191
192	Same as B<--split-length> for urpmi. This option allows to control the
193	minimal length of splitted transactions. The default value is 8.
194	Setting this value to 0 disables the splitting of
195	transactions.
196
197	=item B<split-level>
198
199	Same as B<--split-level> for urpmi. This option allows to control if
200	transactions should be splitted depending of the number of packages to
201	upgrade. The default value is 1.
202
203	=item B<strict-arch>
204
205	Same as B<--strict-arch> for urpmi. Boolean option, enabled by
206	default, meaning that packages can not be upgraded with versions for another
207	architecture.
208
209	=item B<verify-rpm>
210
211	Same as B<--verify-rpm> for urpmi. Enable or disable signature checking
212	(it's enabled by default). Disabling it can be written in various ways (as
213	for all the other boolean options) : C<no-verify-rpm> or C<verify-rpm: no>
214	or C<verify-rpm: off> or C<verify-rpm: 0>.
215
216	=item B<wget-options>
217
218	Additional options to pass to B<wget>'s command line when downloading files.
219
220	=back
221
222	=head1 MEDIUM DESCRIPTION
223
224	A medium is described as follows :
225
226	name url {
227	... list of options, one per line ...
228	}
229
230	where B<name> is the medium name (space characters must be prefixed by a
231	backslash) and where B<url> is the medium URL.
232
233	Most other options like B<list>, B<media_info_dir>,
234	B<synthesis>, B<removable>, B<virtual> are for internal use and should be
235	changed only by experienced users.
236
237	Options like B<update>, B<ignore> or B<key-ids> can be modified by users
238	to respectively mark mediums as update sources, to have them being
239	ignored, or to specify the allowed GPG key ids for packages from the
240	medium for verification (unless of course signature checking has been
241	disabled globally). It's also possible to override B<verify-rpm> and
242	B<downloader> in a medium description.
243
244	The B<noreconfigure> flag can be added to specify that the media should
245	not be reconfigured (by a reconfiguration file present on the mirror).
246
247	Media can be marked as B<static>: this means that they will never get
248	updated by urpmi.update or other means. This is useful for read-only media
249	such as CDs.
250
251	Please note that B<key-ids> is automatically set by urpmi.update or
252	urpmi.addmedia if a remote pubkey file is available on the mirror. This
253	file contains all the GPG armor keys that may be used.
254
255	=head1 BUGS
256
257	A C<{> should finish a line, as well as a C<}> should start it when used.
258	This means the construction C<{ no-verify-rpm }> on a single line is
259	invalid.
260
261	=head1 AUTHOR
262
263	Pascal Rigaux <pixel@mandriva.com> (original author and current maintainer),
264	FranE<ccedil>ois Pons, Rafael Garcia-Suarez
265
266	=head1 SEE ALSO
267
268	urpmi(8), urpmi.files(5).