Weboob 0.h released

man/boobmsg.1

@@ -1,5 +1,5 @@
 .\" -*- coding: utf-8 -*-
-.TH BOOBMSG 1 "03 August 2013" "boobmsg 0\&.g"
+.TH BOOBMSG 1 "08 January 2014" "boobmsg 0\&.h"
 .SH NAME
 boobmsg \- send and receive message threads
 .SH SYNOPSIS
@@ -17,24 +17,24 @@ Console application allowing to send messages on various websites and to display
 .SS Supported websites:
 * aum ("Adopte un Mec" French dating website)
 .br
-* bnporc (BNP Paribas French bank website)
+* bnporc (BNP Paribas)
 .br
 * bouygues (Bouygues Télécom French mobile phone provider)
 .br
 * dlfp (Da Linux French Page news website)
 .br
-* ecrans (Écrans French news website)
-.br
 * fourchan (4chan image board)
 .br
 * hds (Histoires de Sexe French erotic novels)
 .br
-* hellobank (Hello Bank ! website)
+* hellobank (Hello Bank!)
 .br
 * inrocks (Les Inrocks French news website)
 .br
 * lefigaro (Le Figaro French newspaper website)
 .br
+* liberation (Libération newspaper website)
+.br
 * minutes20 (2 Minutes French newspaper website)
 .br
 * newsfeed (Loads RSS and Atom feeds from any website)
@@ -43,6 +43,8 @@ Console application allowing to send messages on various websites and to display
 .br
 * orange (Orange French mobile phone provider)
 .br
+* ovs (OnVaSortir website. Handles private messages only)
+.br
 * phpbb (phpBB forum)
 .br
 * presseurop (Presseurop website)
@@ -131,7 +133,7 @@ Follow a path.
 .TP
 \fBcondition\fR [\fIEXPRESSION\fR | off]
 .br
-If an argument is given, set the condition expression used to filter the results.
+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
@@ -197,11 +199,17 @@ Availables: debug, info, warning, error.
 .br
 * default is an alias for warning
 .TP
-\fBls\fR [\-d] [\fIPATH\fR]
+\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
 .br
 List objects in current path.
 .br
 If an argument is given, list the specified path.
+.br
+Use \-U option to not sort results.
+.br
+
+.br
+Default is limited to 40 results.
 .TP
 \fBquit\fR
 .br
@@ -264,7 +272,8 @@ save every response
 .SH RESULTS OPTIONS
 .TP
 \fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-filter result items to display given a boolean expression
+filter result items to display given a boolean expression. See CONDITION section
+for the syntax
 .TP
 \fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
 limit number of results (from each backends)
@@ -287,6 +296,51 @@ do not display item keys
 \fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
 file to export result
 
+.SH CONDITION
+The -c and --condition is a flexible way to sort and get only interesting results. It supports conditions on numerical values, dates, and strings. Dates are given in YYYY-MM-DD format.
+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
+You can make a expression combinations with the keywords \fB" AND "\fR and \fB" OR "\fR.
+
+.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
+.B boobank history account@backend \-\-condition 'date>2013-12-01 AND date<2013-12-09'
+.fi
+Get transactions betweens the 2th December and 8th December 2013.
+
 .SH COPYRIGHT
 Copyright(C) 2010-2011 Christophe Benz
 .LP