woob-paste.1 8.57 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 WOOB-PASTE 1 "11 April 2021" "woob-paste 3\&.0"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
5
woob-paste \- post and get pastes from pastebins
Romain Bignon's avatar
Romain Bignon committed
6
.SH SYNOPSIS
7
8
.B woob
paste [\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
9
.br
10
11
.B woob
paste [\-\-help] [\-\-version]
Romain Bignon's avatar
Romain Bignon committed
12
13
14
15
16
17
18

.SH DESCRIPTION
.LP

Console application allowing to post and get pastes from pastebins.

.SS Supported websites:
Florent's avatar
Florent committed
19
20
* imgur (imgur image upload service)
.br
Florent's avatar
Florent committed
21
22
* jirafeau (Jirafeau\-based file upload website)
.br
Florent's avatar
Florent committed
23
* lutim (lutim website)
Florent's avatar
Florent committed
24
.br
Romain Bignon's avatar
Romain Bignon committed
25
* pastealacon (Paste à la con text sharing tool)
Romain Bignon's avatar
Romain Bignon committed
26
.br
Romain Bignon's avatar
Romain Bignon committed
27
* pastebin (Pastebin text sharing service)
Florent's avatar
Florent committed
28
29
30
.br
* pixtoilelibre (toile\-libre image hosting website)
.br
Romain Bignon's avatar
Romain Bignon committed
31
32
33
* sprunge (Sprunge text sharing tool)
.br
* zerobin (ZeroBin/0bin/PrivateBin encrypted pastebin)
34
.SH PASTE COMMANDS
Romain Bignon's avatar
Romain Bignon committed
35
.TP
Romain Bignon's avatar
Romain Bignon committed
36
37
38
39
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
40
41
42
43
\fBget\fR \fIID\fR
.br
Get a paste contents.
.TP
Florent's avatar
Florent committed
44
45
46
47
48
49
50
51
52
53
\fBget_bin\fR \fIID\fR
.br
Get a paste contents.
.br
File will be downloaded from binary services.
.TP
\fBinfo\fR \fIID\fR [\fIID\fR2 [...]]
.br
Get information about pastes.
.TP
Romain Bignon's avatar
Romain Bignon committed
54
55
56
57
58
\fBpost\fR [\fIFILENAME\fR]
.br
Submit a new paste.
.br
The filename can be '\-' for reading standard input (pipe).
Florent's avatar
Florent committed
59
60
61
62
63
64
65
66
67
68
.br
If 'bin' is passed, file will be uploaded to binary services.
.TP
\fBpost_bin\fR [\fIFILENAME\fR]
.br
Submit a new paste.
.br
The filename can be '\-' for reading standard input (pipe).
.br
File will be uploaded to binary services.
69
.SH WOOB COMMANDS
Romain Bignon's avatar
Romain Bignon committed
70
71
72
73
74
75
76
77
78
.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
79
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
80
.br
Romain Bignon's avatar
Romain Bignon committed
81
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
82
.br
Romain Bignon's avatar
Romain Bignon committed
83
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
84
.br
Romain Bignon's avatar
Romain Bignon committed
85
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
86
.br
Romain Bignon's avatar
Romain Bignon committed
87
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
88
.br
Romain Bignon's avatar
Romain Bignon committed
89
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
90
.br
Romain Bignon's avatar
Romain Bignon committed
91
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
92
.br
Romain Bignon's avatar
Romain Bignon committed
93
94
95
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
96
.TP
Romain Bignon's avatar
Romain Bignon committed
97
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
98
99
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
100
.br
Romain Bignon's avatar
Romain Bignon committed
101
102
103
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
104
105
106
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent's avatar
Florent committed
107
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
Romain Bignon's avatar
Romain Bignon committed
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
.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
165
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
166
167
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
168
169
.br
If an argument is given, list the specified path.
Florent's avatar
Florent committed
170
.br
Florent's avatar
Florent committed
171
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent's avatar
Florent committed
172
173
174
.br
return results as soon as possible.
.br
Florent's avatar
Florent committed
175
Use \-d option to display information about a collection (and to not
Florent's avatar
Florent committed
176
177
178
.br
display the content of it). It has the same behavior than the well
.br
Florent's avatar
Florent committed
179
known UNIX "ls" command.
Florent's avatar
Florent committed
180
181
182
183
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
.TP
\fBquit\fR
.br
Quit the application.
.TP
\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
211
212
213
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
214
215
216
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent's avatar
Florent committed
217
218
219
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
220
221
222
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
223

224
.SH PASTE OPTIONS
225
226
227
228
229
230
231
232
.TP
\fB\-p\fR, \fB\-\-public\fR
Make paste public.
.TP
\fB\-t TITLE\fR, \fB\-\-title=TITLE\fR
Paste title
.TP
\fB\-m MAX_AGE\fR, \fB\-\-max\-age=MAX_AGE\fR
Florent's avatar
Florent committed
233
Maximum age (duration), default "1 month", "never" for infinite
Florent's avatar
Florent committed
234
235
236
.TP
\fB\-E ENCODING\fR, \fB\-\-encoding=ENCODING\fR
Input encoding
Romain Bignon's avatar
Romain Bignon committed
237
238
239
240

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent's avatar
Florent committed
241
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
242
243
244
245
246
247
248
249
250
251
252
253
.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
254
255
256
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
Romain Bignon's avatar
Romain Bignon committed
257
258
259
260

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent's avatar
Florent committed
261
262
filter result items to display given a boolean expression. See CONDITION section
for the syntax
Romain Bignon's avatar
Romain Bignon committed
263
264
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
265
limit number of results (from each backends)
Romain Bignon's avatar
Romain Bignon committed
266
267
268
269
270
271
272
.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
273
274
select output formatter (csv, htmltable, json, json_line, multiline, simple,
table, webkit)
Romain Bignon's avatar
Romain Bignon committed
275
276
277
278
279
280
281
282
283
284
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result

Florent's avatar
Florent committed
285
.SH CONDITION
Florent's avatar
Florent committed
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.
Florent's avatar
Florent committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
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
307
308
309
310
.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
311
312
.SS Examples:
.nf
313
.B woob bank ls \-\-condition 'label=Livret A'
Florent's avatar
Florent committed
314
315
316
317
.fi
Display only the "Livret A" account.
.PP
.nf
318
.B woob bank ls \-\-condition 'balance>10000'
Florent's avatar
Florent committed
319
320
321
322
.fi
Display accounts with a lot of money.
.PP
.nf
323
.B woob bank history account@backend \-\-condition 'label|rewe'
Florent's avatar
Florent committed
324
325
326
327
.fi
Get transactions containing "rewe".
.PP
.nf
328
.B woob bank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent's avatar
Florent committed
329
330
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent's avatar
Florent committed
331
332
.PP
.nf
333
.B woob bank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
Florent's avatar
Florent committed
334
335
.fi
Get transactions after the 2th December in the last 10 transactions
Florent's avatar
Florent committed
336

Romain Bignon's avatar
Romain Bignon committed
337
.SH COPYRIGHT
338
Copyright(C) 2011-2021 Laurent Bachelier
Romain Bignon's avatar
Romain Bignon committed
339
.LP
340
For full copyright information see the COPYING file in the woob package.
Romain Bignon's avatar
Romain Bignon committed
341
342
343
.LP
.RE
.SH FILES
344
"~/.config/woob/backends" 
Romain Bignon's avatar
Romain Bignon committed
345
346

.SH SEE ALSO
347
Home page: https://woob.tech/applications/paste