X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.1.xml;fp=data%2Fman%2Fmpd_sima.1.xml;h=44d77c4bfb5f004e76084cee0c0b127352e5c0a6;hb=e49af6fd502e9b4e43c1d2f1b93cb01a2e381e4d;hp=0000000000000000000000000000000000000000;hpb=26407984575aaf451eddfe3395a23779ab2c6640;p=mpd-sima.git diff --git a/data/man/mpd_sima.1.xml b/data/man/mpd_sima.1.xml new file mode 100644 index 0000000..44d77c4 --- /dev/null +++ b/data/man/mpd_sima.1.xml @@ -0,0 +1,299 @@ + + + + + + +]> + + + + + &dhutils; + &dhsection; + + + &dhpackage; + &dhpackage; will try to maintain some titles ahead in your play list following different policies. + + + + &dhpackage; + + conf_file + var_directory + pid_file + log_file + log_level + mpd_host + mpd_port + + + &dhpackage; + var_directory + + + + &dhpackage; + + + + + + + + + + + + + + DESCRIPTION + This manual page documents briefly the + &dhpackage; commands. + At start up default configuration is first overridden by user + configuration in mpd_sima.cfg (see ) and finally + command lines options are honored. For instance you can override + default MPD_HOST set in defaults (localhost) or in your configuration + file with -S my_mpd_server option. For default + configuration see . + + + EXAMPLE + + Launch as a system service (dæmon). + Here follows an example on how to launch &dhpackage; as a service on your system, not attach to regular user configuration/database. + &dhpackage; --daemon --conf=/etc/mpd_sima.cfg --var_dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log + + + Launch in user land + Launching &dhpackage; from/whithin your user account is easy, you can simply call &dhpackage; from your shell or one of the following command: + Background execution (dæmonise), log in the specified file, save pid: + &dhpackage; --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.log + Foreground execution, connect my.mpd.server.org, log to std(out|err): + &dhpackage; --host=my.mpd.server.org + + + + OPTIONS + The program follows the usual GNU command line syntax, + with long options starting with two dashes (`-'). A summary of + options is included below. + + + + + + + Print help and exit. + + + + + + Print version and exit. + + + + + + Start as a daemon. Log redirected to /dev/null, usually setting and options in daemon mode are a good idea to monitor/stop the process. + + + + + + + Use the specific file pid_file to store pid to.Default is not to store pid info. + + + + + + + Use the specific file log_file to log messages to.Default is to log to stdout/stderr. + + + + + + + Verbosity in [debug,info,warning,error].Default is to log info messages. + + + + + + + Use the specific file conf_file to set up configuration instead of looking for the default user configuration file.Default is to look for $XDG_CONFIG_HOME/mpd_sima/mpd_sima.cfg. Concerning this file see also .Pay attention: Because you load a specific configuration file from command line interface does not mean it will override others options pass to mpd_sima. In other words launching with will override port setting whatever the configuration file your using, default or command line specified. + + + + + + Use the specific path var_directory to look for (or create) var files (ie. database) instead of looking at the default user data location.Default is to look in $XDG_DATA_HOME/mpd_sima/. Concerning $XDG_DATA_HOME see also + + + + + + Create the database and exit. Uses folder specified with or default directory.Default is to use $XDG_DATA_HOME/mpd_sima/. Concerning $XDG_DATA_HOME see also + + + + + + + Use the specific host mpd_host as MPD server.mpd_host can be an IP or a fully qualified domain name as long as your system can resolve it. This overrides MPD_HOST environment variable.Default is localhost. + See also . + + + + + + + Use the specific port number mpd_port on MPD server. This overrides MPD_PORT environment variable.Default is 6600. + See also + + + + + + FILES + + + ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg + + + The per-user configuration file. Usually XDG_CONFIG_HOME is set to ${HOME}/.config. + + + + ${XDG_DATA_HOME}/mpd_sima/sima.db + + + SQLite database. Usually XDG_DATA_HOME is set to ${HOME}/.local/share. + + + + + + ENVIRONMENT + + + MPD_HOST, MPD_PORT + + &dhutils; will look for MPD_HOST and + MPD_PORT to override built-in configuration + (set to "localhost:6600"). + &dhutils; expects MPD_HOST syntax as documented in mpc manual, + cf. mpc1. + To use a password, provide a value of the form "password@host". + + + + + + + CONFIGURATION + + + mpd_sima.cfg + + mpd_sima.cfg is read if present. + Otherwise built-in defaults are used. An example should be + provided in the tarball within + doc/examples/mpd_sima.cfg. On Debian + system please look in + /usr/share/doc/&dhpackage;. + + + + DEFAULTS + + Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env. var. if set). + The default behavior is to add one track, + this track is to be chosen among titles from + artists similar to the artist of the currently + played track. MPD_sima will add one track when the + play list is one track long. + To change these defaults, use the configuration file mpd_sima.cfg + + + + + + + SEE ALSO + + + + mpc + 1 + , + mpd + 1 + , + mpd-sima.cfg + 5 + + + + /usr/share/doc/mpd-sima/ + + +