webcontentedit.1 7.77 KB
Newer Older
1
.\" -*- coding: utf-8 -*-
Florent's avatar
Florent committed
2
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
3
.TH WEBCONTENTEDIT 1 "27 February 2019" "webcontentedit 1\&.5"
4
.SH NAME
5
webcontentedit \- manage websites content
6
7
8
9
10
11
12
13
14
15
.SH SYNOPSIS
.B webcontentedit
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B webcontentedit
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

Romain Bignon's avatar
Romain Bignon committed
16
Console application allowing to display and edit contents on various websites.
17
18

.SS Supported websites:
Romain Bignon's avatar
Romain Bignon committed
19
* dlfp (Da Linux French Page news website)
Romain Bignon's avatar
Romain Bignon committed
20
.br
Romain Bignon's avatar
Romain Bignon committed
21
* mediawiki (Wikis running MediaWiki, like Wikipedia)
Romain Bignon's avatar
Romain Bignon committed
22
.br
23
24
25
* redmine (The Redmine project management web application)
.SH WEBCONTENTEDIT COMMANDS
.TP
Romain Bignon's avatar
Romain Bignon committed
26
27
28
29
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
30
\fBedit\fR \fIID\fR [\fIID\fR...]
31
32
.br
Edit a content with $EDITOR, then push it on the website.
Romain Bignon's avatar
Romain Bignon committed
33
.TP
Florent's avatar
Florent committed
34
\fBget\fR \fIID\fR [\-r revision]
Florent's avatar
Florent committed
35
36
37
.br
Get page contents
.TP
Romain Bignon's avatar
Romain Bignon committed
38
39
40
\fBlog\fR \fIID\fR
.br
Display log of a page
Florent's avatar
Florent committed
41
42
43
44
.br

.br
Default is limited to 10 results.
45
46
47
48
49
50
51
52
53
54
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br

.br
ACTION is one of the following (default: list):
.br
Romain Bignon's avatar
Romain Bignon committed
55
* enable         enable given backends
56
.br
Romain Bignon's avatar
Romain Bignon committed
57
* disable        disable given backends
58
.br
Romain Bignon's avatar
Romain Bignon committed
59
* only           enable given backends and disable the others
60
.br
Romain Bignon's avatar
Romain Bignon committed
61
* list           list backends
62
.br
Romain Bignon's avatar
Romain Bignon committed
63
* add            add a backend
64
.br
Romain Bignon's avatar
Romain Bignon committed
65
* register       register a new account on a website
66
.br
Romain Bignon's avatar
Romain Bignon committed
67
* edit           edit a backend
68
.br
Romain Bignon's avatar
Romain Bignon committed
69
70
71
* remove         remove a backend
.br
* list\-modules   list modules
72
.TP
Romain Bignon's avatar
Romain Bignon committed
73
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
74
75
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
76
.br
Romain Bignon's avatar
Romain Bignon committed
77
78
79
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
80
.TP
81
82
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent's avatar
Florent committed
83
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
.br
If the "off" value is given, conditional filtering is disabled.
.br

.br
If no argument is given, print the current condition expression.
.TP
\fBcount\fR [\fINUMBER\fR | off]
.br
If an argument is given, set the maximum number of results fetched.
.br
NUMBER must be at least 1.
.br
"off" value disables counting, and allows infinite searches.
.br

.br
If no argument is given, print the current count value.
.TP
\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
.br
If a FORMATTER is given, set the formatter to use.
.br
You can add a COMMAND to apply the formatter change only to
.br
a given command.
.br

.br
If the argument is "list", print the available formatters.
.br

.br
If the argument is "option", set the formatter options.
.br
Valid options are: header, keys.
.br
If on/off value is given, set the value of the option.
.br
If not, print the current value for the option.
.br

.br
If no argument is given, print the current formatter.
.TP
\fBlogging\fR [\fILEVEL\fR]
.br
Set logging level.
.br

