Additional documentation for show jobs

This commit is contained in:
Tilman Kamp 2019-03-01 17:33:41 +01:00
Родитель b0fc25945a
Коммит f3b23c2d85
1 изменённых файлов: 13 добавлений и 1 удалений

Просмотреть файл

@ -658,8 +658,10 @@ program
printExample('pit show users')
printExample('pit show groups')
printExample('pit show nodes')
printExample('pit show jobs')
printExample('pit show aliases')
printExample('pit show jobs')
printExample('pit show jobs user=jill')
printExample('pit show jobs since=4/2010 asc=date title="%test%"')
printExample('pit show user:paul')
printExample('pit show node:machine1')
printExample('pit show job:235')
@ -667,6 +669,16 @@ program
printExample('pit show group:students')
printLine()
printEntityHelp('me', 'users', 'groups', 'nodes', 'jobs', 'aliases', entityUser, entityNode, entityJob, entityAlias, entityGroup)
printLine()
printLine('For "show jobs" the following query parameters (combined by AND) are supported:')
printLine(' since=<date value> - shows jobs with a state change date past the provided date')
printLine(' till=<date value> - shows jobs with a state change date before the provided date')
printLine(' user=<username> - shows jobs owned by the provided user')
printLine(' title=<wildcard> - shows jobs whose titles match the provided wildcard')
printLine(' asc=<field> - orders jobs ascending by provided field (date|user|title|state)')
printLine(' desc=<field> - orders jobs descending by provided field (date|user|title|state)')
printLine(' limit=<number> - shows first N results')
printLine(' offset=<number> - shows jobs beginning with N-th result')
})
.action(function(entity, params, options) {
if(entity === 'users' || entity === 'groups' || entity === 'nodes' || entity === 'aliases') {