woob-lyrics.1 7.92 KB
Newer Older
1
.\" -*- coding: utf-8 -*-
Florent's avatar
Florent committed
2
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
3
.TH WOOB-LYRICS 1 "11 April 2021" "woob-lyrics 3\&.0"
4
.SH NAME
5
woob-lyrics \- search and display song lyrics
6
.SH SYNOPSIS
7
8
.B woob
lyrics [\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
9
.br
10
11
.B woob
lyrics [\-\-help] [\-\-version]
12
13
14
15
16
17
18

.SH DESCRIPTION
.LP

Console application allowing to search for song lyrics on various websites.

.SS Supported websites:
Florent's avatar
Florent committed
19
20
* lyricsdotcom (Lyrics.com lyrics website)
.br
Florent's avatar
Florent committed
21
* lyricsmode (Lyricsmode.com lyrics website)
Florent's avatar
Florent committed
22
23
24
25
26
.br
* lyricsplanet (Lyricsplanet.com song lyrics website)
.br
* paroles2chansons (Paroles2chansons.com song lyrics website)
.br
27
28
29
30
31
* parolesmania (Paroles Mania lyrics website)
.br
* parolesmusique (paroles\-musique lyrics website)
.br
* parolesnet (paroles.net lyrics website)
32
.SH LYRICS COMMANDS
33
.TP
Romain Bignon's avatar
Romain Bignon committed
34
35
36
37
\fBdebug\fR
.br
Launch a debug Python shell
.TP
38
39
40
41
42
43
44
\fBget\fR \fIID\fR
.br
Display lyrics of the song.
.TP
\fBsearch\fR [artist | song] [\fIPATTERN\fR]
.br
Search lyrics by artist name or by song title.
Florent's avatar
Florent committed
45
46
47
48
.br

.br
Default is limited to 10 results.
49
.SH WOOB COMMANDS
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
.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
Florent's avatar
Florent committed
87
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
.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
Florent's avatar
Florent committed
145
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
146
147
148
149
.br
List objects in current path.
.br
If an argument is given, list the specified path.
Florent's avatar
Florent committed
150
.br
Florent's avatar
Florent committed
151
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent's avatar
Florent committed
152
153
154
.br
return results as soon as possible.
.br
Florent's avatar
Florent committed
155
Use \-d option to display information about a collection (and to not
Florent's avatar
Florent committed
156
157
158
.br
display the content of it). It has the same behavior than the well
.br
Florent's avatar
Florent committed
159
known UNIX "ls" command.
Florent's avatar
Florent committed
160
161
162
163
.br

.br
Default is limited to 40 results.
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
.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
Florent's avatar
Florent committed
197
198
199
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
200
201
202
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
203
204
205
206

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent's avatar
Florent committed
207
display debug messages. Set up it twice to more verbosity
208
209
210
211
212
213
214
215
216
217
218
219
.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's avatar
Florent committed
220
221
222
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
223
224
225
226

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent's avatar
Florent committed
227
228
filter result items to display given a boolean expression. See CONDITION section
for the syntax
229
230
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
231
limit number of results (from each backends)
232
233
234
235
236
237
238
.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's avatar
Florent committed
239
240
select output formatter (csv, htmltable, json, json_line, lyrics_get,
lyrics_list, multiline, simple, table, webkit)
241
242
243
244
245
246
247
248
249
250
.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

Florent's avatar
Florent committed
251
.SH CONDITION
Florent's avatar
Florent committed
252
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's avatar
Florent committed
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
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's avatar
Florent committed
273
274
275
276
.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's avatar
Florent committed
277
278
.SS Examples:
.nf
279
.B woob bank ls \-\-condition 'label=Livret A'
Florent's avatar
Florent committed
280
281
282
283
.fi
Display only the "Livret A" account.
.PP
.nf
284
.B woob bank ls \-\-condition 'balance>10000'
Florent's avatar
Florent committed
285
286
287
288
.fi
Display accounts with a lot of money.
.PP
.nf
289
.B woob bank history account@backend \-\-condition 'label|rewe'
Florent's avatar
Florent committed
290
291
292
293
.fi
Get transactions containing "rewe".
.PP
.nf
294
.B woob bank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent's avatar
Florent committed
295
296
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent's avatar
Florent committed
297
298
.PP
.nf
299
.B woob bank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
Florent's avatar
Florent committed
300
301
.fi
Get transactions after the 2th December in the last 10 transactions
Florent's avatar
Florent committed
302

303
.SH COPYRIGHT
304
Copyright(C) 2013-2021 Julien Veyssier
305
.LP
306
For full copyright information see the COPYING file in the woob package.
307
308
309
.LP
.RE
.SH FILES
310
"~/.config/woob/backends" 
311
312

.SH SEE ALSO
313
Home page: https://woob.tech/applications/lyrics