monboob.1 6.03 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 MONBOOB 1 "06 January 2019" "monboob 1\&.4"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
5
monboob \- daemon to send and check messages
Romain Bignon's avatar
Romain Bignon committed
6 7
.SH SYNOPSIS
.B monboob
8
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
9 10
.br
.B monboob
11 12
[\-\-help] [\-\-version]

Romain Bignon's avatar
Romain Bignon committed
13 14 15
.SH DESCRIPTION
.LP

Romain Bignon's avatar
Romain Bignon committed
16
Daemon allowing to regularly check for new messages on various websites, and send an email for each message, and post a reply to a message on a website.
Romain Bignon's avatar
Romain Bignon committed
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
.SH MONBOOB COMMANDS
Romain Bignon's avatar
Romain Bignon committed
71
.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
\fBonce\fR
.br
Send mails only once, then exit.
.TP
Romain Bignon's avatar
Romain Bignon committed
80
\fBpost\fR
81 82 83 84 85 86
.br
Pipe with a mail to post message.
.TP
\fBrun\fR
.br
Run the fetching daemon.
Romain Bignon's avatar
Romain Bignon committed
87 88 89

.SH OPTIONS
.TP
90 91 92 93 94 95 96 97
\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
98 99 100
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
101 102 103
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
104 105 106
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
107 108 109
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
110 111 112 113 114 115 116

.SH MONBOOB OPTIONS
.TP
\fB\-S SMTPD\fR, \fB\-\-smtpd=SMTPD\fR
run a fake smtpd server and set the port

.SH LOGGING OPTIONS
Romain Bignon's avatar
Romain Bignon committed
117 118
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
119
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
120 121 122 123 124 125 126
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
127 128
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
Romain Bignon's avatar
Romain Bignon committed
129
.TP
130 131
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
Florent Fourcot's avatar
Florent Fourcot committed
132 133 134
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
135 136

.SH RESULTS OPTIONS
Romain Bignon's avatar
Romain Bignon committed
137
.TP
138
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
139 140
filter result items to display given a boolean expression. See CONDITION section
for the syntax
141 142
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
143
limit number of results (from each backends)
144 145 146 147 148 149 150
.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
151 152
select output formatter (csv, htmltable, json, json_line, multiline, simple,
table, webkit)
153 154 155 156 157 158
.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
159 160 161
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Romain Bignon's avatar
Romain Bignon committed
162

Florent Fourcot's avatar
Florent Fourcot committed
163
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
164
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
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
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
185 186 187 188
.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
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
.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
206
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
207 208
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
209 210 211 212 213
.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
214

Romain Bignon's avatar
Romain Bignon committed
215
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
216
Copyright(C) 2010-2019 Romain Bignon
Romain Bignon's avatar
Romain Bignon committed
217
.LP
Florent Fourcot's avatar
Florent Fourcot committed
218
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
219 220 221
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
222
"~/.config/weboob/backends" 
223

Romain Bignon's avatar
Romain Bignon committed
224
"~/.config/weboob/monboob"
225 226

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