debian/docs/koha-shell.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2     <title>koha-shell</title>
   3     <info>
   4         <productname>Koha</productname> is the first free software library automation package.
   5         <author>
   6             <personname>
   7                 <firstname>Robin</firstname>
   8                 <surname>Sheat</surname>
   9             </personname>
  10             <affiliation>
  11                 <orgname>Catalyst IT</orgname>
  12                 <uri>http://www.catalyst.net.nz</uri>
  13             </affiliation>
  14             <contrib>Author</contrib>
  15         </author>
  16     </info>
  17
  18     <refentry xml:id="koha-shell">
  19
  20         <refmeta>
  21             <refentrytitle>koha-shell</refentrytitle>
  22             <manvolnum>8</manvolnum>
  23         </refmeta>
  24
  25         <refnamediv>
  26             <refname>koha-shell</refname>
  27             <refpurpose>Gives you a shell with the user and environment set to make it easy to do koha operations.</refpurpose>
  28             <refclass>UNIX/Linux</refclass>
  29         </refnamediv>
  30
  31         <refsynopsisdiv>
  32             <cmdsynopsis>
  33                 <command>koha-shell</command>
  34                 <arg><option>--command|-c</option> COMMAND</arg>
  35                 <arg><option>--help|-h</option></arg>
  36                 <arg><option>--login|-l</option></arg>
  37                 <arg><option>--preserve-environment|-p|-m</option></arg>
  38                 <arg><option>--shell|-s</option> SHELL</arg>
  39                 <arg><option>--verbose|-v</option></arg>
  40                 <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
  41             </cmdsynopsis>
  42         </refsynopsisdiv>
  43
  44         <refsect1><title>Options</title>
  45             <variablelist>
  46                 <varlistentry>
  47                     <term><option>--command</option></term>
  48                     <listitem>
  49                         <para>Run the specified command rather than launching a shell.</para>
  50                     </listitem>
  51                 </varlistentry>
  52                 <varlistentry>
  53                     <term><option>--help</option></term>
  54                     <listitem>
  55                         <para>Show a usage synopsis.</para>
  56                     </listitem>
  57                 </varlistentry>
  58                 <varlistentry>
  59                     <term><option>--login</option></term>
  60                     <listitem>
  61                         <para>Make the shell a login shell.</para>
  62                     </listitem>
  63                 </varlistentry>
  64                 <varlistentry>
  65                     <term><option>--preserve-environment</option></term>
  66                     <listitem>
  67                         <para>Preserve the current environment (note that if you run it through 'sudo', this may not work as you'd expect.)</para>
  68                     </listitem>
  69                 </varlistentry>
  70                 <varlistentry>
  71                     <term><option>--shell</option></term>
  72                     <listitem>
  73                         <para>Run the specified shell. The default is the shell of the current environment, followed by /bin/sh.</para>
  74                     </listitem>
  75                 </varlistentry>
  76                 <varlistentry>
  77                     <term><option>--verbose</option></term>
  78                     <listitem>
  79                         <para>Show the command that is going to be run.</para>
  80                     </listitem>
  81                 </varlistentry>
  82             </variablelist>
  83         </refsect1>
  84
  85         <refsect1><title>Description</title>
  86             <para>This launches a shell with the user and required environment variables set in such a way that running any Koha commands will
  87                 work correctly. With the use of '-c', it can be used to easily run commands in the correct environment.</para>
  88             <para>It behaves mostly as a wrapper for <command>su(1)</command>, so a deeper discussion of the options can be found in there.</para>
  89         </refsect1>
  90
  91         <refsect1>
  92             <title>Examples</title>
  93             <para>
  94                 To get a shell:
  95             </para>
  96             <para><command>$ sudo koha-shell library</command></para>
  97             <para>
  98                 To run a command:
  99             </para>
 100             <para><command>$ sudo koha-shell -c "/usr/share/koha/bin/migration_tools/bulkmarcimport.pl -b -file data.marc" library</command></para>
 101         </refsect1>
 102
 103         <refsect1><title>See also</title>
 104             <simplelist type="inline">
 105                 <member><command>koha-foreach(8)</command></member>
 106                 <member><command>su(1)</command></member>
 107             </simplelist>
 108         </refsect1>
 109
 110     </refentry>
 111
 112 </article>