Skip to content

Commit

Permalink
mdman: update mdman's example outputs
Browse files Browse the repository at this point in the history
  • Loading branch information
weihanglo committed Apr 28, 2023
1 parent e3dec38 commit 137c82a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions crates/mdman/doc/out/mdman.1
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
.SH "NAME"
mdman \- Converts markdown to a man page
.SH "SYNOPSIS"
\fBmdman\fR [\fIoptions\fR] \fB\-t\fR \fItype\fR \fB\-o\fR \fIoutdir\fR \fIsources...\fR
\fBmdman\fR [\fIoptions\fR] \fB\-t\fR \fItype\fR \fB\-o\fR \fIoutdir\fR \fIsources\[u2026]\fR
.SH "DESCRIPTION"
Converts a markdown file to a man page.
.sp
Expand Down Expand Up @@ -83,7 +83,7 @@ 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\[cq]t
available. Outputs with the \fB\&.txt\fR extension.
.RE
.RE
Expand All @@ -107,7 +107,7 @@ matching \fB\-\-man\fR entry, then a relative link to a file named \fIname\fR\fB
be used.
.RE
.sp
\fIsources...\fR
\fIsources\[u2026]\fR
.RS 4
The source input filename, may be specified multiple times.
.RE
Expand Down
4 changes: 2 additions & 2 deletions crates/mdman/doc/out/mdman.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ man page:
<code>.1</code>) matching the man page section.</li>
<li><code>md</code> — A markdown file, after all handlebars processing has been finished.
Outputs with the <code>.md</code> extension.</li>
<li><code>txt</code> — A text file, rendered for situations where a man page viewer isn't
<li><code>txt</code> — A text file, rendered for situations where a man page viewer isnt
available. Outputs with the <code>.txt</code> extension.</li>
</ul></dd>

Expand All @@ -82,7 +82,7 @@ matching <code>--man</code> entry, then a relative link to a file named <em>name
be used.</dd>


<dt class="option-term" id="option-mdman-sources..."><a class="option-anchor" href="#option-mdman-sources..."></a><em>sources...</em></dt>
<dt class="option-term" id="option-mdman-sources"><a class="option-anchor" href="#option-mdman-sources"></a><em>sources</em></dt>
<dd class="option-desc">The source input filename, may be specified multiple times.</dd>


Expand Down
6 changes: 3 additions & 3 deletions crates/mdman/doc/out/mdman.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ NAME
mdman - Converts markdown to a man page

SYNOPSIS
mdman [options] -t type -o outdir sources...
mdman [options] -t type -o outdir sources

DESCRIPTION
Converts a markdown file to a man page.
Expand Down Expand Up @@ -65,7 +65,7 @@ OPTIONS
finished. Outputs with the .md extension.

o txt — A text file, rendered for situations where a man page
viewer isn't available. Outputs with the .txt extension.
viewer isnt available. Outputs with the .txt extension.

-o outdir
Specifies the directory where to save the output.
Expand All @@ -81,7 +81,7 @@ OPTIONS
does not have a matching --man entry, then a relative link to a file
named name.md will be used.

sources...
sources
The source input filename, may be specified multiple times.

EXAMPLES
Expand Down

0 comments on commit 137c82a

Please sign in to comment.