diff --git a/doc/watchexec.1 b/doc/watchexec.1 index 393c6c0..775edb5 100644 --- a/doc/watchexec.1 +++ b/doc/watchexec.1 @@ -1,13 +1,13 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "WATCHEXEC" "1" "February 2017" "" "" +.TH "WATCHEXEC" "1" "April 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\-\-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\.\.\.] +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] [\fB\-\-no\-default\-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\. @@ -30,12 +30,12 @@ Comma\-separated list of file extensions to filter by\. Leading dots are allowed Ignores modifications from paths that do not match \fIpattern\fR\. This option can be specified multiple times, where a match on any given pattern causes the path to trigger \fIcommand\fR\. . .TP -\fB\-s\fR, \fB\-\-signal \fR +\fB\-s\fR, \fB\-\-signal\fR Sends the specified signal (e\.g\. \fBSIGKILL\fR) to the child process\. Defaults to \fBSIGTERM\fR\. . .TP \fB\-n\fR, \fB\-\-no\-shell\fR -Execute command directly, do not wrap it in \fBsh -c\fR resp\. \fBcmd.exec /C\R\. This is especially useful in combination with \fB--signal\fR, as the signal is then send directly to the specified command\. While \fB--no-shell\fR is a little more performant than the default, it prevents using shell-features like pipes and redirects\. +Execute command directly, do not wrap it in \fBsh \-c\fR resp\. \fBcmd\.exe /C\fR\. This is especially useful in combination with \fB\-\-signal\fR, as the signal is then send directly to the specified command\. While \fB\-\-no\-shell\fR is a little more performant than the default, it prevents using shell\-features like pipes and redirects\. . .TP \fB\-i\fR, \fB\-\-ignore\fR \fIpattern\fR @@ -69,6 +69,10 @@ Poll for changes every \fIinterval\fR ms instead of using system\-specific notif \fB\-\-no\-vcs\-ignore\fR 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\. . +.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 +. .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\. . diff --git a/doc/watchexec.1.html b/doc/watchexec.1.html index 4fc28b7..6b084c8 100644 --- a/doc/watchexec.1.html +++ b/doc/watchexec.1.html @@ -74,7 +74,7 @@

SYNOPSIS

-

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...]

+

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] [--no-default-ignore] command [argument...]

DESCRIPTION

@@ -88,8 +88,8 @@
command

Command to run when watched files are modified, and at startup, unless --postpone is specified. All arguments 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.

-
-s, --signal SIGNAL

Sends the specified signal (e.g. SIGKILl) to the child process. Defaults to SIGTERM.

-
-n, --no-shell

Execute command directly, do not wrap it in sh -c resp. cmd.exec /C. This is especially useful in combination with --signal, as the signal is then send directly to the specified command. While --no-shell is a little more performant than the default, it prevents using shell-features like pipes and redirects.

+
-s, --signal

Sends the specified signal (e.g. SIGKILL) to the child process. Defaults to SIGTERM.

+
-n, --no-shell

Execute command directly, do not wrap it in sh -c resp. cmd.exe /C. This is especially useful in combination with --signal, as the signal is then send directly to the specified command. While --no-shell is a little more performant than the default, it prevents using shell-features like pipes and redirects.

-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.

@@ -98,6 +98,7 @@
-d, --debug

Prints diagnostic messages to STDERR

--force-poll interval

Poll for changes every interval ms instead of using system-specific notification mechanisms (such as inotify). This is useful when you are monitoring NFS shares.

--no-vcs-ignore

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

@@ -135,7 +136,7 @@
  1. -
  2. February 2017
    3. +
  3. April 2017
  4. watchexec(1)
diff --git a/doc/watchexec.1.ronn b/doc/watchexec.1.ronn index 7a1cf34..d0d2439 100644 --- a/doc/watchexec.1.ronn +++ b/doc/watchexec.1.ronn @@ -3,7 +3,7 @@ watchexec(1) -- execute commands when watched files change ## SYNOPSIS -watchexec [`--exts` | `-e` ]... [`--filter` | `-f` ]... [`--ignore` | `-i` ]... [`--watch` | `-w` ]... [`--restart` | `-r`] [`--clear` | `-c`] [`--postpone` | `-p`] [`--force-poll` ] [`--debug` | `-d`] [`--no-vcs-ignore`] [...] +watchexec [`--exts` | `-e` ]... [`--filter` | `-f` ]... [`--ignore` | `-i` ]... [`--watch` | `-w` ]... [`--restart` | `-r`] [`--clear` | `-c`] [`--postpone` | `-p`] [`--force-poll` ] [`--debug` | `-d`] [`--no-vcs-ignore`] [`--no-default-ignore`] [...] ## DESCRIPTION @@ -52,6 +52,9 @@ Poll for changes every ms instead of using system-specific notificati * `--no-vcs-ignore`: 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` + ## 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.