Documentation conventions, General, Internal web interface – Netopia 6.3 User Manual

Page 8: Command line interface, Internal web interface command line interface

Advertising
background image

8

Section 1

Documentation Conventions

Documentation Conventions

General

This manual uses the following conventions to present information:

Internal Web Interface

Command Line Interface

Syntax conventions for the Cayman gateway command line interface are
as follows:

Convention (Typeface)

Description

bold italic
monospaced

Menu commands and button names

bold italic sans serif

Web GUI page links

terminal

Computer display text

bold terminal

User-entered text

Italic

Italic type indicates the complete titles of
manuals.

Convention (Graphics)

Description

dot-dot-dash rounded rect-
angle or line

Denotes an “excerpt” from a Web page or
the visual truncation of a Web page

solid rounded rectangle with
an arrow

Denotes an area of emphasis on a Web
page

Convention

Description

straight ([ ]) brackets in cmd line Optional command arguments

curly ({ }) brackets, with values
separated with vertical bars (|).

Alternative values for an argument are
presented in curly ({ }) brackets, with
values separated with vertical bars (|).

bold terminal type face

User-entered text

italic terminal type
face

Variables for which you supply your
own values

Advertising