Debian Codegraph @

upstream/mageia-cauldron/man5/dnf5.conf-vendorpolicy-v1_1.5

raw
1 .\" Man page generated from reStructuredText.
2 .
3 .
4 .nr rst2man-indent-level 0
5 .
6 .de1 rstReportMargin
7 \\$1 \\n[an-margin]
8 level \\n[rst2man-indent-level]
9 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
10 -
11 \\n[rst2man-indent0]
12 \\n[rst2man-indent1]
13 \\n[rst2man-indent2]
14 ..
15 .de1 INDENT
16 .\" .rstReportMargin pre:
17 . RS \\$1
18 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
19 . nr rst2man-indent-level +1
20 .\" .rstReportMargin post:
21 ..
22 .de UNINDENT
23 . RE
24 .\" indent \\n[an-margin]
25 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
26 .nr rst2man-indent-level -1
27 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
28 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
29 ..
30 .TH "DNF5.CONF-VENDORPOLICY-V1_1" "5" "May 10, 2026" "" "dnf5"
31 .SH NAME
32 dnf5.conf-vendorpolicy-v1_1 \- DNF5 Vendor Change Policy File Reference - v1.1
33 .SH DESCRIPTION
34 .sp
35 This document describes the structure and syntax of the DNF5 Vendor Change Policy
36 configuration files using \fBversion 1.1\fP format.
37 .sp
38 For general information about vendor change policy files, see \fI\%DNF5 Vendor Change Policy File Reference\fP\&.
39 .SH FILE STRUCTURE
40 .SS Required Fields
41 .INDENT 0.0
42 .TP
43 .B \fBversion\fP
44 String
45 .sp
46 Configuration file format version.
47 .sp
48 For this format, must be set to \fB\(dq1.1\(dq\fP\&.
49 .sp
50 This field is mandatory and must be specified at the top level of the TOML file.
51 .sp
52 Example:
53 .INDENT 7.0
54 .INDENT 3.5
55 .sp
56 .EX
57 version = \(aq1.1\(aq
58 .EE
59 .UNINDENT
60 .UNINDENT
61 .UNINDENT
62 .sp
63 \fBNOTE:\fP
64 .INDENT 0.0
65 .INDENT 3.5
66 For the configuration file to have any effect on vendor change policy, it must contain
67 at least one of the supported lists (see below): \fBoutgoing_vendors\fP, \fBincoming_vendors\fP,
68 \fBequivalent_vendors\fP, \fBoutgoing_packages\fP, or \fBincoming_packages\fP\&.
69 .sp
70 If the file contains no lists, it will be loaded and its version will be validated,
71 but it will not define any rules and will not affect vendor manager behavior.
72 .UNINDENT
73 .UNINDENT
74 .SS Vendor Mapping Definition
75 .sp
76 The following vendor lists can be used to define vendor mappings.
77 All lists are optional and can be freely combined. All conditions are evaluated together.
78 .INDENT 0.0
79 .TP
80 .B \fB[[outgoing_vendors]]\fP
81 Array of tables
82 .sp
83 List of vendors from which changes are allowed (outgoing package vendors).
84 .TP
85 .B \fB[[incoming_vendors]]\fP
86 Array of tables
87 .sp
88 List of vendors to which changes are allowed (incoming package vendors).
89 .TP
90 .B \fB[[equivalent_vendors]]\fP
91 Array of tables
92 .sp
93 List of vendors that are mutually equivalent. Changes are allowed in both directions
94 between all vendors in this list.
95 .sp
96 \fBNOTE:\fP
97 .INDENT 7.0
98 .INDENT 3.5
99 \fBequivalent_vendors\fP is actually a shorthand notation. It is equivalent to
100 listing the same vendors in both \fBoutgoing_vendors\fP and \fBincoming_vendors\fP\&.
101 .UNINDENT
102 .UNINDENT
103 .UNINDENT
104 .sp
105 \fBIMPORTANT:\fP
106 .INDENT 0.0
107 .INDENT 3.5
108 A vendor change during package replacement is allowed \fBonly if both conditions
109 are met simultaneously\fP:
110 .INDENT 0.0
111 .IP \(bu 2
112 The vendor of the outgoing (installed) package is listed in \fBoutgoing_vendors\fP
113 or \fBequivalent_vendors\fP (or both \fBoutgoing_vendors\fP and \fBequivalent_vendors\fP
114 are missing, which allows any vendor)
115 .IP \(bu 2
116 The vendor of the incoming (new) package is listed in \fBincoming_vendors\fP
117 or \fBequivalent_vendors\fP (or both \fBincoming_vendors\fP and \fBequivalent_vendors\fP
118 are missing, which allows any vendor)
119 .UNINDENT
120 .UNINDENT
121 .UNINDENT
122 .SS Vendor Entry Fields
123 .sp
124 Each entry in \fB[[outgoing_vendors]]\fP, \fB[[incoming_vendors]]\fP, or \fB[[equivalent_vendors]]\fP
125 can contain the following fields:
126 .INDENT 0.0
127 .TP
128 .B \fBvendor\fP
129 String
130 .sp
131 Required field.
132 .sp
133 Vendor name or pattern for matching.
134 .TP
135 .B \fBcomparator\fP
136 String
137 .sp
138 Optional field.
139 .sp
140 The matching method to use when comparing vendor strings.
141 .sp
142 Default: \fB\(dqEXACT\(dq\fP
143 .sp
144 Supported values:
145 .INDENT 7.0
146 .IP \(bu 2
147 \fB\(dqEXACT\(dq\fP \- exact match (case\-sensitive)
148 .IP \(bu 2
149 \fB\(dqIEXACT\(dq\fP \- exact match (case\-insensitive)
150 .IP \(bu 2
151 \fB\(dqGLOB\(dq\fP \- glob pattern (case\-sensitive)
152 .IP \(bu 2
153 \fB\(dqIGLOB\(dq\fP \- glob pattern (case\-insensitive)
154 .IP \(bu 2
155 \fB\(dqREGEX\(dq\fP \- regular expression (case\-sensitive)
156 .IP \(bu 2
157 \fB\(dqIREGEX\(dq\fP \- regular expression (case\-insensitive)
158 .IP \(bu 2
159 \fB\(dqCONTAINS\(dq\fP \- contains string (case\-sensitive)
160 .IP \(bu 2
161 \fB\(dqICONTAINS\(dq\fP \- contains string (case\-insensitive)
162 .IP \(bu 2
163 \fB\(dqSTARTSWITH\(dq\fP \- starts with (case\-sensitive)
164 .IP \(bu 2
165 \fB\(dqISTARTSWITH\(dq\fP \- starts with (case\-insensitive)
166 .IP \(bu 2
167 \fB\(dqENDSWITH\(dq\fP \- ends with (case\-sensitive)
168 .IP \(bu 2
169 \fB\(dqIENDSWITH\(dq\fP \- ends with (case\-insensitive)
170 .IP \(bu 2
171 \fB\(dqNOT_EXACT\(dq\fP, \fB\(dqNOT_IEXACT\(dq\fP, \fB\(dqNOT_GLOB\(dq\fP, \fB\(dqNOT_IGLOB\(dq\fP, \fB\(dqNOT_CONTAINS\(dq\fP, \fB\(dqNOT_ICONTAINS\(dq\fP \- negated variants
172 .UNINDENT
173 .TP
174 .B \fBexclude\fP
175 Boolean
176 .sp
177 Optional field.
178 .sp
179 If \fBtrue\fP, the vendor is excluded from the rule. This is useful for defining
180 exceptions to more general rules. Rules (vendor entries) are processed in the order
181 they are defined. This means that an exclude rule must appear before the rules
182 from which the vendor should be excluded.
183 .sp
184 Default: \fBfalse\fP
185 .UNINDENT
186 .SS Package Filtering
187 .sp
188 Vendor change policies can be further restricted to apply only to specific packages
189 using package filters. These are optional and allow fine\-grained control over which
190 packages are allowed to change vendors.
191 .INDENT 0.0
192 .TP
193 .B \fB[[outgoing_packages]]\fP
194 Array of tables
195 .sp
196 List of package filters that restrict which outgoing (installed) packages are
197 allowed to change vendors. If omitted, all packages are allowed to change from
198 their current vendor.
199 .TP
200 .B \fB[[incoming_packages]]\fP
201 Array of tables
202 .sp
203 List of package filters that restrict which incoming (new) packages are allowed
204 to be installed with a vendor change. If omitted, all packages are allowed to
205 be installed regardless of vendor.
206 .UNINDENT
207 .SS Package Filter Entry Fields
208 .sp
209 Each entry in \fB[[outgoing_packages]]\fP or \fB[[incoming_packages]]\fP can contain:
210 .INDENT 0.0
211 .TP
212 .B \fBfilters\fP
213 Array of tables
214 .sp
215 Required field.
216 .sp
217 List of filter conditions that must all match for the package to be affected by
218 this rule. Each filter is a table with the following fields:
219 .INDENT 7.0
220 .TP
221 .B \fBfilter\fP
222 String
223 .sp
224 Required field.
225 .sp
226 The package attribute to filter on.
227 .sp
228 Supported values:
229 .INDENT 7.0
230 .IP \(bu 2
231 \fB\(dqname\(dq\fP \- package name
232 .IP \(bu 2
233 \fB\(dqsource_name\(dq\fP \- source package name
234 .IP \(bu 2
235 \fB\(dqevr\(dq\fP \- Epoch\-Version\-Release string
236 .IP \(bu 2
237 \fB\(dqepoch\(dq\fP \- epoch number
238 .IP \(bu 2
239 \fB\(dqversion\(dq\fP \- version string
240 .IP \(bu 2
241 \fB\(dqrelease\(dq\fP \- release string
242 .IP \(bu 2
243 \fB\(dqarch\(dq\fP \- package architecture
244 .IP \(bu 2
245 \fB\(dqrepoid\(dq\fP \- repository ID
246 .IP \(bu 2
247 \fB\(dqcmdline_repo\(dq\fP \- whether the package is from command\-line repository (boolean)
248 .UNINDENT
249 .TP
250 .B \fBvalue\fP
251 String
252 .sp
253 Required field.
254 .sp
255 The value to match against.
256 .INDENT 7.0
257 .IP \(bu 2
258 For \fBcmdline_repo\fP filter, use \fB\(dqtrue\(dq\fP/\fB\(dq1\(dq\fP or \fB\(dqfalse\(dq\fP/\fB\(dq0\(dq\fP
259 .IP \(bu 2
260 For \fBepoch\fP filter, use a numeric string (e.g., \fB\(dq0\(dq\fP, \fB\(dq1\(dq\fP)
261 .IP \(bu 2
262 For other filters, use appropriate string values
263 .UNINDENT
264 .TP
265 .B \fBcomparator\fP
266 String
267 .sp
268 Optional field.
269 .sp
270 The matching method to use.
271 .sp
272 Default: \fB\(dqEXACT\(dq\fP
273 .sp
274 \fBFor string\-based filters\fP (\fBname\fP, \fBsource_name\fP, \fBarch\fP, \fBrepoid\fP):
275 .sp
276 Same values as for vendor comparator: \fBEXACT\fP, \fBNOT_EXACT\fP, \fBIEXACT\fP,
277 \fBNOT_IEXACT\fP, \fBCONTAINS\fP, \fBNOT_CONTAINS\fP, \fBICONTAINS\fP, \fBNOT_ICONTAINS\fP,
278 \fBSTARTSWITH\fP, \fBISTARTSWITH\fP, \fBENDSWITH\fP, \fBIENDSWITH\fP, \fBREGEX\fP,
279 \fBIREGEX\fP, \fBGLOB\fP, \fBNOT_GLOB\fP, \fBIGLOB\fP, \fBNOT_IGLOB\fP
280 .sp
281 \fBFor version\-based filters\fP (\fBevr\fP, \fBepoch\fP, \fBversion\fP, \fBrelease\fP):
282 .INDENT 7.0
283 .IP \(bu 2
284 \fB\(dqEXACT\(dq\fP \- equal to
285 .IP \(bu 2
286 \fB\(dqNOT_EXACT\(dq\fP \- not equal to
287 .IP \(bu 2
288 \fB\(dqGT\(dq\fP \- greater than
289 .IP \(bu 2
290 \fB\(dqGTE\(dq\fP \- greater than or equal to
291 .IP \(bu 2
292 \fB\(dqLT\(dq\fP \- less than
293 .IP \(bu 2
294 \fB\(dqLTE\(dq\fP \- less than or equal to
295 .UNINDENT
296 .sp
297 \fBNOTE:\fP
298 .INDENT 7.0
299 .INDENT 3.5
300 Version\-based filters use proper RPM version comparison semantics
301 instead of lexical string comparison. This ensures correct version
302 ordering (e.g., \(dq1.10\(dq > \(dq1.9\(dq).
303 .UNINDENT
304 .UNINDENT
305 .sp
306 \fBNOTE:\fP
307 .INDENT 7.0
308 .INDENT 3.5
309 The \fBcmdline_repo\fP filter only supports \fB\(dqEXACT\(dq\fP comparator.
310 .UNINDENT
311 .UNINDENT
312 .UNINDENT
313 .TP
314 .B \fBexclude\fP
315 Boolean
316 .sp
317 Optional field.
318 .sp
319 If \fBtrue\fP, packages matching the filters are excluded from the rule. This is
320 useful for defining exceptions. Exclusion rules must appear before the rules
321 from which packages should be excluded.
322 .sp
323 Default: \fBfalse\fP
324 .UNINDENT
325 .SH EXAMPLES
326 .SS Example 1: Allow change from \(dqVendorA\(dq to \(dqVendorB\(dq
327 .sp
328 This example shows the minimal required configuration, allowing a change from
329 \(dqVendorA\(dq to \(dqVendorB\(dq, but not the reverse.
330 .INDENT 0.0
331 .INDENT 3.5
332 .sp
333 .EX
334 version = \(aq1.1\(aq
335
336 [[outgoing_vendors]]
337 vendor = \(aqVendorA\(aq
338
339 [[incoming_vendors]]
340 vendor = \(aqVendorB\(aq
341 .EE
342 .UNINDENT
343 .UNINDENT
344 .SS Example 2: Allow change from any vendor to \(dqMy Trusted Vendor\(dq
345 .sp
346 This example shows allowing a change from any vendor to \(dqMy Trusted Vendor\(dq,
347 but not the reverse. Missing \fBoutgoing_vendors\fP means any vendor is allowed.
348 .INDENT 0.0
349 .INDENT 3.5
350 .sp
351 .EX
352 version = \(aq1.1\(aq
353
354 [[incoming_vendors]]
355 vendor = \(aqMy Trusted Vendor\(aq
356 .EE
357 .UNINDENT
358 .UNINDENT
359 .SS Example 3: Equivalent vendors
360 .sp
361 This example shows vendors that are mutually equivalent, allowing changes
362 in both directions.
363 .INDENT 0.0
364 .INDENT 3.5
365 .sp
366 .EX
367 version = \(aq1.1\(aq
368
369 # All following vendors are mutually equivalent
370 [[equivalent_vendors]]
371 vendor = \(aqFedora Project\(aq
372
373 [[equivalent_vendors]]
374 vendor = \(aqRed Hat\(aq
375 comparator = \(aqISTARTSWITH\(aq
376
377 [[equivalent_vendors]]
378 vendor = \(aqCentOS\(aq
379 comparator = \(aqISTARTSWITH\(aq
380 .EE
381 .UNINDENT
382 .UNINDENT
383 .SS Example 4: Equivalent vendors with an exclusion
384 .sp
385 This example shows a vendor policy for SUSE\-related vendors with an exclusion
386 for openSUSE Build Service.
387 .INDENT 0.0
388 .INDENT 3.5
389 .sp
390 .EX
391 version = \(aq1.1\(aq
392
393 # All following vendors are mutually equivalent except excluded ones
394 [[equivalent_vendors]]
395 vendor = \(aqopenSUSE Build Service\(aq
396 comparator = \(aqISTARTSWITH\(aq
397 exclude = true
398
399 [[equivalent_vendors]]
400 vendor = \(aqSUSE\(aq
401 comparator = \(aqISTARTSWITH\(aq
402
403 [[equivalent_vendors]]
404 vendor = \(aqopenSUSE\(aq
405 comparator = \(aqISTARTSWITH\(aq
406 .EE
407 .UNINDENT
408 .UNINDENT
409 .SS Example 5: Combining equivalent vendors with incoming vendors
410 .sp
411 This example demonstrates combining \fBequivalent_vendors\fP with \fBincoming_vendors\fP,
412 a feature introduced in version \fB\(dq1.1\(dq\fP\&. \(dqFirst Vendor\(dq and \(dqSecond Vendor\(dq are mutually
413 equivalent, and both can change to \(dqThird Vendor\(dq.
414 .INDENT 0.0
415 .INDENT 3.5
416 .sp
417 .EX
418 version = \(aq1.1\(aq
419
420 [[equivalent_vendors]]
421 vendor = \(aqFirst Vendor\(aq
422
423 [[equivalent_vendors]]
424 vendor = \(aqSecond Vendor\(aq
425
426 [[incoming_vendors]]
427 vendor = \(aqThird Vendor\(aq
428 .EE
429 .UNINDENT
430 .UNINDENT
431 .SS Example 6: Allow command\-line packages from any vendor
432 .sp
433 This example allows installing packages from the command\-line repository
434 from any vendor, bypassing vendor restrictions.
435 .INDENT 0.0
436 .INDENT 3.5
437 .sp
438 .EX
439 version = \(aq1.1\(aq
440
441 [[incoming_packages]]
442 filters = [
443 { filter = \(aqcmdline_repo\(aq, value = \(aqtrue\(aq }
444 ]
445 .EE
446 .UNINDENT
447 .UNINDENT
448 .SS Example 7: Command\-line packages with exclusion
449 .sp
450 This example allows installing packages from the command\-line repository
451 from any vendor, except for packages whose names start with \(dqmypackage\(dq.
452 .INDENT 0.0
453 .INDENT 3.5
454 .sp
455 .EX
456 version = \(aq1.1\(aq
457
458 [[incoming_packages]]
459 filters = [
460 { filter = \(aqname\(aq, value = \(aqmypackage\(aq, comparator = \(aqSTARTSWITH\(aq }
461 ]
462 exclude = true
463
464 [[incoming_packages]]
465 filters = [
466 { filter = \(aqcmdline_repo\(aq, value = \(aqtrue\(aq }
467 ]
468 .EE
469 .UNINDENT
470 .UNINDENT
471 .SS Example 8: Allow change from any vendor to specific one with package filtering
472 .sp
473 This example allows a change from any vendor to \(dqMy Vendor\(dq, but
474 only for incoming packages whose source package name is \(dqmypackage\(dq and
475 version is greater than or equal to \(dq2.0\(dq.
476 .INDENT 0.0
477 .INDENT 3.5
478 .sp
479 .EX
480 version = \(aq1.1\(aq
481
482 [[incoming_packages]]
483 filters = [
484 { filter = \(aqsource_name\(aq, value = \(aqmypackage\(aq },
485 { filter = \(aqversion\(aq, value = \(aq2.0\(aq, comparator = \(aqGTE\(aq }
486 ]
487
488 [[incoming_vendors]]
489 vendor = \(aqMy Vendor\(aq
490 .EE
491 .UNINDENT
492 .UNINDENT
493 .SH SEE ALSO
494 .INDENT 0.0
495 .IP \(bu 2
496 \fI\%DNF5 Vendor Change Policy File Reference\fP
497 .IP \(bu 2
498 \fI\%DNF5 Vendor Change Policy File Reference \- v1.0\fP
499 .IP \(bu 2
500 \fBdnf5.conf(5)\fP, \fI\%DNF5 Configuration Reference\fP
501 .UNINDENT
502 .SH AUTHOR
503 See AUTHORS.md in dnf5 source distribution.
504 .SH COPYRIGHT
505 Contributors to the dnf5 project.
506 .\" Generated by docutils manpage writer.
507 .