man-pages(7)

ИМЯ
man-pages — правила написания справочных страниц Linux

СИНТАКСИС
man [раздел] имя

ОПИСАНИЕ
На этой странице описаны правила, которые необходимо применять при написании справочных страниц для проекта man-pages Linux, который, в свою очередь, документирует программный интерфейс пространства пользователя, предоставляемый ядром Linux и библиотекой GNU C. Таким образом, проект отвечает за большинство страниц из Раздела 2, за многие страницы из Разделов 3, 4, и 7, и за несколько страниц из Разделов 1, 5 и 8 справочной системы Linux. Данные правила также могут быть полезны при написании справочных страниц для других проектов.

  Разделы справочных страниц
Традиционно они следующие:

1 Команды пользователя (Программы)
    Commands that can be executed by the user from within a shell.

2 Системные вызовы
    Functions which wrap operations performed by the kernel.

3 Библиотечные вызовы
    Все библиотечные функции (в основном функции libc), за исключением представленных в Разделе 2.

4 Специальные файлы (устройства)
    Файлы из /dev, дающие доступ к устройствам через ядро.

5 Форматы файлов и конфигурационные фалы
    Описывает различные подходящие для чтения форматы файлов и конфигурационные файлы.

6 Игры
    Игры и забавные небольшие программы

7 Обзоры, соглашения и разное
    Описания или обзоры, касающиеся различных тем, соглашений и протоколов, а также наборов символов, стандартный шаблон файловой системы, разное.

8 Команды для системного администрирования
    Команды подобные mount(8), большинство из которых могут запускаться только суперпользователем.

  Пакет макросов
Новые справочные страницы должны размечаться с помощью пакета groff an.tmac, описанного в man(7). Данный выбор основан, в основном, на том, что большинство из существующих страниц Linux размечены с помощью этих макросов.

  Правила, касающиеся формата исходных файлов
Длина строки не должна превышать 75 символов. В некоторых почтовых клиентах это помогает избежать переноса строк в заплатах, встроенные в письмо.

  Заголовок
Первой должна быть команда TH:

    .TH title section date source manual-section

The arguments of the command are as follows:

заголовок
    Название страницы, написанное заглавными буквами (например MAN-PAGES).

раздел
    Номер раздела для размещения страницы (например 7).

дата
    Дата последнего значительного изменения справочной страницы (в проекте man-pages необходимые обновления временных отметок выполняются автоматически при помощи сценариев, вручную устанавливать её заплатой не нужно). Дата должна иметь вид YYYY-MM-DD, т. е. год-месяц-день.

источник
    The name and version of the project that provides the manual page (not necessarily the package that provides the functionality).

manual-section
    Normally, this should be empty, since the default value will be good.

  Разделы внутри справочной страницы
Следующий список содержит общепринятые и рекомендуемые разделы. Большинство справочных страниц должно включать в себя по крайней мере выделенные жирным разделы. Соблюдайте очередность, как показано в списке.

    NAME
    LIBRARY | [Normally only in Sections 2, 3]
    ОБЗОР
    НАСТРОЙКА | [Normally only in Section 4]
    ОПИСАНИЕ
    ПАРАМЕТРЫ | [Normally only in Sections 1, 8]
    КОД РЕЗУЛЬТАТА | [Normally only in Sections 1, 8]
    ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ | [Normally only in Sections 2, 3]
    ОШИБКИ | [Typically only in Sections 2, 3]
    ОКРУЖЕНИЕ
    ФАЙЛЫ
    ВЕРСИИ | [Normally only in Sections 2, 3]
    АТРИБУТЫ | [Normally only in Sections 2, 3]
    СТАНДАРТЫ
    ЗАМЕЧАНИЯ
    CAVEATS
    ДЕФЕКТЫ
    ПРИМЕРЫ
    АВТОРЫ | [Discouraged]
    ИНФОРМАЦИЯ ОБ ОШИБКАХ | [Not used in man-pages]
    АВТОРСКИЕ ПРАВА | [Not used in man-pages]
    СМОТРИ ТАКЖЕ

