summaryrefslogtreecommitdiff
path: root/doc/s6-tai64n.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/s6-tai64n.html')
-rw-r--r--doc/s6-tai64n.html50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/s6-tai64n.html b/doc/s6-tai64n.html
new file mode 100644
index 0000000..8b7f5e0
--- /dev/null
+++ b/doc/s6-tai64n.html
@@ -0,0 +1,50 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>s6: the s6-tai64n program</title>
+ <meta name="Description" content="s6: the s6-tai64n program" />
+ <meta name="Keywords" content="s6 command s6-tai64n filter timestamp TAI64 TAI64N" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">s6</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The s6-tai64n program </h1>
+
+<p>
+s6-tai64n acts as a filter, reading from stdin and writing to stdout.
+It prepends lines with a
+<a href="http://skarnet.org/software/skalibs/libstddjb/tai.html#timestamp">TAI64N
+timestamp</a> and a space.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ s6-tai64n
+</pre>
+
+<ul>
+ <li> s6-tai64n exits 0 when it sees the end of stdin. If there's an
+unfinished line, s6-tai64n processes it, adds a newline character to it,
+and writes it before exiting. </li>
+</ul>
+
+<h2> Notes </h2>
+
+<p>
+ s6-tai64n does neither "line buffering" nor "block buffering". It does
+<em>optimal buffering</em>, i.e. it flushes its output buffer every time
+it risks blocking on input. Every filter should behave this way, whether
+its output is a tty or not: it's simpler and more efficient in every
+case.
+</p>
+
+</body>
+</html>