ClusterCockpit/cc-backend
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-backend synced 2024-12-26 13:29: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

16
README.md
View File

@ -26,29 +26,40 @@ 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.
@ -99,6 +110,7 @@ Options:
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