root/Term-TtyRec/trunk/README

Revision 268 (checked in by miyagawa, 19 years ago)

add README

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 NAME
2     Term::TtyRec - handles ttyrec data
3
4 SYNOPSIS
5       use Term::TtyRec;
6       use FileHandle;
7
8       # $handle is any IO::* object
9       my $handle = FileHandle->new('file.tty');
10       my $ttyrec = Term::TtyRec->new($handle);
11
12       # iterates through datafile
13       while (my($sec, $text) = $ttyrec->read_next) {
14           do_some_stuff();
15       }
16
17 DESCRIPTION
18     What is ttyrec? Here is an excerpt.
19
20       ttyrec is a tty recorder. Recorded data can be played back with the
21       included ttyplay command. ttyrec is just a derivative of script
22       command for recording timing information with microsecond accuracy
23       as well. It can record emacs -nw, vi, lynx, or any programs running
24       on tty.
25
26     See http://www.namazu.org/~satoru/ttyrec/ for details.
27
28     Term::TtyRec is a simple class for ttyrec recorded data. This module
29     provides a way to itertate through recorded from any IO. See
30     Term::TtyRec::Player for playing recorded data.
31
32 METHODS
33     read_next
34           ($sec, $text) = $ttyrec->read_next;
35
36         iterates data inside and returns number of second, textdata. Returns
37         empty list when it reaches end of data.
38
39 ACKNOWLEDGEMENT
40     Almost all of its code are stolen from ruby-ttyplay.
41
42 AUTHOR
43     Tatsuhiko Miyagawa <miyagawa@bulknews.net>
44
45     This library is free software; you can redistribute it and/or modify it
46     under the same terms as Perl itself.
47
48 SEE ALSO
49     the Term::TtyRec::Player manpage, http://namazu.org/~satoru/ttyrec/
50
Note: See TracBrowser for help on using the browser.