Typographical Conventions; Command Syntax Conventions - Fortinet FortiGate Series Administration Manual
Hide thumbs
Also See for FortiGate Series:
- Administration manual (60 pages) ,
- Install manual (51 pages) ,
- Quick start manual (14 pages)
Table of Contents
Advertisement
Introduction
Typographical conventions
Command syntax conventions
FortiGate Version 4.0 MR1 Administration Guide
01-410-89802-20090903
http://docs.fortinet.com/
•
Feedback
Fortinet documentation uses the following typographical conventions:
Table 1: Typographical conventions in Fortinet technical documentation
Convention
Button, menu, text box,
field, or check box label
CLI input*
CLI output
Emphasis
File content
Hyperlink
Keyboard entry
Navigation
Publication
* For conventions used to represent command syntax, see
page
29.
The command line interface (CLI) requires that you use valid syntax, and conform to
expected input constraints. It will reject invalid commands.
Brackets, braces, and pipes are used to denote valid permutations of the syntax.
Constraint notations, such as <address_ipv4>, indicate which data types or string
patterns are acceptable value input.
Table 2: Command syntax notation
Convention
Square brackets [ ]
Example
From Minimum log level, select Notification.
config system dns
set primary <address_ipv4>
end
FGT-602803030703 # get system settings
comments
: (null)
opmode
: nat
HTTP connections are not secure and can be intercepted by
a third party.
<HTML><HEAD><TITLE>Firewall
Authentication</TITLE></HEAD>
<BODY><H4>You must authenticate to use this
service.</H4>
Visit the Fortinet Technical Support web site,
https://support.fortinet.com.
Type a name for the remote VPN peer or client, such as
Central_Office_1.
Go to VPN > IPSEC > Auto Key (IKE).
FortiGate Administration Guide
For details, see the
Description
A non-required word or series of words. For example:
[verbose {1 | 2 | 3}]
indicates that you may either omit or type both the verbose word and
its accompanying option, such as:
verbose 3
.
"Command syntax conventions" on
Conventions
29
Advertisement
Table of Contents
