]> kaliko git repositories - mpd-sima.git/commitdiff
Now use "var-dir" as option name
authorkaliko <kaliko@azylum.org>
Sun, 20 Sep 2015 12:06:42 +0000 (14:06 +0200)
committerkaliko <kaliko@azylum.org>
Sun, 20 Sep 2015 12:06:42 +0000 (14:06 +0200)
data/bash/completion.sh
data/man/files.xml
data/man/mpd-sima.1
data/man/mpd_sima.1.xml
data/man/mpd_sima.cfg.5
data/man/simadb_cli.1
doc/Changelog
doc/THANKS
sima/utils/config.py
sima/utils/startopt.py

index 0d320cab5b2157d6d342f00f5a63c1c382da0f70..2940cb7b1fca669c2c88096c9e0adbe4e1e29a45 100644 (file)
@@ -33,7 +33,7 @@ _sima() {
           -S --host \
           -P --port \
           -h --help --version \
-          --var-dir --var_dir \
+          --var-dir \
           --generate-config \
           -d --daemon"
 
@@ -43,7 +43,7 @@ _sima() {
     fi
 
     case "${prev}" in
-        --var_dir|--var-dir)
+        --var-dir)
             _filedir -d
             ;;
         -v|--log-level)
index 806d5de11a9419747a777b58de02abc5ccbec688..5743c5b3307d4e77d3f6d44d38302dc063cc293c 100644 (file)
@@ -24,7 +24,7 @@
         <para>Usually <envar>XDG_DATA_HOME</envar> is set to
             <filename>${HOME}/.local/share</filename> and <envar>XDG_CONFIG_HOME</envar> to
             <filename>${HOME}/.config</filename>.<sbr />You may override them using
-            command line option <option>--var_dir</option> (cf.
+            command line option <option>--var-dir</option> and <option>--config</option> (cf.
             <citerefentry><refentrytitle>mpd-sima</refentrytitle>
                 <manvolnum>1</manvolnum></citerefentry>)</para>
     </refsect1>
index 3e9f6be1ca9a5ae5b32a1a3e6add3d47cc6da9b9..c139e79d8af02ca7ab27d68d14c6e4062430446f 100644 (file)
@@ -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: 02/12/2015
+.\"      Date: 09/20/2015
 .\"    Manual: mpd-sima 0.14.0 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "MPD\-SIMA" "1" "02/12/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual"
+.TH "MPD\-SIMA" "1" "09/20/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -31,9 +31,9 @@
 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 \-\-create\-db [\fB\-\-var_dir=\fR\fIvar_directory\fR]
+\fBmpd\-sima\fR \-\-create\-db [\fB\-\-var\-dir=\fR\fIvar_directory\fR]
 .HP \w'\fBmpd\-sima\fR\ 'u
 \fBmpd\-sima\fR \-\-generate\-config [\fB\&...\fR]
 .HP \w'\fBmpd\-sima\fR\ 'u
@@ -55,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
@@ -138,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
@@ -159,7 +159,7 @@ Generate a sample configuration file according to the current configuration\&. Y
 \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
@@ -230,7 +230,9 @@ 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))
 .SH "ENVIRONMENT"
index 9a36ee5731a7f0471abc97e69016a08b9f99d52d..c0b59d49a63f891cd40bf1cac4cc1d3a6e68775b 100644 (file)
@@ -64,7 +64,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
       <command>&dhpackage;</command>
       <arg choice="opt"><option>--daemon</option></arg>
       <arg choice="opt"><option>--config=</option><replaceable class="option">conf_file</replaceable></arg>
-      <arg choice="opt"><option>--var_dir=</option><replaceable class="option">var_directory</replaceable></arg>
+      <arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
       <arg choice="opt"><option>--pid=</option><replaceable class="option">pid_file</replaceable></arg>
       <arg choice="opt"><option>--log=</option><replaceable class="option">log_file</replaceable></arg>
       <arg choice="opt"><option>--log-level=</option><replaceable class="option">log_level</replaceable></arg>
@@ -74,7 +74,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
     <cmdsynopsis>
       <command>&dhpackage;</command>
       <arg choice="plain">--create-db</arg>
-      <arg choice="opt"><option>--var_dir=</option><replaceable class="option">var_directory</replaceable></arg>
+      <arg choice="opt"><option>--var-dir=</option><replaceable class="option">var_directory</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis>
       <command>&dhpackage;</command>
@@ -114,7 +114,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
         <refsect2 id="daemon">
             <title>Launch as a system service (dæmon).</title>
             <para>Here follows an example on how to launch &dhpackage; as a service on your system, not attach to regular user configuration/database.</para>
-            <para><command>&dhpackage; --daemon --conf=/etc/mpd_sima.cfg --var_dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log</command></para>
+            <para><command>&dhpackage; --daemon --conf=/etc/mpd_sima.cfg --var-dir=/var/cache/mpd-sima/ --pid=/run/mpd-sima.pid --log=/var/log/mpd-sima.log</command></para>
         </refsect2>
         <refsect2 id="user_land">
             <title>Launch in user land</title>
