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

Last change on this file since 3376 was 3376, checked in by Nicklas Nordborg, 14 years ago

References #601

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 4.6 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 3376 2007-05-24 19:50:53Z nicklas $
7 
8  Copyright (C) Authors contributing to this file.
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 2
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 this program; if not, write to the Free Software
25  Foundation, Inc., 59 Temple Place - Suite 330,
26  Boston, MA  02111-1307, USA.
27-->
28
29<appendix id="appendix.jobagent.sh">
30  <title>jobagent.sh reference</title>
31
32  <para>
33    The <filename>jobagent.sh</filename> (or <filename>jobagent.bat</filename> on
34    Windows) is a command-line utitlity for controlling the job agent.
35    The syntax is:
36
37    <informalexample>
38    <programlisting>
39./jobagent.sh [options] command
40</programlisting>
41    </informalexample>
42
43    The options are optional, but a <command>command</command>
44    must always be given. The script is located in the
45    <filename>&lt;base-dir&gt;/bin</filename> diretory and you must
46    change to that directory to be able to use the script.
47  </para>
48
49
50  <simplesect id="appendix.jobagent.sh.options">
51    <title>Options</title>
52   
53    <variablelist>
54    <varlistentry>
55      <term><option>-c</option></term>
56      <listitem>
57        <para>
58          The path to the configuration file to use, for example:
59         
60          <informalexample>
61          <programlisting>
62./jobagent.sh -c other.config start
63</programlisting>
64          </informalexample>
65         
66          The default value is <filename>jobagent.properties</filename>.
67          See <xref linkend="appendix.jobagent.properties" /> 
68          for more information about job agent configuration files.
69        </para>
70      </listitem>
71    </varlistentry>
72    </variablelist>
73    </simplesect>
74
75  <simplesect id="appendix.jobagent.sh.commands">
76    <title>Commands</title>
77   
78    <variablelist>
79    <varlistentry>
80      <term><command>register</command></term>
81      <listitem>
82        <para>
83          Register the job agent with the BASE server.
84          If the job agent already exists this command does nothing.
85        </para>
86      </listitem>
87    </varlistentry>
88
89    <varlistentry>
90      <term><command>unregister</command></term>
91      <listitem>
92        <para>
93          Unregister/delete the job agent from the BASE server. If the
94          job agent doesn't exist this command does nothing.
95        </para>
96      </listitem>
97    </varlistentry>
98
99    <varlistentry>
100      <term><command>start</command></term>
101      <listitem>
102        <para>
103          Start the job agent. As soon as it is up and running it will
104          check the datbase for jobs that are waiting to be executed.
105        </para>
106      </listitem>
107    </varlistentry>
108   
109    <varlistentry>
110      <term><command>pause</command></term>
111      <listitem>
112        <para>
113          Pause the job agent. The job agent will continue running but
114          doesn't check the database for jobs. To start it again use the
115          <command>start</command> command.   
116        </para>
117      </listitem>
118    </varlistentry>
119
120    <varlistentry>
121      <term><command>stop</command></term>
122      <listitem>
123        <para>
124          Stop the job agent. To start it again use the <command>start</command>
125          command.   
126        </para>
127      </listitem>
128    </varlistentry>
129
130    <varlistentry>
131      <term><command>info</command></term>
132      <listitem>
133        <para>
134          Get information about the job agent. This will output a string
135          in the form:
136          <computeroutput>
137          <literallayout>
138Status:Running
139Job:1
140Job:5
141</literallayout>
142</computeroutput>
143          <emphasis>Status</emphasis> can be either <constant>Running</constant>
144          or <constant>Paused</constant>. For each job that is currently
145          running, the ID is given. In the future, the <command>info</command>
146          command may output more information. For example, there is already
147          infrastructure code for cpu and memory usage. The only problem is
148          that the information isn't easy to get for a Java program.
149        </para>
150      </listitem>
151    </varlistentry>
152
153    <varlistentry>
154      <term><command>help</command></term>
155      <listitem>
156        <para>
157          Display usage information.   
158        </para>
159      </listitem>
160    </varlistentry>
161
162    </variablelist>
163    </simplesect>
164
165</appendix>
166
Note: See TracBrowser for help on using the repository browser.