diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.html | 2 | ||||
| -rw-r--r-- | doc/s6-tai64ndiff.html | 60 | ||||
| -rw-r--r-- | doc/upgrade.html | 4 |
3 files changed, 63 insertions, 3 deletions
diff --git a/doc/index.html b/doc/index.html index 157400a..f191c4f 100644 --- a/doc/index.html +++ b/doc/index.html @@ -77,7 +77,7 @@ library. </li> <ul> <li> The current released version of s6-portable-utils is -<a href="s6-portable-utils-2.2.2.5.tar.gz">2.2.2.5</a>. </li> +<a href="s6-portable-utils-2.2.3.0.tar.gz">2.2.3.0</a>. </li> <li> Alternatively, you can checkout a copy of the <a href="//git.skarnet.org/cgi-bin/cgit.cgi/s6-portable-utils/">s6-portable-utils git repository</a>: diff --git a/doc/s6-tai64ndiff.html b/doc/s6-tai64ndiff.html new file mode 100644 index 0000000..c1f0440 --- /dev/null +++ b/doc/s6-tai64ndiff.html @@ -0,0 +1,60 @@ +<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-tai64ndiff program</title> + <meta name="Description" content="s6-portable-utils: the s6-tai64ndiff program" /> + <meta name="Keywords" content="s6 command s6-tai64ndiff filter timestamp TAI64 TAI64N diff time difference log line" /> + <!-- <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 s6-tai64ndiff program </h1> + +<p> +s6-tai64ndiff acts as a filter, reading from stdin and writing to stdout. +It expects every line of its input to begin with a +<a href="//skarnet.org/software/skalibs/libstddjb/tai.html#timestamp">TAI64N +timestamp</a>. It replaces this timestamp with a prefix showing the time +difference between this line and the previous line. +</p> + +<h2> Interface </h2> + +<pre> + s6-tai64ndiff +</pre> + +<ul> + <li> s6-tai64ndiff exits 0 when it sees the end of stdin. If there's an +unfinished line, s6-tai64ndiff processes it and writes it before exiting. </li> + <li> The prefix it prints is of the form <tt>[ <em>seconds</em>.<em>microseconds</em> ]</tt>, +in decimal. It can be interpreted as a fixed-point decimal number of seconds that +elapsed between the timestamp on the previous line and the timestamp on the +current line. </li> + <li> If the difference isn't defined, <em>seconds</em> and <em>microseconds</em> +are just whitespace. The difference is not defined on the first line of stdin or +on non-timestamped lines. Following non-timestamped lines, the difference may not +be accurate. </li> +</ul> + +<h2> Notes </h2> + +<ul> + <li> The typical use case of s6-tai64ndiff is to read files that have +been filtered through <a href="s6-tai64n.html">s6-tai64n</a>, or log files +that have been produced by <a href="s6-log.html">s6-log</a> with the <tt>t</tt> +directive. </li> + <li> The difference is a signed number. Negative numbers probably indicate +a backwards clock jump, which is a bad thing to have on a system. </li> +</ul> + +</body> +</html> diff --git a/doc/upgrade.html b/doc/upgrade.html index 270cea5..9600316 100644 --- a/doc/upgrade.html +++ b/doc/upgrade.html @@ -18,10 +18,10 @@ <h1> What has changed in s6-portable-utils </h1> -<h2> in 2.2.2.5 </h2> +<h2> in 2.2.3.0 </h2> <ul> - <li> Bugfix release, no changes. </li> + <li> New binary: <a href="s6-tai64ndiff.html">s6-tai64ndiff</a>. </li> </ul> <h2> in 2.2.2.4 </h2> |