Bug 20525: Add --timezone switch to koha-create
[koha.git] / debian / docs / koha-create.xml
index 26559c9..77a3e7d 100644 (file)
@@ -3,7 +3,7 @@
 <info>
 <productname>Koha</productname> is the first free software library automation package.
 <author>
-  <orgname>The Koha Communnity</orgname>
+  <orgname>The Koha Community</orgname>
   <uri>http://koha-community.org/</uri>
 </author>
 </info>
       <command>koha-create</command>
       <arg choice="req"><option>--create-db</option>|<option>--request-db</option>|<option>--populate-db</option>|<option>--use-db</option></arg>
       <arg><option>--marcflavor</option> marc21|normarc|unimarc</arg>
-      <arg><option>--zebralang</option> en|nb|fr</arg>
+      <arg><option>--zebralang</option> en|es|fr|gr|nb|ru|uk</arg>
+      <arg><option>--auth-idx</option> dom|grs1</arg>
+      <arg><option>--biblio-idx</option> dom|grs1</arg>
+      <arg><option>--memcached-servers</option> server:port</arg>
+      <arg><option>--memcached-prefix</option> namespace_prefix</arg>
       <arg><option>--defaultsql</option> /path/to/some.sql</arg>
       <arg><option>--configfile</option> /path/to/config</arg>
       <arg><option>--passwdfile</option> /path/to/passwd</arg>
+      <arg><option>--dbhost</option> host</arg>
       <arg><option>--database</option> database</arg>
       <arg><option>--adminuser</option> n</arg>
+      <arg><option>--enable-sru</option></arg>
+      <arg><option>--sru-port</option> port</arg>
+      <arg><option>--template-cache-dir</option> directory</arg>
+      <arg><option>--timezone</option> time/zone</arg>
+      <arg><option>--upload-path</option> directory</arg>
+      <arg><option>--letsencrypt</option></arg>
+      <arg><option>--help</option>|<option>-h</option></arg>
+
       <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
       </listitem>
     </varlistentry>
 
+    <varlistentry>
+      <term><option>--dbhost</option></term>
+      <listitem>
+        <para>Database server hostname/IP to use.</para>
+      </listitem>
+    </varlistentry>
+
     <varlistentry>
       <term><option>--defaultsql</option></term>
       <listitem>
       </listitem>
     </varlistentry>
 
+    <varlistentry>
+      <term><option>--adminuser</option></term>
+      <listitem>
+        <para>Specify the borrowernumber of the user that should have a new, random password set as part of setting up the new instance. The password will be reported as part of the output of the current script. If --adminuser is not specified, the user with borrowernumber = 1 will be updated. If an SQL file is not used to populate the database of the newly created instance, no admin user will be created.</para>
+      </listitem>
+    </varlistentry>
+
     <varlistentry>
       <term><option>--marcflavor</option></term>
       <listitem>
       </listitem>
     </varlistentry>
 
+    <varlistentry>
+      <term><option>--auth-idx</option></term>
+      <listitem>
+        <para>Specified the desired indexing mode for authority records. Valid options are <option>dom</option> (default) and <option>grs1</option>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--biblio-idx</option></term>
+      <listitem>
+        <para>Specified the desired indexing mode for bibliographic records. Valid options are <option>dom</option> (default) and <option>grs1</option>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--memcached-servers</option></term>
+      <listitem>
+        <para>Specify a comma-separated list of host:port memcached servers for using with the created Koha instance. Defaults to <option>127.0.0.1:11211</option>, the needed configuration for a locally installed memcached server.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--memcached-prefix</option></term>
+      <listitem>
+        <para>Specifiy a <option>namespace prefix</option> for memcached. You usually leave this option alone to avoid namespace collisions. It defaults to <option>koha_</option>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--enable-sru</option></term>
+      <listitem>
+        <para>Enable the Z39.50/SRU server for the created instance.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--sru-port</option></term>
+      <listitem>
+        <para>Specifiy a <option> TCP port number</option> for the Z39.50/SRU server to listen on.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--template-cache-dir</option></term>
+      <listitem>
+        <para>Specify a <option>directory</option> for storing the template cache files of the instance.
+              It defaults to <filename>/var/cache/koha/instance/templates</filename>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--timezone</option></term>
+      <listitem>
+        <para>Specify a <option>timezone</option> for the created instance. e.g. America/Argentina</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--upload-path</option></term>
+      <listitem>
+        <para>Specify a <option>directory</option> for storing the permanently uploaded files of the instance.
+              It defaults to <filename>/var/lib/koha/instance/uploads</filename>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--letsencrypt</option></term>
+      <listitem>
+        <para>Set up a https-only website with letsencrypt certificates</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--help</option>,<option>-h</option></term>
+      <listitem>
+        <para>Print usage information.</para>
+      </listitem>
+    </varlistentry>
+
+
   </variablelist>
   </refsect1>
 
         <term><option>DEFAULTSQL</option></term>
         <listitem>
           <para>An SQL file (compressed with gzip) that can be fed  to  mysql(1) to  initialize the database after it has been created.  Might be created using koha-dump-defaults(8).</para>
+          <para>If the SQL file contains users, the user with borrowernumber = 1 will have a new, random password set. This password will be reported in the output of the script. If another user than borrowernumber 1 should have its password set, the borrowernumber of this user can be set with the --adminuser command line option.</para>
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>MEMCACHED_SERVERS</option></term>
+        <listitem>
+          <para>A comma-separated list of valid memcached servers. Usually in the form of <option>host:port</option>. If not present koha-create will default to <option>127.0.0.1:11211</option>. Also, this will be overriden by the arguments of the <option>--memcached-servers</option> switch.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>MEMCACHED_PREFIX</option></term>
+        <listitem>
+          <para>A prefix for all new Koha instances to use in memcached. If not present koha-create will default to <option>koha_</option>. Also, this will be overriden by the arguments of the <option>--memcached-prefix</option> switch.</para>
+        </listitem>
+      </varlistentry>
+
+
       <varlistentry>
         <term><option>ZEBRA_MARC_FORMAT</option></term>
         <listitem>
       <varlistentry>
         <term><option>ZEBRA_LANGUAGE</option></term>
         <listitem>
-          <para>Primary  language  for Zebra indexing. Possible values are 'en', 'fr' and 'nb'.</para>
+          <para>Primary  language  for Zebra indexing. Possible values are 'en', 'es', 'fr', 'nb', 'ru' and 'uk'.</para>
         </listitem>
       </varlistentry>
 
     <varlistentry>
       <term><option><filename>/etc/koha/passwd</filename></option></term>
       <listitem>
-        <para>Pre-selected database credentials are read from this file, if it exists. The format for this file is instancename:username:passwd:database. Database is optional, but the other three are required if you want to use pre-determined database user credentials.</para>
+        <para>Pre-selected database credentials are read from this file, if it exists. The format for this file is instancename:username:passwd:database:dbhost. Database is optional, but the other three are required if you want to use pre-determined database user credentials.</para>
       </listitem>
     </varlistentry>
   </variablelist>