ttyrex

commit fb3a5a0d595af543e9804013b49a3a4be1289752
parent 9bb535f4cdcb4b7815eec3e72e56d94fd3eaf9f3
Author: Antoine Amarilli <a3nm@a3nm.net>
Date:   Wed,  3 Oct 2012 01:12:39 +0200

+quick README additions to explain what is being done

Diffstat:
README
 | 
18
++++++++++++++++++

1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -1,3 +1,20 @@
+ttyrex is ttyrec with Debian patches applied and with two additional options:
+
+  * -f, to try to exec a shell instead of failing
+  * -l limit, to restrict the quantity of data logged to something
+    around 2*limit bytes per second
+
+The rationale of these additions is to make it possible to use ttyrec in all
+your shells. -f is useful to ensure that you can get a shell even if Bad Things
+occur. -l is useful whenever you cat large files and don't want them to make the
+record grow huge: with -l, you will get something like the first limit bytes of
+garbage, 2*limit bytes every second spent displaying garbage, and the last limit
+bytes of the garbage, which resembles more or less what you are likely to see.
+
+-- Antoine Amarilli <a3nm@a3nm.net>
+
+%%%%% Original readme follows %%%%%
+
 ttyrec is a tty recorder. ttyplay is a tty player.
 
 Installation:
@@ -25,3 +42,4 @@ Usage:
 Have fun!
 
 -- Satoru Takabayashi <satoru@namazu.org>
+