about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-02-11 03:12:21 +0000
committerLaurent Bercot <ska@appnovation.com>2023-02-11 03:12:21 +0000
commit774654ad56fc9304e4a064232760835c7a2a6c13 (patch)
tree3f539521073866497ff0370d8a6464c9356cadb4 /doc
parent790c8681d3451b61a536871dad234fc294796fd8 (diff)
downloads6-portable-utils-774654ad56fc9304e4a064232760835c7a2a6c13.tar.gz
s6-portable-utils-774654ad56fc9304e4a064232760835c7a2a6c13.tar.xz
s6-portable-utils-774654ad56fc9304e4a064232760835c7a2a6c13.zip
Add multicall configuration
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html11
-rw-r--r--doc/s6-portable-utils.html53
2 files changed, 64 insertions, 0 deletions
diff --git a/doc/index.html b/doc/index.html
index 3d8c400..69f753f 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -104,6 +104,8 @@ of the s6-portable-utils git repository. </li>
 
 <ul>
  <li> See the enclosed INSTALL file for installation details. </li>
+ <li> Starting with version 2.3.0.0, you can use the
+<tt>--enable-multicall</tt> configure option to save disk space. </li>
 </ul>
 
 <h3> Upgrade notes </h3>
@@ -126,6 +128,9 @@ the previous versions of s6-portable-utils and the current one. </li>
 126 if they fail to execute into a program for another reason.
 </p>
 
+<p>
+ (Miscellaneous tools)
+</p>
 <ul>
  <li> The <a href="s6-basename.html"><tt>s6-basename</tt></a> program </li>
  <li> The <a href="s6-cat.html"><tt>s6-cat</tt></a> program </li>
@@ -171,6 +176,12 @@ the previous versions of s6-portable-utils and the current one. </li>
  <li> The <a href="s6-update-symlinks.html"><tt>s6-update-symlinks</tt></a> program </li>
  <li> The <a href="seekablepipe.html"><tt>seekablepipe</tt></a> program </li>
 </ul>
+<p>
+ (Multicall configuration)
+</p>
+<ul>
+ <li> The <a href="s6-portable-utils.html"><tt>s6-portable-utils</tt></a> multicall binary </li>
+</ul>
 
 <h2> Related resources </h2>
 
diff --git a/doc/s6-portable-utils.html b/doc/s6-portable-utils.html
new file mode 100644
index 0000000..5700f38
--- /dev/null
+++ b/doc/s6-portable-utils.html
@@ -0,0 +1,53 @@
+<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>s6-portable-utils: the s6-portable-utils multicall binary</title>
+    <meta name="Description" content="s6-portable-utils: the s6-portable-utils multicall binary" />
+    <meta name="Keywords" content="s6-portable-utils command multicall" />
+    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+  </head>
+<body>
+
+<p>
+<a href="index.html">s6-portable-utils</a><br />
+<a href="//skarnet.org/software/">Software</a><br />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>s6-portable-utils</tt> multicall binary </h1>
+
+<p>
+The <tt>s6-portable-utils</tt> program is only available when the
+<tt>--enable-multicall</tt> option has been given to the <tt>configure</tt>
+program at build time. In this configuration, <tt>s6-portable-utils</tt> is
+a multicall binary implementing the functionality of <em>all</em>
+the programs in the s6-portable-utils package; and the other programs, instead
+of being executables of their own, are symbolic links to the
+s6-portable-utils binary.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+     s6-portable-utils <em>subcommand</em> <em>subcommand_arguments...</em>
+</pre>
+
+<p>
+ s6-portable-utils will run the <em>subcommand</em> will its arguments. For
+instance, <tt>s6-portable-utils s6-seq 1 10</tt> will run the equivalent of the
+<a href="s6-seq.html">program</a>, so this command will list natural numbers
+from 1 to 10.
+</p>
+
+<p>
+ Alternatively, if s6-portable-utils is called with the name of an existing
+command, it will run the equivalent of that command. For instance,
+if the <tt>/usr/bin/s6-seq</tt> file is a (hard or symbolic) link to
+the <tt>s6-portable-utils</tt> binary, <tt>/usr/bin/s6-seq 1 10</tt> will list
+natural numbers from 1 to 10.
+</p>
+
+</body>
+</html>