From 8d3e4e8c12984565ca30fe58c4612c8a85bc4d43 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Thu, 9 Jun 2022 10:22:37 +0000
Subject:  Add =~ operator to s6-test

Signed-off-by: Laurent Bercot <ska@appnovation.com>
---
 doc/s6-test.html | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'doc')

diff --git a/doc/s6-test.html b/doc/s6-test.html
index 3764a5c..a8424cd 100644
--- a/doc/s6-test.html
+++ b/doc/s6-test.html
@@ -41,6 +41,16 @@ disambiguation technique that has unfortunately not been chosen by the standard.
  s6-test accepts an arbitrary number of arguments.
 </p>
 
+<h2> Exit codes </h2>
+
+<ul>
+ <li> 0: the test is true </li>
+ <li> 1: the test is false </li>
+ <li> 100: wrong usage </li>
+ <li> 101: internal error (should never happen, warrants a bug-report) </li>
+ <li> 111: system call failure </li>
+</ul>
+
 <h2> Posixness </h2>
 
 <p>
@@ -55,6 +65,11 @@ exact same behaviour.
 <ul>
  <li> <tt>-v&nbsp;<em>VAR</em></tt>&nbsp;: tests whether the
 <em>VAR</em> variable is defined in the current environment. </li>
+ <li> <tt><em>string</em>&nbsp;=~&nbsp;<em>pattern</em></tt>&nbsp;:
+tries to match <em>string</em> against extended regular expression
+<em>pattern</em>. True if any part of <em>string</em> matches <em>pattern</em>;
+in order to match whole strings, you must anchor <em>pattern</em> with
+<tt>^</tt> and <tt>$</tt> markers. </li>
 </ul>
 
 </body>
-- 
cgit v1.2.3