diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-12-23 23:59:50 -0700 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-12-24 00:52:24 -0700 |
| commit | 9e68325a273a1aae59b782652263b2b951bf98cb (patch) | |
| tree | e3da92b08443bf6f5fd5656b8d92208157e77209 /docs/modules | |
| parent | ab32e3edf0fcdae975a6839050ad8783fa73b681 (diff) | |
fix documentation to state that mantitle and manvolnum can only be overridden using doctitle
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/manpage-backend/pages/index.adoc | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/modules/manpage-backend/pages/index.adoc b/docs/modules/manpage-backend/pages/index.adoc index 9962a357..f1dccbb7 100644 --- a/docs/modules/manpage-backend/pages/index.adoc +++ b/docs/modules/manpage-backend/pages/index.adoc @@ -136,15 +136,18 @@ These attributes must be set in the document header. |Attribute |Description |Value (as parsed from example above) |`mantitle` -|Alternative way to set the man page name. +|Can be set by overriding the `doctitle` attribute. +Must include both the man page name and volume number. |ASCIIDOCTOR(1) |`manvolnum` -|Manual section number. -|1 +|Can be set by overriding the `doctitle` attribute. +Must include both the man page name and volume number. +|ASCIIDOCTOR(1) |`manname` |Alternative way to set the command name. +Only used if `manpurpose` is also set. |asciidoctor |`manpurpose` |