summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2019-12-30 20:31:24 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2019-12-30 20:31:24 +0000
commit72dd49d7dd07ba4cae13ee1249fd58550991c188 (patch)
treee85f546a63dcdd99e806071ea88b83282341d82a /doc
parentd9b6a5820f195ef681d7cd15d70a184265b37a94 (diff)
downloadexecline-72dd49d7dd07ba4cae13ee1249fd58550991c188.tar.xz
Rename cd/umask to execline-cd/execline-umask, make symlinks, etc.
Diffstat (limited to 'doc')
-rw-r--r--doc/cd.html50
-rw-r--r--doc/execline-cd.html54
-rw-r--r--doc/execline-umask.html50
-rw-r--r--doc/index.html4
-rw-r--r--doc/posix-cd.html23
-rw-r--r--doc/posix-umask.html22
-rw-r--r--doc/umask.html48
-rw-r--r--doc/upgrade.html6
8 files changed, 138 insertions, 119 deletions
diff --git a/doc/cd.html b/doc/cd.html
deleted file mode 100644
index fe64c19..0000000
--- a/doc/cd.html
+++ /dev/null
@@ -1,50 +0,0 @@
-<html>
- <head>
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <meta http-equiv="Content-Language" content="en" />
- <title>execline: the cd command</title>
- <meta name="Description" content="execline: the cd command" />
- <meta name="Keywords" content="execline command cd chdir" />
- <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
-</head>
-<body>
-
-<p>
-<a href="index.html">execline</a><br />
-<a href="//skarnet.org/software/">Software</a><br />
-<a href="//skarnet.org/">skarnet.org</a>
-</p>
-
-<h1> The <tt>cd</tt> program </h1>
-
-<p>
-<tt>cd</tt> changes the current working directory to a
-given directory, then executes a program.
-</p>
-
-<h2> Interface </h2>
-
-<pre>
- cd <em>dir</em> <em>prog...</em>
-</pre>
-
-<p>
-<tt>cd</tt> performs a
-<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/chdir.html">chdir()</a>
-system call on <em>dir</em>, then execs into <em>prog...</em>.
-</p>
-
-<h2> Notes </h2>
-
-<ul>
- <li> <tt>cd</tt> is a standard shell builtin. Be careful if you want to
-use the <tt>cd</tt> command outside of an <tt>execline</tt> script </li>
- <li> When execline has been configured with the <tt>--enable-pedantic-posix</tt>
-option, the <tt>cd</tt> binary is actually a symbolic link to the
-<a href="posix-cd.html">posix-cd</a> binary. </li>
-</ul>
-
-
-</body>
-</html>
diff --git a/doc/execline-cd.html b/doc/execline-cd.html
new file mode 100644
index 0000000..911eb2a
--- /dev/null
+++ b/doc/execline-cd.html
@@ -0,0 +1,54 @@
+<html>
+ <head>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>execline: the execline-cd command</title>
+ <meta name="Description" content="execline: the execline-cd command" />
+ <meta name="Keywords" content="execline command cd chdir execline-cd" />
+ <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+</head>
+<body>
+
+<p>
+<a href="index.html">execline</a><br />
+<a href="//skarnet.org/software/">Software</a><br />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>execline-cd</tt> program </h1>
+
+<p>
+<tt>execline-cd</tt> changes the current working directory to a
+given directory, then executes a program.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ execline-cd <em>dir</em> <em>prog...</em>
+</pre>
+
+<p>
+<tt>execline-cd</tt> performs a
+<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/chdir.html">chdir()</a>
+system call on <em>dir</em>, then execs into <em>prog...</em>.
+</p>
+
+<h2> Notes </h2>
+
+<ul>
+ <li> By default, <tt>execline-cd</tt> can also be invoked as <tt>cd</tt>:
+there is a <tt>cd</tt> program which is a symbolic link to <tt>execline-cd</tt>. </li>
+ <li> When execline has been configured with the <tt>--enable-pedantic-posix</tt>
+option, the <tt>cd</tt> binary is a symbolic link to the
+<a href="posix-cd.html">posix-cd</a> binary instead, so a <tt>cd</tt> command
+in an execline script will invoke <a href="posix-cd.html">posix-cd</a> instead
+of <tt>execline-cd</tt>. </li>
+ <li> Existing scripts that call <tt>cd</tt> will keep working no matter the
+chosen configuration. </li>
+</ul>
+
+
+</body>
+</html>
diff --git a/doc/execline-umask.html b/doc/execline-umask.html
new file mode 100644
index 0000000..f01343d
--- /dev/null
+++ b/doc/execline-umask.html
@@ -0,0 +1,50 @@
+<html>
+ <head>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>execline: the execline-umask command</title>
+ <meta name="Description" content="execline: the execline-umask command" />
+ <meta name="Keywords" content="execline command umask execline-umask" />
+ <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">execline</a><br />
+<a href="//skarnet.org/software/">Software</a><br />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>execline-umask</tt> program </h1>
+
+<p>
+<tt>execline-umask</tt> sets the umask (file creation mask),
+then executes a program.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ execline-umask <em>mask</em> <em>prog...</em>
+</pre>
+
+<p>
+<tt>execline-umask</tt> sets the current umask to <em>mask</em>,
+then execs into <em>prog...</em>.
+</p>
+
+<h2> Notes </h2>
+
+<ul>
+<li> By default, at execline installation time, a <tt>umask</tt>
+symbolic link is created, pointing to <tt>execline-umask</tt>.
+ <li> When execline has been configured with the <tt>--enable-pedantic-posix</tt>
+option, the <tt>umask</tt> symbolic link points to the
+<a href="posix-umask.html">posix-umask</a> binary instead. </li>
+ <li> Existing execline scripts calling <tt>umask</tt> will keep working
+no matter the chosen configuration. </li>
+</ul>
+
+</body>
+</html>
diff --git a/doc/index.html b/doc/index.html
index d93f704..498bb13 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -125,9 +125,9 @@ to your installation: the shebang lines for your system might be something like
(Process state control)
</p>
<ul>
-<li><a href="cd.html">The <tt>cd</tt> program</a></li>
+<li><a href="execline-cd.html">The <tt>execline-cd</tt> program</a></li>
<li><a href="posix-cd.html">The <tt>posix-cd</tt> program</a></li>
-<li><a href="umask.html">The <tt>umask</tt> program</a></li>
+<li><a href="execline-umask.html">The <tt>execline-umask</tt> program</a></li>
<li><a href="posix-umask.html">The <tt>posix-umask</tt> program</a></li>
<li><a href="emptyenv.html">The <tt>emptyenv</tt> program</a></li>
<li><a href="envfile.html">The <tt>envfile</tt> program</a></li>
diff --git a/doc/posix-cd.html b/doc/posix-cd.html
index 5074658..fc40203 100644
--- a/doc/posix-cd.html
+++ b/doc/posix-cd.html
@@ -40,23 +40,26 @@ not empty, it execs into it.
<h2> Notes </h2>
<ul>
- <li> <tt>posix-cd</tt> is only available when execline has been configured
-with the <tt>--enable-pedantic-posix</tt> option, and in this case, the
-<a href="cd.html">cd</a> binary is a symbolic link to it. </li>
+ <li> When execline has been configured
+with the <tt>--enable-pedantic-posix</tt> option, the <tt>cd</tt>
+command is a symbolic link to it. So scripts calling <tt>cd</tt>
+will use <tt>posix-cd</tt>. When this configuration option has not
+been given, <tt>cd</tt> is a symbolic link to
+<a href="execline-cd.html">execline-cd</a>. </li>
<li> <tt>posix-cd</tt> fully conforms to the
<a href="https://pubs.opengroup.org/onlinepubs/9699919799/utilities/cd.html">POSIX
specification</a>. When <em>prog...</em> is not empty, the behaviour of a
<tt>cd</tt> utility is not specified by POSIX, so <tt>posix-cd</tt> extends
the spec to be actually useful and usable in an execline program with the same
-interface as the regular execline <a href="cd.html">cd</a> command. </li>
+interface as the regular execline <a href="execline-cd.html">cd</a> command. </li>
<li> Nobody ever executes or needs the external version (i.e. not a shell
-builtin) of the POSIX <tt>cd</tt> command. Compared to the regular execline
-<a href="cd.html">cd</a>, <tt>posix-cd</tt> is uselessly bloated and slow.
-The only reason it exists is that some distributions refuse to package
-execline correctly unless it is strictly POSIX-compliant; the
-<tt>--enable-pedantic-posix</tt> configure option is there to appease them. </li>
+builtin) of the POSIX <tt>cd</tt> command. Compared to execline's regular <tt>cd</tt>
+binary, <a href="execline-cd.html">execline-cd</a>, <tt>posix-cd</tt> is
+uselessly bloated and slow. The only reason it exists is that some
+distributions refuse to package execline correctly unless it is strictly
+POSIX-compliant; the <tt>--enable-pedantic-posix</tt> configure option is
+there to satisfy their requirements. </li>
</ul>
-
</body>
</html>
diff --git a/doc/posix-umask.html b/doc/posix-umask.html
index 4ee310d..0d89e58 100644
--- a/doc/posix-umask.html
+++ b/doc/posix-umask.html
@@ -48,21 +48,25 @@ specification for a <tt>umask</tt> external utility</a>.
<h2> Notes </h2>
<ul>
- <li> <tt>posix-umask</tt> is only available when execline has been configured
-with the <tt>--enable-pedantic-posix</tt> option, and in this case, the
-<a href="umask.html">cd</a> binary is a symbolic link to it. </li>
+ <li> When execline has been configured
+with the <tt>--enable-pedantic-posix</tt> option, the <tt>umask</tt>
+command is a symbolic link to it. So scripts calling <tt>umask</tt>
+will use <tt>posix-umask</tt>. When this configuration option has not
+been given, <tt>umask</tt> is a symbolic link to
+<a href="execline-umask.html">execline-umask</a>. </li>
<li> <tt>posix-umask</tt> fully conforms to the
<a href="https://pubs.opengroup.org/onlinepubs/9699919799/utilities/umask.html">POSIX
specification</a>. When <em>prog...</em> is not empty, the behaviour of a
<tt>umask</tt> utility is not specified by POSIX, so <tt>posix-umask</tt> extends
the spec to be actually useful and usable in an execline program with the same
-interface as the regular execline <a href="umask.html">umask</a> command. </li>
+interface as the regular execline <a href="execline-umask.html">umask</a> command. </li>
<li> Nobody ever executes or needs the external version (i.e. not a shell
-builtin) of the POSIX <tt>umask</tt> command. Compared to the regular execline
-<a href="umask.html">umask</a>, <tt>posix-umask</tt> is uselessly bloated and slow.
-The only reason it exists is that some distributions refuse to package
-execline correctly unless it is strictly POSIX-compliant; the
-<tt>--enable-pedantic-posix</tt> configure option is there to appease them. </li>
+builtin) of the POSIX <tt>umask</tt> command. Compared to execline's regular <tt>umask</tt>
+binary, <a href="execline-umask.html">execline-umask</a>, <tt>posix-umask</tt> is
+uselessly bloated and slow. The only reason it exists is that some
+distributions refuse to package execline correctly unless it is strictly
+POSIX-compliant; the <tt>--enable-pedantic-posix</tt> configure option is
+there to satisfy their requirements. </li>
</ul>
</body>
diff --git a/doc/umask.html b/doc/umask.html
deleted file mode 100644
index 22ae137..0000000
--- a/doc/umask.html
+++ /dev/null
@@ -1,48 +0,0 @@
-<html>
- <head>
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <meta http-equiv="Content-Language" content="en" />
- <title>execline: the umask command</title>
- <meta name="Description" content="execline: the umask command" />
- <meta name="Keywords" content="execline command umask" />
- <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
- </head>
-<body>
-
-<p>
-<a href="index.html">execline</a><br />
-<a href="//skarnet.org/software/">Software</a><br />
-<a href="//skarnet.org/">skarnet.org</a>
-</p>
-
-<h1> The <tt>umask</tt> program </h1>
-
-<p>
-<tt>umask</tt> sets the umask (file creation mask),
-then executes a program.
-</p>
-
-<h2> Interface </h2>
-
-<pre>
- umask <em>mask</em> <em>prog...</em>
-</pre>
-
-<p>
-<tt>umask</tt> sets the current umask to <em>mask</em>,
-then execs into <em>prog...</em>.
-</p>
-
-<h2> Notes </h2>
-
-<ul>
-<li> <tt>umask</tt> is a standard shell builtin. Be careful if you want to
-use the <tt>umask</tt> command outside of an <tt>execline</tt> script. </li>
- <li> When execline has been configured with the <tt>--enable-pedantic-posix</tt>
-option, the <tt>umask</tt> binary is actually a symbolic link to the
-<a href="posix-umask.html">posix-umask</a> binary. </li>
-</ul>
-
-</body>
-</html>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index bbb10aa..e286098 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -24,6 +24,12 @@
<li> <a href="dollarat.html">dollarat</a> now has its <tt>-0</tt> and <tt>-d</tt>
priority unified. (Rightmost priority.) </li>
<li> New binary: <a href="posix-umask.html">posix-umask</a>. </li>
+ <li> <tt>cd</tt> has been renamed <a href="execline-cd.html">execline-cd</a>. </li>
+ <li> <tt>umask</tt> has been renamed <a href="execline-umask.html">execline-umask</a>. </li>
+ <li> At installation time, <tt>cd</tt> and <tt>umask</tt> symbolic links are created,
+pointing to either the <tt>posix-</tt> or <tt>execline-</tt> -prefixed version of the
+commands, depending on whether the <tt>--enable-pedantic-posix</tt> option
+was given or not. </li>
</ul>
<h2> in 2.5.3.0 </h2>