Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

README

  • Loading branch information...
commit a96949237906ed29a1432ac3d4c2315e34fc41a1 1 parent ff2f5d1
@sartak authored
Showing with 17 additions and 1 deletion.
  1. +17 −1 README
View
18 README
@@ -1,6 +1,22 @@
Tie-Handle-TtyRec 0.01
-Tie::Handle::TtyRec is
+A ttyrec is a format used for recording terminal sessions. Notably, practically
+all NetHack games are recorded using ttyrecs. ttyrecs include precise timing
+data and can be a little fiddly. This module lets you focus on your
+application, instead of making sure your ttyrec headers are perfect.
+
+The usual way to use this module is through its C<new> interface. It will
+clobber the file you decide to record to. A way of allowing you to instead
+append will be included in a future version.
+
+Each argument to print will be put into its own ttyrec frame, using the current
+time. So, the following will create three separate frames,
+
+ print $handle "foo", "bar", "baz";
+
+The following will create only one frame,
+
+ print $handle "foo" . "bar" . "baz";
MAJOR CHANGES
0.01: first version
Please sign in to comment.
Something went wrong with that request. Please try again.