rank

Command Function

Displays information about a single rank or all ranks and sets the debugging scope.

Syntax

Set the debugging scope to global debugging:

rank all [-h | --help]

Displaying information about all ranks:

rank list [-h | --help]

Displaying information about a single rank:

rank info [-h | --help] {RANK_ID}

Setting the debugging scope:

rank set [-h | --help] {RANK_ID}

The rank command can be abbreviated as r, for example, r info 0.
The RANK_ID parameter is mandatory and must be a natural number. For example, if you use -np to set the number of ranks to N, the RANK_ID value ranges from 0 to N-1.

Parameter Description

**Table 1** Parameters of the **all** command
Parameter	Description
None	Set the debugging scope to global debugging:
-h/--help	Obtains help information. This parameter is optional.

**Table 2** Parameters of the **list** command
Parameter	Description
None	Displaying information about all ranks.
-h/--help	Obtains help information. This parameter is optional.

**Table 3** Parameters of the **info** command
Parameter	Description
{RANK_ID}	Replace {RANK_ID} with the actual rank ID to view information about a single rank, for example, rank info 0. This parameter is mandatory.
-h/--help	Obtains help information. This parameter is optional.

**Table 4** Parameters of the **set** command
Parameter	Description
{RANK_ID}	Replace {RANK_ID} with the actual rank ID to set the debugging application scope, for example, rank set 0. This parameter is mandatory.
-h/--help	Obtains help information. This parameter is optional.

Example

Display the information about rank functions:

rank -h

Command output:

The most commonly used rank(r) sub commands are:
    all         Change the workspace to global.
    list        Displays all ranks.
    info        Displays the specified rank.
    set         Specifies the currently operated rank.
See 'rank(r) COMMAND -h/--help' for more information on a specific command.

Parent topic: Debugging Status Commands