ref: 3ed1c37ceaa10a9d4449cc3922bab86fc856e51c
parent: 5258bb0610a7af3630b212f652db71d5f55952ae
author: kvik <kvik@a-b.xyz>
date: Sun Dec 13 20:26:42 EST 2020
README: provide links to formatted manual pages
--- a/README.md
+++ b/README.md
@@ -22,12 +22,13 @@
configuration and an order file.
The read-only meta-stream called order provides ordering information for
-data written to streams within a group. Special readers, such as
-mq-cat(1), can tap into this stream to retrieve data coming from
+data written to streams within a group. Special readers such as
+`mq-cat(1)` can tap into this stream to retrieve data coming from
multiple streams in the same order it was written.
-See the `mq(4)` manual page for complete description of supported
-data modes, queue replay options, usage reference, and other details.
+See the [`mq(4)`][mq] manual page for a complete
+description of supported data modes, queue replay options, usage reference,
+and other details.
Examples
----
@@ -46,8 +47,11 @@
cat fd1 & cat fd2 & cat >>fd0
-The program `pin(1)` provides a polished interface for persisting
+The program [`pin(1)`][pin] provides a polished interface for persisting
program sessions. It also makes use of the data ordering feature for
faithful reproduction of session history.
The program `mq-cat(1)` is an example of an ordered multi-stream reader.
+
+[mq]: http://a-b.xyz/95/34b5
+[pin]: http://a-b.xyz/9b/2151