Там, где обычно используются заголовки, используйте их; это правило может сделать информацию более доступной для понимания. Если это необходимо, Вы можете создать свои собственные заголовки, если они сделают текст более понятным (это может быть особенно полезным для страниц в разделах 4 и 5). Тем не менее, прежде чем создавать их, подумайте, можно ли обойтись традиционными заголовками с созданием своих собственных подразделов (.SS) в пределах стандартных разделов.

В приведённом ниже списке объясняется назначение каждого из разделов.

NAME
    Название данной справочной страниц.

    Смотрите man(7), чтобы ознакомиться с правилами написания заголовков, которые должны следовать за командой .SH NAME. Все слова в этой строке (в том числе идущие сразу после «\-») должны быть в нижнем регистре, за исключением тех случаев, когда правилами языка, на котором написана страница, или сложившейся практикой употребления технических терминов определено иное.

LIBRARY
    The library providing a symbol.

    It shows the common name of the library, and in parentheses, the name of the library file and, if needed, the linker flag needed to link a program against it: (libfoo[, -lfoo]).

ОБЗОР
    Краткое описание команды или интерфейса функции

    Для команд здесь показываются синтаксис и аргументы (включая параметры); полужирное начертание используется для неизменяемого текста, а курсивом обозначаются меняющиеся аргументы. Квадратные скобки ([]) показывают необязательные аргументы, вертикальная черта (|) указывает на выбор одного из вариантов, многоточие (...) означает возможное повторение. Для функций показываются все необходимые объявления данных или #include директивы с последующим объявлением функции.

    Если для получения объявления функции (или переменной) из заголовочного файла требуется определить макрос тестирования свойств, то это указывается в ОБЗОРЕ согласно описанию из feature_test_macros(7).

КОНФИГУРАЦИЯ
    Особенности настройки устройства

    Этот раздел, как правило, присутствует только в разделе 4.

ОПИСАНИЕ
    Объяснение того, для чего предназначена программа, функция или формат

    Здесь описывается взаимодействие с файлами и стандартным вводом, и что записывается в стандартный вывода вывод или ошибок; не приводятся детали реализации, если они не критичны для понимания интерфейса; показывается типичное использование; информация о параметрах командной строки программы даётся в разделе OPTIONS.

    Если описывается новое поведение или новые флаги системного вызова или библиотечной функции, отметьте где введено изменение — версию ядра или библиотеки С. Данную информацию целесообразно приводить в виде части списка .TP в следующем виде (здесь показан новый флаг системного вызова):

    XYZ_FLAG (начиная с Linux 3.7)
        Описание флагов…

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

ПАРАМЕТРЫ
    Описание параметров командной строки и их влияния на поведение программы.

    Этот раздел как правило содержится только в разделах 1 и 8.

КОД ВЫХОДА
    Перечень возможных значений кода выхода программы и ситуаций, при которых программа возвращает данное значение кода.

    Этот раздел как правило содержится только в разделах 1 и 8.

ВОЗВРАЩАЕМЫЕ ЗНАЧЕНИЯ
    Для разделов 2 и 3 эта секция содержит перечень значений, возвращаемых библиотеками вызывающей их программе и условия, при которых библиотеки возвращают данные значения.

ОШИБКИ
    В справочных страницах разделов 2 и 3 здесь описываются значения ошибок, которые могут быть помещены в errno, а также приводится описание причин ошибок.

    Если ошибка возникает при нескольких различных условиях, предпочтительней создавать отдельные записи списка (с повторением имени ошибки) для каждого из условий. Такое разделение делает условия более понятными, этот список проще читать и можно указывать метаинформацию (например, номер версии ядра, в котором условие начало действовать) на каждое условие.

    Список ошибок должен быть в алфавитном порядке.

ОКРУЖЕНИЕ
    Перечень переменных окружения, влияющих на программу и оказываемый ими эффект.

