Weboob 0.h released
This commit is contained in:
Florent
parent
c045c34379
commit
0414bed4de
42 changed files with 3146 additions and 195 deletions
291
man/boobsize.1
Normal file
291
man/boobsize.1
Normal file
|
|
@ -0,0 +1,291 @@
|
|||
.\" -*- coding: utf-8 -*-
|
||||
.TH BOOBSIZE 1 "08 January 2014" "boobsize 0\&.h"
|
||||
.SH NAME
|
||||
boobsize \- display sensors and gauges values
|
||||
.SH SYNOPSIS
|
||||
.B boobsize
|
||||
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
|
||||
.br
|
||||
.B boobsize
|
||||
[\-\-help] [\-\-version]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.LP
|
||||
|
||||
Console application allowing to display various sensors and gauges values.
|
||||
|
||||
.SS Supported websites:
|
||||
* dresdenwetter (Private wetter station Dresden)
|
||||
.br
|
||||
* jcvelaux (City bike renting availability information.
|
||||
Cities: Paris, Rouen, Toulouse, Luxembourg, Valence, Stockholm, Goteborg, Santander, Amiens, Lillestrom, Mulhouse, Lyon, Ljubljana, Seville, Namur, Nancy, Creteil, Bruxelles\-Capitale, Cergy\-Pontoise, Vilnius, Toyama, Kazan, Marseille, Nantes, Besancon)
|
||||
.br
|
||||
* sachsen (Level of Sachsen river)
|
||||
.br
|
||||
* vlille (access to vlille datas)
|
||||
.SH BOOBSIZE COMMANDS
|
||||
.TP
|
||||
\fBdetails\fR \fIGAUGE_ID\fR
|
||||
.br
|
||||
Display details of all sensors of the gauge.
|
||||
.TP
|
||||
\fBhistory\fR \fISENSOR_ID\fR
|
||||
.br
|
||||
Get history of a specific sensor (use 'search' to find a gauge, and sensors GAUGE_ID to list sensors attached to the gauge).
|
||||
.TP
|
||||
\fBlast_sensor_measure\fR \fISENSOR_ID\fR
|
||||
.br
|
||||
Get last measure of a sensor.
|
||||
.TP
|
||||
\fBsearch\fR [\fIPATTERN\fR]
|
||||
.br
|
||||
Display all gauges. If PATTERN is specified, search on a pattern.
|
||||
.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
|
||||
* enable enable given backends
|
||||
.br
|
||||
* disable disable given backends
|
||||
.br
|
||||
* only enable given backends and disable the others
|
||||
.br
|
||||
* list list backends
|
||||
.br
|
||||
* add add a backend
|
||||
.br
|
||||
* register register a new account on a website
|
||||
.br
|
||||
* edit edit a backend
|
||||
.br
|
||||
* remove remove a backend
|
||||
.br
|
||||
* list\-modules list modules
|
||||
.TP
|
||||
\fBcd\fR [\fIPATH\fR]
|
||||
.br
|
||||
Follow a path.
|
||||
.br
|
||||
".." is a special case and goes up one directory.
|
||||
.br
|
||||
"" is a special case and goes home.
|
||||
.TP
|
||||
\fBcondition\fR [\fIEXPRESSION\fR | off]
|
||||
.br
|
||||
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
|
||||
\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
|
||||
\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
|
||||
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)
|
||||
.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
|
||||
|
||||
.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. See CONDITION section
|
||||
for the syntax
|
||||
.TP
|
||||
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
|
||||
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
|
||||
select output formatter (csv, gauge_list, htmltable, json, multiline, simple,
|
||||
table, webkit)
|
||||
.TP
|
||||
\fB\-\-no\-header\fR
|
||||
do not display header
|
||||
.TP
|
||||
\fB\-\-no\-keys\fR
|
||||
do not display item keys
|
||||
.TP
|
||||
\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) 2013 Florent Fourcot
|
||||
.LP
|
||||
For full COPYRIGHT see COPYING file with weboob package.
|
||||
.LP
|
||||
.RE
|
||||
.SH FILES
|
||||
"~/.config/weboob/backends"
|
||||
|
||||
.SH SEE ALSO
|
||||
Home page: http://weboob.org/applications/Boobsize
|
||||
Loading…
Add table
Add a link
Reference in a new issue