New syntax explanation grammatically consistent (issue #70)

git-svn-id: http://svn.gridway.org/gridway/trunk@196 9b4b2aa8-92f0-458a-8103-c3834d721760
oldpatricka · Dec 9, 2009 · 3fcbe7e · 3fcbe7e
1 parent d8dd722
commit 3fcbe7e
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 54 deletions.
diff --git a/src/cmds/gw_acct.c b/src/cmds/gw_acct.c
@@ -1,5 +1,5 @@
 /* -------------------------------------------------------------------------- */
-/* Copyright 2002-2006 GridWay Team, Distributed Systems Architecture         */
+/* Copyright 2002-2009 GridWay Team, Distributed Systems Architecture         */
 /* Group, Universidad Complutense de Madrid                                   */
 /*                                                                            */
 /* Licensed under the Apache License, Version 2.0 (the "License"); you may    */
@@ -31,18 +31,18 @@
 const char * usage =
 "\n gwacct [-h] [-nx] [<-d n | -w n | -m n | -t s>] <-u user|-r host>\n\n"
 "SYNOPSIS\n"
-"  Prints accounting information about users or hosts in the GridWay system\n\n"
+"  Print accounting information about users or hosts in the GridWay system\n\n"
 "OPTIONS\n"
-"  -h        prints this help\n"
+"  -h        print this help\n"
 "  -n        do not print the header lines\n"
 "  -x        xml format\n"
 "  -d n      print accounting information from n days ago  (ex: -d 1)\n"
 "  -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"
+"  -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"
-"  -r host   print accounting information for host\n"
 "  -u user   print accounting information for user\n\n"
+"  -r host   print accounting information for host\n"
 "FIELD INFORMATION\n"
 "  HOST/USER host/user usage summary for this user/host\n"
 "  XFR       total transfer time on this host (for this user)\n"
@@ -104,7 +104,7 @@ int main(int argc, char **argv)
     opterr = 0;
     optind = 1;
 
-    while((opt = getopt(argc,argv,":nxh:u:r:d:w:m:t:"))!= -1)
+    while((opt = getopt(argc,argv,":hnxu:r:d:w:m:t:"))!= -1)
         switch(opt)
         {
             case 'n': n  = 1;

diff --git a/src/cmds/gw_history.c b/src/cmds/gw_history.c
@@ -1,5 +1,5 @@
 /* -------------------------------------------------------------------------- */
-/* Copyright 2002-2006 GridWay Team, Distributed Systems Architecture         */
+/* Copyright 2002-2009 GridWay Team, Distributed Systems Architecture         */
 /* Group, Universidad Complutense de Madrid                                   */
 /*                                                                            */
 /* Licensed under the Apache License, Version 2.0 (the "License"); you may    */
@@ -33,22 +33,22 @@ const char * usage =
 "SYNOPSIS\n"
 "  Prints information about the execution history of a job\n\n"
 "OPTIONS\n"
-"  -h        prints this help.\n"
-"  -n        do not print the header lines.\n"
-"  -x        xml format.\n"
-"  job_id    job identification as provided by gwps.\n\n"
+"  -h        print this help\n"
+"  -n        do not print the header lines\n"
+"  -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"
-"  START     the time the job start its execution on this host.\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"
-"  PROLOG    total prolog (file stage-in phase) time.\n"
-"  WRAPPER   total wrapper (execution phase) time.\n"
-"  EPILOG    total epilog (file stage-out phase) time.\n"
-"  MIGR      total migration time.\n"
-"  REASON    the reason why the job left this host.\n"
-"  QUEUE     name of the queue.\n"
-"  HOST      FQDN/LRMS of the resource.\n";
+"            was migrated\n"
+"  PROLOG    total prolog (file stage-in phase) time\n"
+"  WRAPPER   total wrapper (execution phase) time\n"
+"  EPILOG    total epilog (file stage-out phase) time\n"
+"  MIGR      total migration time\n"
+"  REASON    the reason why the job left this host\n"
+"  QUEUE     name of the queue\n"
+"  HOST      FQDN/LRMS of the resource\n";
 
 const char * susage =
 "usage: gwhistory [-h] [-nx] <job_id>\n";

diff --git a/src/cmds/gw_host.c b/src/cmds/gw_host.c
@@ -1,5 +1,5 @@
 /* -------------------------------------------------------------------------- */
-/* Copyright 2002-2006 GridWay Team, Distributed Systems Architecture         */
+/* Copyright 2002-2009 GridWay Team, Distributed Systems Architecture         */
 /* Group, Universidad Complutense de Madrid                                   */
 /*                                                                            */
 /* Licensed under the Apache License, Version 2.0 (the "License"); you may    */
@@ -34,16 +34,15 @@ const char * usage =
 "SYNOPSIS\n"
 "  Prints information about all the hosts in the GridWay system (default)\n\n"
 "OPTIONS\n"
-"  -h           prints this help\n"
-"  -c <delay>   this will cause gwhost to print job information every <delay>\n"
-"               seconds continuously (similar to top command)\n"
+"  -h           print this help\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>  prints hosts matching the requirements of a given job\n"
-"  host_id      only monitor this host_id, also prints queue information\n\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"
+"  HID          host unique identification assigned by the GridWay system\n"
 "  PRIO         priority assigned to the host\n"
 "  OS           operating system\n"
 "  ARCH         architecture\n"

diff --git a/src/cmds/gw_kill.c b/src/cmds/gw_kill.c
@@ -1,5 +1,5 @@
 /* -------------------------------------------------------------------------- */
-/* Copyright 2002-2006 GridWay Team, Distributed Systems Architecture         */
+/* Copyright 2002-2009 GridWay Team, Distributed Systems Architecture         */
 /* Group, Universidad Complutense de Madrid                                   */
 /*                                                                            */
 /* Licensed under the Apache License, Version 2.0 (the "License"); you may    */
@@ -33,17 +33,17 @@ const char * usage =
 "SYNOPSIS\n"
 "  Sends a signal to a job\n\n"
 "OPTIONS\n"
-"  -h            prints this help.\n"
-"  -a            asynchronous signal, only relevant for KILL and STOP.\n"
+"  -h            print this help\n"
+"  -a            asynchronous signal, only relevant for KILL and STOP\n"
 "  -k            kill (default, if no signal specified)\n"
 "  -t            stop\n"
 "  -r            resume\n"
 "  -o            hold\n"
 "  -l            release\n"
 "  -s            re-schedule\n"
 "  -9            hard kill\n"
-"  job_id        job identification as provided by gwps.\n"
-" -A <array_id>  array identification as provided by gwps.\n";
+"  job_id        job identification as provided by gwps\n"
+" -A <array_id>  array identification as provided by gwps\n";
 
 const char * susage =
 "usage: gwkill [-h] [-a] [-k | -t | -o | -s | -r | -l | -9] <job_id | -A array_id>\n";

diff --git a/src/cmds/gw_ps.c b/src/cmds/gw_ps.c
@@ -1,5 +1,5 @@
 /* -------------------------------------------------------------------------- */
-/* Copyright 2002-2006 GridWay Team, Distributed Systems Architecture         */
+/* Copyright 2002-2009 GridWay Team, Distributed Systems Architecture         */
 /* Group, Universidad Complutense de Madrid                                   */
 /*                                                                            */
 /* Licensed under the Apache License, Version 2.0 (the "License"); you may    */
@@ -33,14 +33,13 @@ const char * usage =
 "SYNOPSIS\n"
 "  Prints information about all the jobs in the GridWay system (default)\n\n"
 "OPTIONS\n"
-"  -h               prints this help\n"
+"  -h               print this help\n"
 "  -u user          monitor only jobs owned by user\n"
 "  -r host          monitor only jobs executed in host\n"
 "  -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>       this will cause gwps to print job information every <delay>\n"
-"                   seconds continuously (similar to top command)\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"

diff --git a/src/cmds/gw_submit.c b/src/cmds/gw_submit.c
@@ -1,5 +1,5 @@
 /* -------------------------------------------------------------------------- */
-/* Copyright 2002-2006 GridWay Team, Distributed Systems Architecture         */
+/* Copyright 2002-2009 GridWay Team, Distributed Systems Architecture         */
 /* Group, Universidad Complutense de Madrid                                   */
 /*                                                                            */
 /* Licensed under the Apache License, Version 2.0 (the "License"); you may    */
@@ -30,14 +30,14 @@
 const char * usage =
 "\n gwsubmit <[-t] template> [-n tasks] [-h] [-v] [-o] [-d \"id1 id2 ...\"] [-p priotity]\n\n"
 "SYNOPSIS\n"
-"  Submit a job or an array job (if the number of tasks is defined) to gwd\n\n"
+"  Submits a job or an array job (if the number of tasks is defined) to gwd\n\n"
 "OPTIONS\n"
-"  -h                  prints this help\n"
+"  -h                  print this help\n"
 "  [-t] <template>     the template file describing 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" 
+"  -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"

diff --git a/src/cmds/gw_user.c b/src/cmds/gw_user.c
@@ -1,5 +1,5 @@
 /* -------------------------------------------------------------------------- */
-/* Copyright 2002-2006 GridWay Team, Distributed Systems Architecture         */
+/* Copyright 2002-2009 GridWay Team, Distributed Systems Architecture         */
 /* Group, Universidad Complutense de Madrid                                   */
 /*                                                                            */
 /* Licensed under the Apache License, Version 2.0 (the "License"); you may    */
@@ -33,7 +33,7 @@ const char * usage =
 "SYNOPSIS\n"
 "  Prints information about users in the GridWay system\n\n"
 "OPTIONS\n"
-"  -h    prints this help\n"
+"  -h    print this help\n"
 "  -n    do not print the header lines\n\n"
 "  -x    xml format\n"
 "FIELD INFORMATION\n"

diff --git a/src/cmds/gw_wait.c b/src/cmds/gw_wait.c
@@ -1,5 +1,5 @@
 /* -------------------------------------------------------------------------- */
-/* Copyright 2002-2006 GridWay Team, Distributed Systems Architecture         */
+/* Copyright 2002-2009 GridWay Team, Distributed Systems Architecture         */
 /* Group, Universidad Complutense de Madrid                                   */
 /*                                                                            */
 /* Licensed under the Apache License, Version 2.0 (the "License"); you may    */
@@ -33,17 +33,16 @@ const char * usage =
 "SYNOPSIS\n"
 "  Waits for a job\n\n"
 "OPTIONS\n"
-"  -h             prints this help.\n"
+"  -h             print this help\n"
 "  -a             any, returns when the first job of the list or array finishes\n"
-"  -v             prints job exit code\n"
-"  -t             timeout no wait more then timeout seconds. A negative value\n"
-"                 means an undetermined amount of time (i.e. wait forever,\n"
-"                 default)\n"
-"  -k             keep jobs, they remain in fail or done  states in the\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 ...     job ids list as provided by gwps.\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";
 
 
 const char * susage =