ФАЙЛЫ
    Список файлов, используемых программой или функцией, таких как конфигурационные файлы, файлы запуска и файлы, с которыми непосредственно работает программа.

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

АТРИБУТЫ
    Общая информация о различных атрибутах функции(функций), описанной на этой странице. Смотри attributes(7) для получения дополнительных сведений.

ВЕРСИИ
    Краткое описание ядра Linux или версии glibc, где впервые появился системный вызов или функция библиотеки, либо существенно изменилось их действие.

    As a general rule, every new interface should include a VERSIONS section in its manual page. Unfortunately, many existing manual pages don't include this information (since there was no policy to do so when they were written). Patches to remedy this are welcome, but, from the perspective of programmers writing new code, this information probably matters only in the case of kernel interfaces that have been added in Linux 2.4 or later (i.e., changes since Linux 2.2), and library functions that have been added to glibc since glibc 2.1 (i.e., changes since glibc 2.0).

    Справочная страница syscalls(2) также содержит информацию о версиях ядра, в которых были впервые реализованы различные системные вызовы.

СТАНДАРТЫ
    Описание любых стандартов или соглашений, относящихся к функции или команде, речь о которой идет на странице.

    Предпочтительные обозначения для различных стандартов указаны в качестве заголовков на странице standards(7).

    Для страницы из раздела 2 или 3, данный раздел должен показывать версию POSIX.1, которой соответствует вызов, а также есть ли вызов в C99 (наличие в других стандартах, таких как SUS, SUSv2 и XPG, или реализациях стандартов SVr4 и 4.xBSD, не важно; если вызов был в этих стандартах, но отсутствует в текущей версии POSIX.1, то это стоит упомянуть).

    Если вызов не соответствует какому-либо стандарту, но существует во многих системах, также упомяните об этом. Если вызов есть только в Linux, то это также стоит отметить.

    If this section consists of just a list of standards (which it commonly does), terminate the list with a period ('.').

ЗАМЕЧАНИЯ
    Различные замечания.

    For Section 2 and 3 man pages you may find it useful to include subsections (SS) named Linux Notes and glibc Notes.

    В разделе 2 используйте заголовок Различия между ядром и библиотекой С, чтобы отметить различия (если имеются) между системными вызовами функций библиотеки и ядра.

CAVEATS
    Warnings about typical user misuse of an API, that don't constitute an API bug or design defect.

ДЕФЕКТЫ
    Перечень известных ошибок, ограничений, недостатков причиняющих неудобство а также других сомнительных свойств.

ПРИМЕРЫ
    Один или несколько примеров, демонстрирующих, каким образом данная функция, команда или файл используются.

    Для получения более подробной информации о написании примеров программ смотрите раздел Примеры программ далее.

АВТОРЫ
    Список авторов документа или программы.

    Использовать раздел АВТОРЫ настоятельно не рекомендуется. Лучше не загромождать каждую страницу списком авторов (список со временем увеличивается); если вы написали или значительно исправили страницу, добавьте уведомление об авторском праве в виде комментария в исходный файл. Если вы автор драйвера устройства и хотите включить адрес для отправки сообщений об ошибках, то сделайте это в разделе ДЕФЕКТЫ.

REPORTING BUGS
    The man-pages project doesn't use a REPORTING BUGS section in manual pages. Information on reporting bugs is instead supplied in the script-generated COLOPHON section. However, various projects do use a REPORTING BUGS section. It is recommended to place it near the foot of the page.

АВТОРСКОЕ ПРАВО
    The man-pages project doesn't use a COPYRIGHT section in manual pages. Copyright information is instead maintained in the page source. In pages where this section is present, it is recommended to place it near the foot of the page, just above SEE ALSO.

