about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2024-11-06 08:05:33 +0000
committerLaurent Bercot <ska@appnovation.com>2024-11-06 08:05:33 +0000
commit3d91d9ce645efa020800b85be1ac2727ebcbad19 (patch)
tree4461d2c99abfb80f3955b4f775b26767e823fc6a /doc
parent32ed930a967c83c5b683d1d22c286b46a9f792ea (diff)
downloadexecline-3d91d9ce645efa020800b85be1ac2727ebcbad19.tar.gz
execline-3d91d9ce645efa020800b85be1ac2727ebcbad19.tar.xz
execline-3d91d9ce645efa020800b85be1ac2727ebcbad19.zip
Prepare for 2.9.7.0 ; rework forx/forstdin -p, add -P maxpar
 Also refactor several things to keep global footprint low

Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/forstdin.html14
-rw-r--r--doc/forx.html14
-rw-r--r--doc/index.html2
-rw-r--r--doc/upgrade.html7
4 files changed, 19 insertions, 18 deletions
diff --git a/doc/forstdin.html b/doc/forstdin.html
index 25f951f..14b9a3b 100644
--- a/doc/forstdin.html
+++ b/doc/forstdin.html
@@ -50,6 +50,11 @@ and 1 if it hasn't read anything. </li>
 instance to finish before spawning the next one. forstdin will
 still wait for all instances of <em>loop</em> to terminate before
 exiting, though. </li>
+ <li> <tt>-P</tt>&nbsp;<em>maxpar</em>&nbsp;: like <tt>-p</tt>, but only
+run up to <em>maxpar</em> instances at a time. Minimum is 1; maximum is
+10000. <tt>-p</tt> is equivalent to <tt>-P 10000</tt>, i.e. it can
+spawn a very large number of loop instances in parallel, but it's
+technically not infinite. </li>
  <li> <tt>-o</tt>&nbsp;<em>okcodes</em>&nbsp;: <em>okcodes</em> must
 be a comma-separated list of exit codes. If the <tt>-p</tt> flag
 hasn't been given and <em>loop</em> exits with one of the codes in
@@ -63,7 +68,7 @@ that will make forstdin break the loop and exit, and the unlisted exit
 codes will make it keep looping. </li>
  <li> <tt>-e</tt>&nbsp;: no autoimport. This is the default. </li>
  <li> <tt>-E</tt>&nbsp;: autoimport. Instead of spawning
-<em>loop...</em>, spawn <tt>importas -ui <em>variable</em> <em>variable</em>
+<em>loop...</em>, spawn <tt>importas -uSi <em>variable</em>
 <em>loop...</em></tt>. This substitutes <em>variable</em> into the command
 line instead of putting it into the environment. </li>
 </ul>
@@ -94,12 +99,5 @@ used simultaneously, the rightmost one wins. </li>
 the input is only split on newlines. </li>
 </ul>
 
-<h2> Notes </h2>
-
-<ul>
- <li> You can start <em>loop...</em> with <tt>importas -u <em>variable</em> <em>variable</em></tt>
-to perform variable substitution. </li>
-</ul>
- 
 </body>
 </html>
diff --git a/doc/forx.html b/doc/forx.html
index 8f1d558..b20ab65 100644
--- a/doc/forx.html
+++ b/doc/forx.html
@@ -29,7 +29,7 @@
 </p>
 
 <pre>
-     forx [ -E | -e ] [ -p ] [ -o <em>okcodes</em> | -x <em>breakcodes</em> ] <em>variable</em> { <em>args...</em> } <em>loop...</em>
+     forx [ -E | -e ] [ -p | -P <em>maxpar</em> ] [ -o <em>okcodes</em> | -x <em>breakcodes</em> ] <em>variable</em> { <em>args...</em> } <em>loop...</em>
 </pre>
 
 <ul>
@@ -65,16 +65,12 @@ list, else it will exit 1. If the <tt>-x</tt> option has been given,
 listed in the <em>breakcodes</em> list, else it will exit 1. </li>
  <li> <tt>-e</tt>&nbsp;: no autoimport. This is the default. </li>
  <li> <tt>-E</tt>&nbsp;: autoimport. Instead of spawning
-<em>loop...</em>, spawn <tt>importas -ui <em>variable</em> <em>variable</em>
+<em>loop...</em>, spawn <tt>importas -uSi <em>variable</em>
 <em>loop...</em></tt>. This substitutes <em>variable</em> into the command
 line instead of putting it into the environment. </li>
-</ul>
-
-<h2> Notes </h2>
-
-<ul>
- <li> You can start <em>loop</em> with "importas -u <em>variable</em> <em>variable</em>"
-if you want variable substitution. </li>
+ <li> <tt>-P</tt>&nbsp;<em>maxpar</em>&nbsp;: similar to <tt>-p</tt>, but run
+up to <em>maxpar</em> instances in parallel, i.e. never have more than <em>maxpar</em>
+children at the same time. Minimum is 1. </li>
 </ul>
 
 </body>
diff --git a/doc/index.html b/doc/index.html
index beb61bd..6dbab1c 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -77,7 +77,7 @@ want nsswitch-like functionality:
 <h3> Download </h3>
 
 <ul>
- <li> The current released version of execline is <a href="execline-2.9.6.1.tar.gz">2.9.6.1</a>. </li>
+ <li> The current released version of execline is <a href="execline-2.9.7.0.tar.gz">2.9.7.0</a>. </li>
  <li> Alternatively, you can checkout a copy of the
 <a href="//git.skarnet.org/cgi-bin/cgit.cgi/execline/">execline
 git repository</a>:
diff --git a/doc/upgrade.html b/doc/upgrade.html
index aeaf0ba..31ddf00 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,13 @@
 
 <h1> What has changed in execline </h1>
 
+<h2> in 2.9.7.0 </h2>
+
+<ul>
+ <li> <em> New <tt>-P</tt> option to
+<a href="forx.html">forx</a> and <a href="forstdin.html">forstdin</a>. </li>
+</ul>
+
 <h2> in 2.9.6.1 </h2>
 
 <ul>