mirror of
https://github.com/watchexec/watchexec.git
synced 2024-09-28 06:01:34 +02:00
Update man page with WATCHEXEC_*_PATH modifications from #90
This commit is contained in:
parent
f61b7507af
commit
c7f7e18e3b
@ -1,7 +1,7 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "WATCHEXEC" "1" "April 2017" "" ""
|
||||
.TH "WATCHEXEC" "1" "August 2018" "" ""
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBwatchexec\fR \- execute commands when watched files change
|
||||
@ -71,10 +71,38 @@ Skip loading of version control system (VCS) ignore files\. By default, watchexe
|
||||
.
|
||||
.TP
|
||||
\fB\-\-no\-default\-ignore\fR
|
||||
Skip default ignore statements\. By default, watchexec ignores common temporary files for you, for example \fB.*\.swp\fR, \fB*\.pyc\fR, and \fB\.DS_Store\fR
|
||||
Skip default ignore statements\. By default, watchexec ignores common temporary files for you, for example \fB*\.swp\fR, \fB*\.pyc\fR, and \fB\.DS_Store\fR\.
|
||||
.
|
||||
.SH "ENVIRONMENT"
|
||||
Processes started by watchexec have the \fB$WATCHEXEC_UPDATED_PATH\fR environment variable set to the path of the first modification observed\. In addition, the \fB$WATCHEXEC_COMMON_PATH\fR environment variable is set to the common path of all observed modifications\.
|
||||
Processes started by watchexec have environment variables set describing the modification(s) observed\. Which variable is set depends on how many modifications were observed and/or what type they were\.
|
||||
.
|
||||
.P
|
||||
If a single file changed (depending on the event type):
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB$WATCHEXEC_CREATED_PATH\fR, the path of the file that was created
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB$WATCHEXEC_REMOVED_PATH\fR, the path of the file that was removed
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB$WATCHEXEC_RENAMED_PATH\fR, the path of the file that was renamed
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB$WATCHEXEC_WRITTEN_PATH\fR, the path of the file that was modified
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB$WATCHEXEC_META_CHANGED_PATH\fR, the path of the file whose metadata changed
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If multiple files changed:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB$WATCHEXEC_COMMON_PATH\fR, the longest common path of all of the files that triggered a change
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Rebuild a project when source files change:
|
||||
|
@ -98,13 +98,31 @@
|
||||
<dt><code>-d</code>, <code>--debug</code></dt><dd><p>Prints diagnostic messages to STDERR</p></dd>
|
||||
<dt><code>--force-poll</code> <var>interval</var></dt><dd><p>Poll for changes every <var>interval</var> ms instead of using system-specific notification mechanisms (such as inotify). This is useful when you are monitoring NFS shares.</p></dd>
|
||||
<dt><code>--no-vcs-ignore</code></dt><dd><p>Skip loading of version control system (VCS) ignore files. By default, watchexec loads .gitignore files in the current directory (or parent directories) and uses them to populate the ignore list.</p></dd>
|
||||
<dt><code>--no-default-ignore</code></dt><dd><p>Skip default ignore statements. By default, watchexec ignores common temporary files for you, for example <code>*.swp</code>, <code>*.pyc</code>, and <code>.DS_Store</code></p></dd>
|
||||
<dt><code>--no-default-ignore</code></dt><dd><p>Skip default ignore statements. By default, watchexec ignores common temporary files for you, for example <code>*.swp</code>, <code>*.pyc</code>, and <code>.DS_Store</code>.</p></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h2 id="ENVIRONMENT">ENVIRONMENT</h2>
|
||||
|
||||
<p>Processes started by watchexec have the <code>$WATCHEXEC_UPDATED_PATH</code> environment variable set to the path of the first modification observed. In addition, the <code>$WATCHEXEC_COMMON_PATH</code> environment variable is set to the common path of all observed modifications.</p>
|
||||
<p>Processes started by watchexec have environment variables set describing the modification(s) observed. Which variable is set depends on how many modifications were observed and/or what type they were.</p>
|
||||
|
||||
<p>If a single file changed (depending on the event type):</p>
|
||||
|
||||
<ul>
|
||||
<li><code>$WATCHEXEC_CREATED_PATH</code>, the path of the file that was created</li>
|
||||
<li><code>$WATCHEXEC_REMOVED_PATH</code>, the path of the file that was removed</li>
|
||||
<li><code>$WATCHEXEC_RENAMED_PATH</code>, the path of the file that was renamed</li>
|
||||
<li><code>$WATCHEXEC_WRITTEN_PATH</code>, the path of the file that was modified</li>
|
||||
<li><code>$WATCHEXEC_META_CHANGED_PATH</code>, the path of the file whose metadata changed</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<p>If multiple files changed:</p>
|
||||
|
||||
<ul>
|
||||
<li><code>$WATCHEXEC_COMMON_PATH</code>, the longest common path of all of the files that triggered a change</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2 id="EXAMPLES">EXAMPLES</h2>
|
||||
|
||||
@ -136,7 +154,7 @@
|
||||
|
||||
<ol class='man-decor man-foot man foot'>
|
||||
<li class='tl'></li>
|
||||
<li class='tc'>April 2017</li>
|
||||
<li class='tc'>August 2018</li>
|
||||
<li class='tr'>watchexec(1)</li>
|
||||
</ol>
|
||||
|
||||
|
@ -53,11 +53,23 @@ Poll for changes every <interval> ms instead of using system-specific notificati
|
||||
Skip loading of version control system (VCS) ignore files. By default, watchexec loads .gitignore files in the current directory (or parent directories) and uses them to populate the ignore list.
|
||||
|
||||
* `--no-default-ignore`:
|
||||
Skip default ignore statements. By default, watchexec ignores common temporary files for you, for example `*.swp`, `*.pyc`, and `.DS_Store`
|
||||
Skip default ignore statements. By default, watchexec ignores common temporary files for you, for example `*.swp`, `*.pyc`, and `.DS_Store`.
|
||||
|
||||
## ENVIRONMENT
|
||||
|
||||
Processes started by watchexec have the `$WATCHEXEC_UPDATED_PATH` environment variable set to the path of the first modification observed. In addition, the `$WATCHEXEC_COMMON_PATH` environment variable is set to the common path of all observed modifications.
|
||||
Processes started by watchexec have environment variables set describing the modification(s) observed. Which variable is set depends on how many modifications were observed and/or what type they were.
|
||||
|
||||
If a single file changed (depending on the event type):
|
||||
|
||||
* `$WATCHEXEC_CREATED_PATH`, the path of the file that was created
|
||||
* `$WATCHEXEC_REMOVED_PATH`, the path of the file that was removed
|
||||
* `$WATCHEXEC_RENAMED_PATH`, the path of the file that was renamed
|
||||
* `$WATCHEXEC_WRITTEN_PATH`, the path of the file that was modified
|
||||
* `$WATCHEXEC_META_CHANGED_PATH`, the path of the file whose metadata changed
|
||||
|
||||
If multiple files changed:
|
||||
|
||||
* `$WATCHEXEC_COMMON_PATH`, the longest common path of all of the files that triggered a change
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user