How to Read Reference Manual

Document revision 1.1 (15-Apr-2003)
This document applies to the MikroTik RouterOS V2.7

Table of Contents
Summary
The Purpose
The Structure
Common Conventions
Additional Resources

Summary

This document contains general information on how to read Reference Manual. Here you can find information about Manual purposes, structure and common conventions.

The Purpose

The Reference Manual is designed to give information about all aspects of MikroTik RouterOS installation, configuration, maintenance and upgrading as well as some tupical examples.

The Structure

The full list of covered topics can be accessed within the main Manual page. Each topic consists of:

Main Header
Table of Contents
Summary
Specifications
Related Documents
[Description]
[Property Description]
Topic 1

[Description]
[Property Description]
[Notes]
[Example]

Topic 2

[Subtopic 1]
[Subtopic 2]
...
[Subtopic n]

...
Topic n
[Notes]
[Example]
Additional Resources

Note, that some items do not present in each Manual part. Such items are put in brackets [].

Main Header - here the theme and document revision are shown

Table of Contents - contains table of links to different subtopics of a theme

Summary - short summary of functions and (or) technology.

Specifications - holds information about packages and licences needed as well as utilized protocols and hardware requirements

Related Documents - contains links to related entries in the Manual

Description - General item description. Includes theoretical aspects and implementation specs

Property Description - Describes available arguments of commands (if any)

Notes - some facts worth to hold in mind

Example - shows typical example or (and) application example

Each manual entry can contain subtopics which hold their own Description, Property Description, Notes and Example items.

Common Conventions

There are some common conventions through the entire Manual which are worth to know:

All commands or arguments are in bold, i.e /ip adress add address=10.10.10.1/24

In case instead of actual value a range has been entered, it is in italics, id est dst-address (IP adress)

Default value of an argument is in bold and is prefixed by the keyword 'default' , i.e action (drop | accept, default: accept)

There are some access modifiers used in Property Description:

read-only - the argument can not be modified by the user directly, exempli gratia from set command

multiple choice - these arguments can be selected in combinations, id est supported-rates-a=6Mbps,9Mbps,12Mbps,18Mbps,24Mbps,36Mbps,48Mbps,54Mbps

Additional Resources

Key words for use in RFCs to Indicate Requirement Levels