Для наглядности в тексте документации используются различные стили оформления:
- Полужирный шрифт — названия элементов пользовательского интерфейса (команды, кнопки клавиатуры, символы консоли, рекомендуемые значения вводимых параметров), значения параметров команд.
Пример:
“Для изменения значения в контекстном режиме конфигурирования порта необходимо вызвать команду
lacp-priority <NUM>
, где NUM — приоритет порта, изменяемый в пределах от 0 до 65535.” - Шрифт
Courier New
на светло-сером фоне — отдельные строки и вставки по ходу текста примеров кода, команд, вывода консоли. В примере выше:lacp-priority <NUM>
. - Блок текста шрифтом
Courier New
на светло-сером фоне — блоки вводимых команд и вывода консоли. Пример:
ecorouter#show counters lacp
Port channel: ae.01
Port LACPDU recv pkts LACPDU sent pkts Unknown recv pkts Illegal recv pkts
te1 0 1648 0 0
Условные обозначения при описании консоли:
< >
— значения параметров вводимые пользователем. Пример:<часть команды>?
.[ ]
— необязательный элемент. Пример:<часть команды>[TAB]
.{ }
— набор обязательных элементов. Требуется выбрать один вариант.│
— Разделитель для взаимоисключающих элементов. Пример:ptp mode {transparent|boundary} {e2e|p2p} {ethernet|udp}