Foundry Networks AR1204 manual Command Conventions, Syntax Conventions, For Syntaxes What it means

Foundry AR-Series Router User Guide

NOTE: Command strings that require identification of a specific interface are context-sensitive.

Command Conventions

Each command is briefly described and then followed by the complete syntax, which is essentially a map of the command that shows mandatory and optional parameters.

The following tables provide details of the conventions used for syntaxes and examples.

	Table 2.2: Syntax Conventions
For Syntaxes		What it means
normal type		Within syntaxes, “normal type” represents required words
		that must be entered by the user — except when followed by
		a parameter setting that is enclosed in angled brackets. In
		that case, only enter the parameter setting enclosed in the
		angled brackets.
		Example 1: Normal type only.
		In this example, the user enters the word or argument
		(module) appearing in the syntax in “normal type.”
		Syntax:
		module
		Command execution:
		module
		Example 2: Normal type word or argument that is followed
		by a second normal type word or argument, which is
		followed by a parameter setting enclosed in angled brackets.
		In this example, the user enters the first word or argument
		“connections,” appearing in normal type, and then only
		enters the value “4” of the second word or argument.
		Syntax:
		connections connections < n >
		Command execution:
		connections 4
		In other words, the first occurence of “connections” must be
		entered because it is not followed by a setting enclosed in
		angled brackets. The second occurence of the word
		“connections” must NOT be entered because it is followed
		by a setting enclosed in angled brackets. This value of the
		setting must be entered to execute the command.

2 - 2 © 2004 Foundry Networks, Inc. June 2004