aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 15 insertions, 6 deletions
diff --git a/README b/README
index 409270163..c58818448 100644
--- a/README
+++ b/README
@@ -645,16 +645,25 @@ title block appears in the document, the title prefix will be used by
itself as the HTML title.
The man page writer extracts a title, man page section number, and
-other header and footer information from the title line. These should
-be separated by pipe characters (`|`), as follows:
+other header and footer information from the title line. The title
+is assumed to be the first word on the title line, which may optionally
+end with a (single-digit) section number in parentheses. (There should
+be no space between the title and the parentheses.) Anything after
+this is assumed to be additional footer and header text. A single pipe
+character (`|`) should be used to separate the footer text from the header
+text. Thus,
- % title | section number (1-9) | footer left | header center
+ % pandoc(1)
-For example,
+will yield a man page with the title `pandoc` and section 1.
- % pandoc | 1 | Pandoc User Manuals | Version 4.0
+ % pandoc(1) Pandoc User Manuals
-The middle of the man page footer is used for the date.
+will also have "Pandoc User Manuals" in the footer.
+
+ % pandoc(1) Pandoc User Manuals | Version 4.0
+
+will also have "Version 4.0" in the header.
Markdown in HTML blocks
-----------------------