Skip to content
boobmsg.1 5.96 KiB
Newer Older
Romain Bignon's avatar
Romain Bignon committed
.TH BOOBMSG 1 "28 October 2012" "boobmsg 0\&.d"
.SH NAME
boobmsg
.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)
Romain Bignon's avatar
Romain Bignon committed
* bnporc (BNP Paribas French bank website)
.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)
Romain Bignon's avatar
Romain Bignon committed
* ecrans (Écrans French news website)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* fourchan (4chan image board)
Romain Bignon's avatar
Romain Bignon committed
* hds (Histoires de Sexe French erotic novels)
Romain Bignon's avatar
Romain Bignon 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
Romain Bignon's avatar
Romain Bignon committed
* minutes20 (2 Minutes French newspaper website)
Romain Bignon's avatar
Romain Bignon committed
.br
* newsfeed (Loads RSS and Atom feeds from any website)
.br
Romain Bignon's avatar
Romain Bignon committed
* okc (OkCupid dating website)
.br
Romain Bignon's avatar
Romain Bignon committed
* orange (Orange French mobile phone provider)
Romain Bignon's avatar
Romain Bignon committed
* phpbb (phpBB forum)
.br
Romain Bignon's avatar
Romain Bignon committed
* presseurop (Presseurop website)
.br
* sfr (SFR French mobile phone provider)
Romain Bignon's avatar
Romain Bignon committed
.br
* taz (Taz newspaper website)
.SH BOOBMSG COMMANDS
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBexport_all\fR
.br
Export All threads
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBexport_thread\fR
.br
Export a thread
.TP
\fBlist\fR
.br
Display all threads.
.TP
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
If an argument is given, set the condition expression used to filter the results.
.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
\fBinspect\fR \fIBACKEND_NAME\fR
.br
Display the HTML string of the current page of the specified backend's browser.
.br

.br
If webkit_mechanize_browser Python module is installed, HTML is displayed in a WebKit GUI.
.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
Romain Bignon's avatar
Romain Bignon committed
\fBls\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.
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)

.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
display debug messages
.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

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
filter result items to display given a boolean expression
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
get a maximum number of results (all backends merged)
.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
Romain Bignon's avatar
Romain Bignon committed
select output formatter (atom, csv, htmltable, 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
Romain Bignon's avatar
Romain Bignon committed
Copyright(C) 2010-2011 Christophe Benz
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
"~/.config/weboob/backends" 
Romain Bignon's avatar
Romain Bignon committed
Home page: http://weboob.org/applications/boobmsg