---
name: "mpd-sima"
section: "1"
platform: "linux"
package: "mpd-sima"
version: "0.18.2-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mpd-sima"
---

# mpd-sima(1)

mpd-sima will try to maintain some titles ahead in the queue following different policies.

## NAME

mpd-sima - mpd-sima will try to maintain some titles ahead in the queue following different policies.

## SYNOPSYS

**mpd-sima \[--daemon\] \[--config=conf\_file\] \[--var-dir=var\_directory\] \[--pid=pid\_file\] \[--log=log\_file\] \[--log-level=log\_level\] \[--host=mpd\_host\] \[--mpd\_port=mpd\_port\]**

**mpd-sima {{-h \| --help} --version}**

**mpd-sima \[--config=conf\_file\] config-test**

**mpd-sima \[--var-dir=var\_directory\] create-db**

**mpd-sima \[…\] generate-config**

**mpd-sima \[--var-dir=var\_directory\] purge-history**

**mpd-sima bl-view**

**mpd-sima bl-add-artist \[artist\]**

**mpd-sima bl-add-album \[album\]**

**mpd-sima bl-add-track \[track\]**

**mpd-sima bl-delete id**

**mpd-sima random \[nbtracks\]**

## 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 *FILES*) and finally command lines options are honored. For instance you can override default MPD host (localhost) in your configuration file or with **-S my\_mpd\_server.local** option. For default configuration see *CONFIGURATION*. See also environment variables special case for MPD host and port in *ENVIRONMENT*.

## 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.

- **--daemon**

  Start as a daemon. Log redirected to **/dev/null**, usually setting **--log** and **--pid** options in daemon mode are a good idea to monitor/stop the process.

- **-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.

- **-v log\_level; --log-level=log\_level**

  Verbosity in \[debug,info,warning,error\].

  Default is to log info messages.

- **-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**. CLI option overrides any equivalent mentioned in configuration file, ie. launching mpd-sima with **--port** CLI option will ignore port setting in configuration file.

  For more details on configuration file see also *FILES* and *CONFIGURATION* sections.

- **--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 *FILES section*.

- **-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 *ENVIRONMENT section*.

- **-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 *ENVIRONMENT section*

## COMMAND ARGUMENTS

- **config-test**

  Test configuration file and exit. Uses the configuration file specified with **--config** or default location. Default is to use $XDG\_CONFIG\_HOME/mpd\_sima/mpd\_sima.cfg.

  config-test tests MPD connection and Tags plugin configuration.

- **create-db**

  Create the database and exit. Uses folder specified with **--var-dir** or default directory.

  Default is to use **$***{XDG\_DATA\_HOME***}/mpd\_sima/** (see *CONFIGURATION* *section* for more).

- **generate-config**

  Generate a sample configuration file according to the current CLI options and environment variables. The configuration is written on stdout.

- **purge-history**

  Purge play history in the database and exit. Uses folder specified with **--var-dir** or default directory.

  Default is to use **$***{XDG\_DATA\_HOME***}/mpd\_sima/** (see *FILES section* for more).

- **bl-view**

  View blocklist, useful to get entry IDs to remove with delete command.

- **bl-add-artist artist**

  Add artist to the blocklist. If artist is not provided, try to get the currently playing artist.

- **bl-add-album album**

  Add album to the blocklist. If album is not provided, try to get the currently playing album.

- **bl-add-track track**

  Add track to the blocklist. If track is not provided, try to get the currently playing track.

- **bl-delete id**

  Remove blocklist entry referenced by its id. Use bloclist view command to get the id.

- **random \[nbtracks\]**

  Starts in random mode overriding internal plugin configuration. If *nbtracks* is provided, as many tracks will be queued (defaults to one).

## 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)](/mpc/1.md)**. To use a password, provide a value of the form **password@host**.

- **HTTP\_PROXY, HTTPS\_PROXY**

  mpd-sima honors HTTP\_PROXY environment variables.

## 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/**. 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 plugins will use Last.fm to find similar tracks to queue and fallback to random if nothing if found.

The get the defaults as detected by mpd-sima on your system you can run mpd-sima to print the config:

**mpd-sima generate-config**

For details about mpd\_sima.cfg refer to the manual **[mpd\_sima.cfg(5)](/mpd_sima.cfg/5.md)**

## FILES

- **$*{XDG\_CONFIG\_HOME*}/mpd\_sima/mpd\_sima.cfg**

  Configuration file.

- **$*{XDG\_DATA\_HOME*}/mpd\_sima/sima.db**

  SQLite internal DB file. Stores play history and blocklists.

- **$*{XDG\_DATA\_HOME*}/mpd\_sima/WEB\_SERVICE/**

  HTTP cache.

Usually **XDG\_DATA\_HOME** is set to **$***{HOME***}/.local/share** and **XDG\_CONFIG\_HOME** to **$***{HOME***}/.config** (for regular users). You may override them using command line option **--var-dir** and **--config** (cf. **[mpd-sima(1)](/mpd-sima/1.md)**)

## SEE ALSO

**[mpc(1)](/mpc/1.md)**, **[mpd(1)](/mpd/1.md)**

## FEEDBACK/BUGS

The maintainer would be more than happy to ear from you, don't hesitate to send feedback, *https://kaliko.me/contact/*

XMPP users are welcome to join the dedicated chat room at *kaliko.me@conf.azylum.org*

## AUTHOR

kaliko

## COPYRIGHT

2009-2024, kaliko