Приняты следующие соглашения об оформлении:
Имена файлов, названия команд, конфигурационные параметры и комбинации клавиш выделяются следующим образом:
/etc/passwd– имя файла;whoami – команда;
http_access allow all– конфигурационный параметр;ctrl-z – комбинация клавиш
Команды и результаты их выполнения представлены на текстовых скриншотах:
$ uname -a
Linux modell.xt.vpn 2.6.8 #1 Mon Sep 6 14:06:09 EEST 2004 i686 GNU/Linux 
Команда
отличается от результатов её работы
более жирным начертанием текста.
Команды, которые выполняются от имени простого пользователя, записываются с приглашением
$, а команды, которые должны быть выполнены от имени суперпользователяroot, записываются с приглашением#:$ id uid=1000(devi) gid=1000(devi) группы=6(disk),24(cdrom),... # id uid=0(root) gid=0(root) группы=0(root)
Изменения, которые нужно сделать с помощью текстового редактора, представлены в формате редактора ed, который получил второе рождение благодаря использованию в программе diff:
# vi /etc/inittab5c5 < id:5:initdefault:
---
> id:3:initdefault:
Представленный диффшот (diffshot) говорит о том, что необходимо заменить пятую строку файла
/etc/inittab
строкой .
Участки текста специфичные для операционной системы Linux или для операционной системы FreeBSD выделяются стилем. Это относится и к командам:
# cd /usr/ports# rpm -i xbill-2.1.4-0.i386.rpmАналогичным образом выделяются и блоки текста, скриншоты и диффшоты.
Инсталляция программного обеспечения может выполняться из пакетов и портов. В первом случае программное обеспечение попадает в систему в откомпилированном виде; во втором – в виде исходного кода, который компилируется и собирается непосредственно в системе.
Раньше, определить относится ли ядро к стабильной ветке, можно было по так называемому минорному номеру – второму числу в версии ядра. Чётные числа обозначали стабильные ядра; нечётные – ядра для разработчиков.
Блоки ссылок содержат ссылки на основные информационные ресурсы, которые могут помочь при изучении модуля.
Поисковый сервер Google
Русскоязычный информационный портал для системных администраторов OpenNet
Учебный центр Сетевые Технологии
Примеры выделяются отступом и вертикальной чертой справа. Пример примера приведён ниже (Пример примера).
В тех случаях, когда необходимо привлечь внимание читателя к распространённой ошибке в команде или конфигурационном параметре, он выделяется специальным стилем.
Пример 1. Пример представления правильных команд и команд с ошибками
Одна из распространённых ошибок при использовании
опции-команды -exec программы find -- отсутствие символа экранирования \
перед символом ; завершающим аргумент -exec:
$ find / -name core -exec rm {} ;
find: отсутствует аргумент у `-exec'
Символ ; не передаётся программе find, поскольку он рассматривается
командным интерпретатором как служебный символ, обозначающий окончание строки.
Правильно записанная команда выглядит следующим образом:
$ find / -name core -exec rm {} \;
Символ экранирования \ защищает ; от обработки командным интерпретатором,
и он передаётся программе find.