Rate This Document
Findability
Accuracy
Completeness
Readability

register

Command Function

Displays information about one or all register variables and sets register variable values.

Syntax

Displaying a single register variable:

1
register get [-h | --help] {-n REGISTER_NAME | --name REGISTER_NAME} [-r RANK_ID | --rank RANK_ID]

Displaying all register variables:

1
register list [-h | --help] [-r RANK_ID | --rank RANK_ID]

Setting the register variable value:

1
register set [-h | --help] {-n REGISTER_NAME | --name REGISTER_NAME} {-v REGISTER_VALUE | --value REGISTER_VALUE} [-r RANK_ID | --rank RANK_ID]

The register command can be abbreviated as re or reg.

Parameter Description

Table 1 get command parameters

Parameter

Description

-h/--help

Obtains help information. This parameter is optional.

-n/--name

Register variable name. This parameter is mandatory.

-r/--rank

Rank ID. This parameter is optional.

Table 2 list command parameters

Parameter

Description

-h/--help

Obtains help information. This parameter is optional.

-r/--rank

Rank ID. This parameter is optional.

Table 3 set command parameters

Parameter

Description

-h/--help

Obtains help information. This parameter is optional.

-n/--name

Register variable name. This parameter is mandatory.

-v/--value

Register variable value. This parameter is mandatory.

-r/--rank

Rank ID. This parameter is optional.

Example

Display the information about register variable functions:

1
register -h

Command output:

1
2
3
4
5
The most commonly used register(reg) sub commands are:
    list        Displays all registers of the specified rank.
    set         Sets a register value of the specified rank.
    get         Obtains the register value of the specified rank.
See 'register(re/reg) COMMAND -h/--help' for more information on a specific command.