Skip to content
boobmsg.1 9.42 KiB
Newer Older
.\" -*- coding: utf-8 -*-
Florent's avatar
Florent committed
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
.TH BOOBMSG 1 "06 January 2019" "boobmsg 1\&.4"
.SH NAME
boobmsg \- send and receive message threads
.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
Console application allowing to send messages on various websites and to display message threads and contents.

.SS Supported websites:
Romain Bignon's avatar
Romain Bignon committed
* aum ("Adopte un Mec" French dating website)
Florent's avatar
Florent committed
* blogspot (Blog reader for blogspot. Read\-only and without comments.)
.br
Florent's avatar
Florent committed
* bnporc (BNP Paribas)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* bouygues (Bouygues Télécom French mobile phone provider)
Romain Bignon's avatar
Romain Bignon committed
* dlfp (Da Linux French Page news website)
Florent's avatar
Florent committed
* feedly (handle the popular RSS reading service Feedly)
.br
Florent's avatar
Florent committed
* freemobile (Free Mobile website)
Florent's avatar
Florent committed
.br
Florent's avatar
Florent committed
* guerrillamail (GuerrillaMail temp mailbox)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* happn (Happn dating mobile application)
.br
Florent's avatar
Florent committed
* hds (Histoires de Sexe French erotic novels)
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
* inrocks (Les Inrocks French news website)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* lefigaro (Le Figaro French newspaper website)
Romain Bignon's avatar
Romain Bignon committed
.br
Florent's avatar
Florent committed
* liberation (Libération newspaper website)
.br
Florent's avatar
Florent committed
* mailinator (mailinator temp mailbox)
.br
Florent's avatar
Florent committed
* minutes20 (20 Minutes French newspaper website)
Romain Bignon's avatar
Romain Bignon committed
.br
* newsfeed (Loads RSS and Atom feeds from any website)
.br
Florent's avatar
Florent committed
* okc (OkCupid)
Romain Bignon's avatar
Romain Bignon committed
.br
Florent's avatar
Florent committed
* openedx (Discussions on OpenEDX\-powered coursewares)
.br
Romain Bignon's avatar
Romain Bignon committed
* phpbb (phpBB forum)
.br
Florent's avatar
Florent committed
* playme (PlayMe dating mobile application)
.br
Romain Bignon's avatar
Romain Bignon committed
* presseurop (Presseurop website)
.br
Romain Bignon's avatar
Romain Bignon committed
* reddit (reddit website)
Romain Bignon's avatar
Romain Bignon committed
.br
Florent's avatar
Florent committed
* tapatalk (Tapatalk\-compatible sites)
.br
Romain Bignon's avatar
Romain Bignon committed
* taz (Taz newspaper website)
Florent's avatar
Florent committed
.br
* tinder (Tinder dating mobile application)
Florent's avatar
Florent committed
.br
* twitter (twitter website)
.SH BOOBMSG COMMANDS
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBexport_all\fR
.br
Export All threads
.TP
Florent's avatar
Florent committed
\fBexport_thread\fR \fIID\fR
Romain Bignon's avatar
Romain Bignon committed
.br
Florent's avatar
Florent committed
Export the thread identified by ID
Romain Bignon's avatar
Romain Bignon committed
.TP
\fBlist\fR
.br
Display all threads.
Florent's avatar
Florent committed
.br

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
\fBphotos\fR \fIID\fR
.br
Display photos of a profile
.TP
\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
\fBprofile\fR \fIID\fR
.br
Display a profile
.TP
\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
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent's avatar
Florent committed
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
.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
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
.br
If an argument is given, list the specified path.
Florent's avatar
Florent committed
.br
Florent's avatar
Florent committed
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent's avatar
Florent committed
.br
return results as soon as possible.
.br
Florent's avatar
Florent committed
Use \-d option to display information about a collection (and to not
Florent's avatar
Florent committed
.br
display the content of it). It has the same behavior than the well
.br
Florent's avatar
Florent committed
known UNIX "ls" command.
Florent's avatar
Florent committed
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
.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
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent's avatar
Florent committed
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered

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

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent's avatar
Florent committed
display debug messages. Set up it twice to more verbosity
.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
.TP
\fB\-\-export\-session\fR
log browser session cookies after login

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent's avatar
Florent committed
filter result items to display given a boolean expression. See CONDITION section
for the syntax
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
limit number of results (from each backends)
.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
select output formatter (atom, csv, htmltable, json, json_line, msg, msglist,
multiline, profile, simple, table, webkit, xhtml)
.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
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Florent's avatar
Florent committed
.SH CONDITION
Florent's avatar
Florent committed
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
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
.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
.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
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent's avatar
Florent committed
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent's avatar
Florent committed
.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

.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
Copyright(C) 2010-2019 Christophe Benz
Florent's avatar
Florent committed
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
"~/.config/weboob/backends" 
Romain Bignon's avatar
Romain Bignon committed
Home page: http://weboob.org/applications/boobmsg