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

.SH DESCRIPTION
.LP

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

.SS Supported websites:
Romain Bignon's avatar
Romain Bignon committed
19
* aum ("Adopte un Mec" French dating website)
20
.br
Florent Fourcot's avatar
Florent Fourcot committed
21 22
* blogspot (Blog reader for blogspot. Read\-only and without comments.)
.br
Florent Fourcot's avatar
Florent Fourcot committed
23
* bnporc (BNP Paribas)
Romain Bignon's avatar
Romain Bignon committed
24
.br
Romain Bignon's avatar
Romain Bignon committed
25
* bouygues (Bouygues Télécom French mobile phone provider)
26
.br
Romain Bignon's avatar
Romain Bignon committed
27
* dlfp (Da Linux French Page news website)
28
.br
Florent Fourcot's avatar
Florent Fourcot committed
29 30
* feedly (handle the popular RSS reading service Feedly)
.br
Florent Fourcot's avatar
Florent Fourcot committed
31
* freemobile (Free Mobile website)
Florent Fourcot's avatar
Florent Fourcot committed
32
.br
Florent Fourcot's avatar
Florent Fourcot committed
33
* guerrillamail (GuerrillaMail temp mailbox)
Romain Bignon's avatar
Romain Bignon committed
34
.br
Romain Bignon's avatar
Romain Bignon committed
35 36
* happn (Happn dating mobile application)
.br
Florent Fourcot's avatar
Florent Fourcot committed
37
* hds (Histoires de Sexe French erotic novels)
Florent Fourcot's avatar
Florent Fourcot committed
38
.br
Romain Bignon's avatar
Romain Bignon committed
39
* inrocks (Les Inrocks French news website)
Romain Bignon's avatar
Romain Bignon committed
40
.br
Romain Bignon's avatar
Romain Bignon committed
41
* lefigaro (Le Figaro French newspaper website)
Romain Bignon's avatar
Romain Bignon committed
42
.br
Florent Fourcot's avatar
Florent Fourcot committed
43 44
* liberation (Libération newspaper website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
45 46
* mailinator (mailinator temp mailbox)
.br
Florent Fourcot's avatar
Florent Fourcot committed
47
* minutes20 (20 Minutes French newspaper website)
Romain Bignon's avatar
Romain Bignon committed
48
.br
49 50
* newsfeed (Loads RSS and Atom feeds from any website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
51
* okc (OkCupid)
Romain Bignon's avatar
Romain Bignon committed
52
.br
Florent Fourcot's avatar
Florent Fourcot committed
53 54
* openedx (Discussions on OpenEDX\-powered coursewares)
.br
Romain Bignon's avatar
Romain Bignon committed
55 56
* phpbb (phpBB forum)
.br
Florent Fourcot's avatar
Florent Fourcot committed
57 58
* playme (PlayMe dating mobile application)
.br
Romain Bignon's avatar
Romain Bignon committed
59 60
* presseurop (Presseurop website)
.br
Romain Bignon's avatar
Romain Bignon committed
61
* reddit (reddit website)
Romain Bignon's avatar
Romain Bignon committed
62
.br
Florent Fourcot's avatar
Florent Fourcot committed
63 64
* tapatalk (Tapatalk\-compatible sites)
.br
Romain Bignon's avatar
Romain Bignon committed
65
* taz (Taz newspaper website)
Florent Fourcot's avatar
Florent Fourcot committed
66 67
.br
* tinder (Tinder dating mobile application)
Florent Fourcot's avatar
Florent Fourcot committed
68 69
.br
* twitter (twitter website)
70 71
.SH BOOBMSG COMMANDS
.TP
Romain Bignon's avatar
Romain Bignon committed
72 73 74 75
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
76 77 78 79
\fBexport_all\fR
.br
Export All threads
.TP
Florent Fourcot's avatar
Florent Fourcot committed
80
\fBexport_thread\fR \fIID\fR
Romain Bignon's avatar
Romain Bignon committed
81
.br
Florent Fourcot's avatar
Florent Fourcot committed
82
Export the thread identified by ID
Romain Bignon's avatar
Romain Bignon committed
83
.TP
84 85 86
\fBlist\fR
.br
Display all threads.
Florent Fourcot's avatar
Florent Fourcot committed
87 88 89 90
.br

.br
Default is limited to 10 results.
91
.TP
Romain Bignon's avatar
Romain Bignon committed
92 93 94 95
\fBphotos\fR \fIID\fR
.br
Display photos of a profile
.TP
96 97 98 99 100 101 102 103 104 105
\fBpost\fR \fIRECEIVER\fR@\fIBACKEND\fR[,\fIRECEIVER\fR@\fIBACKEND\fR[...]] [\fITEXT\fR]
.br
Post a message to the specified receivers.
.br
Multiple receivers are separated by a comma.
.br

.br
If no text is supplied on command line, the content of message is read on stdin.
.TP
Romain Bignon's avatar
Romain Bignon committed
106 107 108 109
\fBprofile\fR \fIID\fR
.br
Display a profile
.TP
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
\fBshow\fR \fIMESSAGE\fR
.br
Read a message
.TP
\fBstatus\fR
.br
Display status information about a backend.
.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
127
* enable         enable given backends
128
.br
Romain Bignon's avatar
Romain Bignon committed
129
* disable        disable given backends
130
.br
Romain Bignon's avatar
Romain Bignon committed
131
* only           enable given backends and disable the others
132
.br
Romain Bignon's avatar
Romain Bignon committed
133
* list           list backends
134
.br
Romain Bignon's avatar
Romain Bignon committed
135
* add            add a backend
136
.br
Romain Bignon's avatar
Romain Bignon committed
137
* register       register a new account on a website
138
.br
Romain Bignon's avatar
Romain Bignon committed
139
* edit           edit a backend
140
.br
Romain Bignon's avatar
Romain Bignon committed
141 142 143
* remove         remove a backend
.br
* list\-modules   list modules
144
.TP
Romain Bignon's avatar
Romain Bignon committed
145
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
146 147
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
148
.br
Romain Bignon's avatar
Romain Bignon committed
149 150 151
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
152
.TP
153 154
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent Fourcot's avatar
Florent Fourcot committed
155
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 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 211 212
.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 Fourcot's avatar
Florent Fourcot committed
213
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
214 215
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
216 217
.br
If an argument is given, list the specified path.
Florent Fourcot's avatar
Florent Fourcot committed
218
.br
Florent Fourcot's avatar
Florent Fourcot committed
219
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
220 221 222
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
223
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
224 225 226
.br
display the content of it). It has the same behavior than the well
.br
Florent Fourcot's avatar
Florent Fourcot committed
227
known UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
228 229 230 231
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
232 233 234 235 236
.TP
\fBquit\fR
.br
Quit the application.
.TP
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
\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 Fourcot's avatar
Florent Fourcot committed
259 260 261
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
262 263 264
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
265 266 267
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
268 269 270
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
271 272 273

.SH BOOBMSG OPTIONS
.TP
Romain Bignon's avatar
Romain Bignon committed
274 275
\fB\-E\fR, \fB\-\-accept\-empty\fR
Send messages with an empty body.
Romain Bignon's avatar
Romain Bignon committed
276 277 278
.TP
\fB\-t TITLE\fR, \fB\-\-title=TITLE\fR
For the "post" command, set a title to message
279 280 281 282

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
283
display debug messages. Set up it twice to more verbosity
284 285 286 287 288 289 290 291 292 293 294 295
.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 Fourcot's avatar
Florent Fourcot committed
296 297 298
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
299 300 301 302

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
303 304
filter result items to display given a boolean expression. See CONDITION section
for the syntax
305 306
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
307
limit number of results (from each backends)
308 309 310 311 312 313 314
.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 Fourcot's avatar
Florent Fourcot committed
315 316
select output formatter (atom, csv, htmltable, json, json_line, msg, msglist,
multiline, profile, simple, table, webkit, xhtml)
317 318 319 320 321 322
.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
323 324 325
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
326

Florent Fourcot's avatar
Florent Fourcot committed
327
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
328
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 Fourcot's avatar
Florent Fourcot committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
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 Fourcot's avatar
Florent Fourcot committed
349 350 351 352
.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 Fourcot's avatar
Florent Fourcot committed
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
.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 Fourcot's avatar
Florent Fourcot committed
370
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
371 372
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
373 374 375 376 377
.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 Fourcot's avatar
Florent Fourcot committed
378

379
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
380
Copyright(C) 2010-2019 Christophe Benz
381
.LP
Florent Fourcot's avatar
Florent Fourcot committed
382
For full copyright information see the COPYING file in the weboob package.
383 384 385
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
386
"~/.config/weboob/backends" 
387 388

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