ClusterCockpit/cc-backend
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-backend synced 2024-12-26 05:19:05 +01:00
Code Issues Packages Releases Activity

Update help text in README

Browse Source
This commit is contained in:
Jan Eitzinger 2019-06-05 08:36:51 +02:00
parent 4b3dff82e1
commit 90ab25e3ec
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -26,36 +26,47 @@ Usage:
Help Options: Help Options:
--help Show help text --help Show help text
--man Show man page --man Show man page
--hasprofile <true|false> Only show jobs with timerseries metric data
--mode <mode> Set the operation mode --mode <mode> Set the operation mode
--user <user_id> Search for jobs of specific user --user <user_id> Search for jobs of specific user
--project <project_id> Search for jobs of specific project --project <project_id> Search for jobs of specific project
--duration <from> <to> Specify duration range of jobs
--numnodes <from> <to> Specify range for number of nodes of job --numnodes <from> <to> Specify range for number of nodes of job
--starttime <from> <to> Specify range for start time of jobs --starttime <from> <to> Specify range for start time of jobs
--duration <from> <to> Specify duration range of jobs
--mem_used <from> <to> Specify range for average main memory capacity of job --mem_used <from> <to> Specify range for average main memory capacity of job
--mem_bandwidth <from> <to> Specify range for average main memory bandwidth of job --mem_bandwidth <from> <to> Specify range for average main memory bandwidth of job
--flops_any <from> <to> Specify range for average flop any rate of job --flops_any <from> <to> Specify range for average flop any rate of job
Options: Options:
--help Show a brief help information. --help Show a brief help information.
--man Read the manual, with examples --man Read the manual, with examples
--mode [012] Specify output mode. Mode can be one of:
--hasprofile [true|false] Only show jobs with or without timerseries
metric data
--mode [ids|query|count|list|stat|perf] Specify output mode. Mode can be
one of:
ids - Print list of job ids matching conditions. One job id per ids - Print list of job ids matching conditions. One job id per
line. line.
query - Print the query string and then exit. query - Print the query string and then exit.
count - Only output the number of jobs matching the conditions. count - Only output the number of jobs matching the conditions.
(Default mode) (Default mode)
list - Output a record of every job matching the conditions. list - Output a record of every job matching the conditions.
stat - Output job statistic for all jobs matching the stat - Output job statistic for all jobs matching the
conditions. conditions.
perf - Output job performance footprint statistic for all jobs perf - Output job performance footprint statistic for all jobs
matching the conditions. matching the conditions.
--user Search job for a specific user id. --user Search job for a specific user id.
--project Search job for a specific project. --project Search job for a specific project.
--duration Specify condition for job duration. This option takes two --duration Specify condition for job duration. This option takes two
arguments: If both arguments are positive integers the condition is arguments: If both arguments are positive integers the condition is
duration between first argument and second argument. If the second duration between first argument and second argument. If the second
@ -63,14 +74,14 @@ Options:
first argument is zero condition is duration larger than second first argument is zero condition is duration larger than second
argument. Duration can be in seconds, minutes (append m) or hours argument. Duration can be in seconds, minutes (append m) or hours
(append h). (append h).
--numnodes Specify condition for number of node range of job. This --numnodes Specify condition for number of node range of job. This
option takes two arguments: If both arguments are positive integers the option takes two arguments: If both arguments are positive integers the
condition is number of nodes between first argument and second argument. condition is number of nodes between first argument and second argument.
If the second argument is zero condition is number of nodes smaller than If the second argument is zero condition is number of nodes smaller than
first argument. If first argument is zero condition is number of nodes first argument. If first argument is zero condition is number of nodes
larger than second argument. larger than second argument.
--starttime Specify condition for the starttime of job. This option --starttime Specify condition for the starttime of job. This option
takes two arguments: If both arguments are positive integers the takes two arguments: If both arguments are positive integers the
condition is start time between first argument and second argument. If condition is start time between first argument and second argument. If
@ -78,27 +89,28 @@ Options:
argument. If first argument is zero condition is start time larger than argument. If first argument is zero condition is start time larger than
second argument. Start time must be given as date in the following second argument. Start time must be given as date in the following
format: %d.%m.%Y/%H:%M. format: %d.%m.%Y/%H:%M.
--mem_used Specify condition for average main memory capacity used by --mem_used Specify condition for average main memory capacity used by
job. This option takes two arguments: If both arguments are positive job. This option takes two arguments: If both arguments are positive
integers the condition is memory used is between first argument and integers the condition is memory used is between first argument and
second argument. If the second argument is zero condition is memory used second argument. If the second argument is zero condition is memory used
is smaller than first argument. If first argument is zero condition is is smaller than first argument. If first argument is zero condition is
memory used is larger than second argument. memory used is larger than second argument.
--mem_bandwidth Specify condition for average main memory bandwidth used --mem_bandwidth Specify condition for average main memory bandwidth used
by job. This option takes two arguments: If both arguments are positive by job. This option takes two arguments: If both arguments are positive
integers the condition is memory bandwidth is between first argument and integers the condition is memory bandwidth is between first argument and
second argument. If the second argument is zero condition is memory second argument. If the second argument is zero condition is memory
bandwidth is smaller than first argument. If first argument is zero bandwidth is smaller than first argument. If first argument is zero
condition is memory bandwidth is larger than second argument. condition is memory bandwidth is larger than second argument.
--flops_any Specify condition for average flops any of job. This option --flops_any Specify condition for average flops any of job. This option
takes two arguments: If both arguments are positive integers the takes two arguments: If both arguments are positive integers the
condition is flops any is between first argument and second argument. If condition is flops any is between first argument and second argument. If
the second argument is zero condition is flops any is smaller than first the second argument is zero condition is flops any is smaller than first
argument. If first argument is zero condition is flops any is larger argument. If first argument is zero condition is flops any is larger
than second argument. than second argument.
``` ```
# Examples # Examples