Changes between Version 27 and Version 28 of client_user_guide

Timestamp:

08/07/13 17:37:54 (11 years ago)

Author:

piontek

Comment:

--

client_user_guide

@@ -75 +75 @@
                 The default identifier of task is 'task'
 }}}
+
+=== qcg-clean ===
+{{{
+Clean task(s). Remove working directory
+ 
+usage: qcg-clean [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ...
+usage: qcg-client clean_task [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ...
+ 
+Options:
+ -h,--help      display help message
+ -v,--version   display version
+ 
+Arguments:
+ JOBID  identifier of the job
+ TASKID optional identifier of the task
+                The default identifier of task is 'task'
+}}}
+
+=== qcg-connect ===
+{{{
+Connect to the task. Open interactive terminal in the working directory of the task
+ 
+usage: qcg-connect [-h] [-v]   JOBID[/TASKID]
+usage: qcg-client connect_to_tasks [-h] [-v]   JOBID[/TASKID]
+ 
+Options:
+ -h,--help      display help message
+ -v,--version   display version
+ 
+Arguments:
+ JOBID  identifier of the job
+ TASKID optional identifier of the task
+                The default identifier of task is 'task'
+}}}
+
+=== qcg-info ===
+{{{
+Display information about task(s)
+ 
+usage: qcg-info [-d] [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ...
+usage: qcg-client task_info [-d] [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ...
+ 
+Options:
+ -d,--description   display user's job description
+ -h,--help          display help message
+ -v,--version       display version
+ 
+Arguments:
+ JOBID  identifier of the job
+ TASKID optional identifier of the task
+                The default identifier of task is 'task'
+}}}
+
+=== qcg-list ===
+{{{
+Display information about tasks
+ 
+usage: qcg-list [-C <period>] [-h] [-n <NOTE>] [-N] [-p <PURGED>] [-R] [-S <period>] [-s <status(es)>] [-v]
+usage: qcg-client get_tasks [-C <period>] [-h] [-n <NOTE>] [-N] [-p <PURGED>] [-R] [-S <period>] [-s <status(es)>] [-v]
+ 
+Options:
+ -C,--changed <period>                           changed in the period of time (not supported yet)
+ -h,--help                                       display help message
+ -n,--note <NOTE>                              list elements with the given note
+ -N,--no-list                                    do not display list
+ -p,--purged <PURGED>                            display whether the working directory is purged or
+                                                 not (PURGED=true|false).
+ -R,--report                                     display summary report.
+ -S,--submitted <period>                         submited in the period of time. If the status is
+                                                 defined the default value of the period is 1 day.
+ -s,--status <status(es)>                        status(es) of the job. Lack of this option is
+                                                 equivalent to requesting unterminated activities.
+ -v,--version                                    display version
+}}}
+
+=== qcg-peak ===
+{{{
+Peek the output file(s)
+ 
+usage: qcg-peek [-c <NUMBER>] [-f <FILE>] [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ...
+usage: qcg-client peek_output [-c <NUMBER>] [-f <FILE>] [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ...
+ 
+Options:
+ -c,--characters <NUMBER>   number of characters
+ -f,--file <FILE>           file to peek
+ -h,--help                  display help message
+ -v,--version               display version
+ 
+Arguments:
+ JOBID  identifier of the job
+ TASKID optional identifier of the task
+                The default identifier of task is 'task'
+}}}
+
+=== qcg-proxy ===
+{{{
+Create user proxy
+ 
+usage: proxy_init [-h] [-v]
+ 
+Options:
+ -h,--help      display help message
+ -v,--version   display version
+}}}
+
+=== qcg-refetch ===
+{{{
+Refetch output files
+ 
+usage: qcg-refetch [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ...
+usage: qcg-client stage_out [-h] [-v]   JOBID[/TASKID] [JOBID[/TASKID]] ...
+ 
+Options:
+ -h,--help      display help message
+ -v,--version   display version
+ 
+Arguments:
+ JOBID  identifier of the job
+ TASKID optional identifier of the task
+                The default identifier of task is 'task'
+}}}
+
+=== qcg-refresh_proxy ===
+{{{
+Refresh proxy for the given job(s)
+ 
+usage: qcg-client refresh_proxy [-h] [-v]   JOBID [JOBID] ...
+ 
+Options:
+ -h,--help      display help message
+ -v,--version   display version
+ 
+Arguments:
+ JOBID  identifier of the job
+}}}
+
+=== qcg-sub ===
+{{{
+Submit job(s) to the QCG infrastructure
+ 
+usage: qcg-sub [-D <DIRECTIVE>] [-h] [-I] [-J | -S | -X] [-R <NUMBER>]  [-v]   FILE [FILE] ...
+usage: qcg-client submit_job [-D <DIRECTIVE>] [-h] [-I] [-J | -S | -X] [-R <NUMBER>]  [-v]   FILE [FILE] ...
+ 
+Options:
+ -D,--directive <DIRECTIVE>   adds #QCG directives to the description
+ -h,--help                    display help message
+ -I,--interactive             Interactive mode
+ -J,--jsdl                    JSDL dialect
+ -R,--repeat <NUMBER>         repeat submission (only for testing)
+ -S,--simple                  QCG Simple dialect
+ -v,--version                 display version
+ -X,--xml                     QCG XML dialect
+}}}
+
+=== qcg-rcancel ===
+{{{
+Cancel reservation(s)
+ 
+usage: qcg-rcancel [-h] [-v]   RESID [RESID] ...
+usage: qcg-client cancel_reservation [-h] [-v]   RESID [RESID] ...
+ 
+Options:
+ -h,--help      display help message
+ -v,--version   display version
+ 
+Arguments:
+ RESID  identifier of the reservation
+}}}
+
+=== qcg-reserve ===
+{{{
+Create reservation(s)
+ 
+usage: qcg-reserve [-h] [-J | -S | -X]  [-v]   FILE [FILE] ...
+usage: qcg-client create_reservation [-h] [-J | -S | -X]  [-v]   FILE [FILE] ...
+ 
+Options:
+ -h,--help      display help message
+ -J,--jsdl      JSDL dialect
+ -S,--simple    QCG Simple dialect
+ -v,--version   display version
+ -X,--xml       QCG XML dialect
+ 
+Arguments:
+ FILE   Path to file with job description
+}}}
+
+=== qcg-rinfo ===
+{{{
+Display information about the given reservation(s)
+ 
+usage: qcg-rinfo [-d] [-D] [-h] [-v]   RESID [RESID] ...
+usage: qcg-client reservation_info [-d] [-D] [-h] [-v]   RESID [RESID] ...
+ 
+Options:
+ -d,--description       display user's job description
+ -D,--qcg_description   display QCG job description
+ -h,--help              display help message
+ -v,--version           display version
+ 
+Arguments:
+ RESID  identifier of the reservation
+}}}
+
+=== qcg-rlist ===
+{{{
+Display information about reservations
+ 
+usage: qcg-rlist [-C <period>] [-h] [-n <NOTE>] [-N] [-R] [-S <period>] [-s <status(es)>] [-v]
+usage: qcg-client get_reservations [-C <period>] [-h] [-n <NOTE>] [-N] [-R] [-S <period>] [-s <status(es)>] [-v]
+ 
+Options:
+ -C,--changed <period>                           changed in the period of time (not supported yet)
+ -h,--help                                       display help message
+ -n,--note                                       list elements with the given note
+ -N,--no-list                                    do not display list
+ -R,--report                                     display summary report.
+ -S,--submitted <period>                         submited in the period of time. If the status is
+                                                 defined the default value of the period is 1 day.
+ -s,--status <status(es)>                        status(es) of the job. Lack of this option is
+                                                 equivalent to requesting unterminated activities.
+ -v,--version                                    display version
+}}}
+
 == QCG-Simple description format ==