More documentation

5 files changed, 43 insertions, 10 deletions

diff --git a/NEWS b/NEWS
index a29f1ae..e281c25 100644
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,13 @@
 Changelog for execline.
 
+In 2.4.0.0
+----------
+
+ - Several programs have been renamed, to fit closer with their
+equivalent functionality in the shell language. See the full list
+in doc/upgrade.html
+
+
 In 2.3.0.4
 ----------
 
diff --git a/doc/index.html b/doc/index.html
index dccdecf..7f40561 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -51,7 +51,7 @@ shell's syntax, and has no security issues.
  <li> A POSIX-compliant system with a standard C development environment </li>
  <li> GNU make, version 3.81 or later. </li>
  <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
-2.6.2.0 or later. It's a build-time requirement. It's also a run-time
+2.6.4.0 or later. It's a build-time requirement. It's also a run-time
 requirement if you link against the shared version of the skalibs
 library. </li>
 </ul>
@@ -66,7 +66,7 @@ library. </li>
 <h3> Download </h3>
 
 <ul>
- <li> The current released version of execline is <a href="execline-2.3.0.4.tar.gz">2.3.0.4</a>. </li>
+ <li> The current released version of execline is <a href="execline-2.4.0.0.tar.gz">2.4.0.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/quine-dam.txt b/doc/quine-dam.txt
index 219a594..fbaaacf 100644
--- a/doc/quine-dam.txt
+++ b/doc/quine-dam.txt
@@ -53,8 +53,8 @@ multisubstitute ${ob}
 = intron ${q}${intron}${q}
 ${cb} printf %s${b}${b}n ${d}${ob}lin${cb} ${cb}
 ${p} That's all, folks! - Well, that wasn't so hard, was it?
-${p} (This quine was written by <david.madore@ens.fr> - see
-${p} <URL: http://www.eleves.ens.fr:8080/home/madore/computers/quine.html >
+${p} (This quine was written by <david@madore.org> - see
+${p} <URL: http://www.madore.org/~david/computers/quine.html >
 ${p} for more information on quines and how to write them.)"
 # HERE is the end of the quine's data.
 # They represent the following code, with various quotations:
@@ -105,6 +105,6 @@ multisubstitute {
 = intron "NOTICE HOW THIS SENTENCE APPEARS ONLY ONCE IN THIS QUINE?"
 } printf %s\\n ${lin} }
 # That's all, folks! - Well, that wasn't so hard, was it?
-# (This quine was written by <david.madore@ens.fr> - see
-# <URL: http://www.eleves.ens.fr:8080/home/madore/computers/quine.html >
+# (This quine was written by <david@madore.org> - see
+# <URL: http://www.madore.org/~david/computers/quine.html >
 # for more information on quines and how to write them.)
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 0c90b8a..d36dd91 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,33 @@
 
 <h1> What has changed in execline </h1>
 
+<h2> in 2.4.0.0 </h2>
+
+<ul>
+ <li> skalibs dependency bumped to 2.6.4.0 </li>
+ <li> In order to reduce execline's verbosity and make life easier for users
+who are used to the shell's syntax, commands that have a close shell equivalent
+have been renamed to match the shell's command. More precisely:
+  <ul>
+   <li> <a href="background.html">background</a> is now named <strong><tt>&amp;</tt></strong> </li>
+   <li> <a href="backtick.html">backtick</a> is now named <strong><tt>`</tt></strong> </li>
+   <li> <a href="define.html">background</a> is now named <strong><tt>=</tt></strong> </li>
+   <li> <a href="dollarat.html">dollarat</a> is now named <strong><tt>$@</tt></strong> </li>
+   <li> <a href="elglob.html">elglob</a> is now named <strong><tt>*</tt></strong> </li>
+   <li> <a href="fdclose.html">fdclose</a> is now named <strong><tt>&gt;&amp;-</tt></strong> </li>
+   <li> <a href="fdmove.html">fdmove</a> is now named <strong><tt>&gt;&amp;</tt></strong> </li>
+   <li> <a href="fdswap.html">fdswap</a> is now named <strong><tt>&lt;&gt;</tt></strong> </li>
+   <li> <a href="foreground.html">foreground</a> is now named <strong><tt>&semi;</tt></strong> </li>
+   <li> <a href="getpid.html">getpid</a> is now named <strong><tt>!</tt></strong> </li>
+   <li> <a href="heredoc.html">heredoc</a> is now named <strong><tt>&lt;&lt;</tt></strong> </li>
+   <li> <a href="homeof.html">homeof</a> is now named <strong><tt>~</tt></strong> </li>
+   <li> <a href="if.html">if</a> is now named <strong><tt>&amp;&amp;</tt></strong> </li>
+   <li> <a href="importas.html">importas</a> is now named <strong><tt>$</tt></strong> </li>
+   <li> <a href="pipeline.html">pipeline</a> is now named <strong><tt>|</tt></strong> </li>
+   <li> <a href="redirfd.html">redirfd</a> is now named <strong><tt>&lt;</tt></strong> </li>
+  </ul> </li>
+</ul>
+
 <h2> in 2.3.0.4 </h2>
 
 <ul>
diff --git a/examples/etc/execline-shell b/examples/etc/execline-shell
index 3e406d7..f16d033 100755
--- a/examples/etc/execline-shell
+++ b/examples/etc/execline-shell
@@ -5,10 +5,8 @@
   && -nt
   {
     ` -n defaultuser { id -un }
-    $ -u defaultuser defaultuser
-    $ -D $defaultuser USER USER
-    < -w 2 /dev/null
-    ~ ${USER}
+    $ -u defaultuser defaultuser $ -D $defaultuser USER USER
+    < -w 2 /dev/null ~ ${USER}
   }
   s6-echo /
 }