Debian Codegraph @

upstream/mageia-cauldron/man5/dnf5.conf-vendorpolicy-v1_0.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_0" "5" "May 10, 2026" "" "dnf5"
31 .SH NAME
32 dnf5.conf-vendorpolicy-v1_0 \- DNF5 Vendor Change Policy File Reference - v1.0
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.0\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.0\(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.0\(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 define
67 vendor mappings using one of the allowed configurations (see below).
68 .sp
69 If the file contains no vendor lists, it will be loaded and its version will be validated,
70 but it will not define any rules and will not affect vendor manager behavior.
71 .UNINDENT
72 .UNINDENT
73 .SS Vendor Mapping Definition
74 .sp
75 The file can use one of the following vendor definition methods.
76 \fBOnly one method can be used\fP\&.
77 .sp
78 \fBOption 1: Separate Lists (outgoing + incoming)\fP
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 .UNINDENT
91 .sp
92 \fBNOTE:\fP
93 .INDENT 0.0
94 .INDENT 3.5
95 \fBoutgoing_vendors\fP and \fBincoming_vendors\fP must be either both present or both missing.
96 .UNINDENT
97 .UNINDENT
98 .sp
99 \fBIMPORTANT:\fP
100 .INDENT 0.0
101 .INDENT 3.5
102 A vendor change during package replacement is allowed \fBonly if both conditions
103 are met simultaneously\fP:
104 .INDENT 0.0
105 .IP \(bu 2
106 The vendor of the outgoing (installed) package is listed in \fBoutgoing_vendors\fP
107 .IP \(bu 2
108 The vendor of the incoming (new) package is listed in \fBincoming_vendors\fP
109 .UNINDENT
110 .UNINDENT
111 .UNINDENT
112 .sp
113 \fBOption 2: Equivalent Vendors\fP
114 .INDENT 0.0
115 .TP
116 .B \fB[[equivalent_vendors]]\fP
117 Array of tables
118 .sp
119 List of vendors that are mutually equivalent. Changes are allowed in both directions
120 between all vendors in this list.
121 .sp
122 \fBNOTE:\fP
123 .INDENT 7.0
124 .INDENT 3.5
125 Cannot combine \fBequivalent_vendors\fP with \fBoutgoing_vendors\fP or \fBincoming_vendors\fP\&.
126 However, \fBequivalent_vendors\fP is actually a shorthand notation. It is equivalent to
127 listing the same vendors in both \fBoutgoing_vendors\fP and \fBincoming_vendors\fP\&.
128 .UNINDENT
129 .UNINDENT
130 .UNINDENT
131 .SS Vendor Entry Fields
132 .sp
133 Each entry in \fB[[outgoing_vendors]]\fP, \fB[[incoming_vendors]]\fP, or \fB[[equivalent_vendors]]\fP
134 can contain the following fields:
135 .INDENT 0.0
136 .TP
137 .B \fBvendor\fP
138 String
139 .sp
140 Required field.
141 .sp
142 Vendor name or pattern for matching.
143 .TP
144 .B \fBcomparator\fP
145 String
146 .sp
147 Optional field.
148 .sp
149 The matching method to use when comparing vendor strings.
150 .sp
151 Default: \fB\(dqEXACT\(dq\fP
152 .sp
153 Supported values:
154 .INDENT 7.0
155 .IP \(bu 2
156 \fB\(dqEXACT\(dq\fP \- exact match (case\-sensitive)
157 .IP \(bu 2
158 \fB\(dqIEXACT\(dq\fP \- exact match (case\-insensitive)
159 .IP \(bu 2
160 \fB\(dqGLOB\(dq\fP \- glob pattern (case\-sensitive)
161 .IP \(bu 2
162 \fB\(dqIGLOB\(dq\fP \- glob pattern (case\-insensitive)
163 .IP \(bu 2
164 \fB\(dqREGEX\(dq\fP \- regular expression (case\-sensitive)
165 .IP \(bu 2
166 \fB\(dqIREGEX\(dq\fP \- regular expression (case\-insensitive)
167 .IP \(bu 2
168 \fB\(dqCONTAINS\(dq\fP \- contains string (case\-sensitive)
169 .IP \(bu 2
170 \fB\(dqICONTAINS\(dq\fP \- contains string (case\-insensitive)
171 .IP \(bu 2
172 \fB\(dqSTARTSWITH\(dq\fP \- starts with (case\-sensitive)
173 .IP \(bu 2
174 \fB\(dqISTARTSWITH\(dq\fP \- starts with (case\-insensitive)
175 .IP \(bu 2
176 \fB\(dqENDSWITH\(dq\fP \- ends with (case\-sensitive)
177 .IP \(bu 2
178 \fB\(dqIENDSWITH\(dq\fP \- ends with (case\-insensitive)
179 .IP \(bu 2
180 \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
181 .UNINDENT
182 .TP
183 .B \fBexclude\fP
184 Boolean
185 .sp
186 Optional field.
187 .sp
188 If \fBtrue\fP, the vendor is excluded from the rule. This is useful for defining
189 exceptions to more general rules. Rules (vendor entries) are processed in the order
190 they are defined. This means that an exclude rule must appear before the rules
191 from which the vendor should be excluded.
192 .sp
193 Default: \fBfalse\fP
194 .UNINDENT
195 .SH EXAMPLES
196 .SS Example 1: Allow change from \(dqVendorA\(dq to \(dqVendorB\(dq
197 .sp
198 This example shows the minimal required configuration, allowing a change from
199 \(dqVendorA\(dq to \(dqVendorB\(dq, but not the reverse.
200 .INDENT 0.0
201 .INDENT 3.5
202 .sp
203 .EX
204 version = \(aq1.0\(aq
205
206 [[outgoing_vendors]]
207 vendor = \(aqVendorA\(aq
208
209 [[incoming_vendors]]
210 vendor = \(aqVendorB\(aq
211 .EE
212 .UNINDENT
213 .UNINDENT
214 .SS Example 2: Allow change from any vendor to \(dqMy Trusted Vendor\(dq
215 .sp
216 This example shows allowing a change from any vendor to \(dqMy Trusted Vendor\(dq,
217 but not the reverse (requires explicit rule for allowing all vendors).
218 .INDENT 0.0
219 .INDENT 3.5
220 .sp
221 .EX
222 version = \(aq1.0\(aq
223
224 [[outgoing_vendors]]
225 vendor = \(aq\(aq
226 comparator = \(aqCONTAINS\(aq
227
228 [[incoming_vendors]]
229 vendor = \(aqMy Trusted Vendor\(aq
230 .EE
231 .UNINDENT
232 .UNINDENT
233 .SS Example 3: Equivalent vendors
234 .sp
235 This example shows vendors that are mutually equivalent, allowing changes
236 in both directions.
237 .INDENT 0.0
238 .INDENT 3.5
239 .sp
240 .EX
241 version = \(aq1.0\(aq
242
243 # All following vendors are mutually equivalent
244 [[equivalent_vendors]]
245 vendor = \(aqFedora Project\(aq
246
247 [[equivalent_vendors]]
248 vendor = \(aqRed Hat\(aq
249 comparator = \(aqISTARTSWITH\(aq
250
251 [[equivalent_vendors]]
252 vendor = \(aqCentOS\(aq
253 comparator = \(aqISTARTSWITH\(aq
254 .EE
255 .UNINDENT
256 .UNINDENT
257 .SS Example 4: Equivalent vendors with an exclusion
258 .sp
259 This example shows a vendor policy for SUSE\-related vendors with an exclusion
260 for openSUSE Build Service.
261 .INDENT 0.0
262 .INDENT 3.5
263 .sp
264 .EX
265 version = \(aq1.0\(aq
266
267 # All following vendors are mutually equivalent except excluded ones
268 [[equivalent_vendors]]
269 vendor = \(aqopenSUSE Build Service\(aq
270 comparator = \(aqISTARTSWITH\(aq
271 exclude = true
272
273 [[equivalent_vendors]]
274 vendor = \(aqSUSE\(aq
275 comparator = \(aqISTARTSWITH\(aq
276
277 [[equivalent_vendors]]
278 vendor = \(aqopenSUSE\(aq
279 comparator = \(aqISTARTSWITH\(aq
280 .EE
281 .UNINDENT
282 .UNINDENT
283 .SH SEE ALSO
284 .INDENT 0.0
285 .IP \(bu 2
286 \fI\%DNF5 Vendor Change Policy File Reference\fP
287 .IP \(bu 2
288 \fI\%DNF5 Vendor Change Policy File Reference \- v1.1\fP
289 .IP \(bu 2
290 \fBdnf5.conf(5)\fP, \fI\%DNF5 Configuration Reference\fP
291 .UNINDENT
292 .SH AUTHOR
293 See AUTHORS.md in dnf5 source distribution.
294 .SH COPYRIGHT
295 Contributors to the dnf5 project.
296 .\" Generated by docutils manpage writer.
297 .