add manpage for locks
[platform/upstream/libzypp.git] / doc / locks.5
1 .TH "locks" "5" "0.4.20" "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 has been read by libzypp at startup if zypp.conf allow it. The entries is used for initial lock of package. Lock package mean does't allow install or uninstall package. Valid entries are
9 .TP
10 \fI attribute\fR\fB:\fR \fIvalue\fR
11 Where attributes and its values is described below.
12 .br
13 Locks is separated by empty line.
14
15
16 .SH "ATTRIBUTES"
17 .LP
18 description of attributes. All attributes are lower-case.
19
20 .TP
21 .B repo
22 specifies repository restriction. Only allias is accepted.
23 .br
24 Default is allowed all repositories.
25
26 .TP
27 .B type
28 type restriction - kind can be package,patch,pattern,product and srcpackage.
29 .br
30 default is all kind 
31
32 .TP
33 .B case_sensitive
34 if string is matched case sensitive.
35 .br
36 default is case insensitive 
37
38 .TP
39 .B require_all
40 if all string must match or at least one
41 .br
42 values are \fBtrue\fR for all match and \fBfalse\fR for at least one
43 .br
44 default is false
45
46 .TP
47 .B install_status
48 status of object. Possibly states is installed,not-installed and all. If more install status is specified then last is used.
49 .br
50 values are \fBinstalled\fR for all packages which is installed,\fBnon-installed\fR for packages which can be install or reinstall and \fBall\fR for both.
51 .br
52 default is all 
53
54 .TP
55 .B match_type 
56 type of string in value. Not affect kind and repo which must be exactly specified.
57 .br
58 values are \fBexact\fR for exact match, \fBsubstring\fR if string contains value, \fBregex\fR for regular expressions, \fBglob\fR for matching as in command line and \fBword\fR.
59 .br
60 default is substring 
61
62 .TP
63 .B query_string
64 string for all attributes. Can be restricted by attribute with empty value. 
65
66 .TP
67 .B solvable_name 
68 name of object 
69
70 .TP
71 .B solvable_summary
72 summary of object 
73
74 .TP
75 .B solvable_description
76 description of object 
77
78 .TP
79 .B solvable_eula 
80 license text of non-opensource object
81
82 .TP
83 .B solvable_license 
84 license of package (only for package)
85
86 .TP
87 .B solvable_keywords 
88 keywords which specify object
89
90 .TP
91 .B solvable_authors
92 authors of object
93
94 .TP
95 .B update_reference_type 
96 reference for update (e.g. bugzilla,cve) (only for patch)
97
98 .SH "EXAMPLES"
99 .LP
100 examples of usage
101
102 .TP
103 .B all kde
104 locks everything which contains kde 
105 .br
106 -----locks-----
107 .br
108 solvable_name: kde
109
110 .TP
111 .B shareware from repository non-oss or factory
112 locks each package which is shareware from repository non-oss or factory 
113 .br
114 -----locks-----
115 .br
116 solvable_license: shareware
117 .br
118 repo: non-oss
119 .br
120 repo: factory
121
122 .TP
123 .B all patches
124 locks all patches
125 .br
126 -----locks-----
127 .br
128 kind:patch
129
130 .TP
131 .B Two locks
132 all objects which contains kde(only low letters) in name and description and second lock for everything which have x11 keyword 
133 .br
134 -----locks-----
135 .br
136 global_string: kde
137 .br
138 solvable_name:
139 .br
140 solvable_description:
141 .br
142 case_sensitive: on
143 .br
144 require_all: on
145 .br
146  
147 .br
148 solvable_keywords: x11
149
150 .TP
151 .B exact package 
152 lock k3b (e.g. don't want update it)
153 .br
154 preferred way is use zypper addlock command (or Yast when they support new locks api-not now)
155 .br
156 -----locks-----
157 .br
158 solvable_name: k3b
159 .br
160 string_type: exact
161
162 .SH "HOMEPAGE"
163
164 http://en.opensuse.org/Libzypp/Locksfile
165
166 .SH "AUTHORS"
167 .LP
168 Josef Reidinger <jreidinger@suse.cz>
169
170 .SH "SEE ALSO"
171 .LP