X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.1.xml;h=9873396e17b46dc2700fdf985ed24b18ff34433a;hb=a260ebea93f23d72aa6e0178744b0f64c469b7ba;hp=44d77c4bfb5f004e76084cee0c0b127352e5c0a6;hpb=e49af6fd502e9b4e43c1d2f1b93cb01a2e381e4d;p=mpd-sima.git
diff --git a/data/man/mpd_sima.1.xml b/data/man/mpd_sima.1.xml
index 44d77c4..9873396 100644
--- a/data/man/mpd_sima.1.xml
+++ b/data/man/mpd_sima.1.xml
@@ -43,7 +43,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
-
+
]>
@@ -56,15 +56,15 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
&dhsection;
- &dhpackage;
- &dhpackage; will try to maintain some titles ahead in your play list following different policies.
+ &dhutils;
+ &dhutils; will try to maintain some titles ahead in the queue following different policies.
- &dhpackage;
+ &dhutils;conf_file
- var_directory
+ var_directorypid_filelog_filelog_level
@@ -72,50 +72,91 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
mpd_port
- &dhpackage;
- var_directory
-
-
-
- &dhpackage;
+ &dhutils;
-
-
+
+
+
-
+
+ &dhutils;
+ config-test
+ conf_file
+
+
+ &dhutils;
+ create-db
+ var_directory
+
+
+ &dhutils;
+ generate-config
+
+
+
+ &dhutils;
+ purge-history
+ var_directory
+
+
+ &dhutils;
+ bl-view
+
+
+ &dhutils;
+ bl-add-artist
+
+
+
+ &dhutils;
+ bl-add-album
+
+
+
+ &dhutils;
+ bl-add-track
+
+
+
+ &dhutils;
+ bl-delete
+
+ DESCRIPTIONThis manual page documents briefly the
- &dhpackage; commands.
+ &dhutils; 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 .
+ default MPD host (localhost) in your configuration
+ file or with -SÂ my_mpd_server option. For default
+ configuration see . See also environment
+ variables special case for MPD host and port in .
+
EXAMPLELaunch 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
+ Here follows an example on how to launch &dhutils; as a service on your system, not attach to regular user configuration/database.
+ &dhutils; --daemon --conf=/etc/mpd_sima.cfg --var-dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.logLaunch 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:
+ Launching &dhutils; from/whithin your user account is easy, you can simply call &dhutils; 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
+ &dhutils; --daemon --pid=$HOME/var/run/mpd-sima.pid --log=$HOME/var/log/mpd-sima.logForeground execution, connect my.mpd.server.org, log to std(out|err):
- &dhpackage; --host=my.mpd.server.org
+ &dhutils; --host=my.mpd.server.org
@@ -167,23 +208,25 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
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
+ 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 &dhutils; with '' CLI option will ignore port setting in configuration file.
+ For more details on configuration file cf.
+ mpd_sima.cfg
+ 5, 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 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 .
@@ -202,35 +245,75 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
See also
+
+
+
+ Test configuration file and exit. Uses the configuration file specified with or default location.Default is to use $XDG_CONFIG_HOME/mpd_sima/mpd_sima.cfg (see for more).
+ config-test tests MPD connection and Tags plugin configuration.
+
+
+
+
+
+ Create the database and exit. Uses folder specified with or default directory.Default is to use $XDG_DATA_HOME/mpd_sima/ (see for more).
+
+
+
+
+
+ Generate a sample configuration file according to the current CLI options and env. var.. The configuration is written on stdout.
+
+
+
+
+
+ Purge play history in the database and exit. Uses folder specified with or default directory.Default is to use $XDG_DATA_HOME/mpd_sima/ (see for more).
+
+
+
+
+
+ View blocklist, useful to get entry IDs to remove with delete command.
+
+
+
+
+
+ Add artist to the blocklist. If
+ artist
+ is not provided, try to get the currently playing artist.
+
+
+
+
+
+
+ Add album to the blocklist. If
+ album
+ is not provided, try to get the currently playing album.
+
+
+
+
+
+
+ Add track to the blocklist. If
+ track
+ is not provided, try to get the currently playing track.
+
+
+
+
+
+
+ Remove blocklist entry referenced by its
+ id. Use bloclist view command to get the id.
+
+
+
-
- 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
@@ -246,6 +329,12 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
+
+ HTTP_PROXY, HTTPS_PROXY
+
+ &dhutils; honors HTTP_PROXY environment variables.
+
+
@@ -257,7 +346,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
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
+ doc/examples/. On Debian
system please look in
/usr/share/doc/&dhpackage;.
@@ -265,35 +354,19 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
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
+ 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 &dhutils; on your system you can run &dhutils; to print the config:
+ &dhpackage; generate-config
-
-
-
- SEE ALSO
-
-
-
- mpc
- 1
- ,
- mpd
- 1
- ,
- mpd-sima.cfg
- 5
-
-
-
- /usr/share/doc/mpd-sima/
+ For details about mpd_sima.cfg refer to the manual
+
+ mpd_sima.cfg
+ 5
+
+
+