Update docs for 1.7.0
This commit is contained in:
Matt Green
parent
5427f9fe93
commit
0e371d1c56
|
|
@ -62,6 +62,10 @@ Run `make` when any file changes, using the `.gitignore` file in the current dir
|
|||
|
||||
$ watchexec make
|
||||
|
||||
Run `make` when any file in `lib` or `src` changes:
|
||||
|
||||
$ watchexec -w lib -w src make
|
||||
|
||||
##Installation
|
||||
|
||||
###Cargo
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "WATCHEXEC" "1" "December 2016" "" ""
|
||||
.TH "WATCHEXEC" "1" "February 2017" "" ""
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBwatchexec\fR \- execute commands when watched files change
|
||||
.
|
||||
.SH "SYNOPSIS"
|
||||
watchexec [\fB\-\-exts\fR | \fB\-e\fR \fIextensions\fR]\.\.\. [\fB\-\-filter\fR | \fB\-f\fR \fIpattern\fR]\.\.\. [\fB\-\-ignore\fR | \fB\-i\fR \fIpattern\fR]\.\.\. [\fB\-\-restart\fR | \fB\-r\fR] [\fB\-\-clear\fR | \fB\-c\fR] [\fB\-\-postpone\fR | \fB\-p\fR] [\fB\-\-force\-poll\fR \fIinterval\fR] [\fB\-\-debug\fR | \fB\-d\fR] [\fB\-\-no\-vcs\-ignore\fR] \fIcmd\fR [\fIargument\fR\.\.\.]
|
||||
watchexec [\fB\-\-exts\fR | \fB\-e\fR \fIextensions\fR]\.\.\. [\fB\-\-filter\fR | \fB\-f\fR \fIpattern\fR]\.\.\. [\fB\-\-ignore\fR | \fB\-i\fR \fIpattern\fR]\.\.\. [\fB\-\-watch\fR | \fB\-w\fR \fIpath\fR]\.\.\. [\fB\-\-restart\fR | \fB\-r\fR] [\fB\-\-clear\fR | \fB\-c\fR] [\fB\-\-postpone\fR | \fB\-p\fR] [\fB\-\-force\-poll\fR \fIinterval\fR] [\fB\-\-debug\fR | \fB\-d\fR] [\fB\-\-no\-vcs\-ignore\fR] \fIcommand\fR [\fIargument\fR\.\.\.]
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
Recursively monitors the current directory for changes, executing the command when a filesystem change is detected\. By default, watchexec uses efficient kernel\-level mechanisms to watch for changes\.
|
||||
|
|
@ -18,8 +18,8 @@ At startup, the specified \fIcommand\fR (passing any supplied \fIargument\fRs) i
|
|||
.SH "OPTIONS"
|
||||
.
|
||||
.TP
|
||||
\fIcmd\fR
|
||||
Command to run when watched files are modified, and at startup, unless \fB\-\-postpone\fR is specified\. All \fIargument\fRs are passed to \fIcmd\fR\.
|
||||
\fIcommand\fR
|
||||
Command to run when watched files are modified, and at startup, unless \fB\-\-postpone\fR is specified\. All \fIargument\fRs are passed to \fIcommand\fR\.
|
||||
.
|
||||
.TP
|
||||
\fB\-e\fR, \fB\-\-exts\fR \fIextensions\fR
|
||||
|
|
@ -38,6 +38,10 @@ Send \fBSIGKILL\fR to the child process group instead of \fBSIGTERM\fR\.
|
|||
Ignores modifications from paths that match \fIpattern\fR\. This option can be specified multiple times, and a match on any pattern causes the path to be ignored\.
|
||||
.
|
||||
.TP
|
||||
\fB\-w\fR, \fB\-\-watch\fR \fIpath\fR
|
||||
Monitor a specific path for changes\. By default, the current working directory is watched\. This may be specified multiple times, where a change in any watched directory (and subdirectories) causes \fIcommand\fR to be executed\.
|
||||
.
|
||||
.TP
|
||||
\fB\-r\fR, \fB\-\-restart\fR
|
||||
Terminates the child process group if it is still running when subsequent file modifications are detected\. By default, sends \fBSIGTERM\fR; use \fB\-\-kill\fR to send \fBSIGKILL\fR\.
|
||||
.
|
||||
|
|
@ -104,7 +108,7 @@ $ watchexec \-c make test
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Launch and restart a node\.js server
|
||||
Launch and restart a node\.js server:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -115,4 +119,17 @@ $ watchexec \-r node app\.js
|
|||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Watch lib and src directories for changes, rebuilding each time:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ watchexec \-w lib \-w src make
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@
|
|||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<p>watchexec [<code>--exts</code> | <code>-e</code> <var>extensions</var>]... [<code>--filter</code> | <code>-f</code> <var>pattern</var>]... [<code>--ignore</code> | <code>-i</code> <var>pattern</var>]... [<code>--restart</code> | <code>-r</code>] [<code>--clear</code> | <code>-c</code>] [<code>--postpone</code> | <code>-p</code>] [<code>--force-poll</code> <var>interval</var>] [<code>--debug</code> | <code>-d</code>] [<code>--no-vcs-ignore</code>] <var>cmd</var> [<var>argument</var>...]</p>
|
||||
<p>watchexec [<code>--exts</code> | <code>-e</code> <var>extensions</var>]... [<code>--filter</code> | <code>-f</code> <var>pattern</var>]... [<code>--ignore</code> | <code>-i</code> <var>pattern</var>]... [<code>--watch</code> | <code>-w</code> <var>path</var>]... [<code>--restart</code> | <code>-r</code>] [<code>--clear</code> | <code>-c</code>] [<code>--postpone</code> | <code>-p</code>] [<code>--force-poll</code> <var>interval</var>] [<code>--debug</code> | <code>-d</code>] [<code>--no-vcs-ignore</code>] <var>command</var> [<var>argument</var>...]</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
|
|
@ -85,11 +85,12 @@
|
|||
<h2 id="OPTIONS">OPTIONS</h2>
|
||||
|
||||
<dl>
|
||||
<dt class="flush"><var>cmd</var></dt><dd><p>Command to run when watched files are modified, and at startup, unless <code>--postpone</code> is specified. All <var>argument</var>s are passed to <var>cmd</var>.</p></dd>
|
||||
<dt class="flush"><var>command</var></dt><dd><p>Command to run when watched files are modified, and at startup, unless <code>--postpone</code> is specified. All <var>argument</var>s are passed to <var>command</var>.</p></dd>
|
||||
<dt><code>-e</code>, <code>--exts</code> <var>extensions</var></dt><dd><p>Comma-separated list of file extensions to filter by. Leading dots are allowed (.rs) are allowed. (This is a shorthand for <code>-f</code>).</p></dd>
|
||||
<dt><code>-f</code>, <code>--filter</code> <var>pattern</var></dt><dd><p>Ignores modifications from paths that do not match <var>pattern</var>. This option can be specified multiple times, where a match on any given pattern causes the path to trigger <em>command</em>.</p></dd>
|
||||
<dt><code>-f</code>, <code>--filter</code> <var>pattern</var></dt><dd><p>Ignores modifications from paths that do not match <var>pattern</var>. This option can be specified multiple times, where a match on any given pattern causes the path to trigger <var>command</var>.</p></dd>
|
||||
<dt><code>-k</code>, <code>--kill</code></dt><dd><p>Send <code>SIGKILL</code> to the child process group instead of <code>SIGTERM</code>.</p></dd>
|
||||
<dt><code>-i</code>, <code>--ignore</code> <em>pattern</em></dt><dd><p>Ignores modifications from paths that match <var>pattern</var>. This option can be specified multiple times, and a match on any pattern causes the path to be ignored.</p></dd>
|
||||
<dt><code>-i</code>, <code>--ignore</code> <var>pattern</var></dt><dd><p>Ignores modifications from paths that match <var>pattern</var>. This option can be specified multiple times, and a match on any pattern causes the path to be ignored.</p></dd>
|
||||
<dt><code>-w</code>, <code>--watch</code> <var>path</var></dt><dd><p>Monitor a specific path for changes. By default, the current working directory is watched. This may be specified multiple times, where a change in any watched directory (and subdirectories) causes <var>command</var> to be executed.</p></dd>
|
||||
<dt><code>-r</code>, <code>--restart</code></dt><dd><p>Terminates the child process group if it is still running when subsequent file modifications are detected. By default, sends <code>SIGTERM</code>; use <code>--kill</code> to send <code>SIGKILL</code>.</p></dd>
|
||||
<dt><code>-c</code>, <code>--clear</code></dt><dd><p>Clears the screen before executing <var>command</var>.</p></dd>
|
||||
<dt><code>-p</code>, <code>--postpone</code></dt><dd><p>Postpone execution of <var>command</var> until the first file modification is detected.</p></dd>
|
||||
|
|
@ -120,15 +121,20 @@
|
|||
<pre><code>$ watchexec -c make test
|
||||
</code></pre>
|
||||
|
||||
<p>Launch and restart a node.js server</p>
|
||||
<p>Launch and restart a node.js server:</p>
|
||||
|
||||
<pre><code>$ watchexec -r node app.js
|
||||
</code></pre>
|
||||
|
||||
<p>Watch lib and src directories for changes, rebuilding each time:</p>
|
||||
|
||||
<pre><code>$ watchexec -w lib -w src make
|
||||
</code></pre>
|
||||
|
||||
|
||||
<ol class='man-decor man-foot man foot'>
|
||||
<li class='tl'></li>
|
||||
<li class='tc'>December 2016</li>
|
||||
<li class='tc'>February 2017</li>
|
||||
<li class='tr'>watchexec(1)</li>
|
||||
</ol>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ watchexec(1) -- execute commands when watched files change
|
|||
|
||||
## SYNOPSIS
|
||||
|
||||
watchexec [`--exts` | `-e` <extensions>]... [`--filter` | `-f` <pattern>]... [`--ignore` | `-i` <pattern>]... [`--restart` | `-r`] [`--clear` | `-c`] [`--postpone` | `-p`] [`--force-poll` <interval>] [`--debug` | `-d`] [`--no-vcs-ignore`] <cmd> [<argument>...]
|
||||
watchexec [`--exts` | `-e` <extensions>]... [`--filter` | `-f` <pattern>]... [`--ignore` | `-i` <pattern>]... [`--watch` | `-w` <path>]... [`--restart` | `-r`] [`--clear` | `-c`] [`--postpone` | `-p`] [`--force-poll` <interval>] [`--debug` | `-d`] [`--no-vcs-ignore`] <command> [<argument>...]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
|
@ -13,21 +13,24 @@ At startup, the specified <command> (passing any supplied <argument>s) is run on
|
|||
|
||||
## OPTIONS
|
||||
|
||||
* <cmd>:
|
||||
Command to run when watched files are modified, and at startup, unless `--postpone` is specified. All <argument>s are passed to <cmd>.
|
||||
* <command>:
|
||||
Command to run when watched files are modified, and at startup, unless `--postpone` is specified. All <argument>s are passed to <command>.
|
||||
|
||||
* `-e`, `--exts` <extensions>:
|
||||
Comma-separated list of file extensions to filter by. Leading dots are allowed (.rs) are allowed. (This is a shorthand for `-f`).
|
||||
|
||||
* `-f`, `--filter` <pattern>:
|
||||
Ignores modifications from paths that do not match <pattern>. This option can be specified multiple times, where a match on any given pattern causes the path to trigger *command*.
|
||||
Ignores modifications from paths that do not match <pattern>. This option can be specified multiple times, where a match on any given pattern causes the path to trigger <command>.
|
||||
|
||||
* `-k`, `--kill`:
|
||||
Send `SIGKILL` to the child process group instead of `SIGTERM`.
|
||||
|
||||
* `-i`, `--ignore` *pattern*:
|
||||
* `-i`, `--ignore` <pattern>:
|
||||
Ignores modifications from paths that match <pattern>. This option can be specified multiple times, and a match on any pattern causes the path to be ignored.
|
||||
|
||||
* `-w`, `--watch` <path>:
|
||||
Monitor a specific path for changes. By default, the current working directory is watched. This may be specified multiple times, where a change in any watched directory (and subdirectories) causes <command> to be executed.
|
||||
|
||||
* `-r`, `--restart`:
|
||||
Terminates the child process group if it is still running when subsequent file modifications are detected. By default, sends `SIGTERM`; use `--kill` to send `SIGKILL`.
|
||||
|
||||
|
|
@ -64,7 +67,11 @@ Run tests when source files change, clearing the screen each time:
|
|||
|
||||
$ watchexec -c make test
|
||||
|
||||
Launch and restart a node.js server
|
||||
Launch and restart a node.js server:
|
||||
|
||||
$ watchexec -r node app.js
|
||||
|
||||
Watch lib and src directories for changes, rebuilding each time:
|
||||
|
||||
$ watchexec -w lib -w src make
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue