Robot
/
watchexec
mirror of https://github.com/watchexec/watchexec.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Generate html manpage with toc style

This commit is contained in:
Félix Saparelli 2021-04-17 02:11:16 +12:00
parent 81b3340f6c
commit 1c338adb9d
No known key found for this signature in database
GPG Key ID: B948C4BAE44FC474
4 changed files with 125 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/manpage
View File

@ -1,2 +1,2 @@
#!/bin/sh
exec ronn doc/watchexec.1.ronn
exec ronn --roff --html --style=toc doc/watchexec.1.ronn

79
doc/watchexec.1
View File

@ -21,6 +21,9 @@ At startup, the specified \fIcommand\fR (passing any supplied \fIargument\fRs) i
\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\. If you pass flags to the command, you should separate it with \fB\-\-\fR, for example: \fBwatchexec \-w src \-\- rsync \-a src dest\fR\.
.
.P
Behaviour depends on the value of \fB\-\-shell\fR: for all except \fBnone\fR, every part of \fIcommand\fR is joined together into one string with a single ascii space character, and given to the shell as described\. For \fBnone\fR, each distinct element of \fIcommand\fR is passed as per the execvp(3) convention: first argument is the program, as a file or searched in the \fBPATH\fR, rest are arguments\.
.
.TP
\fB\-e\fR, \fB\-\-exts\fR \fIextensions\fR
Comma\-separated list of file extensions to filter by\. Leading dots (\.rs) are allowed\. (This is a shorthand for \fB\-f\fR)\.
@ -41,7 +44,16 @@ Change the shell used to run the command\. Set to \fBnone\fR to run the command
The special value \fBpowershell\fR will use Microsoft Powershell\'s calling convention, otherwise \fBSHELL \-c COMMAND\fR\.
.
.P
The \fBnone\fR value is especially useful in combination with \fB\-\-signal\fR, as the signal is then send directly to the specified command\. While \fB\-\-shell=none\fR is a little more performant than the default, it prevents using shell\-features like pipes and redirects\.
On Windows, the additional \fBcmd\fR special value uses CMD\.EXE calling convention\.
.
.P
The \fBnone\fR value is especially useful in combination with \fB\-\-signal\fR, as the signal is then sent directly to the running command\. While \fB\-\-shell=none\fR is a little more performant than the default, it prevents using shell\-features like pipes and redirects\.
.
.P
If not a special value, the string provided may contain arguments to the shell as long as that is kept simple: the string is split along whitespace, and used as per execvp(3): first is shell program, rest are arguments to the shell, then \fB\-c\fR is added, and finally the \fBCOMMAND\fR\.
.
.P
See the \fIEXAMPLES\fR for uses of each of these\.
.
.TP
\fB\-\-no\-shell\fR
@ -213,4 +225,69 @@ $ watchexec \-w lib \-w src make
.fi
.
.IP "" 0
.
.P
Use without shell:
.
.IP "" 4
.
.nf
$ watchexec \-n \-\- zsh \-x \-o shwordsplit scr
.
.fi
.
.IP "" 0
.
.P
Use with powershell (default on windows from 2\.0):
.
.IP "" 4
.
.nf
$ watchexec \-\-shell=powershell \-\- test\-connection localhost
.
.fi
.
.IP "" 0
.
.P
Use with cmd (default on windows until 2\.0):
.
.IP "" 4
.
.nf
$ watchexec \-\-shell=cmd \-\- dir
.
.fi
.
.IP "" 0
.
.P
Use with a different unix shell:
.
.IP "" 4
.
.nf
$ watchexec \-\-shell=bash \-\- \'echo $BASH_VERSION\'
.
.fi
.
.IP "" 0
.
.P
Use with a unix shell and options:
.
.IP "" 4
.
.nf
$ watchexec \-\-shell=\'zsh \-x \-o shwordsplit\' \-\- scr
.
.fi
.
.IP "" 0

47
doc/watchexec.1.html
View File

@ -41,6 +41,12 @@
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
<style type='text/css' media='all'>
/* style: toc */
.man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
.man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
.man-navigation a:hover {color:#111;text-decoration:underline}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
@ -85,7 +91,13 @@
<h2 id="OPTIONS">OPTIONS</h2>
<dl>
<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>. If you pass flags to the command, you should separate it with <code>--</code>, for example: <code>watchexec -w src -- rsync -a src dest</code>.</p></dd>
<dt class="flush"><var>command</var></dt><dd>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>. If you pass flags to the command, you should separate it with <code>--</code>, for example: <code>watchexec -w src -- rsync -a src dest</code>.</dd>
</dl>
<p>Behaviour depends on the value of <code>--shell</code>: for all except <code>none</code>, every part of <var>command</var> is joined together into one string with a single ascii space character, and given to the shell as described. For <code>none</code>, each distinct element of <var>command</var> is passed as per the <span class="man-ref">execvp<span class="s">(3)</span></span> convention: first argument is the program, as a file or searched in the <code>PATH</code>, rest are arguments.</p>
<dl>
<dt><code>-e</code>, <code>--exts</code> <var>extensions</var></dt><dd><p>Comma-separated list of file extensions to filter by. Leading dots (.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 <var>command</var>.</p></dd>
<dt><code>-s</code>, <code>--signal</code></dt><dd><p>Sends the specified signal (e.g. <code>SIGKILL</code>) to the command. Defaults to <code>SIGTERM</code>.</p></dd>
@ -95,7 +107,13 @@
<p>The special value <code>powershell</code> will use Microsoft Powershell's calling convention, otherwise <code>SHELL -c COMMAND</code>.</p>
<p>The <code>none</code> value is especially useful in combination with <code>--signal</code>, as the signal is then send directly to the specified command. While <code>--shell=none</code> is a little more performant than the default, it prevents using shell-features like pipes and redirects.</p>
<p>On Windows, the additional <code>cmd</code> special value uses CMD.EXE calling convention.</p>
<p>The <code>none</code> value is especially useful in combination with <code>--signal</code>, as the signal is then sent directly to the running command. While <code>--shell=none</code> is a little more performant than the default, it prevents using shell-features like pipes and redirects.</p>
<p>If not a special value, the string provided may contain arguments to the shell as long as that is kept simple: the string is split along whitespace, and used as per <span class="man-ref">execvp<span class="s">(3)</span></span>: first is shell program, rest are arguments to the shell, then <code>-c</code> is added, and finally the <code>COMMAND</code>.</p>
<p>See the <a href="#EXAMPLES" title="EXAMPLES" data-bare-link="true">EXAMPLES</a> for uses of each of these.</p>
<dl>
<dt><code>--no-shell</code></dt><dd><p>Deprecated. Alias for <code>--shell=none</code>.</p></dd>
@ -174,6 +192,31 @@
<pre><code>$ watchexec -w lib -w src make
</code></pre>
<p>Use without shell:</p>
<pre><code>$ watchexec -n -- zsh -x -o shwordsplit scr
</code></pre>
<p>Use with powershell (default on windows from 2.0):</p>
<pre><code>$ watchexec --shell=powershell -- test-connection localhost
</code></pre>
<p>Use with cmd (default on windows until 2.0):</p>
<pre><code>$ watchexec --shell=cmd -- dir
</code></pre>
<p>Use with a different unix shell:</p>
<pre><code>$ watchexec --shell=bash -- 'echo $BASH_VERSION'
</code></pre>
<p>Use with a unix shell and options:</p>
<pre><code>$ watchexec --shell='zsh -x -o shwordsplit' -- scr
</code></pre>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>

2
doc/watchexec.1.ronn
View File

@ -34,7 +34,7 @@ The special value `powershell` will use Microsoft Powershell's calling conventio
On Windows, the additional `cmd` special value uses CMD.EXE calling convention.
The `none` value is especially useful in combination with `--signal`, as the signal is then send directly to the specified command. While `--shell=none` is a little more performant than the default, it prevents using shell-features like pipes and redirects.
The `none` value is especially useful in combination with `--signal`, as the signal is then sent directly to the running command. While `--shell=none` is a little more performant than the default, it prevents using shell-features like pipes and redirects.
If not a special value, the string provided may contain arguments to the shell as long as that is kept simple: the string is split along whitespace, and used as per execvp(3): first is shell program, rest are arguments to the shell, then `-c` is added, and finally the `COMMAND`.