X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd-sima.1;fp=data%2Fman%2Fmpd-sima.1;h=0000000000000000000000000000000000000000;hb=dd2a18ade8d2cdbd3111c4eb01cf95f4a631f8a7;hp=8e1b63d994336e3091a5f35bf4d7550e2711918a;hpb=6288b079e5de8e9ee5482e8009111b6ba3cba93a;p=mpd-sima.git diff --git a/data/man/mpd-sima.1 b/data/man/mpd-sima.1 deleted file mode 100644 index 8e1b63d..0000000 --- a/data/man/mpd-sima.1 +++ /dev/null @@ -1,389 +0,0 @@ -'\" t -.\" Title: mpd-sima -.\" Author: kaliko -.\" Generator: DocBook XSL Stylesheets v1.79.2 -.\" Date: 11/16/2021 -.\" Manual: mpd-sima 0.18.0 User Manual -.\" Source: mpd-sima -.\" Language: English -.\" -.TH "MPD\-SIMA" "1" "11/16/2021" "mpd-sima" "mpd-sima 0.18.0 User Manual" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -mpd-sima \- mpd\-sima will try to maintain some titles ahead in the queue following different policies\&. -.SH "SYNOPSIS" -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR [\fB\-\-daemon\fR] [\fB\-\-config=\fR\fIconf_file\fR] [\fB\-\-var\-dir=\fR\fIvar_directory\fR] [\fB\-\-pid=\fR\fIpid_file\fR] [\fB\-\-log=\fR\fIlog_file\fR] [\fB\-\-log\-level=\fR\fIlog_level\fR] [\fB\-\-host=\fR\fImpd_host\fR] [\fB\-\-mpd_port=\fR\fImpd_port\fR] -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR {{\fB\-h\fR\ |\ \fB\-\-help\fR}\ \fB\-\-version\fR} -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR config\-test [\fB\-\-config=\fR\fIconf_file\fR] -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR create\-db [\fB\-\-var\-dir=\fR\fIvar_directory\fR] -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR generate\-config [\fB\&...\fR] -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR purge\-history [\fB\-\-var\-dir=\fR\fIvar_directory\fR] -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR bl\-view -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR bl\-add\-artist [\fBartist\fR] -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR bl\-add\-album [\fBalbum\fR] -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR bl\-add\-track [\fBtrack\fR] -.HP \w'\fBmpd\-sima\fR\ 'u -\fBmpd\-sima\fR bl\-delete \fBid\fR -.SH "DESCRIPTION" -.PP -This manual page documents briefly the -\fBmpd\-sima\fR -commands\&. -.PP -At start up default configuration is first overridden by user configuration in mpd_sima\&.cfg (see -the section called \(lqFILES\(rq) and finally command lines options are honored\&. For instance you can override default MPD host (localhost) in your configuration file or with -\fB\-S\ \&my_mpd_server\fR -option\&. For default configuration see -the section called \(lqCONFIGURATION\(rq\&. See also environment variables special case for MPD host and port in -the section called \(lqENVIRONMENT\(rq\&. -.SH "EXAMPLE" -.SS "Launch as a system service (d\(aemon)\&." -.PP -Here follows an example on how to launch mpd\-sima as a service on your system, not attach to regular user configuration/database\&. -.PP -\fBmpd\-sima \-\-daemon \-\-conf=/etc/mpd_sima\&.cfg \-\-var\-dir=/var/cache/mpd\-sima/ \-\-pid=/run/mpd\-sima\&.pid \-\-log=/var/log/mpd\-sima\&.log\fR -.SS "Launch in user land" -.PP -Launching mpd\-sima from/whithin your user account is easy, you can simply call -\fBmpd\-sima\fR -from your shell or one of the following command: -.PP -Background execution (d\(aemonise), log in the specified file, save pid: -.PP -\fBmpd\-sima \-\-daemon \-\-pid=$HOME/var/run/mpd\-sima\&.pid \-\-log=$HOME/var/log/mpd\-sima\&.log\fR -.PP -Foreground execution, connect -\fImy\&.mpd\&.server\&.org\fR, log to std(out|err): -.PP -\fBmpd\-sima \-\-host=my\&.mpd\&.server\&.org\fR -.SH "OPTIONS" -.PP -The program follows the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&. -.PP -\fB\-h\fR, \fB\-\-help\fR -.RS 4 -Print help and exit\&. -.RE -.PP -\fB\-\-version\fR -.RS 4 -Print version and exit\&. -.RE -.PP -\fB\-\-daemon\fR -.RS 4 -Start as a daemon\&. Log redirected to /dev/null, usually setting -\fB\-\-log\fR -and -\fB\-\-pid\fR -options in daemon mode are a good idea to monitor/stop the process\&. -.RE -.PP -\fB\-p \fR\fB\fIpid_file\fR\fR, \fB\-\-pid=\fR\fB\fIpid_file\fR\fR -.RS 4 -Use the specific file -\fIpid_file\fR -to store pid to\&. -.br -Default is not to store pid info\&. -.RE -.PP -\fB\-l \fR\fB\fIlog_file\fR\fR, \fB\-\-log=\fR\fB\fIlog_file\fR\fR -.RS 4 -Use the specific file -\fIlog_file\fR -to log messages to\&. -.br -Default is to log to stdout/stderr\&. -.RE -.PP -\fB\-v \fR\fB\fIlog_level\fR\fR, \fB\-\-log\-level=\fR\fB\fIlog_level\fR\fR -.RS 4 -Verbosity in [debug,info,warning,error]\&. -.br -Default is to log info messages\&. -.RE -.PP -\fB\-c \fR\fB\fIconf_file\fR\fR, \fB\-\-config=\fR\fB\fIconf_file\fR\fR -.RS 4 -Use the specific file -\fIconf_file\fR -to set up configuration instead of looking for the default user configuration file\&. -.br -Default is to look for -\fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR\&. -.br - -CLI option overrides any equivalent mentioned in configuration file, ie\&. launching mpd\-sima with \*(Aq\fB\-\-port\fR\*(Aq CLI option will ignore port setting in configuration file\&. -.br - -For more details on configuration file cf\&. -\fBmpd_sima.cfg\fR(5), see also -the section called \(lqFILES\(rq\&. -.br - -.RE -.PP -\fB\-\-var\-dir=\fR\fB\fIvar_directory\fR\fR -.RS 4 -Use the specific path -\fIvar_directory\fR -to look for (or create) var files (ie\&. database) instead of looking at the default user data location\&. -.br -Default is to look in -\fB$XDG_DATA_HOME/mpd_sima/\fR\&. Concerning -\fB$XDG_DATA_HOME\fR -see also -the section called \(lqFILES\(rq\&. -.RE -.PP -\fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR -.RS 4 -Use the specific host -\fImpd_host\fR -as MPD server\&. -.br -\fImpd_host\fR -can be an -IP -or a fully qualified domain name as long as your system can resolve it\&. This overrides -\fBMPD_HOST\fR -environment variable\&. -.br -Default is -\fIlocalhost\fR\&. -.sp -See also -the section called \(lqENVIRONMENT\(rq\&. -.RE -.PP -\fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR -.RS 4 -Use the specific port number -\fImpd_port\fR -on MPD server\&. This overrides -\fBMPD_PORT\fR -environment variable\&. -.br -Default is -\fI6600\fR\&. -.sp -See also -the section called \(lqENVIRONMENT\(rq -.RE -.PP -\fBconfig\-test\fR -.RS 4 -Test configuration file and exit\&. Uses the configuration file specified with -\fB\-\-config\fR -or default location\&. -.br -Default is to use -\fB$XDG_CONFIG_HOME/mpd_sima/mpd_sima\&.cfg\fR -(see -the section called \(lqFILES\(rq -for more)\&. -.sp -config\-test tests MPD connection and Tags plugin configuration\&. -.RE -.PP -\fBcreate\-db\fR -.RS 4 -Create the database and exit\&. Uses folder specified with -\fB\-\-var\-dir\fR -or default directory\&. -.br -Default is to use -\fB$XDG_DATA_HOME/mpd_sima/\fR -(see -the section called \(lqFILES\(rq -for more)\&. -.RE -.PP -\fBgenerate\-config\fR -.RS 4 -Generate a sample configuration file according to the current CLI options and env\&. var\&.\&. The configuration is written on stdout\&. -.RE -.PP -\fBpurge\-history\fR -.RS 4 -Purge play history in the database and exit\&. Uses folder specified with -\fB\-\-var\-dir\fR -or default directory\&. -.br -Default is to use -\fB$XDG_DATA_HOME/mpd_sima/\fR -(see -the section called \(lqFILES\(rq -for more)\&. -.RE -.PP -\fBbl\-view\fR -.RS 4 -View blocklist, useful to get entry IDs to remove with delete command\&. -.RE -.PP -\fBbl\-add\-artist \fR\fB\fIartist\fR\fR -.RS 4 -Add artist to the blocklist\&. If -\fIartist\fR -is not provided, try to get the currently playing artist\&. -.RE -.PP -\fBbl\-add\-album \fR\fB\fIalbum\fR\fR -.RS 4 -Add album to the blocklist\&. If -\fIalbum\fR -is not provided, try to get the currently playing album\&. -.RE -.PP -\fBbl\-add\-track \fR\fB\fItrack\fR\fR -.RS 4 -Add track to the blocklist\&. If -\fItrack\fR -is not provided, try to get the currently playing track\&. -.RE -.PP -\fBbl\-delete \fR\fB\fIid\fR\fR -.RS 4 -Remove blocklist entry referenced by its -\fIid\fR\&. Use bloclist view command to get the id\&. -.RE -.SH "FILES" -.PP -${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg -.RS 4 -Configuration file\&. -.RE -.PP -${XDG_DATA_HOME}/mpd_sima/sima\&.db -.RS 4 -SQLite DB file\&. -.RE -.PP -${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/ -.RS 4 -Persistent http cache\&. -.RE -.PP -Usually -\fBXDG_DATA_HOME\fR -is set to -${HOME}/\&.local/share -and -\fBXDG_CONFIG_HOME\fR -to -${HOME}/\&.config\&. -.br -You may override them using command line option -\fB\-\-var\-dir\fR -and -\fB\-\-config\fR -(cf\&. -\fBmpd-sima\fR(1)) -.SH "ENVIRONMENT" -.PP -\fBMPD_HOST\fR, \fBMPD_PORT\fR -.RS 4 -mpd\-sima will look for -\fBMPD_HOST\fR -and -\fBMPD_PORT\fR -to override built\-in configuration (set to "localhost:6600")\&. -.sp -mpd\-sima expects -\fBMPD_HOST\fR -syntax as documented in mpc manual, cf\&. -\fBmpc\fR(1)\&. - -.br -To use a password, provide a value of the form "password@host"\&. -.RE -.PP -\fBHTTP_PROXY\fR, \fBHTTPS_PROXY\fR -.RS 4 -mpd\-sima honors -\fBHTTP_PROXY\fR -environment variables\&. -.RE -.SH "CONFIGURATION" -.PP -mpd_sima\&.cfg -.RS 4 -mpd_sima\&.cfg -is read if present\&. Otherwise built\-in defaults are used\&. An example should be provided in the tarball within -doc/examples/\&. On Debian system please look in -/usr/share/doc/mpd_sima\&. -.RE -.PP -DEFAULTS -.RS 4 -Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&. var\&. if set)\&. The default plugins will use Last\&.fm to find similar tracks to queue and fallback to random if nothing if found\&. -.sp -The get the defaults as detected by mpd\-sima on your system you can run mpd\-sima to print the config: -.sp -\fBmpd_sima generate\-config\fR -.RE -.PP -For details about mpd_sima\&.cfg refer to the manual -\fBmpd_sima.cfg\fR(5) -.SH "FEEDBACK/BUGS" -.PP -The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback, -\m[blue]\fB\%https://kaliko.me/contact/\fR\m[]\&. -.PP -XMPP -users are welcome to join the dedicated chat room at -\m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&. -.SH "SEE ALSO" -.PP -\fBmpc\fR(1), -\fBmpd\fR(1) -.PP -/usr/share/doc/mpd\-sima/ -.SH "AUTHOR" -.PP -\fBkaliko\fR <\&kaliko@azylum\&.org\&> -.RS 4 -Wrote this man page and is currently leading MPD_sima project\&. -.RE -.SH "COPYRIGHT" -.br -Copyright \(co 2009-2021 kaliko -.br -.PP -This manual page was written for the Debian system (and may be used by others)\&. -.PP -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\&. -.PP -On Debian systems, the complete text of the GNU General Public License can be found in -/usr/share/common\-licenses/GPL\&. -.sp