.br
Availables: debug, info, warning, error.
.br
* quiet is an alias for error
.br
* default is an alias for warning
.TP
Florent's avatar
Florent committed
141
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
142
143
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
144
145
.br
If an argument is given, list the specified path.
Florent's avatar
Florent committed
146
.br
Florent's avatar
Florent committed
147
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent's avatar
Florent committed
148
149
150
.br
return results as soon as possible.
.br
Florent's avatar
Florent committed
151
Use \-d option to display information about a collection (and to not
Florent's avatar
Florent committed
152
153
154
.br
display the content of it). It has the same behavior than the well
.br
Florent's avatar
Florent committed
155
known UNIX "ls" command.
Florent's avatar
Florent committed
156
157
158
159
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
160
161
162
163
164
.TP
\fBquit\fR
.br
Quit the application.
.TP
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
\fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full"
.br
If an argument is given, set the selected fields.
.br
$direct selects all fields loaded in one http request.
.br
$full selects all fields using as much http requests as necessary.
.br

.br
If no argument is given, print the currently selected fields.

.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
what backend(s) to enable (comma separated)
Florent's avatar
Florent committed
187
188
189
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
190
191
192
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent's avatar
Florent committed
193
194
195
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
196
197
198
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
199
200
201
202

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent's avatar
Florent committed
203
display debug messages. Set up it twice to more verbosity
204
205
206
207
208
209
210
211
212
213
214
215
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
Florent's avatar
Florent committed
216
217
218
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
219
220
221
222

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent's avatar
Florent committed
223
224
filter result items to display given a boolean expression. See CONDITION section
for the syntax
225
226
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
227
limit number of results (from each backends)
228
229
230
231
232
233
234
.TP
\fB\-s SELECT\fR, \fB\-\-select=SELECT\fR
select result item keys to display (comma separated)

.SH FORMATTING OPTIONS
.TP
\fB\-f FORMATTER\fR, \fB\-\-formatter=FORMATTER\fR
Florent's avatar
Florent committed
235
236
select output formatter (csv, htmltable, json, json_line, multiline, simple,
table, webkit)
237
238
239
240
241
242
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
Romain Bignon's avatar
Romain Bignon committed
243
244
245
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
246

Florent's avatar
Florent committed
247
.SH CONDITION
Florent's avatar
Florent committed
248
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.
Florent's avatar
Florent committed
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
The syntax of one expression is "\fBfield operator value\fR". The field to test is always the left member of the expression.
.LP
The field is a member of the objects returned by the command. For example, a bank account has "balance", "coming" or "label" fields.
.SS The following operators are supported:
.TP
=
Test if object.field is equal to the value.
.TP
!=
Test if object.field is not equal to the value.
.TP
>
Test if object.field is greater than the value. If object.field is date, return true if value is before that object.field.
.TP
<
Test if object.field is less than the value. If object.field is date, return true if value is after that object.field.
.TP
|
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.
.SS Expression combination
Florent's avatar
Florent committed
269
270
271
272
.LP
You can make a expression combinations with the keywords \fB" AND "\fR, \fB" OR "\fR an \fB" LIMIT "\fR.
.LP
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.
Florent's avatar
Florent committed
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
.SS Examples:
.nf
.B boobank ls \-\-condition 'label=Livret A'
.fi
Display only the "Livret A" account.
.PP
.nf
.B boobank ls \-\-condition 'balance>10000'
.fi
Display accounts with a lot of money.
.PP
.nf
.B boobank history account@backend \-\-condition 'label|rewe'
.fi
Get transactions containing "rewe".
.PP
.nf
Florent's avatar
Florent committed
290
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent's avatar
Florent committed
291
292
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent's avatar
Florent committed
293
294
295
296
297
.PP
.nf
.B boobank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
.fi
Get transactions after the 2th December in the last 10 transactions
Florent's avatar
Florent committed
298

299
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
300
Copyright(C) 2010-2019 Romain Bignon
301
.LP
Florent's avatar
Florent committed
302
For full copyright information see the COPYING file in the weboob package.
303
304
305
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
306
"~/.config/weboob/backends" 
307
308

.SH SEE ALSO
Romain Bignon's avatar
Romain Bignon committed
309
Home page: http://weboob.org/applications/webcontentedit