]> kaliko git repositories - mpd-sima.git/blob - data/man/simadb_cli.1
dbed229f15c3d2398b800aba6fae31354c231607
[mpd-sima.git] / data / man / simadb_cli.1
1 '\" t
2 .\"     Title: simadb_cli
3 .\"    Author: Jack Kaliko <kaliko@azylum.org>
4 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5 .\"      Date: 05/03/2020
6 .\"    Manual: mpd-sima 0.15.3 User Manual
7 .\"    Source: mpd-sima
8 .\"  Language: English
9 .\"
10 .TH "SIMADB_CLI" "1" "05/03/2020" "mpd-sima" "mpd-sima 0.15.3 User Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 simadb_cli \- simadb_cli is a command line interface editor for the sima user DB\&.
32 .SH "SYNOPSIS"
33 .HP \w'\fBsimadb_cli\fR\ 'u
34 \fBsimadb_cli\fR \fB\-\-remove_artist=\fR\fIartist\fR [\fB\-\-dbfile=\fR\fIdb_file\fR] [\fB\-\-reciprocal\fR]
35 .HP \w'\fBsimadb_cli\fR\ 'u
36 \fBsimadb_cli\fR \fB\-\-purge_hist\fR [\fB\-\-dbfile=\fR\fIdb_file\fR]
37 .HP \w'\fBsimadb_cli\fR\ 'u
38 \fBsimadb_cli\fR \fB\-\-view_all\fR [\fB\-\-dbfile=\fR\fIdb_file\fR]
39 .HP \w'\fBsimadb_cli\fR\ 'u
40 \fBsimadb_cli\fR {\fB\-\-bl_curr_trk\fR | \fB\-\-bl_curr_art\fR | \fB\-\-bl_curr_alb\fR | \fB\-\-bl_art=\fR\fIartist_name\fR} [\fB\-\-dbfile=\fR\fIdb_file\fR] [\fB\-\-host=\fR\fImpd_host\fR] [\fB\-\-port=\fR\fImpd_port\fR]
41 .HP \w'\fBsimadb_cli\fR\ 'u
42 \fBsimadb_cli\fR \fB\-\-remove_bl=\fR\fIrow_id\fR [\fB\-\-dbfile=\fR\fIdb_file\fR]
43 .HP \w'\fBsimadb_cli\fR\ 'u
44 \fBsimadb_cli\fR \fB\-\-view_bl\fR [\fB\-\-dbfile=\fR\fIdb_file\fR]
45 .HP \w'\fBsimadb_cli\fR\ 'u
46 \fBsimadb_cli\fR {{\fB\-h\fR\ |\ \fB\-\-help\fR} | \fB\-\-version\fR}
47 .SH "DESCRIPTION"
48 .PP
49 This manual page documents briefly the
50 \fBsimadb_cli\fR
51 commands\&.
52 .PP
53 simadb_cli is a command line interface to get and edit users blacklist database used with MPD_sima\&. The default database file (see
54 the section called \(lqFILES\(rq) can be overridden if you want\&.
55 .SH "EXAMPLE"
56 .SS "Black list edition"
57 .PP
58 \fIAdding to black list\&.\fR
59 You can add a single track, an album or an artist to the black list\&. The element to black list is chosen from the currently playing track\&. Use
60 \fB\-\-bl_curr_trk\fR
61 to prevent simadb_cli to queue this track,
62 \fB\-\-bl_curr_alb\fR
63 or
64 \fB\-\-bl_curr_art\fR
65 respectively for the album and the artist\&.
66 .PP
67 Remember you need access to your MPD server to retrieve information to black list\&. Defaults are localhost:6600 or found in environment variables but you may set it up from command line:
68 .PP
69 \fBsimadb_cli \-\-bl_curr_art \-S mympd\&.example\&.org\fR
70 .PP
71 \fITo black list a specific artist\fR
72 (not currently playing) you can use
73 \fB\-\-bl_ar="Artist name to black list"\fR\&.
74 .SH "OPTIONS"
75 .PP
76 The program follows the usual GNU command line syntax, with long options starting with two dashes ("\-")\&. A summary of options is included below\&.
77 .PP
78 \fB\-h\fR, \fB\-\-help\fR
79 .RS 4
80 Print help and exit\&.
81 .RE
82 .PP
83 \fB\-\-version\fR
84 .RS 4
85 Print version and exit\&.
86 .RE
87 .PP
88 \fB\-\-bl_art=\fR\fB\fIartist_name\fR\fR
89 .RS 4
90 Use to black list
91 \fIartist_name\fR\&. simadb_cli is checking
92 \fIartist_name\fR
93 is actually in MPD music library (cf
94 \fB\-S\fR
95 and
96 \fB\-P\fR
97 options to set MPD host/address if necessary)\&.
98 .sp
99 If
100 \fIartist_name\fR
101 is not found the script print out a list of matching artists\&.
102 .RE
103 .PP
104 \fB\-\-bl_curr_trk\fR | \fB\-\-bl_curr_art\fR | \fB\-\-bl_curr_alb\fR
105 .RS 4
106 Use to black list the currently playing track|artist|album\&. You need access to your MPD server, use
107 \fB\-S\fR
108 and
109 \fB\-P\fR
110 to set MPD host/address if necessary\&.
111 .RE
112 .PP
113 \fB\-d \fR\fB\fIdb_file\fR\fR, \fB\-\-dbfile=\fR\fB\fIdb_file\fR\fR
114 .RS 4
115 Use the specific file
116 \fIdb_file\fR
117 as database\&.
118 .br
119 Default is too use
120 \fBXDG_DATA_HOME\fR
121 (see
122 the section called \(lqFILES\(rq)\&.
123 .RE
124 .PP
125 \fB\-\-purge_hist\fR
126 .RS 4
127 Purge history, you may supply an alternative DB file with \-\-dbfile option\&.
128 .RE
129 .PP
130 \fB\-\-remove_bl=\fR\fB\fIrow_id\fR\fR
131 .RS 4
132 Use to remove a black list entry\&. To get the row_id to suppress use
133 \fB\-\-view_bl\fR
134 option\&.
135 .RE
136 .PP
137 \fB\-\-view_bl\fR
138 .RS 4
139 Get all entries in the black list\&.
140 .RE
141 .PP
142 \fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR
143 .RS 4
144 Use the specific port number
145 \fImpd_port\fR
146 on MPD server\&. This overrides
147 \fBMPD_PORT\fR
148 environment variable\&.
149 .br
150 Default is
151 \fI6600\fR\&.
152 .RE
153 .PP
154 \fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR
155 .RS 4
156 Use the specific host
157 \fImpd_host\fR
158 as MPD server\&.
159 .br
160 \fImpd_host\fR
161 can be an
162 IP
163 or a fully qualified domain name as long as your system can resolve it\&. This overrides
164 \fBMPD_HOST\fR
165 environment variable\&.
166 .br
167 Default is
168 \fIlocalhost\fR\&.
169 .RE
170 .SH "FILES"
171 .PP
172 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
173 .RS 4
174 SQLite DB file\&. Usually
175 \fBXDG_DATA_HOME\fR
176 is set to
177 ${HOME}/\&.local/share\&.
178 .RE
179 .SH "FEEDBACK/BUGS"
180 .PP
181 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
182 \m[blue]\fB\%https://kaliko.me/contact/\fR\m[]\&.
183 .PP
184 XMPP
185 users are welcome to join the dedicated chat room at
186 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
187 .SH "SEE ALSO"
188 .PP
189 \fBmpc\fR(1),
190 \fBmpd\fR(1)
191 .PP
192 /usr/share/doc/mpd\-sima/
193 .SH "AUTHOR"
194 .PP
195 \fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
196 .RS 4
197 Wrote this man page and is currently leading MPD_sima project\&.
198 .RE
199 .SH "COPYRIGHT"
200 .br
201 Copyright \(co 2009-2020 Jack Kaliko
202 .br
203 .PP
204 This manual page was written for the Debian system (and may be used by others)\&.
205 .PP
206 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation\&.
207 .PP
208 On Debian systems, the complete text of the GNU General Public License can be found in
209 /usr/share/common\-licenses/GPL\&.
210 .sp