doc/src/docbook/appendix/jobagent.sh.xml

Code
Comments
Other
Rev Date Author Line
3334 14 May 07 nicklas 1 <?xml version="1.0" encoding="UTF-8"?>
3334 14 May 07 nicklas 2 <!DOCTYPE appendix PUBLIC 
3334 14 May 07 nicklas 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3334 14 May 07 nicklas 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3334 14 May 07 nicklas 5 <!--
3334 14 May 07 nicklas 6   $Id$
3334 14 May 07 nicklas 7   
4889 06 Apr 09 nicklas 8   Copyright (C) 2007 Jari Häkkinen, Peter Johansson, Nicklas Nordborg
3334 14 May 07 nicklas 9   
3334 14 May 07 nicklas 10   This file is part of BASE - BioArray Software Environment.
3334 14 May 07 nicklas 11   Available at http://base.thep.lu.se/
3334 14 May 07 nicklas 12   
3334 14 May 07 nicklas 13   BASE is free software; you can redistribute it and/or
3334 14 May 07 nicklas 14   modify it under the terms of the GNU General Public License
4477 05 Sep 08 jari 15   as published by the Free Software Foundation; either version 3
3334 14 May 07 nicklas 16   of the License, or (at your option) any later version.
3334 14 May 07 nicklas 17   
3334 14 May 07 nicklas 18   BASE is distributed in the hope that it will be useful,
3334 14 May 07 nicklas 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
3334 14 May 07 nicklas 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3334 14 May 07 nicklas 21   GNU General Public License for more details.
3334 14 May 07 nicklas 22   
3334 14 May 07 nicklas 23   You should have received a copy of the GNU General Public License
4509 11 Sep 08 jari 24   along with BASE. If not, see <http://www.gnu.org/licenses/>.
3334 14 May 07 nicklas 25 -->
3334 14 May 07 nicklas 26
3334 14 May 07 nicklas 27 <appendix id="appendix.jobagent.sh">
5782 04 Oct 11 nicklas 28   <?dbhtml filename="jobagent.sh.html" ?>
3334 14 May 07 nicklas 29   <title>jobagent.sh reference</title>
3334 14 May 07 nicklas 30
3334 14 May 07 nicklas 31   <para>
3376 24 May 07 nicklas 32     The <filename>jobagent.sh</filename> (or <filename>jobagent.bat</filename> on
3411 30 May 07 jari 33     Windows) is a command-line utility for controlling the job agent. 
3376 24 May 07 nicklas 34     The syntax is:
3376 24 May 07 nicklas 35
3376 24 May 07 nicklas 36     <informalexample>
3376 24 May 07 nicklas 37     <programlisting>
3376 24 May 07 nicklas 38 ./jobagent.sh [options] command
3376 24 May 07 nicklas 39 </programlisting>
3376 24 May 07 nicklas 40     </informalexample>
3376 24 May 07 nicklas 41
3376 24 May 07 nicklas 42     The options are optional, but a <command>command</command>
3376 24 May 07 nicklas 43     must always be given. The script is located in the 
3411 30 May 07 jari 44     <filename>&lt;base-dir&gt;/bin</filename> directory and you must
3376 24 May 07 nicklas 45     change to that directory to be able to use the script.
3334 14 May 07 nicklas 46   </para>
3334 14 May 07 nicklas 47
3376 24 May 07 nicklas 48
3376 24 May 07 nicklas 49   <simplesect id="appendix.jobagent.sh.options">
3376 24 May 07 nicklas 50     <title>Options</title>
3376 24 May 07 nicklas 51     
3376 24 May 07 nicklas 52     <variablelist>
3376 24 May 07 nicklas 53     <varlistentry>
3376 24 May 07 nicklas 54       <term><option>-c</option></term>
3376 24 May 07 nicklas 55       <listitem>
3376 24 May 07 nicklas 56         <para>
3376 24 May 07 nicklas 57           The path to the configuration file to use, for example:
3376 24 May 07 nicklas 58           
3376 24 May 07 nicklas 59           <informalexample>
3376 24 May 07 nicklas 60           <programlisting>
3376 24 May 07 nicklas 61 ./jobagent.sh -c other.config start
3376 24 May 07 nicklas 62 </programlisting>
3376 24 May 07 nicklas 63           </informalexample>
3376 24 May 07 nicklas 64           
3376 24 May 07 nicklas 65           The default  value is <filename>jobagent.properties</filename>.
3992 22 Nov 07 nicklas 66           The classpath is not searched which means that it doesn't find
3992 22 Nov 07 nicklas 67           the configuration file in <filename>&lt;base-dir&gt;/www/WEB-INF/classes/</filename>
3992 22 Nov 07 nicklas 68           unless you specify the path to it.
3376 24 May 07 nicklas 69           See <xref linkend="appendix.jobagent.properties" /> 
3376 24 May 07 nicklas 70           for more information about job agent configuration files.
3376 24 May 07 nicklas 71         </para>
3376 24 May 07 nicklas 72       </listitem>
3376 24 May 07 nicklas 73     </varlistentry>
3376 24 May 07 nicklas 74     </variablelist>
3376 24 May 07 nicklas 75     </simplesect>
3376 24 May 07 nicklas 76
3376 24 May 07 nicklas 77   <simplesect id="appendix.jobagent.sh.commands">
3376 24 May 07 nicklas 78     <title>Commands</title>
3376 24 May 07 nicklas 79     
3376 24 May 07 nicklas 80     <variablelist>
3376 24 May 07 nicklas 81     <varlistentry>
3376 24 May 07 nicklas 82       <term><command>register</command></term>
3376 24 May 07 nicklas 83       <listitem>
3376 24 May 07 nicklas 84         <para>
3376 24 May 07 nicklas 85           Register the job agent with the BASE server. 
3376 24 May 07 nicklas 86           If the job agent already exists this command does nothing.
3376 24 May 07 nicklas 87         </para>
3376 24 May 07 nicklas 88       </listitem>
3376 24 May 07 nicklas 89     </varlistentry>
3376 24 May 07 nicklas 90
3376 24 May 07 nicklas 91     <varlistentry>
3376 24 May 07 nicklas 92       <term><command>unregister</command></term>
3376 24 May 07 nicklas 93       <listitem>
3376 24 May 07 nicklas 94         <para>
3376 24 May 07 nicklas 95           Unregister/delete the job agent from the BASE server. If the 
3487 13 Jun 07 peter 96           job agent does not exist this command does nothing.
3376 24 May 07 nicklas 97         </para>
3376 24 May 07 nicklas 98       </listitem>
3376 24 May 07 nicklas 99     </varlistentry>
3376 24 May 07 nicklas 100
3376 24 May 07 nicklas 101     <varlistentry>
3376 24 May 07 nicklas 102       <term><command>start</command></term>
3376 24 May 07 nicklas 103       <listitem>
3376 24 May 07 nicklas 104         <para>
3376 24 May 07 nicklas 105           Start the job agent. As soon as it is up and running it will 
3411 30 May 07 jari 106           check the database for jobs that are waiting to be executed.
3376 24 May 07 nicklas 107         </para>
3376 24 May 07 nicklas 108       </listitem>
3376 24 May 07 nicklas 109     </varlistentry>
3376 24 May 07 nicklas 110     
3376 24 May 07 nicklas 111     <varlistentry>
3376 24 May 07 nicklas 112       <term><command>pause</command></term>
3376 24 May 07 nicklas 113       <listitem>
3376 24 May 07 nicklas 114         <para>
3376 24 May 07 nicklas 115           Pause the job agent. The job agent will continue running but 
3487 13 Jun 07 peter 116           does not check the database for jobs. To start it again use the 
3376 24 May 07 nicklas 117           <command>start</command> command.    
3376 24 May 07 nicklas 118         </para>
3376 24 May 07 nicklas 119       </listitem>
3376 24 May 07 nicklas 120     </varlistentry>
3376 24 May 07 nicklas 121
3376 24 May 07 nicklas 122     <varlistentry>
3376 24 May 07 nicklas 123       <term><command>stop</command></term>
3376 24 May 07 nicklas 124       <listitem>
3376 24 May 07 nicklas 125         <para>
3376 24 May 07 nicklas 126           Stop the job agent. To start it again use the <command>start</command>
3376 24 May 07 nicklas 127           command.    
3376 24 May 07 nicklas 128         </para>
3376 24 May 07 nicklas 129       </listitem>
3376 24 May 07 nicklas 130     </varlistentry>
3376 24 May 07 nicklas 131
3376 24 May 07 nicklas 132     <varlistentry>
3376 24 May 07 nicklas 133       <term><command>info</command></term>
3376 24 May 07 nicklas 134       <listitem>
3376 24 May 07 nicklas 135         <para>
3376 24 May 07 nicklas 136           Get information about the job agent. This will output a string
3376 24 May 07 nicklas 137           in the form:
3376 24 May 07 nicklas 138           <computeroutput>
3376 24 May 07 nicklas 139           <literallayout>
3376 24 May 07 nicklas 140 Status:Running
5678 29 Jun 11 nicklas 141 Cpu:15
5678 29 Jun 11 nicklas 142 Total memory:8254955520
5678 29 Jun 11 nicklas 143 Used memory:8002252800
5678 29 Jun 11 nicklas 144 Job:42
5678 29 Jun 11 nicklas 145 Job.42.slot:SHORT
3376 24 May 07 nicklas 146 </literallayout>
3376 24 May 07 nicklas 147 </computeroutput>
3376 24 May 07 nicklas 148           <emphasis>Status</emphasis> can be either <constant>Running</constant>
5678 29 Jun 11 nicklas 149           or <constant>Paused</constant>. There is some information about the
5678 29 Jun 11 nicklas 150           current CPU and memory usage, but this information may not be available on
5678 29 Jun 11 nicklas 151           all platforms. For each job that is currently running, the ID is given. A
5678 29 Jun 11 nicklas 152           second entry gives information about the slot the job uses for execution.
5678 29 Jun 11 nicklas 153           In the future, the <command>info</command> command may output more information.
3376 24 May 07 nicklas 154         </para>
3376 24 May 07 nicklas 155       </listitem>
3376 24 May 07 nicklas 156     </varlistentry>
3992 22 Nov 07 nicklas 157     
3992 22 Nov 07 nicklas 158     <varlistentry>
3992 22 Nov 07 nicklas 159       <term><command>status</command></term>
3992 22 Nov 07 nicklas 160       <listitem>
3992 22 Nov 07 nicklas 161         <para>
3992 22 Nov 07 nicklas 162           Similar to the <command>info</command> command but with less output.
3992 22 Nov 07 nicklas 163           The output is either <computeroutput>Running, Pauses or Stopped</computeroutput>.
3992 22 Nov 07 nicklas 164           In case of an unexpected error, an error message may be displayed instead.
3992 22 Nov 07 nicklas 165         </para>
3992 22 Nov 07 nicklas 166       </listitem>
3992 22 Nov 07 nicklas 167     </varlistentry>
3376 24 May 07 nicklas 168
3376 24 May 07 nicklas 169     <varlistentry>
3376 24 May 07 nicklas 170       <term><command>help</command></term>
3376 24 May 07 nicklas 171       <listitem>
3376 24 May 07 nicklas 172         <para>
3376 24 May 07 nicklas 173           Display usage information.    
3376 24 May 07 nicklas 174         </para>
3376 24 May 07 nicklas 175       </listitem>
3376 24 May 07 nicklas 176     </varlistentry>
3376 24 May 07 nicklas 177
3376 24 May 07 nicklas 178     </variablelist>
3376 24 May 07 nicklas 179     </simplesect>
3376 24 May 07 nicklas 180
3334 14 May 07 nicklas 181 </appendix>
3334 14 May 07 nicklas 182

Generated on Sat Oct  7 02:27:12 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)