Чтобы чётко выделить специальные слова в потоке текста, мы используем различные виды оформления. В приведенной ниже таблице показаны примеры для каждого из специальных слов или группы слов с их оформлением и описанием их значения.
| Форматированный пример | Значение | |
|---|---|---|
| inode | Используется для выделения технических терминов, описываемых в Приложение A, Глоссарий. | |
| ls -lta | Используется для команд и их аргументов. Также применяется для опций и имён файлов (смотрите раздел «Краткий обзор команд»). | |
| ls(1) | Ссылка на страницу руководства (man page). Чтобы прочитать страницу, просто наберите в командной строке man 1 ls. | |
| Форматирование, используемое для снимков текстовых областей, которые вы можете увидеть на своём экране, включая результаты выполнения команд, распечатки программы и т.д. | |
| localhost | Буквенные данные, не подходящие под описание ни одной из ранее определённых категорий. Например, ключевое слово, взятое из конфигурационного файла. | |
| Konqueror | Определяет названия приложений. В зависимости от контекста, приложения и название команды могут быть одинаковыми, но иметь разное оформление. Например, большинство команд пишется в нижнем регистре, в то время как приложения обычно начинаются с большой буквы. | |
| Обозначает пункты меню или метки графического интерфейса. Доступ к подчёркнутой букве, информирующей вас о наличии «быстрой» клавиши, может быть получен нажатием на клавишу Alt плюс сама буква. | ||
| SCSI-шина | Указывает на часть компьютера или сам компьютер. | |
| Le petit chaperon rouge | Обозначает слова на иностранном языке. | |
| Предупреждение! | Зарезервировано для особых предупреждений, чтобы подчеркнуть важность слов. Читается вслух :-) |
![[Note]](images/note.png) | Замечание |
|---|---|
Выделяет примечание. Обычно в нём содержится дополнительная информация об определённом контексте. | |
![[Tip]](images/tip.png)
![[Warning]](images/warning.png)
В приведенном ниже примере показано описание автором аргументов команды:
команда <небуквенный аргумент> [--опция={арг1,арг2,арг3}]
[опциональный арг. ...] |
Эти соглашения являются стандартным и вы можете встретить их где угодно, например, в страницах руководства.
Знаки «<» (меньше) и «>» (больше) выделяют обязательный аргумент, но не копируемый один в один, а заменяемый на нужное вам значение. Например, <имя_файла> означает реальное имя файла. Если это имя foo.txt, вы должны ввести foo.txt, но не <foo.txt> или <имя_файла>.
Квадратные скобки («[ ]») выделяют необязательные аргументы, которые вы можете включать или не включать в свою команду.
Троеточие («...») означает произвольное число аргументов.
В фигурные скобки («{ }») заключаются аргументы, разрешённые для этого случая. Должен быть указан один из них.
Время от времени вам будет предлагаться нажать, например, клавиши Ctrl-R, означая, что вам нужно, нажав и удерживая клавишу Ctrl, и сразу после этого стукнуть по клавише R. То же самое относится к клавишам Alt и Shift.
Также, в отношении к меню, переход к пункту меню -> (Ctrl-R) означает: кликнуть по надписи , находящейся в меню (обычно расположенном в левом верхнем углу окна). Затем в ниспадающем меню кликните по пункту . Кроме того, для получения того же результата, вы можете воспользоваться комбинацией клавиш Ctrl-R (как описано выше).