Skip to content

Commit

Permalink
doc: fix -pP description
Browse files Browse the repository at this point in the history
Previously, the docs said that -p == --paste-after
and that -P == --paste-before
and didn't mention --paste-section-after/--paste-section-before at all.

That's not correct.

Actually, -p == --paste-section-after
and -P == --paste-section-before;
also there's --paste-after and --paste-before
which have no short option alias.
  • Loading branch information
mle86 committed Nov 18, 2019
1 parent fac90f0 commit 35b65b0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ to Markdown README files.
# Options


* **-p**, **--paste-after** _SECTION_:_FILENAME_
* **-p**, **--paste-section-after** _SECTION_:_FILENAME_
Instructs the program to attach a Markdown file
after the section named _SECTION_
has been completely written to the output.
Expand All @@ -29,11 +29,15 @@ to Markdown README files.
as their top-level section title.
This option can be supplied more than once.
Multiple files for the same section will be attached in the options' order.
* **-P**, **--paste-before** _SECTION_:_FILENAME_
Like **--paste-after**,
* **-P**, **--paste-section-before** _SECTION_:_FILENAME_
Like **--paste-section-after**,
but attaches the file contents
to the output
just _before_ the named section is written.
* **--paste-after** _SECTION_:_FILENAME_
Like **--paste-section-after**, but does not add a section title.
* **--paste-before** _SECTION_:_FILENAME_
Like **--paste-section-before**, but does not add a section title.
* **-c**, **--comment** [_COMMENT_]
Adds an invisible comment as first line.
Without the argument, it uses this default comment:
Expand Down
12 changes: 9 additions & 3 deletions doc/man-to-md.1
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ man page files
to Markdown README files.
.SH OPTIONS
.TP
\fB\-p\fR, \fB\-\-paste\-after\fR \fISECTION\fR:\fIFILENAME\fR
\fB\-p\fR, \fB\-\-paste\-section\-after\fR \fISECTION\fR:\fIFILENAME\fR
Instructs the program to attach a Markdown file
after the section named \fISECTION\fR
has been completely written to the output.
Expand All @@ -31,12 +31,18 @@ as their top-level section title.
This option can be supplied more than once.
Multiple files for the same section will be attached in the options' order.
.TP
\fB\-P\fR, \fB\-\-paste\-before\fR \fISECTION\fR:\fIFILENAME\fR
Like \fB\-\-paste\-after\fR,
\fB\-P\fR, \fB\-\-paste\-section\-before\fR \fISECTION\fR:\fIFILENAME\fR
Like \fB\-\-paste\-section\-after\fR,
but attaches the file contents
to the output
just \fIbefore\fR the named section is written.
.TP
\fB\-\-paste-after\fR \fISECTION\fR:\fIFILENAME\fR
Like \fB\-\-paste\-section\-after\fR, but does not add a section title.
.TP
\fB\-\-paste-before\fR \fISECTION\fR:\fIFILENAME\fR
Like \fB\-\-paste\-section\-before\fR, but does not add a section title.
.TP
\fB\-c\fR, \fB\-\-comment\fR [\fICOMMENT\fR]
Adds an invisible comment as first line.
Without the argument, it uses this default comment:
Expand Down

0 comments on commit 35b65b0

Please sign in to comment.