Skip to content

Commit

Permalink
Add docs for fileglob support in remark(1)
Browse files Browse the repository at this point in the history
Closes GH-120.
  • Loading branch information
wooorm committed Jan 3, 2016
1 parent fa1f0c1 commit f9f9a36
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 4 deletions.
7 changes: 6 additions & 1 deletion doc/remark.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@

## SYNOPSIS

`remark` \[`options`] <_file|dir_ _..._>
`remark` \[`options`] <_pathspec_...>

## DESCRIPTION

**remark** is a markdown processor powered by plugins.

<_pathspec_...> refers to files to process. Fileglobs (e.g., `*.md`)
can be given to add all matching files. Directories can be given (e.g. `dir`
to add `dir/readme.md` and `dir/sub/history.mkd`) to add files with a known
markdown extension (see the `-e`, `--ext` flag).

Logs verbose debugging information when `$DEBUG` is set to `"*"`.

## OPTIONS
Expand Down
2 changes: 1 addition & 1 deletion lib/cli/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ function help() {
var program = new Command(pack.name)
.version(pack.version)
.description(pack.description)
.usage('[options] <file|dir ...>')
.usage('[options] <pathspec...>')
.option('-o, --output [path]', 'specify output location')
.option('-c, --config-path <path>', 'specify configuration location')
.option('-i, --ignore-path <path>', 'specify ignore location')
Expand Down
4 changes: 3 additions & 1 deletion man/remark.1
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@
\fBremark\fR - Markdown processor
.SH "SYNOPSIS"
.P
\fBremark\fR \[lB]\fBoptions\fR\[rB] <\fIfile\[ba]dir\fR \fI...\fR>
\fBremark\fR \[lB]\fBoptions\fR\[rB] <\fIpathspec\fR...>
.SH "DESCRIPTION"
.P
\fBremark\fR is a markdown processor powered by plugins.
.P
<\fIpathspec\fR...> refers to files to process. Fileglobs (e.g., \fB*.md\fR) can be given to add all matching files. Directories can be given (e.g. \fBdir\fR to add \fBdir\[sl]readme.md\fR and \fBdir\[sl]sub\[sl]history.mkd\fR) to add files with a known markdown extension (see the \fB-e\fR, \fB--ext\fR flag).
.P
Logs verbose debugging information when \fB\[Do]DEBUG\fR is set to \fB\[dq]*\[dq]\fR.
.SH "OPTIONS"
.SS "\fB-h\fR, \fB--help\fR"
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ npm install --global remark
Use:

```text
Usage: remark [options] <file|dir ...>
Usage: remark [options] <pathspec...>
Markdown processor powered by plugins
Expand Down

0 comments on commit f9f9a36

Please sign in to comment.