summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2019-12-24 14:27:51 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2019-12-24 14:27:51 +0000
commitd9b6a5820f195ef681d7cd15d70a184265b37a94 (patch)
tree49f952f89c5e6aa0992a0e45fdba636ab0d2bbca /doc
parent2a96bc93c24f34a972740da3e7df031a2d36e7cb (diff)
downloadexecline-d9b6a5820f195ef681d7cd15d70a184265b37a94.tar.xz
Add posix-umask; prepare for 2.6.0.0
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html3
-rw-r--r--doc/posix-cd.html2
-rw-r--r--doc/posix-umask.html69
-rw-r--r--doc/umask.html11
-rw-r--r--doc/upgrade.html8
5 files changed, 87 insertions, 6 deletions
diff --git a/doc/index.html b/doc/index.html
index 0a3643c..d93f704 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -66,7 +66,7 @@ library. </li>
<h3> Download </h3>
<ul>
- <li> The current released version of execline is <a href="execline-2.5.3.0.tar.gz">2.5.3.0</a>. </li>
+ <li> The current released version of execline is <a href="execline-2.6.0.0.tar.gz">2.6.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>:
@@ -128,6 +128,7 @@ to your installation: the shebang lines for your system might be something like
<li><a href="cd.html">The <tt>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="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>
<li><a href="export.html">The <tt>export</tt> program</a></li>
diff --git a/doc/posix-cd.html b/doc/posix-cd.html
index 3a24602..5074658 100644
--- a/doc/posix-cd.html
+++ b/doc/posix-cd.html
@@ -26,7 +26,7 @@ given directory, then executes a program.
<h2> Interface </h2>
<pre>
- posix-cd <em>dir</em> <em>prog...</em>
+ posix-cd [ -L | -P ] <em>dir</em> <em>prog...</em>
</pre>
<p>
diff --git a/doc/posix-umask.html b/doc/posix-umask.html
new file mode 100644
index 0000000..4ee310d
--- /dev/null
+++ b/doc/posix-umask.html
@@ -0,0 +1,69 @@
+<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 posix-umask command</title>
+ <meta name="Description" content="execline: the posix-umask command" />
+ <meta name="Keywords" content="execline command umask mask posix posix-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>posix-umask</tt> program </h1>
+
+<p>
+<tt>posix-umask</tt> changes its file mode creation mask, then executes a program.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ posix-umask [ -S ] [ <em>mask</em> ] [ <em>prog...</em> ]
+</pre>
+
+<p>
+When called with no argument, <tt>posix-umask</tt> prints the value of the
+file mode creation mask of the invoking process, then exits 0.
+</p>
+
+<p>
+ When called with a <em>mask</em> argument, <tt>posix-umask</tt> changes
+its file mode creation mask; then, if <em>prog...</em> is not empty, it execs
+into it.
+</p>
+
+<p>
+ <tt>posix-umask</tt> interprets <em>mask</em> as specified by the
+<a href="https://pubs.opengroup.org/onlinepubs/9699919799/utilities/umask.html">POSIX
+specification for a <tt>umask</tt> external utility</a>.
+</p>
+
+<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> <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>
+ <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>
+</ul>
+
+</body>
+</html>
diff --git a/doc/umask.html b/doc/umask.html
index 1acd04b..22ae137 100644
--- a/doc/umask.html
+++ b/doc/umask.html
@@ -36,10 +36,13 @@ then execs into <em>prog...</em>.
<h2> Notes </h2>
-<p>
-<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.
-</p>
+<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 045803e..bbb10aa 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,14 @@
<h1> What has changed in execline </h1>
+<h2> in 2.6.0.0 </h2>
+
+<ul>
+ <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>
+</ul>
+
<h2> in 2.5.3.0 </h2>
<ul>