source: trunk/doc/admin/jobagent.sh.html @ 3675

Last change on this file since 3675 was 3675, checked in by Jari Häkkinen, 15 years ago

Fixing copyright statements. Fixing svn properties.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 3.3 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
3<!--
4    $Id: jobagent.sh.html 3675 2007-08-16 14:16:43Z jari $
5
6    Copyright (C) 2006 Nicklas Nordborg
7
8    This file is part of BASE - BioArray Software Environment.
9    Available at http://base.thep.lu.se/
10
11    BASE is free software; you can redistribute it and/or modify it
12    under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 2 of the License, or
14    (at your option) any later version.
15
16    BASE is distributed in the hope that it will be useful, but
17    WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19    General Public License for more details.
20
21    You should have received a copy of the GNU General Public License
22    along with this program; if not, write to the Free Software
23    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24    02111-1307, USA.
25-->
26
27<html>
28  <head>
29    <title>BASE 2.0 - Administrator documentation: jobagent.sh reference</title>
30  <link rel=stylesheet type="text/css" href="../styles.css">
31  </head>
32<body>
33
34<div class="navigation">
35  <a href="../index.html">BASE</a>
36  <img src="../next.gif">
37  <a href="index.html">Administrator documentation</a>
38  <img src="../next.gif">
39  jobagent.sh reference
40</div>
41
42<h1>BASE 2.0 - Administrator documentation: jobagent.sh reference</h1>
43
44<div class="abstract">
45
46  <p>
47  This document describes how to use the jobagent.sh command line
48  interface for controlling the job agent.
49  </p>
50
51  <p class="authors">
52  <b>Last updated:</b> $Date: 2007-08-16 14:16:43 +0000 (Thu, 16 Aug 2007) $<br>
53  <b>Copyright &copy;</b> 2006 The respective authors. All rights reserved.
54  </p>
55
56</div>
57
58  <p>
59  The general syntax is:
60  </p>
61
62  <pre class="code">
63./jobagent.sh [options] command
64</pre>
65
66  <p>
67    All options are optional, but a command must be specified.
68  </p>
69
70  <h2>Options</h2>
71 
72  <table border="1" cellspacing="0" cellpadding="2" width="100%"> 
73  <tr>
74    <th>Option</th>
75    <th>Default value</th>
76    <th>Description</th>
77  </tr>
78 
79  <tr>
80    <td>-c</td>
81    <td>jobagent.properties</td>
82    <td>
83   
84    Which configuration file to use for the job agent. For example:
85    <pre class="code">
86./jobagent.sh -c other.config start
87</pre>
88    </td>
89  </tr>
90  </table>
91
92  <h2>Commands</h2>
93
94  <table border="1" cellspacing="0" cellpadding="2" width="100%"> 
95  <tr>
96    <th>Command</th>
97    <th>Description</th>
98  </tr>
99 
100  <tr>
101    <td>register</td>
102    <td>
103      Register the job agent with the BASE server. If the job agent
104      already exists this command does nothing.
105    </td>
106  </tr>
107
108  <tr>
109    <td>unregister</td>
110    <td>
111      Unregister/delete the job agent from the BASE server. If the job agent
112      doesn't exist this command does nothing.
113    </td>
114  </tr>
115 
116  <tr>
117    <td>start</td>
118    <td>
119      Start the job agent. It will now check the datbase for jobs that
120      are waiting to be executed.
121    </td>
122  </tr>
123
124  <tr>
125    <td>pause</td>
126    <td>
127      Pause the job agent. The job agent will continue running but doesn't check
128      the database for jobs. To start it again use the <code>start</code> command.
129    </td>
130  </tr>
131
132  <tr>
133    <td>stop</td>
134    <td>
135      Stop the job agent. To start it again use the <code>start</code> command.
136    </td>
137  </tr>
138
139  <tr>
140    <td>info</td>
141    <td>
142      Get information about the job agent.
143    </td>
144  </tr>
145 
146  <tr>
147    <td>help</td>
148    <td>
149      Display usage information.
150    </td>
151  </tr>
152  </table>
153
154</body>
155</html>
Note: See TracBrowser for help on using the repository browser.