summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/getcwd.html52
-rw-r--r--doc/index.html1
-rw-r--r--doc/upgrade.html3
3 files changed, 55 insertions, 1 deletions
diff --git a/doc/getcwd.html b/doc/getcwd.html
new file mode 100644
index 0000000..ffd89a8
--- /dev/null
+++ b/doc/getcwd.html
@@ -0,0 +1,52 @@
+<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 getcwd program</title>
+ <meta name="Description" content="execline: the getcwd program" />
+ <meta name="Keywords" content="execline command getcwd current working directory variable pwd" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">execline</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>getcwd</tt> program </h1>
+
+<p>
+<tt>getcwd</tt> stores its current working directory
+into a given environment variable,
+then executes a program.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ getcwd <em>var</em> <em>prog...</em>
+</pre>
+
+<p>
+<tt>getcwd</tt> stores a fully resolved absolute path (i.e. without any
+<tt>..</t> or symbolic link components) to its current working directory
+into the <em>var</em> variable, then
+execs into <em>prog</em> with its arguments.
+</p>
+
+<h2> Notes </h2>
+
+<ul>
+ <li> <em>var</em> must be given without a dollar&nbsp;! </li>
+ <li> <em>var</em> must not contain <tt>=</tt>. </li>
+ <li> Unlike the
+<a href="http://pubs.opengroup.org/onlinepubs/9699919799/utilities/pwd.html">pwd</a>
+POSIX command, <tt>getcwd</tt> does not depend on the PWD environment
+variable and will always exhibit the same behaviour. </li>
+</ul>
+
+</body>
+</html>
diff --git a/doc/index.html b/doc/index.html
index 1b61375..a5b5974 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -132,6 +132,7 @@ to your installation: the shebang lines for your system might be something like
<li><a href="piperw.html">The <tt>piperw</tt> program</a></li>
<li><a href="heredoc.html">The <tt>heredoc</tt> program</a></li>
<li><a href="wait.html">The <tt>wait</tt> program</a></li>
+<li><a href="getcwd.html">The <tt>getpid</tt> program</a></li>
<li><a href="getpid.html">The <tt>getpid</tt> program</a></li>
<li><a href="exec.html">The <tt>exec</tt> program</a></li>
<li><a href="tryexec.html">The <tt>tryexec</tt> program</a></li>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 6013a41..0b39ea2 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -24,7 +24,8 @@
<li> New <tt>EXECLINE_BLOCK_END_STRING</tt> and <tt>EXECLINE_BLOCK_QUOTE_STRING</tt> macros </li>
<li> New command: <a href="withstdinas.html">withstdinas</a>. It's a simplification
of <a href="backtick.html">backtick</a>, which is now implemented as a combination of
-<a href="pipeline.html">pipeline</a> and <a href="withstdinas.html">withstdinas</a>. </li>
+<a href="pipeline.html">pipeline</a> and <a href="withstdinas.html">withstdinas</a>.
+ <li> Also new command: <a href="getcwd.html">getcwd</a>. </li>
</ul>
<h2> in 2.1.3.1 </h2>