initial commit

author: Laurent Bercot <ska-skaware@skarnet.org> 2014-09-19 02:53:32 +0000
committer: Laurent Bercot <ska-skaware@skarnet.org> 2014-09-19 02:53:32 +0000
commit: bea0037dbdd979603fb0b5be8b43f5478c1f6fec (patch)
tree: 5776ae3af5a3e83d41c7087f70713952b6360988 /doc/index.html
download: s6-portable-utils-bea0037dbdd979603fb0b5be8b43f5478c1f6fec.tar.xz
1 files changed, 162 insertions, 0 deletions
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 0000000..1775002
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,162 @@
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>s6-portable-utils - skarnet.org's tiny general Unix utilities</title>
+    <meta name="Description" content="s6-portable-utils - skarnet.org's tiny general Unix utilities" />
+    <meta name="Keywords" content="s6 unix administration root skarnet portable utilities tiny coreutils" />
+    <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+  </head>
+<body>
+
+<p>
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> s6-portable-utils </h1>
+
+<ul>
+<li><a href="install.html">How to install s6-portable-utils</a></li>
+<li><a href="upgrade.html">Upgrading from previous versions of s6-portable-utils</a></li>
+</ul>
+
+<h2> What is it&nbsp;? </h2>
+
+<p>
+ s6-portable-utils is a set of tiny general Unix utilities, often
+performing well-known tasks such as <em>cut</em> and <em>grep</em>,
+but optimized for simplicity and small size. They were designed
+for embedded systems and other constrained environments, but they
+work everywhere.
+</p>
+
+<p>
+ Other set of small utilities are usually system-specific; for
+instance, the (otherwise excellent)
+<a href="http://busybox.net/">BusyBox</a> project only works on Linux.
+</p>
+
+<p>
+ Some of s6-portable-utils' programs are a conformant implementation
+of a POSIX utility as determined by the
+<a href="http://pubs.opengroup.org/onlinepubs/9699919799/nfindex.html">Single
+Unix Specification, version 4</a>; the relevant documentation pages mentions
+this.
+However, none of the s6-portable-utils programs supports internationalization.
+</p>
+
+<p>
+It is now an explicit non-goal of s6-portable-utils to duplicate the work of
+existing projects that aim to provide a lightweight implementation of
+standard commands. 
+ No more rewriting of standard commands will occur in s6-portable-utils;
+the package is now used to host specific utilities such as
+<a href="s6-uniquename.html"><tt>s6-uniquename</tt></a>.
+</p>
+
+<hr />
+
+<h2> Installation </h2>
+
+<h3> Requirements </h3>
+
+<ul>
+ <li> A POSIX-compliant system with a standard C development environment </li>
+ <li> GNU make, version 3.81 or later </li>
+ <li> <a href="http://skarnet.org/software/skalibs/">skalibs</a> version
+2.0.0.0 or later </li>
+</ul>
+
+<h3> Licensing </h3>
+
+<p>
+ s6-portable-utils is free software. It is available under the
+<a href="http://opensource.org/licenses/ISC">ISC license</a>.
+</p>
+
+<h3> Download </h3>
+
+<ul>
+ <li> The current released version of s6-portable-utils is
+<a href="s6-portable-utils-2.0.0.0.tar.gz">2.0.0.0</a>. </li>
+ <li> Alternatively, you can checkout a copy of the s6-portable-utils git repository:
+<pre> git clone git://git.skarnet.org/s6-portable-utils </pre> </li>
+</ul>
+
+<h3> Compilation </h3>
+
+<ul>
+ <li> See the enclosed INSTALL file for installation details. </li>
+</ul>
+
+<h3> Upgrade notes </h3>
+
+<ul>
+ <li> <a href="upgrade.html">This page</a> lists the differences to be aware of between
+the previous versions of s6-portable-utils and the current one. </li>
+</ul>
+
+<hr />
+
+<h2> Reference </h2>
+
+<h3> Commands </h3>
+
+<p>
+ All these commands exit 111 if they encounter a temporary error, and
+100 if they encounter a permanent error - such as a misuse.
+</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>
+ <li> The <a href="s6-chmod.html"><tt>s6-chmod</tt></a> program </li>
+ <li> The <a href="s6-chown.html"><tt>s6-chown</tt></a> program </li>
+ <li> The <a href="s6-clock.html"><tt>s6-clock</tt></a> program </li>
+ <li> The <a href="s6-cut.html"><tt>s6-cut</tt></a> program </li>
+ <li> The <a href="s6-dirname.html"><tt>s6-dirname</tt></a> program </li>
+ <li> The <a href="s6-echo.html"><tt>s6-echo</tt></a> program </li>
+ <li> The <a href="s6-env.html"><tt>s6-env</tt></a> program </li>
+ <li> The <a href="s6-expr.html"><tt>s6-expr</tt></a> program </li>
+ <li> The <a href="s6-false.html"><tt>s6-false</tt></a> program </li>
+ <li> The <a href="s6-format-filter.html"><tt>s6-format-filter</tt></a> program </li>
+ <li> The <a href="s6-grep.html"><tt>s6-grep</tt></a> program </li>
+ <li> The <a href="s6-head.html"><tt>s6-head</tt></a> program </li>
+ <li> The <a href="s6-linkname.html"><tt>s6-linkname</tt></a> program </li>
+ <li> The <a href="s6-ln.html"><tt>s6-ln</tt></a> program </li>
+ <li> The <a href="s6-ls.html"><tt>s6-ls</tt></a> program </li>
+ <li> The <a href="s6-maximumtime.html"><tt>s6-maximumtime</tt></a> program </li>
+ <li> The <a href="s6-mkdir.html"><tt>s6-mkdir</tt></a> program </li>
+ <li> The <a href="s6-mkfifo.html"><tt>s6-mkfifo</tt></a> program </li>
+ <li> The <a href="s6-nice.html"><tt>s6-nice</tt></a> program </li>
+ <li> The <a href="s6-nuke.html"><tt>s6-nuke</tt></a> program </li>
+ <li> The <a href="s6-pause.html"><tt>s6-pause</tt></a> program </li>
+ <li> The <a href="s6-printenv.html"><tt>s6-printenv</tt></a> program </li>
+ <li> The <a href="s6-quote-filter.html"><tt>s6-quote-filter</tt></a> program </li>
+ <li> The <a href="s6-quote.html"><tt>s6-quote</tt></a> program </li>
+ <li> The <a href="s6-rename.html"><tt>s6-rename</tt></a> program </li>
+ <li> The <a href="s6-rmrf.html"><tt>s6-rmrf</tt></a> program </li>
+ <li> The <a href="s6-sleep.html"><tt>s6-sleep</tt></a> program </li>
+ <li> The <a href="s6-sort.html"><tt>s6-sort</tt></a> program </li>
+ <li> The <a href="s6-sync.html"><tt>s6-sync</tt></a> program </li>
+ <li> The <a href="s6-tail.html"><tt>s6-tail</tt></a> program </li>
+ <li> The <a href="s6-test.html"><tt>s6-test</tt></a> program </li>
+ <li> The <a href="s6-touch.html"><tt>s6-touch</tt></a> program </li>
+ <li> The <a href="s6-true.html"><tt>s6-true</tt></a> program </li>
+ <li> The <a href="s6-uniquename.html"><tt>s6-uniquename</tt></a> program </li>
+ <li> The <a href="s6-unquote-filter.html"><tt>s6-unquote-filter</tt></a> program </li>
+ <li> The <a href="s6-unquote.html"><tt>s6-unquote</tt></a> program </li>
+ <li> The <a href="s6-update-symlinks.html"><tt>s6-update-symlinks</tt></a> program </li>
+</ul>
+
+<h2> Related resources </h2>
+
+<ul>
+ <li> <tt>s6-portable-utils</tt> is discussed on the
+<a href="http://skarnet.org/lists.html#skaware">skaware</a> mailing-list. </li>
+ </li>
+</ul>
+
+</body>
+</html>
author	Laurent Bercot <ska-skaware@skarnet.org>	2014-09-19 02:53:32 +0000
committer	Laurent Bercot <ska-skaware@skarnet.org>	2014-09-19 02:53:32 +0000
commit	bea0037dbdd979603fb0b5be8b43f5478c1f6fec (patch)
tree	5776ae3af5a3e83d41c7087f70713952b6360988 /doc/index.html
download	s6-portable-utils-bea0037dbdd979603fb0b5be8b43f5478c1f6fec.tar.xz