MIB Smithy

  1. Up to Table of Contents

Document Conventions

The following is a list of some of the more important conventions, such as fonts, colors, and related style information, used by this document.

Note Wells

Note wells are short paragraphs that appear occasionally throughout this document. In graphical browsers they appear as a box with a dark outline and a light yellow background. These boxes contain side text pertinent to the area that they appear in, such as important information that one should be aware of or related information that doesn't necessarily flow with the rest of the text. Example:

This is an obscure feature of the SMI that is not commonly supported by MIB compilers and related applications. MIB Smithy SDK supports this feature, but its use should be avoided when possible in order to maximize compatibility with other tools.

Monospaced Text

Monospaced text, usually the Courier font, is used to distinguish text that represents source code fragments, parameters, return values, or other text that you might see on screen or enter at the keyboard but which not necessarily a complete example of a function call with its return value by its self, as in this example of a syntax specification for one of the APIs provided by the SDK:

% smilib get property

(The % sign here represents the Tcl shell prompt and is not an actual part of the command.)

Function Parameters

Function parameters, such as those that appear in syntax specifications, appear in an italicized version of the other Monospaced Text used for code fragments. In the preceding section, the property part of the example represents a function parameter that must be specified as part of the command, while the rest of the text (other than the % prompt) is intended to be interpreted verbatim.

Optional Parameters

This document follows the convention commonly used in other Tcl documentation with regards to optional function parameters. Such parameters appear wrapped in a pair of ? (question mark) characters. If multiple parameters appear between the same pair of ?'s, then they are taken to be optional but if one is present than the other is required. Example:

% smilib set record option value ?option value ...?

In this example, smilib set is interpreted verbatim, record and the first option/value pair are considered to be required parameters that must be specified, while the second option/value pair are optional but the second value must be present if the second option is present. The ellipsis (...) indicates that the pair may be repeated any number of times.

On-Screen Text

On-Screen Text, such as code entered into a command line in source code examples, along with their output (if any) appear as pre-formatted text such as in the example below. In graphical browsers, this appears as a box with a dark outline and a light-grey background, using a monospaced font such as Courier. Commands entered by the user at the shell prompt are preceded by a % (percent) sign. Any relevant output appears after, in the same box, without th % sign. Lines that are too long to display pre-formatted in a typical screen width may be broken with a \ (backslash) at the end of the line, as in Tcl source code. Example:

% smilib get -modules
@File1 SNMPv2-TC @File2 SNMPv2-MIB
  1. Up to Table of Contents