debian/docs/koha-sitemap.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-sitemap</title>
   3 <info>
   4 <productname>Koha</productname> is the first free software library automation package.
   5 <author>
   6   <orgname>The Koha community</orgname>
   7   <uri>http://koha-community.org/</uri>
   8 </author>
   9 </info>
  10
  11 <refentry xml:id="koha-sitemap">
  12
  13   <refmeta>
  14     <refentrytitle>koha-sitemap</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-sitemap</refname>
  20     <refpurpose>Manage sitemaps for Koha instances.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-sitemap</command>
  27       <arg choice="req" rep="norepeat">
  28         <option>--enable</option>|
  29         <option>--disable</option>|
  30         <option>--generate</option>|
  31         <option>--help</option>|<option>-h</option>
  32         |<option>--quiet</option>|<option>-q</option>
  33       </arg>
  34       <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
  35     </cmdsynopsis>
  36   </refsynopsisdiv>
  37
  38   <refsect1><title>Options</title>
  39
  40   <variablelist>
  41
  42     <varlistentry>
  43       <term><option>--enable</option></term>
  44       <listitem>
  45         <para>Enable sitemap generation for the desired Koha instances.</para>
  46       </listitem>
  47     </varlistentry>
  48
  49     <varlistentry>
  50       <term><option>--disable</option></term>
  51       <listitem>
  52         <para>Disable sitemap generation for the desired Koha instances.</para>
  53       </listitem>
  54     </varlistentry>
  55
  56     <varlistentry>
  57       <term><option>--generate</option></term>
  58       <listitem>
  59         <para>Generate sitemap for the desired Koha instances.</para>
  60       </listitem>
  61     </varlistentry>
  62
  63     <varlistentry>
  64       <term><option>--quiet|-q</option></term>
  65       <listitem>
  66         <para>Make the script quiet about non existent instance names or missing directories. Useful when calling <command>koha-sitemap</command> from another scripts.</para>
  67       </listitem>
  68     </varlistentry>
  69
  70     <varlistentry>
  71       <term><option>--help|-h</option></term>
  72       <listitem>
  73         <para>Show usage information.</para>
  74       </listitem>
  75     </varlistentry>
  76
  77   </variablelist>
  78   </refsect1>
  79
  80   <refsect1><title>Description</title>
  81     <para>The <command>koha-sitemap</command> script lets you manage your Koha instances sitemaps.</para>
  82   </refsect1>
  83
  84   <refsect1><title>See also</title>
  85   <simplelist type="inline">
  86     <member><command>/etc/default/koha-common</command></member>
  87   </simplelist>
  88   </refsect1>
  89
  90 </refentry>
  91
  92 </article>