Command Description Format - Alaxala AX3640S Software Manual

1. Reading the Manual

Command description format

Each command is described in the following format:
Function
Describes the purpose of the command.
Syntax
Defines the input format of the command. The format is governed by the following rules:
1. Parameters for setting values or character strings are enclosed in angle brackets (
2. Characters that are not enclosed in angle brackets (
exactly as they appear.
3. indicates that either
{A|B}
4. Parameters or keywords enclosed in square brackets (
5. For details on the parameter input format, see Specifiable values for parameters.
Input mode
Indicates the mode required to enter the command. The name of a sub-mode of a configuration
command mode corresponds to the name displayed on the command prompt.
Parameters
Describes in detail the parameters that can be set by the command. The default value and the values
that can be specified for each parameter are described.
Default behavior
If there are default values for parameters, or a default behavior when a command is not entered,
related information is provided here.
Impact on communication
If a setting has an impact on communication, such as interruptions to communication, that impact
is described here.
When the change is applied
Describes whether changes to values for configuration information in memory are immediately
effective, or whether they take effect only after temporarily stopping operation, such as by
restarting the switch.
Notes
Provides cautionary information on using the command.
Related commands
Describes the commands that must be set in order to use the applicable command.
2
or must be selected.
A B
) are keywords that must be typed
<>
) are optional and can be omitted.
[]
).
<>