Update changelog and manuals

[mpd-sima.git] / data / man / mpd-sima.1

diff --git a/data/man/mpd-sima.1 b/data/man/mpd-sima.1
index fbbf6f5776bd27bbe57cd8e45c783e4b038b3228..dfc1f96b6af95152011a02a222cdd68f7e907ae6 100644 (file)
--- a/data/man/mpd-sima.1
+++ b/data/man/mpd-sima.1
@@ -2,12 +2,12 @@
 .\"     Title: mpd-sima
 .\"    Author: Jack Kaliko <kaliko@azylum.org>
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 11/24/2014
-.\"    Manual: mpd-sima 0.12.3 User Manual
+.\"      Date: 01/02/2016
+.\"    Manual: mpd-sima 0.14.1 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "MPD\-SIMA" "1" "11/24/2014" "mpd-sima" "mpd-sima 0.12.3 User Manual"
+.TH "MPD\-SIMA" "1" "01/02/2016" "mpd-sima" "mpd-sima 0.14.1 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -31,11 +31,13 @@
 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]
+\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\-\-var_dir=\fR\fIvar_directory\fR] [\fB\-\-create\-db>\fR]
+\fBmpd\-sima\fR \-\-create\-db [\fB\-\-var\-dir=\fR\fIvar_directory\fR]
 .HP \w'\fBmpd\-sima\fR\ 'u
-\fBmpd\-sima\fR [{\fB\-h\fR\ |\ \fB\-\-help\fR} | \fB\-\-version\fR]
+\fBmpd\-sima\fR \-\-generate\-config [\fB\&...\fR]
+.HP \w'\fBmpd\-sima\fR\ 'u
+\fBmpd\-sima\fR {{\fB\-h\fR\ |\ \fB\-\-help\fR}\ \fB\-\-version\fR} 
 .SH "DESCRIPTION"
 .PP
 This manual page documents briefly the
@@ -53,7 +55,7 @@ the section called \(lqENVIRONMENT\(rq\&.
 .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
+\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
@@ -136,7 +138,7 @@ the section called \(lqFILES\(rq\&.
 
 .RE
 .PP
-\fB\-\-var_dir=\fR\fB\fIvar_directory\fR\fR
+\fB\-\-var\-dir=\fR\fB\fIvar_directory\fR\fR
 .RS 4
 Use the specific path
 \fIvar_directory\fR
@@ -149,10 +151,15 @@ see also
 the section called \(lqFILES\(rq
 .RE
 .PP
+\fB\-\-generate\-config\fR
+.RS 4
+Generate a sample configuration file according to the current configuration\&. You can put other options with this one to get them in the generated configuration\&.
+.RE
+.PP
 \fB\-\-create\-db\fR
 .RS 4
 Create the database and exit\&. Uses folder specified with
-\fB\-\-var_dir\fR
+\fB\-\-var\-dir\fR
 or default directory\&.
 .br
 Default is to use
@@ -223,9 +230,11 @@ to
 ${HOME}/\&.config\&.
 .br
 You may override them using command line option
-\fB\-\-var_dir\fR
+\fB\-\-var\-dir\fR
+and
+\fB\-\-config\fR
 (cf\&.
-\fBmpd_sima\fR(1))
+\fBmpd-sima\fR(1))
 .SH "ENVIRONMENT"
 .PP
 \fBMPD_HOST\fR, \fBMPD_PORT\fR
@@ -244,6 +253,13 @@ syntax as documented in mpc manual, cf\&.
 .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
@@ -258,10 +274,9 @@ DEFAULTS
 .RS 4
 Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env\&. var\&. if set)\&.
 .sp
-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 unplayed queue is one track long\&.
+The get the defaults as detected by mpd\-sima on your system you can run mpd\-sima to print the config:
 .sp
-To change these defaults, use the configuration file
-mpd_sima\&.cfg
+\fBmpd\-sima \-\-generate\-config\fR
 .RE
 .PP
 For details about mpd_sima\&.cfg refer to the manual
@@ -288,7 +303,7 @@ Wrote this man page and is currently leading MPD_sima project\&.
 .RE
 .SH "COPYRIGHT"
 .br
-Copyright \(co 2009-2014 Jack Kaliko
+Copyright \(co 2009-2016 Jack Kaliko
 .br
 .PP
 This manual page was written for the Debian system (and may be used by others)\&.