Changes between Version 36 and Version 37 of qcg-tools

Timestamp:

11/26/13 22:36:49 (10 years ago)

Author:

piontek

Comment:

--

qcg-tools

@@ -633 +633 @@
 {{{
 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
+
+usage: qcg-rlist [-C <period>] [-c] [-F <format>] [-h] [-n <NOTE>] [-N] [-R] [-S <period>] [-s
+       <status(es)>] [-T <format>] [-t] [-v]
+usage: qcg-client get_reservations [-C <period>] [-c] [-F <format>] [-h] [-n <NOTE>] [-N] [-R] [-S
+       <period>] [-s <status(es)>] [-T <format>] [-t] [-v]
+
+Options:
+ -C,--changed <period>      changed in the period of time
+ -c,--color                 Colorize output
+ -F,--format <format>       columns format
+ -h,--help                  display help message
+ -n,--note <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.
+ -T,--time <format>         time format
+ -t,--truncated             display truncated identifiers
+ -v,--version               display version
+
 }}}
 
 '''IMPORTANT:''' For some details please see the description of the "qcg-list" command.
 
-List of reservation statuses:
+'''List of reservation statuses:'''
 * ''SUBMITTED'' - reservation request was submitted to the system,
 * ''RESERVED'' - resources ware reserved, but the reservation is not yet active,
@@ -665 +672 @@
 * ''unterminated'' - any of not terminal statuses (SUBMITTED,ACTIVE,RESERVED).
 
+'''Date display format'''
+
+User can define his own format for dates:
+* YY - year (4 digits)
+* yy - year (2 digits)
+* m - month (01-12)
+* B - name of the month
+* b - short name of the month
+* A - week day
+* a - short week day
+* d - day (01-31)
+* e - day (1-31)
+* H - hour (00-23)
+* k - hour (0-23)
+* M - minutes (00-59)
+* S - seconds (00-59)
+Default format is: "dd.MM.yy HH:mm"
+
+ 
+'''Columns format'''
+
+User can define his own format for columns.
+
+In the format one can define list of columns, their widths and alignment using the following schema: 
+{{{
+%[-]<WIDTH><COLUMN_ID> [ %[-]<WIDTH><COLUMN_ID> ] ...
+}}}
+
+where:
+* % - mandatory character starting 
+* - optional character "minus" for the adjustment to the left
+* WIDTH - width of the column
+* COLUMN_ID - identifier of the column (see the table below).
+
+The default format is: "%-22I  %-20N  %-15T  %-15X  %-15E  %-16S  %-8H  %-5C  %-20D"
+
+'''List of displayed columns:'''
+||= Column =||= Format Identifier =|| Meaning =||
+|| IDENTIFIER || I ||reservation identifier ||
+|| NOTE || N ||value of the #QCG note directive ||
+|| SUBMISSION TIME || T || time when the task was submitted to the system ||
+|| START TIME || X || estimated (if known) of real start time ||
+|| FINISH TIME || E ||time when the task has been finished
+|| STATUS || S ||task status ||
+|| HOSTNAME || H || name of the cluster which the task is or was executed on ||
+|| SLOTS || C || Number of slots ||
+|| STATUS DESCRIPTION || D || human readable description (reason) of the status. Should be present for FAILED status ||
+
+{{{
+qcg-rlist -F "%-22I  %-20N  %-15T  %-15X  %-15E  %-16S  %-8H  %-5C  %-20D" -t "dd.MM.yy HH:mm"
+}}}
+
+
 {{{
 [plgpiontek@qcg EGI]$ qcg-rlist