Bug 20116: Fix package install path for clear_cache.pl
[koha-ffzg.git] / debian / docs / koha-create.xml
index 47b4a00..f37eb20 100644 (file)
       <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|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>--use-memcached</option></arg>
+      <arg><option>--zebralang</option> el|en|es|fr|nb|ru|uk</arg>
       <arg><option>--memcached-servers</option> server:port</arg>
       <arg><option>--memcached-prefix</option> namespace_prefix</arg>
+      <arg><option>--elasticsearch-server</option> server:port</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>--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>--tmp-path</option> directory</arg>
       <arg><option>--letsencrypt</option></arg>
       <arg><option>--help</option>|<option>-h</option></arg>
 
     </varlistentry>
 
     <varlistentry>
-      <term><option>--auth-idx</option></term>
+      <term><option>--memcached-servers</option></term>
       <listitem>
-        <para>Specified the desired indexing mode for authority records. Valid options are <option>dom</option> (default) and <option>grs1</option>.</para>
+        <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>--biblio-idx</option></term>
+      <term><option>--memcached-prefix</option></term>
       <listitem>
-        <para>Specified the desired indexing mode for bibliographic records. Valid options are <option>dom</option> (default) and <option>grs1</option>.</para>
+        <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>--use-memcached</option></term>
+      <term><option>--elasticsearch-server</option></term>
       <listitem>
-        <para>Make the Koha instance use memcached. <option>Disabled by default</option>.</para>
+        <para>Specifiy a <option>server:port</option> Elasticsearch server configuration. It defaults to <option>localhost:9200</option>.</para>
       </listitem>
     </varlistentry>
 
     <varlistentry>
-      <term><option>--memcached-servers</option></term>
+      <term><option>--enable-sru</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>
+        <para>Enable the Z39.50/SRU server for the created instance.</para>
       </listitem>
     </varlistentry>
 
     <varlistentry>
-      <term><option>--memcached-prefix</option></term>
+      <term><option>--sru-port</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>
+        <para>Specifiy a <option> TCP port number</option> for the Z39.50/SRU server to listen on.</para>
       </listitem>
     </varlistentry>
 
     <varlistentry>
-      <term><option>--enable-sru</option></term>
+      <term><option>--template-cache-dir</option></term>
       <listitem>
-        <para>Enable the Z39.50/SRU server for the created instance.</para>
+        <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>--sru-port</option></term>
+      <term><option>--timezone</option></term>
       <listitem>
-        <para>Specifiy a <option> TCP port number</option> for the Z39.50/SRU server to listen on.</para>
+        <para>Specify a <option>timezone</option> for the created instance. e.g. America/Argentina</para>
       </listitem>
     </varlistentry>
 
     </varlistentry>
 
     <varlistentry>
+      <term><option>--tmp-path</option></term>
+      <listitem>
+        <para>Specify a <option>directory</option> for storing the temporary files. For example temporarily
+              uploaded files of the instance. It defaults to <filename>/var/lib/koha/instance/tmp</filename>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
       <term><option>--letsencrypt</option></term>
       <listitem>
         <para>Set up a https-only website with letsencrypt certificates</para>
       </varlistentry>
 
       <varlistentry>
-        <term><option>USE_MEMCACHED</option></term>
-        <listitem>
-          <para>Valid values are <option>yes</option> and <option>no</option>. If not present koha-create will default to <option>no</option>. Also, this will be overriden by the <option>--use-memcached</option> switch.</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>