Debian Codegraph @

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