sandbox-top – display Sandbox tasks
sandbox-top [-h] [--log-path LOG_PATH]
[--xml-rpc-url URL | --host HOST] [--show-childs]
[--hide-hidden] [--task-type TASK_TYPE] [--owner USERNAME]
[--statuses STATUS [STATUS ...]] [--interval SECONDS]
[--layout LAYOUT_STRING] [--force-start]
[--version | --list-task-types]
The sandbox-top program provides a dynamic view of a running Sandbox. It can display a list of tasks being managed by the Sandbox. The order and size of information displayed for tasks are all user configurable.
Columns
a. Description of Fields
b. Selecting and Ordering Columns
c. Layout Examples
Bugs
When operating sandbox-top, the most useful key is quit (q
) key. Alternatively, you could simply use the traditional interrupt key (^C
) when you are done.
-h
, --help
Show the help message and exit.
--log-path LOG_PATH
Specifies the log file path.
--xml-rpc-url
Specifies Sandbox XML RPC URL.
--host
Specifies Sandbox host in format of host[:XML RPC port]
.
--show-childs
Tells sandbox-top to show also child tasks.
--hide-hidden
Tells sandbox-top to not show hidden tasks.
--task-type TASK_TYPE
Tells sandbox-top to show tasks of the type TASK_TYPE
only.
--owner USERNAME
Tells sandbox-top to show tasks that are owned by the specified user.
--statuses STATUS [STATUS ...]
Tells sandbox-top to show tasks with the specified statuses only:
q
or Q
= ENQUEUED
u
or U
= UNKNOWN
x
or X
= EXECUTING
--interval INTERVAL
Specifies the refresh interval, in seconds.
--layout LAYOUT
Specifies the columns to show together with their order and size (see below).
--force-start
Do not ping Sandbox at start.
--version
Show version and exit.
--list-task-types
Show available task types and exit.
Listed below are sandbox-top's available fields.
The task's unique ID.
The type of the task.
The priority of the task.
The "hidden" flag:
H
= the task IS hidden.
= the task IS NOT hiddenThe status of the task which can be of:
Q
= ENQUEUEDU
= UNKNOWNX
= EXECUTINGThis column shows the task execution time if the task is executing, and the lifetime of the task (which is, in fact, the time in queue) otherwise.
This column shows the description of the task.
This column shows the CPU model of the client that executes the task.
This column shows the host name of the client that executes the task.
This column shows the OS name of the client that executes the task.
The layout string specifies the order and size of columns. The format of layout string is:
layout ::= column[ column[ column[ ...]]]
column ::= column_name[align][width]
align ::= <|>|^
Column names is described above in the Columns section.
Align can be of:
<
= left>
= right^
= centerWidth can be of:
0
= stretch up to the window width (not supported by all columns)id>8 type<25 priority>4 hidden<1 status<1 time>9 description<0
Default layout.
description<0
Show the description only.
Send bug reports to: Pavel Perestoronin, eigenein@yandex-team.ru
The file is generated with setup.py readme
.