Skip to content

Commit 0d8cc26

Browse files
committed
Some md-convert doc tweaks.
1 parent 2955888 commit 0d8cc26

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

INSTALL.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ build user (after installing python3's pip package):
2626
2727
You can test if you've got it fixed by running (from the rsync checkout):
2828

29-
> ./md2man --test rsync-ssl.1.md
29+
> ./md-convert --test rsync-ssl.1.md
3030
3131
Alternately, you can avoid generating the manpages by fetching the very latest
3232
versions (that match the latest git source) from the [generated-files][6] dir.

md-convert

+3-3
Original file line numberDiff line numberDiff line change
@@ -609,12 +609,12 @@ def die(*msg):
609609

610610

611611
if __name__ == '__main__':
612-
parser = argparse.ArgumentParser(description="Output html and (optionally) nroff for markdown pages.", add_help=False)
612+
parser = argparse.ArgumentParser(description="Convert markdown into html and (optionally) nroff. Each input filename must have a .md suffix, which is changed to .html for the output filename. If the input filename ends with .num.md (e.g. foo.1.md) then a nroff file is also output with the input filename's .md suffix removed (e.g. foo.1).", add_help=False)
613613
parser.add_argument('--test', action='store_true', help="Just test the parsing without outputting any files.")
614-
parser.add_argument('--dest', metavar='DIR', help="Put files into DIR instead of the current directory.")
614+
parser.add_argument('--dest', metavar='DIR', help="Create files in DIR instead of the current directory.")
615615
parser.add_argument('--debug', '-D', action='count', default=0, help='Output copious info on the html parsing. Repeat for even more.')
616616
parser.add_argument("--help", "-h", action="help", help="Output this help message and exit.")
617-
parser.add_argument("mdfiles", nargs='+', help="The source .md files to convert.")
617+
parser.add_argument("mdfiles", metavar='FILE.md', nargs='+', help="One or more .md files to convert.")
618618
args = parser.parse_args()
619619

620620
try:

0 commit comments

Comments
 (0)