Debian Codegraph @

upstream/debian-unstable/man5/dnf5.conf-vendorpolicy-v1_1.5

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