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

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

Типографские способы выделения текста

В документации используются следующие типографские способы выделения текста:
Полужирный
  • Команды, приведенные в нижнем или смешанном регистре, параметры и переменные среды, которые трудно отличить от окружающего текста
  • Элементы управления интерфейсом (переключатели, кнопки, радиокнопки, кнопки для прокрутки значений, поля, папки, значки, списки, элементы списков, списки с несколькими столбцами, контейнеры, пункты меню, имена меню, вкладки, таблицы свойств), метки (например, Подсказка:).
  • Ключевые слова и параметры в тексте
Курсив
  • Цитаты (например: названия публикаций, дискет и компакт-дисков)
  • Определения в виде слов и фраз в тексте (пример: некоммутируемая линия называется линией точка-точка)
  • Слова и буквы в тексте, которые нужно выделить (например: Адрес LUN должен начинаться с буквы L.)
  • Новые термины в тексте, кроме списка определений (пример: представление - это часть рабочего пространства, содержащая данные).
  • Переменные и значения, которые вы должны ввести (пример: где имя - это …)
Моноширинный шрифт
  • Примеры и примеры кода
  • Имена файлов, имена каталогов, имена путей, ключевые слова программирования и другие элементы, которые трудно отличить от окружающего текста
  • Текст сообщений и запросов
  • Текст, который вы должны вводить
  • Значение аргументов или опций команд
Полужирный моноширинный
  • Имена команд и имена макрокоманд и утилит, которые можно ввести как команды
  • Имена переменных среды в тексте
  • Ключевые слова
  • Имена параметров в тексте: параметры структуры API, параметры и аргументы команд и параметры конфигурации
  • Имена процессов
  • Имена переменных реестра в тексте
  • Имена сценариев

Синтаксис переменных и каталогов, зависящий от операционной системы

В документации наклон косой черты в путях каталогов может быть разным. Независимо от того, что вам встретится в документации, следуйте приведенным ниже рекомендациям:
  • Linux или AIX Используйте обычную косую черту (/).
  • Windows Используйте обратную косую черту (\).

Имена переменных среды в Windows и в AIX могут не совпадать. Например, переменная среды %TEMP% в Windows эквивалентна переменной среды $TMPDIR в AIX или Linux.

Для переменных среды придерживайтесь следующих рекомендаций:
  • Linux или AIX Используйте $переменная.
  • Windows Используйте %переменная%.

WindowsЕсли вы используете в системе Windows оболочку bash shell, то можно использовать соглашения AIX.

Переменная каталога установки и пути для агентов

каталог_установки - это каталог установки агентов. Каталог по умолчанию зависит от операционной системы.
  • WindowsC:\IBM\APM
  • Linux/opt/ibm/apm/agent
  • AIX/opt/ibm/apm/agent