СМОТРИ ТАКЖЕ
    Разделённый запятыми список уместных справочных страниц, возможно, ведущих на другие страницы или документы.

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

    Если список СМОТРИТЕ ТАКЖЕ содержит много длинных имён справочных страниц, то для улучшения визуального представления может быть полезно воспользоваться командами .ad l (не выравнивать по правому краю) и .nh (отключить перенос). Запретить перенос имён справочных страниц можно с помощью указания перед словом строки «\%».

    Given the distributed, autonomous nature of FOSS projects and their documentation, it is sometimes necessary—and in many cases desirable—that the SEE ALSO section includes references to manual pages provided by other projects.

FORMATTING AND WORDING CONVENTIONS
The following subsections note some details for preferred formatting and wording conventions in various sections of the pages in the man-pages project.

  СИНТАКСИС
Wrap the function prototype(s) in a .nf/.fi pair to prevent filling.

In general, where more than one function prototype is shown in the SYNOPSIS, the prototypes should not be separated by blank lines. However, blank lines (achieved using .PP) may be added in the following cases:

•   to separate long lists of function prototypes into related groups (see for example list(3));

•   in other cases that may improve readability.

In the SYNOPSIS, a long function prototype may need to be continued over to the next line. The continuation line is indented according to the following rules:

(1) If there is a single such prototype that needs to be continued, then align the continuation line so that when the page is rendered on a fixed-width font device (e.g., on an xterm) the continuation line starts just below the start of the argument list in the line above. (Exception: the indentation may be adjusted if necessary to prevent a very long continuation line or a further continuation line where the function prototype is very long.) As an example:

    int tcsetattr(int fd, int optional_actions,
                  const struct termios *termios_p);

(2) But, where multiple functions in the SYNOPSIS require continuation lines, and the function names have different lengths, then align all continuation lines to start in the same column. This provides a nicer rendering in PDF output (because the SYNOPSIS uses a variable width font where spaces render narrower than most characters). As an example:

    int getopt(int argc, char * const argv[],
               const char *optstring);
    int getopt_long(int argc, char * const argv[],
               const char *optstring,
               const struct option *longopts, int *longindex);

  ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ
The preferred wording to describe how errno is set is "errno is set to indicate the error" or similar. This wording is consistent with the wording used in both POSIX.1 and FreeBSD.

  АТРИБУТЫ
Также заметим следующее:

•   Wrap the table in this section in a .ad l/.ad pair to disable text filling and a .nh/.hy pair to disable hyphenation.

•   Ensure that the table occupies the full page width through the use of an lbx description for one of the columns (usually the first column, though in some cases the last column if it contains a lot of text).

•   Make free use of T{/T} macro pairs to allow table cells to be broken over multiple lines (also bearing in mind that pages may sometimes be rendered to a width of less than 80 columns).

For examples of all of the above, see the source code of various pages.

РУКОВОДСТВО ПО СТИЛЮ ОФОРМЛЕНИЯ
В следующих абзацах представлен предпочтительный стиль написания страница в проекте man-pages. Если что-то не описано подробно, то следует придерживаться чикагского стилистического справочника (Chicago Manual of Style); также постарайтесь поискать схожие примеры в исходном коде дерева проекта.

  Использование гендерно-нейтральных выражений
Используйте гендерно-нейтральный язык в тексте справочных страниц насколько это возможно. Приемлемо использовать местоимения «они» («им», «себя», «их»).

  Соглашения о форматировании справочных страниц, описывающих команды
Для справочных страниц, описывающих команду (как правило в разделах 1 и 8), аргументы всегда указываются с помощью курсива, даже в разделе ОБЗОР.

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

  Соглашения по оформлению справочных страниц, описывающих функции
В справочных страницах, которые описывают функции (обычно, в разделах 2 и 3), параметры всегда оформляются, используя курсив; даже в разделе ОБЗОР, где остальная часть функции определена полужирным:

int имя_функции(int argc, char **argv);

Имена переменных, как и имена параметров, должны быть оформлены курсивом.

