diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2022-01-04 01:59:04 -0700 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2022-01-04 01:59:04 -0700 |
| commit | afe08ff207c307ec76defeafa18635987bde2ab4 (patch) | |
| tree | 8337de0a8a65b9d7c5130004735422e4d51e7768 /docs/modules | |
| parent | afa970836219b5655b63dc5b36aef7b696462665 (diff) | |
document how the secondary names are handled by the manpage converter
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/manpage-backend/pages/index.adoc | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/modules/manpage-backend/pages/index.adoc b/docs/modules/manpage-backend/pages/index.adoc index f1dccbb7..bf2a0481 100644 --- a/docs/modules/manpage-backend/pages/index.adoc +++ b/docs/modules/manpage-backend/pages/index.adoc @@ -37,8 +37,9 @@ There are several built-in document attributes that impact how the source is par Refer to the <<document-attributes>> section. The NAME Section:: -The first section is mandatory, must be titled "`Name`" (or "`NAME`") and must contain a single paragraph (usually a single line) consisting of a list of one or more comma-separated command name(s) separated from the command purpose by a dash character (e.g., `progname - does stuff`). +The first section is mandatory, must be titled "`Name`" (or "`NAME`"), and must contain a single paragraph (usually a single line) consisting of a list of one or more comma-separated command name(s) separated from the command's purpose by a dash character (e.g., `progname - does stuff` or `name1, name2 - does stuff`). The dash must have at least one space character on either side. +If multiple names are given, Asciidoctor will generate alias files for the secondary names that point to the primary name. The SYNOPSIS Section:: The second section is recommended and, if present, must be titled "`Synopsis`" (or "`SYNOPSIS`"). |