Browse Source

man: remove deleted app woob-athon

Vincent A 1 month ago
parent
commit
7f0c5015c9
1 changed files with 0 additions and 347 deletions
  1. 0
    347
      man/woob-athon.1

+ 0
- 347
man/woob-athon.1 View File

@@ -1,347 +0,0 @@
1
-.\" -*- coding: utf-8 -*-
2
-.\" This file was generated automatically by tools/make_man.sh.
3
-.TH WOOB-ATHON 1 "03 March 2021" "woob-athon 2\&.1"
4
-.SH NAME
5
-woob-athon \- participate in a Woobathon
6
-.SH SYNOPSIS
7
-.B woob\-athon
8
-[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIwoobathon\fR
9
-.br
10
-.B woob\-athon
11
-[\-\-help] [\-\-version]
12
-
13
-.SH DESCRIPTION
14
-.LP
15
-
16
-Console application to participate to a Woobathon.
17
-
18
-.SS Supported websites:
19
-* dlfp (Da Linux French Page news website)
20
-.br
21
-* mediawiki (Wikis running MediaWiki, like Wikipedia)
22
-.br
23
-* redmine (The Redmine project management web application)
24
-.SH WOOB\-ATHON COMMANDS
25
-.TP
26
-\fBaddtask\fR \fIBACKEND\fR \fICAPABILITY\fR
27
-.br
28
-Add a new task.
29
-.TP
30
-\fBcancel\fR
31
-.br
32
-Cancel the current task.
33
-.TP
34
-\fBclose\fR \fIWINNER\fR
35
-.br
36
-Close the event and set the winner.
37
-.TP
38
-\fBdebug\fR
39
-.br
40
-Launch a debug Python shell
41
-.TP
42
-\fBdone\fR
43
-.br
44
-Set the current task as done.
45
-.TP
46
-\fBedit\fR [event | me]
47
-.br
48
-Edit information about you or about event.
49
-.TP
50
-\fBinfo\fR
51
-.br
52
-Display information about this event.
53
-.TP
54
-\fBjoin\fR
55
-.br
56
-Join this event.
57
-.TP
58
-\fBleave\fR
59
-.br
60
-Leave this event.
61
-.TP
62
-\fBmembers\fR
63
-.br
64
-Display members information.
65
-.TP
66
-\fBprogress\fR
67
-.br
68
-Display progress of members.
69
-.TP
70
-\fBremtask\fR \fITASK_ID\fR
71
-.br
72
-Remove a task.
73
-.TP
74
-\fBstart\fR [\fITASK_ID\fR]
75
-.br
76
-Start a task. If you don't give a task ID, the first available
77
-.br
78
-task will be taken.
79
-.TP
80
-\fBtasks\fR
81
-.br
82
-Display all tasks of members.
83
-.SH WOOB COMMANDS
84
-.TP
85
-\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
86
-.br
87
-Select used backends.
88
-.br
89
-
90
-.br
91
-ACTION is one of the following (default: list):
92
-.br
93
-* enable         enable given backends
94
-.br
95
-* disable        disable given backends
96
-.br
97
-* only           enable given backends and disable the others
98
-.br
99
-* list           list backends
100
-.br
101
-* add            add a backend
102
-.br
103
-* register       register a new account on a website
104
-.br
105
-* edit           edit a backend
106
-.br
107
-* remove         remove a backend
108
-.br
109
-* list\-modules   list modules
110
-.TP
111
-\fBcd\fR [\fIPATH\fR]
112
-.br
113
-Follow a path.
114
-.br
115
-".." is a special case and goes up one directory.
116
-.br
117
-"" is a special case and goes home.
118
-.TP
119
-\fBcondition\fR [\fIEXPRESSION\fR | off]
120
-.br
121
-If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
122
-.br
123
-If the "off" value is given, conditional filtering is disabled.
124
-.br
125
-
126
-.br
127
-If no argument is given, print the current condition expression.
128
-.TP
129
-\fBcount\fR [\fINUMBER\fR | off]
130
-.br
131
-If an argument is given, set the maximum number of results fetched.
132
-.br
133
-NUMBER must be at least 1.
134
-.br
135
-"off" value disables counting, and allows infinite searches.
136
-.br
137
-
138
-.br
139
-If no argument is given, print the current count value.
140
-.TP
141
-\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
142
-.br
143
-If a FORMATTER is given, set the formatter to use.
144
-.br
145
-You can add a COMMAND to apply the formatter change only to
146
-.br
147
-a given command.
148
-.br
149
-
150
-.br
151
-If the argument is "list", print the available formatters.
152
-.br
153
-
154
-.br
155
-If the argument is "option", set the formatter options.
156
-.br
157
-Valid options are: header, keys.
158
-.br
159
-If on/off value is given, set the value of the option.
160
-.br
161
-If not, print the current value for the option.
162
-.br
163
-
164
-.br
165
-If no argument is given, print the current formatter.
166
-.TP
167
-\fBlogging\fR [\fILEVEL\fR]
168
-.br
169
-Set logging level.
170
-.br
171
-
172
-.br
173
-Availables: debug, info, warning, error.
174
-.br
175
-* quiet is an alias for error
176
-.br
177
-* default is an alias for warning
178
-.TP
179
-\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
180
-.br
181
-List objects in current path.
182
-.br
183
-If an argument is given, list the specified path.
184
-.br
185
-Use \-U option to not sort results. It allows you to use a "fast path" to
186
-.br
187
-return results as soon as possible.
188
-.br
189
-Use \-d option to display information about a collection (and to not
190
-.br
191
-display the content of it). It has the same behavior than the well
192
-.br
193
-known UNIX "ls" command.
194
-.br
195
-
196
-.br
197
-Default is limited to 40 results.
198
-.TP
199
-\fBquit\fR
200
-.br
201
-Quit the application.
202
-.TP
203
-\fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full"
204
-.br
205
-If an argument is given, set the selected fields.
206
-.br
207
-$direct selects all fields loaded in one http request.
208
-.br
209
-$full selects all fields using as much http requests as necessary.
210
-.br
211
-
212
-.br
213
-If no argument is given, print the currently selected fields.
214
-
215
-.SH OPTIONS
216
-.TP
217
-\fB\-\-version\fR
218
-show program's version number and exit
219
-.TP
220
-\fB\-h\fR, \fB\-\-help\fR
221
-show this help message and exit
222
-.TP
223
-\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
224
-what backend(s) to enable (comma separated)
225
-.TP
226
-\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
227
-what backend(s) to exclude (comma separated)
228
-.TP
229
-\fB\-I\fR, \fB\-\-insecure\fR
230
-do not validate SSL
231
-.TP
232
-\fB\-\-nss\fR
233
-Use NSS instead of OpenSSL
234
-.TP
235
-\fB\-\-auto\-update\fR
236
-Automatically check for updates when a bug in a module is encountered
237
-
238
-.SH LOGGING OPTIONS
239
-.TP
240
-\fB\-d\fR, \fB\-\-debug\fR
241
-display debug messages. Set up it twice to more verbosity
242
-.TP
243
-\fB\-q\fR, \fB\-\-quiet\fR
244
-display only error messages
245
-.TP
246
-\fB\-v\fR, \fB\-\-verbose\fR
247
-display info messages
248
-.TP
249
-\fB\-\-logging\-file=LOGGING_FILE\fR
250
-file to save logs
251
-.TP
252
-\fB\-a\fR, \fB\-\-save\-responses\fR
253
-save every response
254
-.TP
255
-\fB\-\-export\-session\fR
256
-log browser session cookies after login
257
-
258
-.SH RESULTS OPTIONS
259
-.TP
260
-\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
261
-filter result items to display given a boolean expression. See CONDITION section
262
-for the syntax
263
-.TP
264
-\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
265
-limit number of results (from each backends)
266
-.TP
267
-\fB\-s SELECT\fR, \fB\-\-select=SELECT\fR
268
-select result item keys to display (comma separated)
269
-
270
-.SH FORMATTING OPTIONS
271
-.TP
272
-\fB\-f FORMATTER\fR, \fB\-\-formatter=FORMATTER\fR
273
-select output formatter (csv, htmltable, json, json_line, multiline, simple,
274
-table, webkit)
275
-.TP
276
-\fB\-\-no\-header\fR
277
-do not display header
278
-.TP
279
-\fB\-\-no\-keys\fR
280
-do not display item keys
281
-.TP
282
-\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
283
-file to export result
284
-
285
-.SH CONDITION
286
-The \-c and \-\-condition is a flexible way to filter and get only interesting results. It supports conditions on numerical values, dates, durations and strings. Dates are given in YYYY\-MM\-DD or YYYY\-MM\-DD HH:MM format. Durations look like XhYmZs where X, Y and Z are integers. Any of them may be omitted. For instance, YmZs, XhZs or Ym are accepted.
287
-The syntax of one expression is "\fBfield operator value\fR". The field to test is always the left member of the expression.
288
-.LP
289
-The field is a member of the objects returned by the command. For example, a bank account has "balance", "coming" or "label" fields.
290
-.SS The following operators are supported:
291
-.TP
292
-=
293
-Test if object.field is equal to the value.
294
-.TP
295
-!=
296
-Test if object.field is not equal to the value.
297
-.TP
298
->
299
-Test if object.field is greater than the value. If object.field is date, return true if value is before that object.field.
300
-.TP
301
-<
302
-Test if object.field is less than the value. If object.field is date, return true if value is after that object.field.
303
-.TP
304
-|
305
-This operator is available only for string fields. It works like the Unix standard \fBgrep\fR command, and returns True if the pattern specified in the value is in object.field.
306
-.SS Expression combination
307
-.LP
308
-You can make a expression combinations with the keywords \fB" AND "\fR, \fB" OR "\fR an \fB" LIMIT "\fR.
309
-.LP
310
-The \fBLIMIT\fR keyword can be used to limit the number of items upon which running the expression. \fBLIMIT\fR can only be placed at the end of the expression followed by the number of elements you want.
311
-.SS Examples:
312
-.nf
313
-.B boobank ls \-\-condition 'label=Livret A'
314
-.fi
315
-Display only the "Livret A" account.
316
-.PP
317
-.nf
318
-.B boobank ls \-\-condition 'balance>10000'
319
-.fi
320
-Display accounts with a lot of money.
321
-.PP
322
-.nf
323
-.B boobank history account@backend \-\-condition 'label|rewe'
324
-.fi
325
-Get transactions containing "rewe".
326
-.PP
327
-.nf
328
-.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
329
-.fi
330
-Get transactions betweens the 2th December and 8th December 2013.
331
-.PP
332
-.nf
333
-.B boobank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
334
-.fi
335
-Get transactions after the 2th December in the last 10 transactions
336
-
337
-.SH COPYRIGHT
338
-Copyright(C) 2011-2021 Romain Bignon
339
-.LP
340
-For full copyright information see the COPYING file in the woob package.
341
-.LP
342
-.RE
343
-.SH FILES
344
-"~/.config/woob/backends" 
345
-
346
-.SH SEE ALSO
347
-Home page: http://woob.tech/applications/woob-athon