Document Conventions - ZyXEL Communications Dimension GS-3012 Cli Reference Manual

Document Conventions

Warnings and Notes
These are how warnings and notes are shown in this CLI Reference Guide.
Warnings tell you about things that could harm you or your device. See your
User's Guide for product specific warnings.
Notes tell you other important information (for example, other things you may
need to configure or helpful tips) or recommendations.
Syntax Conventions
This manual follows these general conventions:
• ZyXEL's switches (such as the ES-2024A, ES-2108, GS-3012, and so on) may be referred
to as the "Switch", the "device", the "system" or the "product" in this Reference Guide.
• Units of measurement may denote the "metric" value or the "scientific" value. For
example, "k" for kilo may denote "1000" or "1024", "M" for mega may denote "1000000"
or "1048576" and so on.
Command descriptions follow these conventions:
• Commands are in
• Required input values are in angle brackets <>; for example,
must specify an IP address for this command.
• Optional fields are in square brackets []; for instance show logins [name], the name
field is optional.
The following is an example of a required field within an optional field: snmp-server
[contact <system contact>], the contact field is optional. However, if you
use contact, then you must provide the system contact information.
• Lists (such as <port-list>) consist of one or more elements separated by commas.
Each element might be a single value (1, 2, 3, ...) or a range of values (1-2, 3-5, ...)
separated by a dash.
• The | (bar) symbol means "or".
• italic terms represent user-defined input values; for example, in snmp-server
[contact <system contact>], system contact can be replaced by the
administrator's name.
• A key stroke is denoted by square brackets and uppercase text, for example, [ENTER]
means the "Enter" or "Return" key on your keyboard.
4
Document Conventions
courier new font
.
ping <
Ethernet Switch CLI Reference Guide
means that you
ip
>