summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-02-28 03:32:47 +0000
committerLaurent Bercot <ska@appnovation.com>2023-02-28 03:32:47 +0000
commitcaef85892cd91cdd713562567ab14cb29689f148 (patch)
tree7668fc440814198bfa476f124ad2a31766342aa0 /doc
parent6dd30a29f70b246ffc7771d0e79277392834cb71 (diff)
downloadexecline-caef85892cd91cdd713562567ab14cb29689f148.tar.xz
Prepare for 2.9.3.0; add elgetopt -D
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/elgetopt.html13
-rw-r--r--doc/index.html2
-rw-r--r--doc/upgrade.html7
3 files changed, 19 insertions, 3 deletions
diff --git a/doc/elgetopt.html b/doc/elgetopt.html
index b3a28ce..bb2563f 100644
--- a/doc/elgetopt.html
+++ b/doc/elgetopt.html
@@ -26,7 +26,7 @@ arguments to an execline script.
<h2> Interface </h2>
<pre>
- elgetopt <em>optstring</em> <em>prog...</em>
+ elgetopt [ -D <em>default</em> ] <em>optstring</em> <em>prog...</em>
</pre>
<ul>
@@ -44,13 +44,22 @@ string. </li>
<li> If the <tt>-<em>c</em></tt> switch is recognized, <tt>elgetopt</tt>
sets the <tt>ELGETOPT_<em>c</em></tt> environment variable. The value
of that variable is the argument to the <tt>-<em>c</em></tt> switch if
-it has one, and 1 otherwise. </li>
+it has one, and <tt>1</tt> (or <em>default</em> if given) otherwise. </li>
<li> After setting all recognized options, <tt>elgetopt</tt> makes
new <tt>#</tt>, <tt>1</tt>, <tt>2</tt>... "positional parameters" with
what remains. </li>
<li> <tt>elgetopt</tt> then execs into <em>prog...</em>. </li>
</ul>
+<h2> Options </h2>
+
+<ul>
+ <li> <tt>-D&nbsp;<em>default</em></tt>&nbsp;: use <em>default</em> as the
+value for the <tt>ELGETOPT_<em>c</em></tt> environment variable if there is
+no argument to the <tt>-<em>c</em></tt> switch. Default is <tt>1</tt>. The
+value is the same for all the options defined by elgetopt. </li>
+</ul>
+
<h2> Notes </h2>
<ul>
diff --git a/doc/index.html b/doc/index.html
index 87c6f75..0e6b43f 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.2.1.tar.gz">2.9.2.1</a>. </li>
+ <li> The current released version of execline is <a href="execline-2.9.3.0.tar.gz">2.9.3.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 6a65fac..23479b9 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,13 @@
<h1> What has changed in execline </h1>
+<h2> in 2.9.3.0 </h2>
+
+<ul>
+ <li> New <tt>-D <em>default</em></tt> option to
+<a href="elgetopt.html">elgetopt</a>. </li>
+</ul>
+
<h2> in 2.9.2.1 </h2>
<ul>