@@ -189,8 +189,8 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                    </para>
             </listitem>
         </varlistentry>
-        <varlistentry> <!-- var_dir -->
-            <term><option>--var_dir=<replaceable class="parameter">var_directory</replaceable></option></term>
+        <varlistentry> <!-- var-dir -->
+            <term><option>--var-dir=<replaceable class="parameter">var_directory</replaceable></option></term>
             <listitem>
                 <para>Use the specific path <replaceable>var_directory</replaceable> to look for (or create) var files (ie. database) instead of looking at the default user data location.<sbr />Default is to look in <envar>$XDG_DATA_HOME/mpd_sima/</envar>.  Concerning <envar>$XDG_DATA_HOME</envar> see also <xref linkend="files"/></para>
             </listitem>
@@ -204,7 +204,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
         <varlistentry> <!-- create-db -->
             <term><option>--create-db</option></term>
             <listitem>
-                <para>Create the database and exit. Uses folder specified with <option>--var_dir</option> or default directory.<sbr />Default is to use <envar>$XDG_DATA_HOME/mpd_sima/</envar>.  Concerning <envar>$XDG_DATA_HOME</envar> see also <xref linkend="files"/></para>
+                <para>Create the database and exit. Uses folder specified with <option>--var-dir</option> or default directory.<sbr />Default is to use <envar>$XDG_DATA_HOME/mpd_sima/</envar>.  Concerning <envar>$XDG_DATA_HOME</envar> see also <xref linkend="files"/></para>
             </listitem>
         </varlistentry>
         <varlistentry><!-- host -->
index cd7cf0183cd548b128415c9d370af915fd64813f..d5e0c5793cb1d1f6a582aaf46724d05ca1345b0a 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: mpd_sima.cfg
 .\"    Author: Jack Kaliko <kaliko@azylum.org>
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 02/15/2015
+.\"      Date: 09/20/2015
 .\"    Manual: mpd-sima 0.14.0 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "MPD_SIMA\&.CFG" "5" "02/15/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual"
+.TH "MPD_SIMA\&.CFG" "5" "09/20/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -455,7 +455,9 @@ 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))
 .SH "FEEDBACK/BUGS"
index 19a4fe9e7e80a92351dfcefedf241688e383c8bc..734a2cfc57e3b57b173b12cec9a141c58bd4b800 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: simadb_cli
 .\"    Author: Jack Kaliko <kaliko@azylum.org>
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 02/08/2015
+.\"      Date: 09/20/2015
 .\"    Manual: mpd-sima 0.14.0 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "SIMADB_CLI" "1" "02/08/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual"
+.TH "SIMADB_CLI" "1" "09/20/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
index 87f6b04104c227f25e7aabfd5642be8bf6f98c42..03d5ee32809b95e81942a7d262f1a7b6bc5232f0 100644 (file)
@@ -7,6 +7,7 @@ MPD_sima v0.14.0
  * Fixed default conf file name (back to mpd_sima.cfg)
  * Fixed http cache for lastFM
  * Cleanup code (removed users similarities)
+ * Make "var-dir" option default name instead of "var_dir"
 
 -- kaliko jack <kaliko@azylum.org> UNRELEASED
 
index 322163bbda04d92ace29aa2448411016bb7d3723..2960c9236858f1f94c8a8b1cb671205cc85e56f6 100644 (file)
@@ -1,5 +1,7 @@
 THANKS
 
+ * Codingteam, the original forge hosting the project.
+
  * Mathieu (a.k.a. MuLiMa), for the projet mpd_dynamic_playlister, initial
    inspiration of MPD_sima.
    http://forum.ubuntu-fr.org/viewtopic.php?id=146141
index 346bbe77c1103b3141746549e4b2fa8b7a95d773..92d3fb916c4b6ff2b499c712e7c4f1f284e6725a 100644 (file)
@@ -214,7 +214,7 @@ class ConfMan(object):  # CONFIG MANAGER CLASS
             data_dir = join(homedir, '.local', 'share', DIRNAME)
         else:
             self.log.critical('Can\'t find a suitable location for data folder (XDG_DATA_HOME)')
-            self.log.critical('Please use "--var_dir" to set a proper location')
+            self.log.critical('Please use "--var-dir" to set a proper location')
             sys.exit(1)
 
         if self.startopt.get('conf_file'):
index e39330431711290d09e4e0095a85146aca8d53b8..86463097a696c7a38ae83ac4397a044d63563b84 100644 (file)
@@ -98,7 +98,7 @@ OPTS = [
         'action': 'store_true',
         'dest': 'create_db',
         'help': '''Create database and exit, use destination
-                   specified in --var_dir or standard location.'''},
+                   specified in --var-dir or standard location.'''},
     {
         'sw':['--queue-mode', '-q'],
         'dest': 'queue_mode',