summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html11
-rw-r--r--doc/s6-linux-utils.html53
-rw-r--r--doc/upgrade.html2
3 files changed, 66 insertions, 0 deletions
diff --git a/doc/index.html b/doc/index.html
index d46cf3d..898b002 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -77,6 +77,8 @@ of the s6-linux-utils git repository. </li>
 
 <ul>
  <li> See the enclosed INSTALL file for installation details. </li>
+ <li> Starting with version 2.6.1.0, you can use the
+<tt>--enable-multicall</tt> configure option to save disk space. </li>
 </ul>
 
 <h3> Upgrade notes </h3>
@@ -99,6 +101,9 @@ the previous versions of s6-linux-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><a href="rngseed.html">The <tt>rngseed</tt> program</a></li>
 <li><a href="s6-chroot.html">The <tt>s6-chroot</tt> program</a></li>
@@ -112,6 +117,12 @@ the previous versions of s6-linux-utils and the current one. </li>
 <li><a href="s6-swapon.html">The <tt>s6-swapon</tt> program</a></li>
 <li><a href="s6-umount.html">The <tt>s6-umount</tt> program</a></li>
 </ul>
+<p>
+ (Multicall configuration)
+</p>
+<ul>
+ <li> The <a href="s6-linux-utils.html"><tt>s6-linux-utils</tt></a> multicall binary </li>
+</ul>
 
 <h2> Related resources </h2>
 
diff --git a/doc/s6-linux-utils.html b/doc/s6-linux-utils.html
new file mode 100644
index 0000000..d366937
--- /dev/null
+++ b/doc/s6-linux-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-linux-utils: the s6-linux-utils multicall binary</title>
+    <meta name="Description" content="s6-linux-utils: the s6-linux-utils multicall binary" />
+    <meta name="Keywords" content="s6-linux-utils command multicall" />
+    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+  </head>
+<body>
+
+<p>
+<a href="index.html">s6-linux-utils</a><br />
+<a href="//skarnet.org/software/">Software</a><br />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>s6-linux-utils</tt> multicall binary </h1>
+
+<p>
+The <tt>s6-linux-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-linux-utils</tt> is
+a multicall binary implementing the functionality of <em>all</em>
+the programs in the s6-linux-utils package; and the other programs, instead
+of being executables of their own, are symbolic links to the
+s6-linux-utils binary.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+     s6-linux-utils <em>subcommand</em> <em>subcommand_arguments...</em>
+</pre>
+
+<p>
+ s6-linux-utils will run the <em>subcommand</em> will its arguments. For
+instance, <tt>s6-linux-utils s6-ps -H</tt> will run the equivalent of the
+<a href="s6-ps.html">s6-ps</a> program, so this command will print a
+tree of the currently running processes.
+</p>
+
+<p>
+ Alternatively, if s6-linux-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-ps</tt> file is a (hard or symbolic) link to
+the <tt>s6-linux-utils</tt> binary, <tt>/usr/bin/s6-ps -H</tt> will print
+a tree of the currently running processes.
+</p>
+
+</body>
+</html>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 79e9ef1..eaa7187 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -23,6 +23,8 @@
 <ul>
  <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
 dependency bumped to 2.13.1.0. </li>
+ <li> New <a href="s6-linux-utils.html">s6-linux-utils</a>
+multicall binary. </li>
 </ul>
 
 <h2> in 2.6.0.1 </h2>