source: trunk/doc/src/docbook/appendix/jobagent.sh.xml

Last change on this file was 5782, checked in by Nicklas Nordborg, 10 years ago

References #1590: Documentation cleanup

Restructured documentation to generate shorter filenames.

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