vacp2p
/
mdcheckr
mirror of
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update manpage, usage

This commit is contained in:
Michael 2017-06-06 16:34:46 +10:00
parent 51ebc2570d
commit c98635b3f0
3 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -29,6 +29,12 @@ sudo cp mdcheckr /usr/local/bin
## Usage
```
mdcheckr [ -h | --help ] [ -v | --version ] FILE ..
```
## Examples
Check a single markdown file:
```
@ -46,6 +52,3 @@ Check all the markdown files in your Git repository:
```bash
git ls-files | grep '\.md$' | tr '\n' '\0' | xargs -0 mdcheckr
```

2
mdcheckr
View File

@ -227,7 +227,7 @@ function explain() {
# Parse command-line optins...
function show_usage() {
cat << EOF
usage: mdcheckr [ -h | --help | -v | --version ] FILE ..
usage: mdcheckr [ -h | --help ] [ -v | --version ] FILE ..
EOF
}

2
mdcheckr.1
View File

@ -3,7 +3,7 @@
mdcheckr \- check markdown files for broken links and other errors.
.SH SYNOPSIS
.B mdcheckr
.IR file ...
[ \-h | --help ] [ -v | --version ] FILE ..
.SH DESCRIPTION
.B mdcheckr
checks for broken internal and external links, as well as syntax issues with