Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Documentation in the web page now matches the help output (issue #70).

git-svn-id: http://svn.gridway.org/gridway/trunk@198 9b4b2aa8-92f0-458a-8103-c3834d721760
  • Loading branch information...
commit 12d7b793e8bae215e1e474ba776b4200a5346a62 1 parent 15c2c45
alorca authored
View
8 src/cmds/gw_acct.c
@@ -29,9 +29,9 @@
/* ------------------------------------------------------------------------- */
const char * usage =
-"\n gwacct [-h] [-nx] [<-d n | -w n | -m n | -t s>] <-u user|-r host>\n\n"
+"\n gwacct [-h] [-nx] [-d n|-w n|-m n|-t s] <-u user|-r host>\n\n"
"SYNOPSIS\n"
-" Print accounting information about users or hosts in the GridWay system\n\n"
+" Prints accounting information about users or hosts in the GridWay system\n\n"
"OPTIONS\n"
" -h print this help\n"
" -n do not print the header lines\n"
@@ -40,7 +40,7 @@ const char * usage =
" -w n print accounting information from n weeks ago (ex: -w 1)\n"
" -m n print accounting information from n months ago (ex: -m 1)\n"
" -t s print accounting information from s seconds, where s is an\n"
-" epoch (ex: -t 1159809792)\n"
+" epoch (i.e. -t 1159809792)\n"
" -u user print accounting information for user\n\n"
" -r host print accounting information for host\n"
"FIELD INFORMATION\n"
@@ -62,7 +62,7 @@ const char * usage =
const char * susage =
-"usage: gwacct [-h] [-nx] [<-d n | -w n | -m n | -t s>] <-u user|-r host>\n";
+"usage: gwacct [-h] [-nx] [-d n|-w n|-m n|-t s] <-u user|-r host>\n";
extern char *optarg;
extern int optind, opterr, optopt;
View
8 src/cmds/gw_dagman.rb
@@ -37,12 +37,16 @@
options={}
parser=OptionParser.new do |opts|
- opts.banner="Usage: #{File.basename(__FILE__)} [options] <dagman file>"
+ opts.banner="Usage: #{File.basename(__FILE__)} [-h] [-d] <dagman file>"
opts.separator ""
- opts.on('-d', '--dot', "Generate DOT file. it is written to STDOUT.") do |d|
+ opts.on('-d', '--dot', "Generate DOT file. It is written to STDOUT") do |d|
options[:dot]=d
end
+ opts.on_tail('-h', '--help', "Print this help") do
+ puts opts
+ exit
+ end
end
begin
View
4 src/cmds/gw_history.c
@@ -29,7 +29,7 @@
/* ------------------------------------------------------------------------- */
const char * usage =
-"\n gwhistory [-h] [-nx] <job_id>\n\n"
+"USAGE\n gwhistory [-h] [-nx] <job_id>\n\n"
"SYNOPSIS\n"
" Prints information about the execution history of a job\n\n"
"OPTIONS\n"
@@ -38,7 +38,7 @@ const char * usage =
" -x xml format\n"
" job_id job identification as provided by gwps\n\n"
"FIELD INFORMATION\n"
-" HID host unique identification assigned by the Gridway system\n"
+" HID host unique identification assigned by the GridWay system\n"
" START the time the job start its execution on this host\n"
" END the time the job left this host, because it finished or it\n"
" was migrated\n"
View
6 src/cmds/gw_host.c
@@ -30,16 +30,16 @@
/* ------------------------------------------------------------------------- */
const char * usage =
-"\n gwhost [-h] [-c delay] [-nfx] [-m job_id] [host_id]\n\n"
+"USAGE\n gwhost [-h] [-c delay] [-nfx] [-m job_id] [host_id]\n\n"
"SYNOPSIS\n"
" Prints information about all the hosts in the GridWay system (default)\n\n"
"OPTIONS\n"
" -h print this help\n"
-" -c <delay> refresh host information every <delay> seconds\n"
+" -c delay refresh host information every delay seconds\n"
" -n do not print the header\n"
" -f full format\n"
" -x xml format\n"
-" -m <job_id> print hosts matching the requirements of a given job\n"
+" -m job_id print hosts matching the requirements of a given job\n"
" host_id only monitor this host_id, printing also queue information\n\n"
"FIELD INFORMATION\n"
" HID host unique identification assigned by the GridWay system\n"
View
7 src/cmds/gw_kill.c
@@ -29,7 +29,7 @@
/* ------------------------------------------------------------------------- */
const char * usage =
-"\n gwkill [-h] [-a] [-k | -t | -o | -s | -r | -l | -9] <job_id | -A array_id>\n\n"
+"USAGE\n gwkill [-h] [-a] [-k|-t|-o|-s|-r|-l|-9] <job_id [job_id2 ...]|-A array_id>\n\n"
"SYNOPSIS\n"
" Sends a signal to a job\n\n"
"OPTIONS\n"
@@ -41,8 +41,9 @@ const char * usage =
" -o hold\n"
" -l release\n"
" -s re-schedule\n"
-" -9 hard kill\n"
-" job_id job identification as provided by gwps\n"
+" -9 hard kill, removes the job from the system without synchronizing"
+" remote job execution or cleaning remote host\n"
+" job_id [job_id2 ...] job identification as provided by gwps\n"
" -A <array_id> array identification as provided by gwps\n";
const char * susage =
View
4 src/cmds/gw_ps.c
@@ -29,7 +29,7 @@
/* ------------------------------------------------------------------------- */
const char * usage =
-"\n gwps [-h] [-u user] [-r host] [-A AID] [-s job_state] [-o output_format] [-c delay] [-nfx] [job_id]\n\n"
+"USAGE\n gwps [-h] [-u user] [-r host] [-A AID] [-s job_state] [-o output_format] [-c delay] [-nfx] [job_id]\n\n"
"SYNOPSIS\n"
" Prints information about all the jobs in the GridWay system (default)\n\n"
"OPTIONS\n"
@@ -39,7 +39,7 @@ const char * usage =
" -A AID monitor only jobs part of the array AID\n"
" -s job_state monitor only jobs in state job_state (see JOB STATES)\n"
" -o output_format define output information (see FIELD INFORMATION)\n"
-" -c <delay> refresh job information every <delay> seconds\n"
+" -c delay refresh job information every delay seconds\n"
" -n do not print the header\n"
" -f full format\n"
" -x xml format\n"
View
18 src/cmds/gw_submit.c
@@ -28,24 +28,24 @@
/* ------------------------------------------------------------------------- */
const char * usage =
-"\n gwsubmit <[-t] template> [-n tasks] [-h] [-v] [-o] [-d \"id1 id2 ...\"] [-p priotity]\n\n"
+"USAGE\n gwsubmit [-h] [-v] [-o] [-d \"id1 id2 ...\"] [-p priotity] [-n tasks [-s start] [-i increment]] <[-t] template>\n\n"
"SYNOPSIS\n"
" Submits a job or an array job (if the number of tasks is defined) to gwd\n\n"
"OPTIONS\n"
" -h print this help\n"
-" [-t] <template> the template file describing the job\n"
+" -v print to stdout the job ids returned by gwd\n"
+" -o hold job on submission\n"
+" -d \"id1 id2 ...\" job dependencies. Submit the job on hold state, and\n"
+" release it once the jobs with id1, id2, ... have finished\n"
+" -p <priority> initial priority for the job\n"
" -n <tasks> submit an array job with the given number of tasks\n"
" all the jobs in the array will use the same template\n"
-" -v print to stdout the job ids returned by gwd\n"
-" -o hold job on submission\n"
-" -d \"id1 id2...\" job dependencies. Submit the job on hold state, and\n"
-" release it once jobs with id1,id2,.. have finished\n"
" -s <start> start value for custom param in array jobs. Default 0\n"
" -i <increment> increment value for custom param in array jobs.\n"
" Each task has associated the value\n"
-" PARAM=<start> + <increment> * TASK_ID, and\n"
-" MAX_PARM = <start>+<increment>*(<tasks>-1). Default 1\n"
-" -p <priority> initial priority for the job\n\n";
+" PARAM = <start> + <increment> * TASK_ID, and\n"
+" MAX_PARM = <start> + <increment> * (<tasks> - 1). Default 1\n"
+" -t <template> template file describing the job\n\n";
const char * susage =
"usage: gwsubmit <[-t] template> [-n tasks] [-h] [-v] [-o] [-d \"id1 id2 ...\"] [-p priotity]\n";
View
8 src/cmds/gw_user.c
@@ -29,15 +29,15 @@
/* ------------------------------------------------------------------------- */
const char * usage =
-"\n gwuser [-h] [-nx]\n\n"
+"USAGE\n gwuser [-h] [-nx]\n\n"
"SYNOPSIS\n"
" Prints information about users in the GridWay system\n\n"
"OPTIONS\n"
" -h print this help\n"
-" -n do not print the header lines\n\n"
-" -x xml format\n"
+" -n do not print the header lines\n"
+" -x xml format\n\n"
"FIELD INFORMATION\n"
-" UID user unique identification assigned by the Gridway system\n"
+" UID user unique identification assigned by the GridWay system\n"
" NAME name of this user\n"
" JOBS number of Jobs in the GridWay system\n"
" RUN number of running jobs\n"
View
13 src/cmds/gw_wait.c
@@ -29,20 +29,21 @@
/* ------------------------------------------------------------------------- */
const char * usage =
-"\n gwwait [-h] [-a] [-v] [-k] [-t timeout] <job_id ...| -A array_id>\n\n"
+"USAGE\n gwwait [-h] [-a] [-v] [-k] [-t timeout] <job_id [job_id2 ...]|-A array_id>\n\n"
"SYNOPSIS\n"
" Waits for a job\n\n"
"OPTIONS\n"
" -h print this help\n"
-" -a any, returns when the first job of the list or array finishes\n"
+" -a any. Return when the first job of the list or array finishes\n"
" -v print job exit code\n"
-" -t <timeout> do not wait more than <timeout> seconds. A negative value\n"
-" means waiting for ever (default)\n"
" -k keep jobs. They remain in fail or done states in the\n"
" GridWay system.\n"
" By default, jobs are killed and their resources freed\n"
-" -A <array_id> array identification as provided by gwps\n"
-" job_id ... list of job ids as provided by gwps\n";
+" -t timeout do not wait more than timeout seconds. A negative value\n"
+" means waiting for ever (default)\n"
+" By default, jobs are killed and their resources freed\n"
+" job_id [job_id2 ...] job identification or list of jobs ids as provided by gwps\n"
+" -A array_id array identification as provided by gwps\n";
const char * susage =
View
11 src/cmds/jsdl2gw.sh
@@ -23,15 +23,20 @@ if [ -z "${GW_LOCATION}" ]; then
fi
if [ "x$1" = "x-h" ]; then
- echo "jsdl2gw [-h] input_jsdl [output_gwjt]"
+ echo "USAGE"
+ echo " jsdl2gw [-h] input_jsdl [output_gwjt]"
echo
echo "SYNOPSIS"
- echo " Converts a jsdl document into a gridway job template"
- echo " If no output file is defined, it defaults to the standard output"
+ echo " Converts a jsdl document into a GridWay job template."
+ echo " If no output file is defined, it defaults to the standard output."
echo " This enables the use of pipes with gwsubmit in the following fashion:"
echo
echo " jsdl2gw jsdl-job.xml | gwsubmit"
echo
+ echo "OPTIONS"
+ echo " -h print this help"
+ echo " input_jsdl read the jsdl document from the input_jsdl"
+ echo " output_gwjt store the GridWay Job Template specification in the output_gwjt.jt file"
exit 0
fi
Please sign in to comment.
Something went wrong with that request. Please try again.