Любая ссылка на тему текущей справочной страницы должна быть записана с именем оформленным полужирным, включая пару круглых скобок, в прямом(нормальном) шрифте. Например, на странице fcntl(2), ссылки на тему страницы были бы записаны как: fcntl(). Рекомендуемый способ записи в исходном файле:

        .BR fcntl ()

(используйте этот формат вместо б\fB...\fP ()» — такой подход упрощает создание инструментов разбора исходных файлов справочных страниц)

  Использование семантики новых строк
In the source of a manual page, new sentences should be started on new lines, long sentences should be split into lines at clause breaks (commas, semicolons, colons, and so on), and long clauses should be split at phrase boundaries. This convention, sometimes known as "semantic newlines", makes it easier to see the effect of patches, which often operate at the level of individual sentences, clauses, or phrases.

  Списки
There are different kinds of lists:

Tagged paragraphs
    These are used for a list of tags and their descriptions. When the tags are constants (either macros or numbers) they are in bold. Use the .TP macro.

    An example is this "Tagged paragraphs" subsection is itself.

Ordered lists
    Elements are preceded by a number in parentheses (1), (2). These represent a set of steps that have an order.

    When there are substeps, they will be numbered like (4.2).

Positional lists
    Elements are preceded by a number (index) in square brackets [4], [5]. These represent fields in a set. The first index will be:

    0   When it represents fields of a C data structure, to be consistent with arrays.
    1   When it represents fields of a file, to be consistent with tools like cut(1).

Alternatives list
    Elements are preceded by a letter in parentheses (a), (b). These represent a set of (normally) exclusive alternatives.

Bullet lists
    Elements are preceded by bullet symbols (\[bu]). Anything that doesn't fit elsewhere is usually covered by this type of list.

Numbered notes
    Not really a list, but the syntax is identical to "positional lists".

There should always be exactly 2 spaces between the list symbol and the elements. This doesn't apply to "tagged paragraphs", which use the default indentation rules.

  Общие соглашения по оформлению
Параграфы должны разделяться подходящими маркерами (обычно .PP или .IP). Не разделяйте параграфы пробельными строками, так как это приводит к плохому отображению в некоторых выходных форматах (в частности, PostScript и PDF).

