ab89790aa4c712e044063e9111890b739d647f74
[platform/upstream/libzypp.git] / doc / locks.5
1 .TH "locks" "5" "4.25.0" "libzypp" "System Tools"
2 .SH "NAME"
3 .LP
4 locks - libzypp locking file
5
6 .SH "DESCRIPTION"
7 .LP
8 The file \fI/etc/zypp/locks\fR is read by libzypp at startup if
9 \fIzypp.conf\fR allows it. The entries are used for initial locking of
10 packages. Locking a package means not allowing to install or uninstall
11 it. Valid entries are
12 .TP
13 \fI attribute\fR\fB:\fR \fIvalue\fR
14 Where attributes and their values are described below.
15 .br
16 Locks are separated by empty lines.
17
18 .SH "ATTRIBUTES"
19 .LP
20 All attributes are lower-case.
21
22 .TP
23 .B repo
24 specifies repository restriction. Only alias is accepted.
25 .br
26 By default all repositories match.
27
28 .TP
29 .B type
30 resolvable type restriction
31 .br
32 The values can be \fBpackage\fR, \fBpatch\fR, \fBpattern\fR, \fBproduct\fR and \fBsrcpackage\fR.
33 .br
34 By default all types match.
35
36 .TP
37 .B case_sensitive
38 if strings are matched case sensitive.
39 The values are \fBtrue\fR, \fBfalse\fR, \fBon\fR, \fBoff\fR.
40 .br
41 The default is case insensitive.
42
43 .TP
44 .B install_status
45 status of object. Possible states are \fBinstalled\fR,
46 \fBnot-installed\fR and \fBall\fR. If more install statuses are
47 specified then the last one is used.
48 .br
49 The values are \fBinstalled\fR for all packages which are installed, \fBnon-installed\fR for packages which can be installed or reinstalled and \fBall\fR for both.
50 .br
51 The default is \fBall\fR.
52
53 .TP
54 .B match_type 
55 type of string matching in values. Does not affect \fBtype\fR and \fBrepo\fR which must be specified exactly.
56 .br
57 The values are \fBexact\fR, \fBsubstring\fR, \fBregex\fR for regular
58 expressions, \fBglob\fR for matching as on the command line, and \fBword\fR.
59 .br
60 The default is \fBsubstring\fR.
61
62 .TP
63 .B query_string
64 String to be matched in multiple attributes. Should be restricted by
65 another attribute with empty value ( it is recommended, because without restriction expect some performance problems ). 
66
67 .TP
68 .B version
69 Restrict the lock only to some versions. It contains two parts: an
70 optional operator and the version.
71 .br
72 The operator is \fB==\fR,\fB!=\fR,\fB<\fR,\fB>\fR,\fB<=\fR,\fB>=\fR. If operator is not specified then \fB==\fR is used.
73 .br
74 The version has the format 
75 .RB [ epoch: ] version [ -release ].
76 .br
77 Example: version: < 0:0.11.4-2
78
79 .TP
80 .B solvable_name 
81 name of object (e.g. zypper)
82
83 .TP
84 .B solvable_summary
85 summary of object
86
87 .TP
88 .B solvable_arch
89 architecture of object (e.g. x86_64, i586) 
90
91 .TP
92 .B solvable_description
93 description of object 
94
95 .TP
96 .B solvable_eula 
97 license text of objects which request accepting license by user
98
99 .TP
100 .B solvable_license 
101 license of package (only for package) (e.g. GPL2)
102
103 .TP
104 .B solvable_keywords 
105 keywords which specify package (only for package)
106
107 .TP
108 .B solvable_authors
109 authors of package (only for package)
110
111 .TP
112 .B solvable_group
113 package group (only for package) (e.g. Development/Tools/Version Control )
114
115 .TP
116 .B update_reference_type
117 reference for update (e.g. bugzilla,cve) (only for patches)
118
119 .SH "EXAMPLES"
120 .LP
121
122 .TP
123 .B Exact Package
124 This is the way YaST UI does it. Lock k3b (e.g. you don't want to update it).
125 .br
126 -----locks-----
127 .br
128 type: package
129 .br
130 solvable_name: k3b
131 .br
132 match_type: exact
133 .br
134 case_sensitive: on
135
136 .TP
137 .B Package Wildcard
138 This is the way "zypper addlock cross-*-gcc-icecream-backend" does it.
139 .br
140 -----locks-----
141 .br
142 type: package
143 .br
144 solvable_name: cross-*-gcc-icecream-backend
145 .br
146 match_type: glob
147 .br
148 case_sensitive: on
149
150 .TP
151 .B Versioned Lock
152 Do not install new GCC. This format is used when converting from the
153 openSUSE-10.3 lock format.
154 .br
155 -----locks-----
156 .br
157 solvable_name: gcc
158 .br
159 match_type: glob
160 .br
161 version: > 4.2
162
163 .TP
164 .B Anything named KDE
165 Locks everything which contains kde in the name.
166 .br
167 -----locks-----
168 .br
169 solvable_name: kde
170
171 .TP
172 .B Anything mentioning KDE
173 Locks everything which contains kde in the name, summary, or description.
174 .br
175 -----locks-----
176 .br
177 query_string: kde
178 .br
179 solvable_name:
180 .br
181 solvable_summary:
182 .br
183 solvable_description:
184
185 .SH "HOMEPAGE"
186
187 This manual page only covers the most important attributes. The
188 complete list is available at
189 http://en.opensuse.org/Libzypp/Locksfile
190
191 .SH "AUTHORS"
192 .LP
193 Josef Reidinger <jreidinger@suse.cz>
194 .br
195 Manual page contributions by Martin Vidner <mvidner@suse.cz>.
196
197 .SH "SEE ALSO"
198 .LP
199 zypper(8)