Debian Codegraph @

upstream/debian-unstable/man5/rpm-config.5

raw
1 .\" Generated by scdoc 1.11.4
2 .\" Complete documentation for this program is not available as a GNU info page
3 .ie \n(.g .ds Aq \(aq
4 .el .ds Aq '
5 .nh
6 .ad l
7 .\" Begin generated content:
8 .TH "RPM-CONFIG" "5" "2026-04-10" "RPM 6.0.1"
9 .PP
10 .SH NAME
11 \fBrpm-config\fR - rpm runtime macro configuration
12 .PP
13 .SH SYNOPSIS
14 \fINAME\fR \fIVALUE\fR
15 .PP
16 .SH FILES
17 \fI/usr/lib/rpm/macros\fR
18 .br
19 \fI/usr/lib/rpm/macros.\&d/macros.\&*\fR
20 .br
21 \fI/usr/lib/rpm/platform/%{_target}/macros\fR
22 .br
23 \fI/usr/lib/rpm/fileattrs/*.\&attr\fR
24 .br
25 \fI/usr/lib/rpm/<vendor>/macros\fR
26 .br
27 \fI/etc/rpm/macros.\&*\fR
28 .br
29 \fI/etc/rpm/macros\fR
30 .br
31 \fI/etc/rpm/%{_target}/macros\fR
32 .br
33 \fI\(ti/.\&config/rpm/macros\fR
34 .PP
35 .SH DESCRIPTION
36 The primary configuration mechanism in \fBrpm\fR is \fBrpm-macros\fR(7).\&
37 On startup, \fBrpm\fR reads a set of \fBrpm-macrofile\fR(5) files determined
38 by the \fImacro path\fR.\&
39 .PP
40 Each file or \fBglob\fR(7) pattern in the colon-separated \fImacro path\fR is
41 read sequentially by \fBrpm\fR for macro definitions.\& \fB%{_target}\fR is
42 expanded to the detected <arch>-<os> platform.\& Tildes are expanded
43 to the value of the environment variable \fBHOME\fR.\&
44 .PP
45 If a macro is defined multiple times, the last entry wins.\& The default
46 \fImacro path\fR uses this to achieve the following hierarchy of settings:
47 .PD 0
48 .IP 1. 4
49 Generic \fBrpm\fR factory defaults
50 .IP 2. 4
51 Platform-specific \fBrpm\fR factory defaults
52 .IP 3. 4
53 Vendor (distribution) specific settings
54 .IP 4. 4
55 Host specific settings
56 .IP 5. 4
57 User specific settings
58 .IP 6. 4
59 Command-line override settings
60 .PD
61 .PP
62 The default \fImacro path\fR can be inspected with \fBrpm --showrc|grep \(haMacro\fR.\&
63 .PP
64 In older versions of rpm, the path of per-user macros was \fI\(ti/.\&rpmmacros\fR.\&
65 This is still processed if it exists and the new configuration directory
66 does not exist.\&
67 .PP
68 .SH CONFIGURATION
69 The following configurables are supported for the \fBrpm\fR runtime (as
70 opposed to just package building) parts:
71 .PP
72 \fB%_color_output\fR \fIMODE\fR
73 .RS 4
74 Output coloring mode.\& Valid values are \fBnever\fR and \fBauto\fR.\&
75 .PP
76 .RE
77 \fB%_db_backend\fR \fIBACKEND\fR
78 .RS 4
79 The database backend to use.\& Possible values for \fIBACKEND\fR are:
80 .PD 0
81 .IP \(bu 4
82 \fBdummy\fR: Dummy backend (no actual functionality)
83 .IP \(bu 4
84 \fBbdb_ro\fR: Berkeley DB (read-only)
85 .IP \(bu 4
86 \fBndb\fR: Native database (no external dependencies)
87 .IP \(bu 4
88 \fBsqlite\fR: Sqlite database
89 .PD
90 .PP
91 .RE
92 \fB%_dbpath\fR \fIDIRECTORY\fR
93 .RS 4
94 The location of the rpm database file(s).\&
95 .PP
96 .RE
97 \fB%_excludedocs\fR \fIVALUE\fR
98 .RS 4
99 Boolean (i.\&e.\& 1 == "yes", 0 == "no") that controls whether files
100 marked as %doc should be installed.\&
101 .PP
102 .RE
103 \fB%_flush_io\fR \fIVALUE\fR
104 .RS 4
105 Flush file IO during transactions (at a severe cost in performance
106 for rotational disks).\& Possible values are 1 to enable, 0 to disable.\&
107 .PP
108 .RE
109 \fB%_group_path\fR \fIPATH\fR
110 .RS 4
111 Location of group(5) files as : separated list
112 .PP
113 .RE
114 \fB%_httpport\fR \fIPORT\fR
115 .RS 4
116 The port of HTTP proxy (used for FTP/HTTP).\&
117 .PP
118 .RE
119 \fB%_httpproxy\fR \fIHOSTNAME\fR
120 .RS 4
121 The hostname of HTTP proxy (used for FTP/HTTP).\&
122 .PP
123 .RE
124 \fB%_install_langs\fR \fILOCALES\fR
125 .RS 4
126 A colon separated list of desired locales to be installed;
127 \fBall\fR means install all locale specific files.\&
128 .PP
129 .RE
130 \fB%_install_script_path\fR \fIPATH\fR
131 .RS 4
132 The PATH put into the environment before running %pre/%post et al.\&
133 .PP
134 .RE
135 \fB%_keyring\fR \fIBACKEND\fR
136 .RS 4
137 The keyring type to use.\& Possible values for \fIBACKEND\fR are:
138 .PD 0
139 .IP \(bu 4
140 \fBfs\fR: Plain ASCII files in a directory
141 .IP \(bu 4
142 \fBopenpgp\fR: Shared OpenPGP certificate directory
143 .IP \(bu 4
144 \fBrpmdb\fR: Pseudo-packages in the rpmdb
145 .PD
146 .PP
147 .RE
148 \fB%_keyringpath\fR \fIDIRECTORY\fR
149 .RS 4
150 The location of the keyring path for non-rpmdb variants.\&
151 .PP
152 .RE
153 \fB%_minimize_writes\fR \fIVALUE\fR
154 .RS 4
155 Minimize writes during transactions (at the cost of more reads) to
156 conserve eg SSD disks (EXPERIMENTAL).\& Possible values are:
157 .PD 0
158 .IP \(bu 4
159 \fB0\fR: disable
160 .IP \(bu 4
161 \fB1\fR: enable
162 .IP \(bu 4
163 \fB-1\fR: (or undefined) autodetect on platforms where supported,
164 otherwise default to disabled
165 .PD
166 .PP
167 .RE
168 \fB%_netsharedpath\fR \fIPATH\fR
169 .RS 4
170 A colon separated list of paths where files should \fBnot\fR be installed.\&
171 Usually, these are network filesystem mount points.\&
172 .PP
173 .RE
174 \fB%_passwd_path\fR \fIPATH\fR
175 .RS 4
176 Location of passwd(5) files as : separated list
177 .PP
178 .RE
179 \fB%_pkgverify_digests\fR \fIHASHALGOS\fR
180 .RS 4
181 A colon separated list of hash algorithms to calculate digests on the
182 entire package files during verification.\& The calculated digests
183 are stored in the \fBPackagedigests\fR tag of packages in the rpmdb,
184 and the corresponding algorithms in the \fBPackagedigestalgos\fR tag.\&
185 No package digests are calculated or stored if \fB--noverify\fR is
186 used during package installation.\&
187 .PP
188 .RE
189 \fB%_pkgverify_flags\fR \fIVSFLAGS\fR
190 .RS 4
191 Transaction package verification flags, used for fine-grained
192 control of \fB%_pkgverify_level\fR operation.\&
193 Set to 0x0 for full compatibility with v4 packages.\&
194 .PP
195 .RE
196 \fB%_pkgverify_level\fR \fIMODE\fR
197 .RS 4
198 Enforced package verification mode in transactions,
199 where \fIMODE\fR is one of:
200 .PD 0
201 .IP \(bu 4
202 \fBall\fR: require valid digest(s) and signature(s)
203 .IP \(bu 4
204 \fBsignature\fR: require valid signature(s)
205 .IP \(bu 4
206 \fBdigest\fR: require valid digest(s)
207 .IP \(bu 4
208 \fBnone\fR: legacy rpm behavior, nothing required
209 .PD
210 .PP
211 .RE
212 \fB%_prefer_color\fR \fIVALUE\fR
213 .RS 4
214 Package conflict resolution in bi-arch transactions.\&
215 See also \fB%_transaction_color\fR.\& Possible values are:
216 .PD 0
217 .IP \(bu 4
218 \fB0\fR: disabled
219 .IP \(bu 4
220 \fB1\fR: prefer 32-bit packages
221 .IP \(bu 4
222 \fB2\fR: prefer 64-bit packages
223 .PD
224 .PP
225 .RE
226 \fB%__plugindir\fR \fIDIRECTORY\fR
227 .RS 4
228 Transaction plugin directory.\&
229 .PP
230 .RE
231 \fB%_query_all_fmt\fR \fIFORMAT\fR
232 .RS 4
233 Default output format for \fBrpm\fR(8) query operations, as described by
234 \fBrpm-queryformat\fR(7).\& Percent signs need to be escaped, for example
235 \fB%%{nevra}\fR.\&
236 .PP
237 .RE
238 \fB%_rpmlock_path\fR \fIFILE\fR
239 .RS 4
240 The path of the file used for transaction fcntl lock.\&
241 .PP
242 .RE
243 \fB%_tmppath\fR \fIPATH\fR
244 .RS 4
245 The directory where temporary files are created.\&
246 .PP
247 .RE
248 \fB%__urlhelpercmd\fR \fIEXECUTABLE\fR
249 .RS 4
250 The executable to use for retrieving remote files.\&
251 .PP
252 .RE
253 \fB%__urlhelperopts\fR \fIOPTIONS\fR
254 .RS 4
255 Generic options to pass to the \fB%__urlhelpercmd\fR command.\&
256 .PP
257 .RE
258 \fB%__urlhelper_localopts\fR \fIOPTIONS\fR
259 .RS 4
260 User/host specific options to pass to the \fB%__urlhelpercmd\fR command.\&
261 .PP
262 .RE
263 \fB%__urlhelper_proxyopts\fR \fIOPTIONS\fR
264 .RS 4
265 Proxy options to pass to the \fB%__urlhelpercmd\fR command.\&
266 .PP
267 .RE
268 \fB%_urlhelper\fR \fICOMMAND\fR
269 .RS 4
270 Full command (with options) to use when retrieving remote files.\&
271 Normally pieced together from the double-underscore \fB%__urlhelper*\fR
272 macros.\&
273 .PP
274 .RE
275 \fB%_transaction_color\fR \fIVALUE\fR
276 .RS 4
277 Package and file conflict behavior in bi-arch transactions.\&
278 See also \fB%_prefer_color\fR.\& Possible values are:
279 .PD 0
280 .IP \(bu 4
281 \fB0\fR: do not consider "colors", only use arch compatibility map
282 .IP \(bu 4
283 \fB1\fR: only allow 32-bit packages
284 .IP \(bu 4
285 \fB2\fR: only allow 64-bit packages
286 .IP \(bu 4
287 \fB3\fR: allow 32- and 64-bit packages to share files
288 .PD
289 .PP
290 .RE
291 \fB%_vsflags_erase\fR \fIVSFLAGS\fR
292 .RS 4
293 Transaction verification flags used when erasing or updating packages.\&
294 .PP
295 .RE
296 \fB%_vsflags_install\fR \fIVSFLAGS\fR
297 .RS 4
298 Transaction verification flags used when installing packages.\&
299 .PP
300 .RE
301 \fB%_vsflags_query\fR \fIVSFLAGS\fR
302 .RS 4
303 Transaction verification flags used when querying packages.\&
304 .PP
305 .RE
306 \fB%_vsflags_rebuilddb\fR \fIVSFLAGS\fR
307 .RS 4
308 Transaction verification flags used when rebuilding the database.\&
309 .PP
310 .RE
311 \fB%_vsflags_verify\fR \fIVSFLAGS\fR
312 .RS 4
313 Transaction verification flags used when verifying packages.\&
314 .PP
315 .RE
316 .SS Verification flags
317 Digest/signature verification flags for various rpm operations are controlled
318 by a bitmask known as \fIVSFLAGS\fR.\& These flags control various aspects
319 of digital checksum and signature verification when reading rpm package
320 files and their headers.\&
321 .PP
322 \fIVSFLAGS\fR is formed by bitwise or'\&ing the individual flags:
323 .PD 0
324 .IP \(bu 4
325 \fB0x00001\fR (RPMVSF_NOHDRCHK): don'\&t verify headers from rpmdb
326 .IP \(bu 4
327 \fB0x00100\fR (RPMVSF_NOSHA1HEADER): don'\&t verify header SHA1 digest
328 .IP \(bu 4
329 \fB0x00200\fR (RPMVSF_NOSHA256HEADER): don'\&t verify header SHA256 digest
330 .IP \(bu 4
331 \fB0x00400\fR (RPMVSF_NODSAHEADER): don'\&t verify header DSA signature(s)
332 .IP \(bu 4
333 \fB0x00800\fR (RPMVSF_NORSAHEADER): don'\&t verify header RSA signature(s)
334 .IP \(bu 4
335 \fB0x01000\fR (RPMVSF_NOOPENPGP): don'\&t verify header OpenPGP signature(s)
336 .IP \(bu 4
337 \fB0x02000\fR (RPMVSF_NOSHA3_256HEADER): don'\&t verify header SHA3_256 digest
338 .IP \(bu 4
339 \fB0x04000\fR (RPMVSF_NOSHA512PAYLOAD): don'\&t verify package payload SHA512 digest
340 .IP \(bu 4
341 \fB0x08000\fR (RPMVSF_NOSHA3_256PAYLOAD): don'\&t verify package payload SHA3_256 digest
342 .IP \(bu 4
343 \fB0x10000\fR (RPMVSF_NOSHA256PAYLOAD): don'\&t verify package payload SHA256 digest
344 .IP \(bu 4
345 \fB0x20000\fR (RPMVSF_NOMD5): don'\&t verify legacy header+payload MD5 digest
346 .IP \(bu 4
347 \fB0x40000\fR (RPMVSF_NODSA): don'\&t verify legacy header+payload DSA signature
348 .IP \(bu 4
349 \fB0x80000\fR (RPMVSF_NORSA): don'\&t verify legacy header+payload RSA signature
350 .PD
351 .PP
352 RPM'\&s Python bindings can be helpful for working with these values,
353 for example:
354 .nf
355 .RS 4
356 >>> import rpm
357 >>> hex(rpm\&.RPMVSF_NOSHA1HEADER)
358 \&'0x100\&'
359 >>> hex(rpm\&.RPMVSF_NOSHA1HEADER|rpm\&.RPMVSF_NOMD5)
360 \&'0x20100\&'
361 >>>
362 .fi
363 .RE
364 .PP
365 .SS Hash algorithms
366 The following hash algorithms (denoted by \fIHASHALGO\fR) are known to rpm,
367 but availability can vary depending how rpm and it'\&s underlying libraries
368 have been built:
369 .PD 0
370 .IP \(bu 4
371 \fB1\fR: MD5 (obsolete)
372 .IP \(bu 4
373 \fB2\fR: SHA1 (obsolete)
374 .IP \(bu 4
375 \fB8\fR: SHA256
376 .IP \(bu 4
377 \fB9\fR: SHA384
378 .IP \(bu 4
379 \fB10\fR: SHA512
380 .IP \(bu 4
381 \fB12\fR: SHA3-256
382 .IP \(bu 4
383 \fB14\fR: SHA3-512
384 .PD
385 .PP
386 .SH ENVIRONMENT
387 If \fBXDG_CONFIG_HOME\fR environment variable is set, it replaces \fI\(ti/.\&config\fR
388 in the \fImacro path\fR.\&
389 .PP
390 .SH SEE ALSO
391 \fBrpm\fR(8), \fBrpm-common\fR(8), \fBrpm-macrofile\fR(5), \fBrpm-rpmrc\fR(5), \fBrpm-macros\fR(7)