radioob.1 8.19 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 RADIOOB 1 "06 January 2019" "radioob 1\&.4"
4
.SH NAME
5
radioob \- search, show or listen to radio stations
6 7 8 9 10 11 12 13 14 15
.SH SYNOPSIS
.B radioob
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B radioob
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

Romain Bignon's avatar
Romain Bignon committed
16
Console application allowing to search for web radio stations, listen to them and get information like the current song.
17

Florent Fourcot's avatar
Florent Fourcot committed
18 19 20
.SS Supported websites:
* audioaddict (Internet radios powered by audioaddict.com services)
.br
Romain Bignon's avatar
Romain Bignon committed
21 22 23 24
* bandcamp (Bandcamp music website)
.br
* freeteknomusic (freeteknomusic website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
25 26 27 28 29 30 31 32 33 34 35 36 37
* ina (INA French TV video archives)
.br
* nectarine (Nectarine Demoscene Radio)
.br
* nova (Nova French radio)
.br
* ouifm (OÜI FM French radio)
.br
* radiofrance (Radios of Radio France: Inter, Info, Bleu, Culture, Musique, FIP, Le Mouv')
.br
* somafm (SomaFM web radio)
.br
* virginradio (VirginRadio french radio)
38 39
.SH RADIOOB COMMANDS
.TP
Romain Bignon's avatar
Romain Bignon committed
40 41 42 43
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Florent Fourcot's avatar
Florent Fourcot committed
44
\fBdownload\fR \fIID\fR [\fIDIRECTORY\fR]
Florent Fourcot's avatar
Florent Fourcot committed
45 46 47
.br
Download an audio file
.TP
48 49
\fBinfo\fR \fIID\fR
.br
Florent Fourcot's avatar
Florent Fourcot committed
50
Get information about a radio or an audio file.
51
.TP
Florent Fourcot's avatar
Florent Fourcot committed
52 53 54 55 56 57 58 59 60
\fBplay\fR \fIID\fR [stream\fI_\fRid]
.br
Play a radio or a audio file with a found player (optionnaly specify the wanted stream).
.TP
\fBplaylist\fR cmd [args]playlist add ID [ID2 ID3 ...]
.br
playlist remove ID [ID2 ID3 ...]
.br
playlist export [FILENAME]
Romain Bignon's avatar
Romain Bignon committed
61
.br
Florent Fourcot's avatar
Florent Fourcot committed
62
playlist display
Romain Bignon's avatar
Romain Bignon committed
63
.TP
Florent Fourcot's avatar
Florent Fourcot committed
64
\fBsearch\fR (radio|song|file|album|playlist) \fIPATTERN\fR
65
.br
Florent Fourcot's avatar
Florent Fourcot committed
66
List (radio|song|file|album|playlist) matching a PATTERN.
67 68 69
.br

.br
Florent Fourcot's avatar
Florent Fourcot committed
70
If PATTERN is not given, this command will list all the (radio|song|album|playlist).
Florent Fourcot's avatar
Florent Fourcot committed
71 72 73 74
.br

.br
Default is limited to 10 results.
75 76 77 78 79 80 81 82 83 84
.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
85
* enable         enable given backends
86
.br
Romain Bignon's avatar
Romain Bignon committed
87
* disable        disable given backends
88
.br
Romain Bignon's avatar
Romain Bignon committed
89
* only           enable given backends and disable the others
90
.br
Romain Bignon's avatar
Romain Bignon committed
91
* list           list backends
92
.br
Romain Bignon's avatar
Romain Bignon committed
93
* add            add a backend
94
.br
Romain Bignon's avatar
Romain Bignon committed
95
* register       register a new account on a website
96
.br
Romain Bignon's avatar
Romain Bignon committed
97
* edit           edit a backend
98
.br
Romain Bignon's avatar
Romain Bignon committed
99 100 101
* remove         remove a backend
.br
* list\-modules   list modules
102
.TP
Romain Bignon's avatar
Romain Bignon committed
103
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
104 105
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
106
.br
Romain Bignon's avatar
Romain Bignon committed
107 108 109
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
110
.TP
111 112
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent Fourcot's avatar
Florent Fourcot committed
113
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
.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
Romain Bignon's avatar
Romain Bignon committed
171 172
\fBls\fR
.br
Romain Bignon's avatar
Romain Bignon committed
173
List radios
Romain Bignon's avatar
Romain Bignon committed
174 175 176 177 178
.TP
\fBquit\fR
.br
Quit the application.
.TP
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
\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 Fourcot's avatar
Florent Fourcot committed
201 202 203
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
204 205 206
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
207 208 209
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
210 211 212
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
213 214 215 216

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
217
display debug messages. Set up it twice to more verbosity
218 219 220 221 222 223 224 225 226 227 228 229
.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 Fourcot's avatar
Florent Fourcot committed
230 231 232
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
233 234 235 236

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
237 238
filter result items to display given a boolean expression. See CONDITION section
for the syntax
239 240
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
241
limit number of results (from each backends)
242 243 244 245 246 247 248
.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
249 250 251
select output formatter (album_tracks_list_info, csv, htmltable, json,
json_line, multiline, playlist_tracks_list_info, radio_list, simple, song_list,
table, webkit)
252 253 254 255 256 257
.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
258 259 260
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
261

Florent Fourcot's avatar
Florent Fourcot committed
262
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
263
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
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
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
284 285 286 287
.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
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
.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
305
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
306 307
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
308 309 310 311 312
.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
313

314
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
315 316
Copyright(C) 2010-2019 Romain Bignon
Copyright(C) 2019 Pierre Maziere
317
.LP
Florent Fourcot's avatar
Florent Fourcot committed
318
For full copyright information see the COPYING file in the weboob package.
319 320 321
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
322
"~/.config/weboob/backends" 
323 324

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