Fossil SCM

th1 docs: added new capexpr and marked (anycap, hascap, anoncap) as deprecated.

stephan 2021-01-26 17:53 trunk
Commit 828821463aa630aab145d33addc6a351738cafa7652e0dfd6304ae441301b6fa
Parent f96de5abdf2229e…
1 file changed +32
~ www/th1.md
M www/th1.md
+32
--- www/th1.md
+++ www/th1.md
@@ -168,10 +168,11 @@
168168
 features of Fossil. The following is a summary of the extended commands:
169169
170170
 * [anoncap](#anoncap)
171171
 * [anycap](#anycap)
172172
 * [artifact](#artifact)
173
+ * [capexpr](#capexpr)
173174
 * [captureTh1](#captureTh1)
174175
 * [cgiHeaderLine](#cgiHeaderLine)
175176
 * [checkout](#checkout)
176177
 * [combobox](#combobox)
177178
 * [copybtn](#copybtn)
@@ -233,17 +234,21 @@
233234
 in order to successfully make use of these commands.
234235
235236
 <a id="anoncap"></a>TH1 anoncap Command
236237
 -----------------------------------------
237238
239
+Deprecated: prefer [capexpr](#capexpr) instead.
240
+
238241
 * anoncap STRING...
239242
240243
 Returns true if the anonymous user has all of the capabilities listed
241244
 in STRING.
242245
243246
 <a id="anycap"></a>TH1 anycap Command
244247
 ---------------------------------------
248
+
249
+Deprecated: prefer [capexpr](#capexpr) instead.
245250
246251
 * anycap STRING
247252
248253
 Returns true if the current user user has any one of the capabilities
249254
 listed in STRING.
@@ -255,10 +260,35 @@
255260
256261
 Attempts to locate the specified artifact and return its contents. An
257262
 error is generated if the repository is not open or the artifact cannot
258263
 be found.
259264
265
+
266
+
267
+<a id="capexpr"></a>TH1 capexpr Command
268
+-----------------------------------------------------
269
+
270
+ * capexpr CAPABILITY-EXPR
271
+
272
+The capability expression is a list. Each term of the list is a
273
+cluster of capability letters. The overall expression is true if any
274
+one term is true. A single term is true if all letters within that
275
+term are true. Or, if the term begins with "!", then the term is true
276
+if none of the terms or true. Or, if the term begins with "@" then
277
+the term is true if all of the capability letters in that term are
278
+available to the "anonymous" user. Or, if the term is "*" then it is
279
+always true.
280
+
281
+Examples:
282
+
283
+```
284
+ capexpr {j o r} True if any one of j, o, or r are available
285
+ capexpr {oh} True if both o and h are available
286
+ capexpr {@2 @3 4 5 6} 2 or 3 available for anonymous or one of
287
+ 4, 5 or 6 is available for the user
288
+```
289
+
260290
 <a id="captureTh1"></a>TH1 captureTh1 Command
261291
 -----------------------------------------------------
262292
263293
 * captureTh1 STRING
264294
@@ -425,10 +455,12 @@
425455
 in a script error. Additional global state variables may be exposed
426456
 in the future.
427457
428458
 <a id="hascap"></a>TH1 hascap Command
429459
 ---------------------------------------
460
+
461
+Deprecated: prefer [capexpr](#capexpr) instead.
430462
431463
 * hascap STRING...
432464
433465
 Returns true if the current user has all of the capabilities listed
434466
 in STRING.
435467
--- www/th1.md
+++ www/th1.md
@@ -168,10 +168,11 @@
168 features of Fossil. The following is a summary of the extended commands:
169
170 * [anoncap](#anoncap)
171 * [anycap](#anycap)
172 * [artifact](#artifact)
 
173 * [captureTh1](#captureTh1)
174 * [cgiHeaderLine](#cgiHeaderLine)
175 * [checkout](#checkout)
176 * [combobox](#combobox)
177 * [copybtn](#copybtn)
@@ -233,17 +234,21 @@
233 in order to successfully make use of these commands.
234
235 <a id="anoncap"></a>TH1 anoncap Command
236 -----------------------------------------
237
 
 
238 * anoncap STRING...
239
240 Returns true if the anonymous user has all of the capabilities listed
241 in STRING.
242
243 <a id="anycap"></a>TH1 anycap Command
244 ---------------------------------------
 
 
245
246 * anycap STRING
247
248 Returns true if the current user user has any one of the capabilities
249 listed in STRING.
@@ -255,10 +260,35 @@
255
256 Attempts to locate the specified artifact and return its contents. An
257 error is generated if the repository is not open or the artifact cannot
258 be found.
259
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
260 <a id="captureTh1"></a>TH1 captureTh1 Command
261 -----------------------------------------------------
262
263 * captureTh1 STRING
264
@@ -425,10 +455,12 @@
425 in a script error. Additional global state variables may be exposed
426 in the future.
427
428 <a id="hascap"></a>TH1 hascap Command
429 ---------------------------------------
 
 
430
431 * hascap STRING...
432
433 Returns true if the current user has all of the capabilities listed
434 in STRING.
435
--- www/th1.md
+++ www/th1.md
@@ -168,10 +168,11 @@
168 features of Fossil. The following is a summary of the extended commands:
169
170 * [anoncap](#anoncap)
171 * [anycap](#anycap)
172 * [artifact](#artifact)
173 * [capexpr](#capexpr)
174 * [captureTh1](#captureTh1)
175 * [cgiHeaderLine](#cgiHeaderLine)
176 * [checkout](#checkout)
177 * [combobox](#combobox)
178 * [copybtn](#copybtn)
@@ -233,17 +234,21 @@
234 in order to successfully make use of these commands.
235
236 <a id="anoncap"></a>TH1 anoncap Command
237 -----------------------------------------
238
239 Deprecated: prefer [capexpr](#capexpr) instead.
240
241 * anoncap STRING...
242
243 Returns true if the anonymous user has all of the capabilities listed
244 in STRING.
245
246 <a id="anycap"></a>TH1 anycap Command
247 ---------------------------------------
248
249 Deprecated: prefer [capexpr](#capexpr) instead.
250
251 * anycap STRING
252
253 Returns true if the current user user has any one of the capabilities
254 listed in STRING.
@@ -255,10 +260,35 @@
260
261 Attempts to locate the specified artifact and return its contents. An
262 error is generated if the repository is not open or the artifact cannot
263 be found.
264
265
266
267 <a id="capexpr"></a>TH1 capexpr Command
268 -----------------------------------------------------
269
270 * capexpr CAPABILITY-EXPR
271
272 The capability expression is a list. Each term of the list is a
273 cluster of capability letters. The overall expression is true if any
274 one term is true. A single term is true if all letters within that
275 term are true. Or, if the term begins with "!", then the term is true
276 if none of the terms or true. Or, if the term begins with "@" then
277 the term is true if all of the capability letters in that term are
278 available to the "anonymous" user. Or, if the term is "*" then it is
279 always true.
280
281 Examples:
282
283 ```
284 capexpr {j o r} True if any one of j, o, or r are available
285 capexpr {oh} True if both o and h are available
286 capexpr {@2 @3 4 5 6} 2 or 3 available for anonymous or one of
287 4, 5 or 6 is available for the user
288 ```
289
290 <a id="captureTh1"></a>TH1 captureTh1 Command
291 -----------------------------------------------------
292
293 * captureTh1 STRING
294
@@ -425,10 +455,12 @@
455 in a script error. Additional global state variables may be exposed
456 in the future.
457
458 <a id="hascap"></a>TH1 hascap Command
459 ---------------------------------------
460
461 Deprecated: prefer [capexpr](#capexpr) instead.
462
463 * hascap STRING...
464
465 Returns true if the current user has all of the capabilities listed
466 in STRING.
467

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button