Imported Upstream version 15.0.0
[platform/upstream/libzypp.git] / doc / locks.5
1 '\" t
2 .\"     Title: locks
3 .\"    Author: [see the "AUTHORS" section]
4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5 .\"      Date: 10/02/2014
6 .\"    Manual: LIBZYPP
7 .\"    Source: libzypp
8 .\"  Language: English
9 .\"
10 .TH "LOCKS" "5" "10/02/2014" "libzypp" "LIBZYPP"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 locks \- libzypp locking file
32 .SH "DESCRIPTION"
33 .sp
34 The file \fI/etc/zypp/locks\fR is read by libzypp at start\-up if \fIzypp\&.conf\fR allows it\&. The entries are used for initial locking of packages\&. Locking a package means not allowing to install or uninstall it\&.
35 .sp
36 Valid entries are of the form:
37 .PP
38 \fIattribute\fR\fB:\fR \fIvalue\fR
39 .RS 4
40 Where attributes and their values are described below\&.
41 .RE
42 .sp
43 Locks are separated by an empty lines\&.
44 .SH "ATTRIBUTES"
45 .sp
46 All attributes are lower\-case\&.
47 .PP
48 \fBrepo\fR
49 .RS 4
50 specifies repository restriction\&. Only alias is accepted\&.
51
52 By default all repositories match\&.
53 .RE
54 .PP
55 \fBtype\fR
56 .RS 4
57 resolvable type restriction\&. The values can be
58 \fBpackage\fR,
59 \fBpatch\fR,
60 \fBpattern\fR,
61 \fBproduct\fR
62 and
63 \fBsrcpackage\fR\&.
64
65 By default all types match\&.
66 .RE
67 .PP
68 \fBcase_sensitive\fR
69 .RS 4
70 if strings are matched case sensitive\&. The values are
71 \fBtrue\fR,
72 \fBfalse\fR,
73 \fBon\fR,
74 \fBoff\fR\&.
75
76 The default is case insensitive\&.
77 .RE
78 .PP
79 \fBinstall_status\fR
80 .RS 4
81 status of object\&. Possible states are
82 \fBinstalled\fR,
83 \fBnot\-installed\fR
84 and
85 \fBall\fR\&. If more install statuses are specified then the last one is used\&. The values are
86 \fBinstalled\fR
87 for all packages which are installed,
88 \fBnon\-installed\fR
89 for packages which can be installed or reinstalled and
90 \fBall\fR
91 for both\&.
92
93 The default is
94 \fBall\fR\&.
95 .RE
96 .PP
97 \fBmatch_type\fR
98 .RS 4
99 type of string matching in values\&. Does not affect
100 \fBtype\fR
101 and
102 \fBrepo\fR
103 which must be specified exactly\&. The values are
104 \fBexact\fR,
105 \fBsubstring\fR,
106 \fBregex\fR
107 for regular expressions,
108 \fBglob\fR
109 for matching as on the command line, and
110 \fBword\fR\&.
111
112 The default is
113 \fBsubstring\fR\&.
114 .RE
115 .PP
116 \fBquery_string\fR
117 .RS 4
118 String to be matched in multiple attributes\&. Should be restricted by another attribute with empty value (it is recommended, because without restriction expect some performance problems)\&.
119 .RE
120 .PP
121 \fBversion\fR
122 .RS 4
123 Restrict the lock only to some versions\&. It contains two parts: an optional operator and the version\&.
124
125 The operator is
126 \fB==\fR,
127 \fB!=\fR,
128 \fB<\fR,
129 \fB>\fR,
130 \fB⇐\fR,
131 \fB>=\fR\&. If operator is not specified then
132 \fB==\fR
133 is used\&.
134
135 The version has the format [\fIepoch\fR\fB:\fR]\fIversion\fR[\fB\-\fR\fIrelease\fR]\&.
136
137 Example:
138 \fBversion: < 0:0\&.11\&.4\-2\fR
139 .RE
140 .PP
141 \fBsolvable_name\fR
142 .RS 4
143 name of object (e\&.g\&. zypper)
144 .RE
145 .PP
146 \fBsolvable_summary\fR
147 .RS 4
148 summary of object
149 .RE
150 .PP
151 \fBsolvable_arch\fR
152 .RS 4
153 architecture of object (e\&.g\&. x86_64, i586)
154 .RE
155 .PP
156 \fBsolvable_description\fR
157 .RS 4
158 description of object
159 .RE
160 .PP
161 \fBsolvable_eula\fR
162 .RS 4
163 license text of objects which request accepting license by user
164 .RE
165 .PP
166 \fBsolvable_license\fR
167 .RS 4
168 license of package (only for package) (e\&.g\&. GPL2)
169 .RE
170 .PP
171 \fBsolvable_keywords\fR
172 .RS 4
173 keywords which specify package (only for package)
174 .RE
175 .PP
176 \fBsolvable_authors\fR
177 .RS 4
178 authors of package (only for package)
179 .RE
180 .PP
181 \fBsolvable_group\fR
182 .RS 4
183 package group (only for package) (e\&.g\&. Development/Tools/Version Control )
184 .RE
185 .PP
186 \fBupdate_reference_type\fR
187 .RS 4
188 reference for update (e\&.g\&. bugzilla,cve) (only for patches)
189 .RE
190 .SH "EXAMPLES"
191 .PP
192 \fBExact Package\fR
193 .RS 4
194 This is the way YaST UI does it\&. Lock k3b (e\&.g\&. you don\(cqt want to update it)\&.
195 .RE
196 .sp
197 .if n \{\
198 .RS 4
199 .\}
200 .nf
201 \-\-\-\-\-locks\-\-\-\-\-
202 type: package
203 solvable_name: k3b
204 match_type: exact
205 case_sensitive: on
206 .fi
207 .if n \{\
208 .RE
209 .\}
210 .PP
211 \fBPackage Wildcard\fR
212 .RS 4
213 This is the way "zypper addlock cross\-*\-gcc\-icecream\-backend" does it\&.
214 .RE
215 .sp
216 .if n \{\
217 .RS 4
218 .\}
219 .nf
220 \-\-\-\-\-locks\-\-\-\-\-
221 type: package
222 solvable_name: cross\-*\-gcc\-icecream\-backend
223 match_type: glob
224 case_sensitive: on
225 .fi
226 .if n \{\
227 .RE
228 .\}
229 .PP
230 \fBVersioned Lock\fR
231 .RS 4
232 Do not install new GCC\&. This format is used when converting from the openSUSE\-10\&.3 lock format\&.
233 .RE
234 .sp
235 .if n \{\
236 .RS 4
237 .\}
238 .nf
239 \-\-\-\-\-locks\-\-\-\-\-
240 solvable_name: gcc
241 match_type: glob
242 version: > 4\&.2
243 .fi
244 .if n \{\
245 .RE
246 .\}
247 .PP
248 \fBAnything named KDE\fR
249 .RS 4
250 Locks everything which contains kde in the name\&.
251 .RE
252 .sp
253 .if n \{\
254 .RS 4
255 .\}
256 .nf
257 \-\-\-\-\-locks\-\-\-\-\-
258 solvable_name: kde
259 .fi
260 .if n \{\
261 .RE
262 .\}
263 .PP
264 \fBAnything mentioning KDE\fR
265 .RS 4
266 Locks everything which contains kde in the name, summary, or description\&.
267 .RE
268 .sp
269 .if n \{\
270 .RS 4
271 .\}
272 .nf
273 \-\-\-\-\-locks\-\-\-\-\-
274 query_string: kde
275 solvable_name:
276 solvable_summary:
277 solvable_description:
278 .fi
279 .if n \{\
280 .RE
281 .\}
282 .SH "HOMEPAGE"
283 .sp
284 This manual page only covers the most important attributes\&. The complete list is available at http://en\&.opensuse\&.org/Libzypp/Locksfile
285 .SH "AUTHORS"
286 .sp
287 Josef Reidinger <jreidinger@suse\&.cz> Manual page contributions by Martin Vidner <mvidner@suse\&.cz>\&.
288 .SH "SEE ALSO"
289 .sp
290 zypper(8)