Условные обозначения в документе, Формат текста, Договоренности о синтаксисе команд – Инструкция по эксплуатации Dell Brocade Adapters

Страница 19

Advertising
background image

Руководство

по

устранению

неполадок

адаптеров

Brocade

xix

53-1002145-01

Условные обозначения в документе

В данном разделе описываются условные обозначения формата текста и важных замечаний,
используемых в документе.

Формат текста

В тексте документа используются следующие форматы:

полужирный шрифт

используется в названиях команд
используется в названиях элементов графического интерфейса

пользователя, которые может использовать пользователь
при работе

используется в названиях ключевых слов и операндов
используется в тексте, вводимом в графический интерфейс

пользователя или интерфейс командной строки

курсив

используется для выделения текста
используется в названиях переменных
используется при вводе адреса пути или адреса в Интернете
используется в названиях документов

машинный

шрифт

используется в тексте выводимых сообщений интерфейса

командной строки
используется в примерах синтаксиса команд

Для удобочитаемости в названиях команд и повествовательных фрагментах документа
используется смешанный регистр: например, switchShow. В конкретных примерах все
команды приводятся в нижнем регистре.

Договоренности о синтаксисе команд

В тексте команд в настоящем документе используются следующие обозначения:

команда

Названия команд набраны полужирным шрифтом

--

опция, опция

Опции команд набраны полужирным шрифтом

-

аргумент, арг

Аргументы

[ ]

Необязательные элементы

Параметры и
переменные

Переменные набраны курсивом. На страницах справки значения
приводятся подчеркнутым шрифтом или заключены в угловые скобки < >

...

Повтор предыдущего элемента, например, «member[;member...]»

Значение

Фиксированные значения после аргументов написаны обычным
шрифтом. Пример:

--

show WWN

|

Символ двоичной логики. Взаимоисключающие элементы. Пример:

--

show

-

mode вывод | ввод

Advertising