MPD-SIMA

Section: mpd-sima User Manual (1) Updated: 05/05/2011 Local index Up

NAME

mpd-sima - mpd-sima will try to maintain some titles ahead in your play list following different policies.

SYNOPSIS

mpd-sima [--config=conf_file] [--var_dir=var_directory] [--pid=pid_file] [--log=log_file] [--host=mpd_host] [--mpd_port=mpd_port] [--new-version]
mpd-sima [{-h | --help} | --version]

DESCRIPTION

This manual page documents briefly the mpd-sima commands.

At start up default configuration is first overridden by user configuration in mpd_sima.cfg (see the section called "FILES") 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 the section called "CONFIGURATION".

EXAMPLES

Launch as a system service

Here follows an example on how to launch mpd-sima as a service on your system, not attach to regular user configuration/database.

mpd-sima --conf=/etc/mpd_sima.cfg --var_dir=/var/cache/mpd-sima/ --log=/var/log/mpd-sima.log

Launch in user land

Launching mpd-sima from/whithin your user acount is easy, you can simply call mpd-sima from your shell or one of the following command:

mpd-sima --log=$HOME/var/log/mpd-sima.log

mpd-sima --host=my.mpdserver.org

Daemon mode

The script is not yet forking the process in background as a regular daemon. Hence you'll have to explicitly ask for it, refer to your shell documentation to do so.

OPTIONS

The program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below.

-h, --help

: Print help and exit.

--version

: Print version and exit.

-p pid_file, --pid=pid_file

: Use the specific file pid_file to store pid to.
Default is not to store pid info.

-l log_file, --log=log_file

: Use the specific file log_file to log messages to.
Default is to log to stdout/stderr.

-c conf_file, --config=conf_file

: 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 the section called "FILES".
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 -P 6666 will override port setting whatever the configuration file your using, default or command line specified.

--var_dir=var_directory

: 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 the section called "FILES"

-S mpd_host, --host=mpd_host

: 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 the section called "ENVIRONMENT".

-P mpd_port, --port=mpd_port

: Use the specific port number mpd_port on MPD server. This overrides MPD_PORT environment variable.
Default is 6600.
See also the section called "ENVIRONMENT"

--new-version

: Check and log for new version at start up (issue a warning).

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

mpd-sima will look for MPD_HOST and MPD_PORT to override built-in configuration (set to "localhost:6600").

mpd-sima expects MPD_HOST syntax as documented in mpc manual, cf. mpc(1).

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-ib 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/mpd-sima.

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

BUGS

The upstream BTS can be found at m[blue]http://codingteam.net/project/sima/bugsm[].

FEEDBACK

The maintainer would be more than happy to ear from you, don't hesitate to send feedback on the forge, via the upstream BTS, the forum or the chat room, all available on the forge at m[blue]http://codingteam.net/project/simam[].

XMPP users are welcome to join the dedicated chat room at m[blue]sima@conference.codingteam.netm[].

AUTHOR

Jack Kaliko <efrim@azylum.org>

: Wrote this man page and is currently leading MPD_sima project.

COPYRIGHT

This manual page was written for the Debian system (and may be used by others).

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

This document was created by man2html, using the manual pages.
Time: 07:53:08 GMT, June 15, 2011