Имена файлов (также пути или ссылки на заголовочные файлы) всегда должны быть оформлены курсивом (например, <stdio.h>), кроме раздела ОБЗОР, где включаемые файлы должны быть полужирным (например, #include <stdio.h>). Тут ссылка на стандартный заголовочный файл включает имя заголовочного файл, окружённого угловыми скобками, это типично для C (например, <stdio.h>).

Специальные макросы, которые обычно находятся в верхнем регистре, оформляют полужирным (например, MAXINT). Исключение: не делайте полужирным NULL.

В списке, при перечислении кодов ошибок, коды оформляют полужирным (в этом списке обычно используют макрос .TP).

Составные команды, если они длинные, должны быть записаны с отступом по линии, как самодостаточные, с пустой строкой перед и после команды, например

    man 7 man-pages

If the command is short, then it can be included inline in the text, in italic format, for example, man 7 man-pages. In this case, it may be worth using nonbreaking spaces (\[ti]) at suitable places in the command. Command options should be written in italics (e.g., -l).

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

При показе примера сеанса оболочки пользовательский ввод должен быть выделен жирным, например

    $ date
    Thu Jul  7 13:01:27 CEST 2016

Все ссылки на другие справочные страницы должны выделяться жирным шрифтом, всегда должен быть указан номер раздела шрифтом Roman (обычным) и без пробелов (например, intro(2)). В исходном файле это лучше записывать так:

        .BR intro (2)

(включение номера раздела в перекрёстных ссылках позволяет таким инструментам как man2html(1) создавать правильные гиперссылки между страницами)

Control characters should be written in bold face, with no quotes; for example, ^X.

  Орфография
Начиная с версии man-pages следует при написании Американским соглашениям (до этого использовалось английское и американское написание); пишите новые страницы и присылайте заплаты с учётом этих соглашений.

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

•   Американский вариант английского языка имеет обыкновение использовать формы «backward» (назад), «upward» (вверх), «toward» (к) и т. д., а в британском варианте это «backwards», «upwards», «towards» и т. д.

•   Opinions are divided on "acknowledgement" vs "acknowledgment". The latter is predominant, but not universal usage in American English. POSIX and the BSD license use the former spelling. In the Linux man-pages project, we use "acknowledgement".

  Номера версий BSD
Классической схемой обозначения версий BSD является x.yBSD, где x.y - номер версии (например, 4.2BSD). Избегайте написания в стиле BSD 4.3.

  Печать заглавными буквами
В заголовках разделов («SS») начинайте первое слово заголовка с заглавной буквы, а остальные буквы должны быть строчными, если обратного не требуют правила английского языка (например, имён собственных) или языка программирования (например, идентификаторы имён). Пример:

    .SS Unicode under Linux

  Отступ при определении структур, содержимого журналов сеансов оболочек и т. п.
When structure definitions, shell session logs, and so on are included in running text, indent them by 4 spaces (i.e., a block enclosed by .in +4n and .in), format them using the .EX and .EE macros, and surround them with suitable paragraph markers (either .PP or .IP). For example:

    .PP
    .in +4n
    .EX
    int
    main(int argc, char *argv[])
    {
        return 0;
    }
    .EE
    .in
    .PP

  Предпочтительные термины
В следующей таблице перечислены некоторые предпочтительные термины, для использования в справочных страницах, главным образом, для непротиворечивости информации на страницах.
Термин (перевод) | Не используйте | Примечания
bit mask (маска битов) | bitmask
built-in (встроенный) | builtin
Epoch (эпоха) | epoch | Эпоха UNIX (00:00:00, 1 января 1970 UTC)
filename (имя файла) | file name
filesystem (файловая система) | file system
hostname (имя узла) | host name
inode | i-node
lowercase (строчные) | lower case, lower-case
nonzero | non-zero
pathname (путь) | path name
pseudoterminal (псевдо-терминал) | pseudo-terminal
privileged port (привилегированный порт) | reserved port, system port
real-time (реальное время) | realtime, real time
run time (время исполнения) | runtime
saved set-group-ID (сохранённый set-group-ID) | saved group ID, saved set-GID
saved set-user-ID (сохранённый saved set-user-ID) | saved user ID, saved set-UID
set-group-ID | set-GID, setgid
set-user-ID | set-UID, setuid
superuser (суперпользователь) | super user, super-user
superblock (суперблок) | super block, super-block
symbolic link | symlink
timestamp (метка времени) | time stamp
timezone (часовой пояс) | time zone
uppercase (прописные) | upper case, upper-case
usable (приемлемый) | useable
user space (пространство пользователя) | userspace
username (имя пользователя) | user name
x86-64 | x86_64 | Кроме случая, когда ссылаются на результат «uname -m» или подобных
zeros (нули) | zeroes

Смотрите также Дефисы в составных терминах далее.

  Термины, которых следует избегать
В следующей таблице перечислены некоторые термины, которые лучше не использовать в справочных страницах и предлагаемые им альтернативы, использование которых поможет избежать противоречий между справочными страницами.
Не используйте | Для использования | Примечания
32bit | 32-bit (32-битный) | это же с 8-bit, 16-bit и т. п.
current process (текущий процесс) | calling process (вызывающий процесс) | Частая ошибка, делаемая программистами ядра при написании справочных страниц
manpage | man page, manual page (справочная страница)
minus infinity (минус бесконечность) | negative infinity (отрицательная бесконечность)
non-root | unprivileged user (непривилегированный пользователь)
non-superuser | unprivileged user (непривилегированный пользователь)
nonprivileged | непривилегированный
OS | operating system (операционная система)
plus infinity (плюс бесконечность) | positive infinity (положительная бесконечность)
pty | pseudoterminal (псевдо-терминал)
tty | terminal (терминал)
Unices | UNIX systems (системы UNIX)
Unixes | UNIX systems (системы UNIX)

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

    DG/UX
    HP-UX
    UNIX
    UnixWare

  NULL, NUL, null pointer, and null byte
A null pointer is a pointer that points to nothing, and is normally indicated by the constant NULL. On the other hand, NUL is the null byte, a byte with the value 0, represented in C via the character constant '\0'.

Данный указатель лучше называть «указатель null» или просто «NULL»; не используйте «указатель NULL».

Для описания байта используйте «байт null». Не пишите «NUL», так как такое наименование легко спутать с «NULL». Также избегайте терминов «нулевой байт» и «символ null». Байт, которым заканчиваются строки в C, нужно описывать как «завершающий байт null» (terminating null byte); про строки можно сказать как «завершающиеся null» (null-terminated), но не используйте «завершающиеся NUL».

  Гиперссылки
Для указания гиперссылок используйте пару макросов .UR/.UE (смотрите groff_man(7)). Они создаёт корректные гиперссылки, которые можно использовать при просмотре в браузере, например так:

    BROWSER=firefox man -H pagename

  Использование сокращений e.g. (например), i.e. (т. е.), a.k.a. (также известно как) и подобных
In general, the use of abbreviations such as "e.g.", "i.e.", "etc.", "cf.", and "a.k.a." should be avoided, in favor of suitable full wordings ("for example", "that is", "and so on", "compare to", "also known as").

Единственным приемлемым местом для их использования является короткая сноска (как, напр., эта).

Всегда указывайте точки в подобных аббревиатурах. Также после «напр.р» и «т.е.» всегда ставится запятая.

  Длинное тире
The way to write an em-dash—the glyph that appears at either end of this subphrase—in *roff is with the macro "\[em]". (On an ASCII terminal, an em-dash typically renders as two hyphens, but in other typographical contexts it renders as a long dash.) Em-dashes should be written without surrounding spaces.

  Дефисы в составных терминах
Составные термины пишутся через дефис при использовании в качестве определителя (т. е., для уточнения последующего существительного). Примеры:

    32-bit value
    command-line argument
    floating-point number
    run-time check
    user-space function
    wide-character string

  Дефис с multi, non, pre, re, sub и т. п.
Общая тенденция на современном английском языке состоит в том, чтобы не ставить дефисы после префиксов «multi», «non», «pre», «re», «sub» и т. д. В справочных страницах, в основном, нужно следовать этому правилу, когда эти префиксы используются в естественных английских конструкциях с простыми суффиксами. В следующем списке приведены некоторые примеры правильного написания:

    interprocess
    multithreaded
    multiprocess
    nonblocking
    nondefault
    nonempty
    noninteractive
    nonnegative
    nonportable
    nonzero
    preallocated
    precreate
    prerecorded
    reestablished
    reinitialize
    rearm
    reread
    subcomponent
    subdirectory
    subsystem

Дефисы должны быть сохранены после префиксов для нестандартных английских слов, торговых марок, имён собственных, акронимов или составных терминов. Несколько примеров:

    non-ASCII
    non-English
    non-NULL
    non-real-time

И напоследок заметим, что «re-create» и «recreate» — это два различных глагола и первый, вероятно то, что нужно.

  Generating optimal glyphs
Если требуется символ математического минуса (например, для чисел (-1), перекрёстных ссылок справочных страниц (utf-8(7) или при записи параметров, у которых есть начальные тире (ls -l)), используйте следующую форму записи в справочной странице:

    \-

Это правило применимо и в примерах кода.

The use of real minus signs serves the following purposes:

•   To provide better renderings on various targets other than ASCII terminals, notably in PDF and on Unicode/UTF-8-capable terminals.

•   To generate glyphs that when copied from rendered pages will produce real minus signs when pasted into a terminal.

To produce unslanted single quotes that render well in ASCII, UTF-8, and PDF, use "\[aq]" ("apostrophe quote"); for example

    \[aq]C\[aq]

где C — символ в кавычках. Это правило применимо и в примерах кода.

Where a proper caret (^) that renders well in both a terminal and PDF is required, use "\[ha]". This is especially necessary in code samples, to get a nicely rendered caret when rendering to PDF.

Using a naked "~" character results in a poor rendering in PDF. Instead use "\[ti]". This is especially necessary in code samples, to get a nicely rendered tilde when rendering to PDF.

  Примеры программ и сценариев оболочки
Справочные страницы могут включать примеры программ, демонстрирующие использование системных вызовов или библиотечных функций. При этом нужно учитывать ряд условий:

•   Примеры программ должны быть написаны на языке C.

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

•   Example programs should ideally be short (e.g., a good example can often be provided in less than 100 lines of code), though in some cases longer programs may be necessary to properly illustrate the use of an API.

•   Expressive code is appreciated.

•   Comments should included where helpful. Complete sentences in free-standing comments should be terminated by a period. Periods should generally be omitted in "tag" comments (i.e., comments that are placed on the same line of code); such comments are in any case typically brief phrases rather than complete sentences.

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

•   Примеры программ должны быть полными и компилироваться без предупреждений при использовании cc -Wall.

•   Там, где это возможно и целесообразно, примеры программ должны демонстрировать эксперимент, изменяя свое поведение в зависимости от входных параметров (в идеале от параметров командной строки или получаемых программой через стандартный ввод).

•   Примеры программ должны быть написаны в стиле Кернигана (Kernighan) и Ритчи (Ritchie), с отступом, состоящим из 4 пробелов. (Избегайте использования символа табуляции в исходном коде!) Следующие команды могут быть использованы для форматирования исходного кода в что-то близкое к предпочтительному стилю:

        indent -npro -kr -i4 -ts4 -sob -l72 -ss -nut -psl prog.c

•   Для удобства восприятия, все программы должны завершаться с использованием одного из вариантов:

        exit(EXIT_SUCCESS);
        exit(EXIT_FAILURE);

    Избегайте использования следующих форм завершения программы:

        exit(0);
        exit(1);
        return n;

•   В случаях, когда примеру программы предшествует обширный пояснительный текст, определите код в подраздел и пометьте соответствующим заголовком Код программы, как показано ниже:

        .SS Program source

    Всегда делайте это, если пояснительный текст включает примеры вывода в терминал.

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

•   Place the session log above the source code listing.

•   Обозначьте лог терминала четырьмя пробелами.

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

Ознакомиться с тем, как должны выглядеть примеры программ Вы можете, прочитав wait(2) и pipe(2).

ПРИМЕРЫ
В качестве канонического примера того, как должны выглядеть страницы в пакете man-pages, смотрите pipe(2) и fcntl(2).

СМ. ТАКЖЕ
man(1), man2html(1), attributes(7), groff(7), groff_man(7), man(7), mdoc(7)

ПЕРЕВОД
Русский перевод этой страницы руководства был сделан aereiae <aereiae@gmail.com>, Alexey <a.chepugov@gmail.com>, Azamat Hackimov <azamat.hackimov@gmail.com>, Dmitriy S. Seregin <dseregin@59.ru>, Dmitry Bolkhovskikh <d20052005@yandex.ru>, ITriskTI <ITriskTI@gmail.com>, Max Is <ismax799@gmail.com>, Yuri Kozlov <yuray@komyakino.ru>, Иван Павлов <pavia00@gmail.com> и Малянов Евгений Викторович <maljanow@outlook.com>

Этот перевод является бесплатной документацией; прочитайте Стандартную общественную лицензию GNU версии 3 (https://www.gnu.org/licenses/gpl-3.0.html) или более позднюю, чтобы узнать об условиях авторского права. Мы не несем НИКАКОЙ ОТВЕТСТВЕННОСТИ.

Если вы обнаружите ошибки в переводе этой страницы руководства, пожалуйста, отправьте электронное письмо на man-pages-ru-talks@lists.sourceforge.net.