Для того, чтобы четко дифференцировать специальные слова от текстового потока, команда документации использует различные начертания. В этой таблице приведены примеры каждого специального слова или группы слов с их начертаниями и описаниями их значений.
| Пример | Значение | |
|---|---|---|
| inode | Используется для обозначения технических терминов | |
| ls -lta | Обозначает команду или аргументы команды. Применяется для обозначения команд, опций команд, а также имен файлов. Также смотрите раздел “Краткий обзор команд”. | |
| ls(1) | Ссылка на страницы руководства ( man page). Чтобы прочитать страницу в shell (или в командной строке), просто наберите man 1 ls . | |
| Мы используем это выделение для отображения текстовых снимков экрана. Сюда входят результаты выполнения команд, распечатки программы, и т.д. | |
| localhost | Это - литеральные данные, которые вообще не входят не в одну из описанных в этой таблице категорий. Например, это могут быть ключевые слова, взятые из конфигурационного файла. | |
| Apache | Обозначения названий приложений. В данном примере (“Apache”) это не имя команды. Однако, в зависимости от контекста, названия программ и команд могут совпадать, но они будут выделяться по-разному. | |
| Используется для обозначения пунктов меню или текстовых строк в графическом интерфейсе. Подчеркнутый символ указывает быструю клавишу (конечно, если она существует). | ||
| SCSI-Bus | Так обозначается компьютер или его часть (любое устройство). | |
| Le petit chaperon rouge | Так обозначаются слова на иностранном языке (не русском и не английском). | |
| Warning! | Таким образом выделяется что либо важное. Например предупреждения. Советуем прочитать это вслух :-) |
Этот значок выделяет примечание. В общем случае, это дополнительная информация для текущего контекста.
В примере, приведенном ниже, показано как автор описывает аргументы команды:
command <non
literal argument> [--option={arg1,arg2,arg3}]
[optional arg. ...] |
Это соглашение является стандартным и используется во многих других местах, например в страницах руководства (man pages).
Между знаками “<” (меньше чем) и “>” (больше чем) помещаются обязательные аргументы. Такие параметры должны быть обязательно указаны. Вы не должны копировать то что, написано в руководстве, а вместо этого подставить свое значение. Например, <filename> требует чтобы вы указали реальное имя файла. Если это имя foo.txt то вы должны ввести foo.txt, но не <foo.txt> и уж не как не <filename> .
Квадратные скобки (“[ ]”) обозначают необязательные аргументы, которые вы можете указать или не указать для вашей команды.
Троеточие (“...”) подразумевает, что может быть добавлено произвольное число аргументов.
Фигурные скобки (“{ }”) указывают на то, что один из заключенных в них аргументов должен содержаться в этом месте.
Иногда вам будет предложено нажать комбинации клавиш. Например напрямую Ctrl+R , Это значит что вам нужно нажать и удерживать клавишу Ctrl и не отпуская ее нажать клавишу R Аналогичные действия нужно проделать для нажатия клавиш Alt и Shift .
Теперь о меню. Для того чтобы выбрать пункт меню -> (Ctrl+R) вам нужно: выбрать текст , находящийся в меню (обычно располагается в левой верхней части окна). В результате должно появиться подменю. В нем вы должны выбрать пункт . Вместо этого вы можете просто использовать комбинацию клавиш (как было описано выше) для быстрого вызова этой функции Ctrl+R , и, в конечном итоге, вы получите такой же результат.