From e1fe79a9e705e3cab8f632cdbe8e1774cdef2761 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Thu, 19 Feb 2015 04:13:20 +0000
Subject:  - exit code overhaul: forx, forbacktickx, loopwhilex, if, ifelse,
 ifte, ifthenelse  - new -o option to forx, forbacktickx, loopwhilex  -
 documentation updated  - version: rc for 2.1.0.0

---
 doc/forbacktickx.html | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

(limited to 'doc/forbacktickx.html')

diff --git a/doc/forbacktickx.html b/doc/forbacktickx.html
index d40799a..0780f3d 100644
--- a/doc/forbacktickx.html
+++ b/doc/forbacktickx.html
@@ -29,7 +29,7 @@ run another program.
 </p>
 
 <pre>
-     forbacktickx [ -p | -x breakcode ] [ -n ] [ -C | -c ] [ -0 | -d <em>delim</em> ] <em>variable</em> { <em>gen...</em> } <em>loop...</em>
+     forbacktickx [ -p | -o <em>okcodes</em> | -x <em>breakcodes</em> ] [ -n ] [ -C | -c ] [ -0 | -d <em>delim</em> ] <em>variable</em> { <em>gen...</em> } <em>loop...</em>
 </pre>
 
 <ul>
@@ -56,11 +56,17 @@ exiting, though. </li>
  <li> <tt>-0</tt>&nbsp;: accept null characters from <em>gen</em>'s output,
 using them as delimiters. If this option and a <tt>-d</tt> option are
 used simultaneously, the rightmost one wins. </li>
- <li> <tt>-x</tt>&nbsp;<em>breakcodes</em>&nbsp;: <em>breakcodes</em> must
-be a comma-separated list of exit codes. If at some point <em>loop...</em>
-exits with a code listed in <em>breakcodes</em>, forbacktickx will not keep
-looping, but will exit immediately with the same exit code. This doesn't apply
-if the <tt>-p</tt> option has been given. </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
+<em>okcodes</em>,
+forbacktickx will run the following instances of the loop, but if the exit code is
+not listed in <em>okcodes</em>, forbacktickx will exit immediately with an
+<a href="exitcodes.html">approximation</a> of the same exit code. </li>
+ <li> <tt>-x</tt>&nbsp;<em>breakcodes</em>&nbsp;: like the previous
+option, but with inverted meaning - the listed exit codes are codes
+that will make forbacktickx break the loop and exit, and the unlisted exit
+codes will make it keep looping. </li>
  <li> Other options are used to <a href="el_transform.html">control
 the substitution mechanism</a> for every <em>x</em>. Of course, you can't
 split <em>x</em>. </li>
-- 
cgit v1.3.1