diff --git a/crates/mdman/doc/mdman.md b/crates/mdman/doc/mdman.md index 30d07139be2..2025c13dc3d 100644 --- a/crates/mdman/doc/mdman.md +++ b/crates/mdman/doc/mdman.md @@ -57,11 +57,11 @@ man page: {{#option "`-t` _type_"}} Specifies the output type. The following output types are supported: -- `man` — A troff-style man page. Outputs with a numbered extension (like +- `man` — A troff-style man page. Outputs with a numbered extension (like `.1`) matching the man page section. -- `md` — A markdown file, after all handlebars processing has been finished. +- `md` — A markdown file, after all handlebars processing has been finished. Outputs with the `.md` extension. -- `txt` — A text file, rendered for situations where a man page viewer isn't +- `txt` — A text file, rendered for situations where a man page viewer isn't available. Outputs with the `.txt` extension. {{/option}} diff --git a/crates/mdman/doc/out/mdman.1 b/crates/mdman/doc/out/mdman.1 index c3a626d2510..0718d6ddb3c 100644 --- a/crates/mdman/doc/out/mdman.1 +++ b/crates/mdman/doc/out/mdman.1 @@ -73,17 +73,17 @@ next to the source file. Templates can be included with an expression like Specifies the output type. The following output types are supported: .sp .RS 4 -\h'-04'\(bu\h'+02'\fBman\fR \[em]\ A troff\-style man page. Outputs with a numbered extension (like +\h'-04'\(bu\h'+02'\fBman\fR \[em] A troff\-style man page. Outputs with a numbered extension (like \fB\&.1\fR) matching the man page section. .RE .sp .RS 4 -\h'-04'\(bu\h'+02'\fBmd\fR \[em]\ A markdown file, after all handlebars processing has been finished. +\h'-04'\(bu\h'+02'\fBmd\fR \[em] A markdown file, after all handlebars processing has been finished. Outputs with the \fB\&.md\fR extension. .RE .sp .RS 4 -\h'-04'\(bu\h'+02'\fBtxt\fR \[em]\ A text file, rendered for situations where a man page viewer isn't +\h'-04'\(bu\h'+02'\fBtxt\fR \[em] A text file, rendered for situations where a man page viewer isn't available. Outputs with the \fB\&.txt\fR extension. .RE .RE diff --git a/crates/mdman/doc/out/mdman.md b/crates/mdman/doc/out/mdman.md index 47b2b625d28..d0dd3451136 100644 --- a/crates/mdman/doc/out/mdman.md +++ b/crates/mdman/doc/out/mdman.md @@ -54,36 +54,36 @@ man page:
-t
type-t
typeman
— A troff-style man page. Outputs with a numbered extension (like
+man
— A troff-style man page. Outputs with a numbered extension (like
.1
) matching the man page section.md
— A markdown file, after all handlebars processing has been finished.
+md
— A markdown file, after all handlebars processing has been finished.
Outputs with the .md
extension.txt
— A text file, rendered for situations where a man page viewer isn't
+txt
— A text file, rendered for situations where a man page viewer isn't
available. Outputs with the .txt
extension.-o
outdir-o
outdir--url
base_url--url
base_url--man
name:
section=
url{{man name section}}
expression is used, the given URL will be inserted as a link. This
+--man
name:
section=
url{{man name section}}
expression is used, the given URL will be inserted as a link. This
may be specified multiple times. If a man page reference does not have a
matching --man
entry, then a relative link to a file named name.md
will
be used.