Debian Codegraph @

upstream/debian-unstable/man5/rpmbuild-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 "RPMBUILD-CONFIG" "5" "2026-04-10" "RPM 6.0.1"
9 .PP
10 .SH NAME
11 \fBrpmbuild-config\fR - rpmbuild macro configuration
12 .PP
13 .SH SYNOPSIS
14 \fINAME\fR \fIVALUE\fR
15 .PP
16 .SH DESCRIPTION
17 The primary configuration mechanism in \fBrpmbuild\fR is \fBrpm-macros\fR(7).\&
18 See \fBrpm-config\fR(5) for the description of the general mechanism,
19 this manual only describes the configurables affecting \fBrpmbuild\fR
20 operation.\&
21 .PP
22 .SH CONFIGURATION
23 The following configurables are supported for the \fBrpm\fR build operation,
24 typically invoked through the \fBrpmbuild\fR command.\&
25 .PP
26 .SS Locations and filenames
27 .PP
28 \fB%_builddir\fR \fIDIRECTORY\fR
29 .RS 4
30 The directory where the per-package build directories will be placed
31 when building.\&
32 .PP
33 .RE
34 \fB%_fileattrsdir\fR \fIDIRECTORY\fR
35 .RS 4
36 The directory where the file classifier configuration is located.\&
37 .PP
38 .RE
39 \fB%_rpmdir\fR \fIDIRECTORY\fR
40 .RS 4
41 The directory where newly built binary packages will be written.\&
42 .PP
43 .RE
44 \fB%_rpmfilename\fR \fITEMPLATE\fR
45 .RS 4
46 The output binary package filename query format used when building
47 binary packages, as described by \fBrpm-queryformat\fR(7).\& The filename is
48 considered relative to \fB%_rpmdir\fR.\&
49 .PP
50 .RE
51 \fB%_sourcedir\fR \fIDIRECTORY\fR
52 .RS 4
53 The directory where the sources and patches are found when building.\&
54 .PP
55 .RE
56 \fB%_srcrpmdir\fR \fIDIRECTORY\fR
57 .RS 4
58 The directory where newly built source packages will be written.\&
59 .PP
60 .RE
61 \fB%_topdir\fR \fIDIRECTORY\fR
62 .RS 4
63 The toplevel directory under which the package build directories
64 reside by default.\&
65 .PP
66 .RE
67 .SS Informational tags
68 These are a special group of macros that if defined, behave as if the
69 corresponding tag had been used in a specfile.\& This allows changing
70 the values without modifying thousands of specfiles.\&
71 .PP
72 \fB%bugurl\fR \fIURL\fR
73 .RS 4
74 Configurable bug URL, same as BugURL: tag in a specfile.\&
75 If set, should point to a website for searching for existing
76 and filing new issues for this package.\&
77 .PP
78 .RE
79 \fB%distribution\fR \fISTRING\fR
80 .RS 4
81 Configurable distribution informationsame as Distribution: tag in a
82 specfile.\&
83 .PP
84 .RE
85 \fB%disturl\fR \fIURL\fR
86 .RS 4
87 Configurable distribution URL, same as DistURL: tag in a specfile.\&
88 .PP
89 .RE
90 \fB%disttag\fR \fISTRING\fR
91 .RS 4
92 Configurable distribution tag, same as DistTag: tag in a specfile.\&
93 .PP
94 .RE
95 \fB%modularitylabel\fR \fISTRING\fR
96 .RS 4
97 Configurable modularity label, same as ModularityLabel: in a specfile.\&
98 Obsolete.\&
99 .PP
100 .RE
101 \fB%packager\fR \fISTRING\fR
102 .RS 4
103 Configurable packager information, same as Packager: in a specfile.\&
104 .PP
105 .RE
106 \fB%translationurl\fR \fIURL\fR
107 .RS 4
108 Configurable translation URL, same as TranslationURL: in a specfile.\&
109 .PP
110 .RE
111 \fB%upstreamreleases\fR \fIURL\fR
112 .RS 4
113 Configurable URL for checking for newer upstream releases, same as
114 UpstreamReleases: in a specfile.\&
115 .PP
116 .RE
117 \fB%vendor\fR \fISTRING\fR
118 .RS 4
119 Configurable vendor information, same as Vendor: in a specfile.\&
120 .PP
121 .RE
122 .SS Build operation
123 These settings affect various aspects of the build and can cause a build
124 to fail or succeed, but have no direct impact on the produced packages.\&
125 .PP
126 \fB%_build_pkgcheck\fR \fIEXECUTABLE\fR
127 .RS 4
128 A program to call for each successfully built and written binary
129 package, such as \fBrpmlint\fR.\&
130 The path to the package is passed to the program as a command-line
131 argument.\&
132 .PP
133 .RE
134 \fB%_build_pkgcheck_set\fR \fIEXECUTABLE\fR
135 .RS 4
136 A program to call for the whole binary package set after a successfully
137 build, such as \fBrpmlint\fR.\&
138 The paths to the package set are passed to the program as
139 command-line arguments.\&
140 .PP
141 .RE
142 \fB%_build_pkgcheck_srpm\fR \fIEXECUTABLE\fR
143 .RS 4
144 A program to call for each successfully built and written source
145 package, such as \fBrpmlint\fR.\&
146 The path to the package is passed to the program as a command-line
147 argument.\&
148 .PP
149 .RE
150 \fB%_default_patch_flags\fR \fISTRING\fR
151 .RS 4
152 Set of default options on all \fB%patch\fR applications.\&
153 .PP
154 .RE
155 \fB%_default_patch_fuzz\fR \fINUMBER\fR
156 .RS 4
157 Default fuzz level for patch application in spec file.\&
158 See \fBpatch\fR(1) for details.\&
159 .PP
160 .RE
161 \fB%_smp_ncpus_max\fR \fINUMBER\fR
162 .RS 4
163 A hard limit for maximum number of CPU'\&s to use in parallel
164 during a package build.\& Zero means unlimited.\&
165 .PP
166 .RE
167 \fB%_smp_nthreads_max\fR \fINUMBER\fR
168 .RS 4
169 A hard limit for maximum number of threads to use in parallel
170 during a package build.\& Zero means unlimited.\&
171 .PP
172 .RE
173 \fB%_smp_tasksize_proc\fR \fINUMBER\fR
174 .RS 4
175 Assumed task size of build processes (during compilation).\&
176 Used for tuning the amount of parallelism based on available memory.\&
177 .PP
178 .RE
179 \fB%_smp_tasksize_thread\fR \fINUMBER\fR
180 .RS 4
181 Assumed task size of threads (during package generation).\&
182 Used for tuning the amount of parallelism based on available memory.\&
183 .PP
184 .RE
185 .SS Package generation
186 These settings affect various aspects of the produced binary and source
187 packages.\&
188 .PP
189 \fB%build_mtime_policy\fR \fIPOLICY\fR
190 .RS 4
191 Define how file timestamps are handled in built packages.\& Clamping
192 means ensuring the value does not exceed the threshold value.\&
193 .PD 0
194 .IP \(bu 4
195 \fBclamp_to_buildtime\fR: Clamp file timestamps to package buildtime.\&
196 .IP \(bu 4
197 \fBclamp_to_source_date_epoch\fR: Clamp file timestamps to the
198 \fBSOURCE_DATE_EPOCH\fR environment variable.\&
199 .PD
200 .PP
201 .RE
202 \fB%clamp_mtime_to_source_date_epoch\fR \fIBOOLEAN\fR
203 .RS 4
204 Alias for \fB%build_mtime_policy\fR \fBclamp_to_source_date_epoch\fR.\&
205 Do not use.\& Deprecated and scheduled for removal.\&
206 .PP
207 .RE
208 \fB%source_date_epoch_from_changelog\fR \fIBOOLEAN\fR
209 .RS 4
210 Whether to set the \fBSOURCE_DATE_EPOCH\fR environment variable from
211 the timestamp of the topmost \fB%changelog\fR entry.\&
212 .PP
213 .RE
214 \fB%use_source_date_epoch_as_buildtime\fR \fIBOOLEAN\fR
215 .RS 4
216 Whether to use the \fBSOURCE_DATE_EPOCH\fR environment variable value
217 as the buildtime of packages.\&
218 .PP
219 .RE
220 \fB%_binary_filedigest_algorithm\fR \fIHASHALGO\fR
221 .RS 4
222 The algorithm to use for generating per-file checksums (aka digests)
223 of binary packages.\& See \fBrpm-config\fR(5) for the supported values.\&
224 .PP
225 .RE
226 \fB%_binary_payload\fR \fIIOFLAGS\fR
227 .RS 4
228 The IO method and compression to use for generating the payload
229 of binary packages.\& See \fBrpm-payloadflags\fR(7).\&
230 .PP
231 .RE
232 \fB%_buildhost\fR \fIHOSTNAME\fR
233 .RS 4
234 Use \fIHOSTNAME\fR as the package buildhost instead of acquiring
235 the value from \fBgethostname\fR(2).\&
236 .PP
237 .RE
238 \fB%_buildtime\fR \fITIMESTAMP\fR
239 .RS 4
240 Use \fITIMESTAMP\fR as the package buildtime instead of acquiring
241 the value from \fBtime\fR(2).\&
242 .PP
243 .RE
244 \fB%_changelog_trimage\fR \fITIMESTAMP\fR
245 .RS 4
246 Maximum age of preserved changelog entries in binary packages,
247 relative to newest existing entry.\& Unix timestamp format.\&
248 The value of zero disables trimming by age.\&
249 .PP
250 .RE
251 \fB%_changelog_trimtime\fR \fITIMESTAMP\fR
252 .RS 4
253 An alternative strategy for changelog trimming: trim all changelog
254 entries older than the specified timestamp.\& Unix timestamp format.\&
255 The value of zero disables trimming by time.\&
256 .PP
257 .RE
258 \fB%_docdir_fmt\fR \fITEMPLATE\fR
259 .RS 4
260 A template for the per-package documentation directory name,
261 ie.\& the files packaged with \fB%doc\fR.\&
262 .PP
263 .RE
264 \fB%__docdir_path\fR \fIPATH\fR
265 .RS 4
266 A colon separated list of directories whose contents should be
267 always considered as documentation.\&
268 .PP
269 .RE
270 \fB%_openpgp_autosign_id\fR \fIKEYID\fR
271 .RS 4
272 The OpenPGP key id or fingerprint to use for automatically signing
273 packages after a successful build.\& See also \fBrpmsign\fR(1).\&
274 .PP
275 .RE
276 \fB%_rpmformat\fR \fIVERSION\fR
277 .RS 4
278 The RPM package format to produce.\& Supported values are:
279 .PD 0
280 .IP \(bu 4
281 \fB4\fR: RPM v4 format
282 .IP \(bu 4
283 \fB6\fR: RPM v6 format
284 .PD
285 .PP
286 .RE
287 \fB%_source_filedigest_algorithm\fR \fIHASHALGO\fR
288 .RS 4
289 The algorithm to use for generating per-file checksums (aka digests)
290 of source packages.\& See \fBrpm-config\fR(5) for the supported values.\&
291 .PP
292 .RE
293 \fB%_source_payload\fR
294 .RS 4
295 The IO method and compression to use for generating the payload
296 of source packages.\& See \fBrpm-payloadflags\fR(7).\&
297 .PP
298 .RE
299 \fB%__gpg_reserved_space\fR \fINUMBER\fR
300 .RS 4
301 The number of bytes to reserve for signatures in the signature header.\&
302 This reserve helps to speed up package signing significantly.\&
303 .PP
304 .RE
305 .SS Debuginfo generation
306 Debuginfo sub-packages contain information necessary to debug otherwise
307 release-specification builds with a debugger.\& These settings determine
308 whether debuginfo packages are generated and various aspects of the
309 generated debugging information.\&
310 .PP
311 \fB%_build_id_links\fR \fIMODE\fR
312 .RS 4
313 Defines how and if build_id links are generated for ELF files.\&
314 The following settings are supported:
315 .PD 0
316 .IP \(bu 4
317 \fBnone\fR: No build_id links are generated.\&
318 .IP \(bu 4
319 \fBalldebug\fR: Generate rpm < 4.\&14 style build_id links, ie everything
320 in the -debuginfo package.\&
321 .IP \(bu 4
322 \fBseparate\fR: Generate build_id links in binary packages.\&
323 .IP \(bu 4
324 \fBcompat\fR: Same as \fBseparate\fR but with a compatibility link(s)
325 in the -debuginfo packages.\&
326 .PD
327 .PP
328 .RE
329 \fB%_debuginfo_subpackages\fR \fIBOOLEAN\fR
330 .RS 4
331 Whether rpm should create separate debuginfo packages for each
332 subpackage.\&
333 .PP
334 .RE
335 \fB%_debugsource_packages\fR \fIBOOLEAN\fR
336 .RS 4
337 Whether rpm should put debug source files into their own subpackage.\&
338 .PP
339 .RE
340 \fB%_enable_debug_packages\fR \fIBOOLEAN\fR
341 .RS 4
342 Whether rpm should generate debuginfo subpackages.\&
343 .PP
344 .RE
345 \fB%_include_gdb_index\fR \fIBOOLEAN\fR
346 .RS 4
347 Include a .\&gdb_index section in the .\&debug files.\&
348 Requires \fB%_enable_debug_packages\fR to be enabled and
349 \fBgdb-add-index\fR(1) to be installed.\&
350 .PP
351 .RE
352 \fB%_include_minidebuginfo\fR \fIBOOLEAN\fR
353 .RS 4
354 Include minimal debug information in build binaries.\&
355 Requires \fB%_enable_debug_packages\fR to be enabled.\&
356 .PP
357 .RE
358 \fB%_no_recompute_build_ids\fR \fIBOOLEAN\fR
359 .RS 4
360 Disable recomputation of build-ids.\&
361 Cannot be used with \fB%_unique_build_ids\fR.\&
362 .PP
363 .RE
364 \fB%_unique_build_ids\fR \fIBOOLEAN\fR
365 .RS 4
366 Whether build-ids should be made unique between package
367 version/releases when generating debuginfo packages.\&
368 .PP
369 .RE
370 \fB%_unique_debug_names\fR \fIBOOLEAN\fR
371 .RS 4
372 Whether .\&debug files should be made unique between package version,
373 release and architecture.\& Requires \fB%_unique_build_ids\fR to be enabled.\&
374 .PP
375 .RE
376 \fB%_unique_debug_srcs\fR \fIBOOLEAN\fR
377 .RS 4
378 Whether the /usr/debug/src/<package> directories should be unique
379 between package version, release and architecture.\&
380 .PP
381 .RE
382 \fB%__find_debuginfo\fR \fIEXECUTABLE\fR
383 .RS 4
384 The location of the debuginfo helper executable.\&
385 .PP
386 .RE
387 .SS Legacy compatibility
388 These settings deal with several decades of backwards compatibility.\& Most
389 of them determine whether a particular issue is considered an error or
390 just a warning.\&
391 Sometimes also useful for temporarily working around issues while packaging.\&
392 .PP
393 \fB%_binaries_in_noarch_packages_terminate_build\fR \fIBOOLEAN\fR
394 .RS 4
395 Whether ELF binaries in noarch packages should terminate a build.\&
396 .PP
397 .RE
398 \fB%_duplicate_files_terminate_build\fR \fIBOOLEAN\fR
399 .RS 4
400 Whether duplicate files in \fB%files\fR section should terminate a build.\&
401 .PP
402 .RE
403 \fB%_empty_manifest_terminate_build\fR \fIBOOLEAN\fR
404 .RS 4
405 Whether an empty \fB%files\fR manifest file should terminate a build.\&
406 .PP
407 .RE
408 \fB%_invalid_encoding_terminates_build\fR \fIBOOLEAN\fR
409 .RS 4
410 Whether a non-UTF8 encoding in package data should terminate a build.\&
411 .PP
412 .RE
413 \fB%__find_provides\fR \fIEXECUTABLE\fR
414 .RS 4
415 The executable to use for rpm 3.\&x style provides generation.\&
416 Do not use.\& Deprecated and scheduled for removal.\&
417 .PP
418 .RE
419 \fB%__find_requires\fR \fIEXECUTABLE\fR
420 .RS 4
421 The executable to use for rpm 3.\&x style requires generation.\&
422 Do not use.\& Deprecated and scheduled for removal.\&
423 .PP
424 .RE
425 \fB%_missing_build_ids_terminate_build\fR \fIBOOLEAN\fR
426 .RS 4
427 Whether ELF files without build-ids should terminate a build.\&
428 For historical reasons, this is only applicable if
429 \fB%_enable_debug_packages\fR is also enabled.\&
430 .PP
431 .RE
432 \fB%_missing_doc_files_terminate_build\fR \fIBOOLEAN\fR
433 .RS 4
434 Whether missing %doc files in the build directory should terminate
435 a build.\&
436 .PP
437 .RE
438 \fB%_unpackaged_files_terminate_build\fR \fIBOOLEAN\fR
439 .RS 4
440 Whether unpackaged files in a build root should terminate a build.\&
441 .PP
442 .RE
443 \fB%_nonzero_exit_pkgcheck_terminate_build\fR \fIBOOLEAN\fR
444 .RS 4
445 Whether the build of packages should fail if package checker
446 (if defined) returns an error?\& See the \fB%_build_pkgcheck_*\fR macros.\&
447 .PP
448 .RE
449 \fB%_use_internal_dependency_generator\fR \fIBOOLEAN\fR
450 .RS 4
451 If enabled, use rpm 3.\&x style dependency generation.\&
452 Do not use.\& Deprecated and scheduled for removal.\&
453 .PP
454 .RE
455 \fB%_use_weak_usergroup_deps\fR \fIBOOLEAN\fR
456 .RS 4
457 If enabled, dilute user() and group() requires into recommends.\&
458 Useful when transitioning to sysusers.\&d based user/group management.\&
459 .PP
460 .RE
461 \fB%_wrong_version_format_terminate_build\fR \fIBOOLEAN\fR
462 .RS 4
463 Whether invalid version format in dependencies etc should
464 terminate a build.\&
465 .PP
466 .RE
467 .SH SEE ALSO
468 \fBrpmbuild\fR(1), \fBrpm-common\fR(8), \fBrpm-macrofile\fR(5),
469 \fBrpm-rpmrc\fR(5), \fBrpm-config\fR(5), \fBrpm-payloadflags\fR(7)
470 \fBrpm-macros\fR(7)