fixup Fix to build with libxml 2.12.x (fixes #505)
[platform/upstream/libzypp.git] / doc / locks.5.txt
1 LOCKS(5)
2 ========
3 :man manual: LIBZYPP
4 :man source: SUSE Linux
5
6
7 NAME
8 ----
9 locks - libzypp locking file
10
11
12 DESCRIPTION
13 -----------
14 The file '/etc/zypp/locks' is read by libzypp at start-up if 'zypp.conf' allows it. The entries are used for initial locking of packages. Locking a package means not allowing to install or uninstall it.
15
16 Valid entries are of the form:
17
18 'attribute'*:* 'value'::
19       Where attributes and their values are described below.
20
21 Locks are separated by an empty lines.
22
23
24 ATTRIBUTES
25 ----------
26 All attributes are lower-case.
27
28 *repo*::
29         specifies repository restriction. Only alias is accepted. +
30         By default all repositories match.
31
32 *type*::
33         resolvable type restriction. The values can be *package*, *patch*, *pattern*, *product* and *srcpackage*. +
34         By default all types match.
35
36
37 *case_sensitive*::
38         if strings are matched case sensitive. The values are *true*, *false*, *on*, *off*. +
39         The default is case insensitive.
40
41
42 *install_status*::
43         status of object. Possible states are *installed*, *not-installed* and *all*. If more install statuses are specified then the last one is used. The values are *installed* for all packages which are installed, *non-installed* for packages which can be installed or reinstalled and *all* for both. +
44         The default is *all*.
45
46
47 *match_type*::
48         type of string matching in values. Does not affect *type* and *repo* which must be specified exactly. The values are *exact*, *substring*, *regex* for regular expressions, *glob* for matching as on the command line, and *word*. +
49         The default is *substring*.
50
51 *query_string*::
52         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).
53
54 *version*::
55         Restrict the lock only to some versions. It contains two parts: an optional operator and the version. +
56         The operator is *==*, *!=*, *<*, *>*, *<=*, *>=*.  If operator is not specified then *==* is used. +
57         The version has the format ['epoch'*:*+]+'version'[*-*'release']. +
58         Example: *version: < 0:0.11.4-2*
59
60 *solvable_name*::
61         name of object (e.g. zypper)
62
63 *solvable_summary*::
64         summary of object
65
66 *solvable_arch*::
67         architecture of object (e.g. x86_64, i586)
68
69 *solvable_description*::
70         description of object
71
72 *solvable_eula*::
73         license text of objects which request accepting license by user
74
75 *solvable_license*::
76         license of package (only for package) (e.g. GPL2)
77
78 *solvable_keywords*::
79         keywords which specify package (only for package)
80
81 *solvable_authors*::
82         authors of package (only for package)
83
84 *solvable_group*::
85         package group (only for package) (e.g. Development/Tools/Version Control )
86
87 *update_reference_type*::
88         reference for update (e.g. bugzilla,cve) (only for patches)
89
90
91 EXAMPLES
92 --------
93 *Exact Package*::
94         This is the way YaST UI does it. Lock k3b (e.g. you don't want to update it).
95 --------------------
96 -----locks-----
97 type: package
98 solvable_name: k3b
99 match_type: exact
100 case_sensitive: on
101 --------------------
102
103 *Package Wildcard*::
104         This is the way "zypper addlock cross-*-gcc-icecream-backend" does it.
105 --------------------
106 -----locks-----
107 type: package
108 solvable_name: cross-*-gcc-icecream-backend
109 match_type: glob
110 case_sensitive: on
111 --------------------
112
113 *Versioned Lock*::
114         Do not install new GCC. This format is used when converting from the openSUSE-10.3 lock format.
115 --------------------
116 -----locks-----
117 solvable_name: gcc
118 match_type: glob
119 version: > 4.2
120 --------------------
121
122 *Anything named KDE*::
123         Locks everything which contains kde in the name.
124 --------------------
125 -----locks-----
126 solvable_name: kde
127 --------------------
128
129 *Anything mentioning KDE*::
130         Locks everything which contains kde in the name, summary, or description.
131 --------------------
132 -----locks-----
133 query_string: kde
134 solvable_name:
135 solvable_summary:
136 solvable_description:
137 --------------------
138
139
140 HOMEPAGE
141 --------
142 This manual page only covers the most important attributes. The complete list is available at http://en.opensuse.org/Libzypp/Locksfile
143
144
145 AUTHORS
146 -------
147 Josef Reidinger <jreidinger@suse.cz>
148 Manual page contributions by Martin Vidner <mvidner@suse.cz>.
149
150
151 SEE ALSO
152 --------
153 zypper(8)