documentation

1 files changed, 46 insertions, 0 deletions

diff --git a/bin/ttyrec b/bin/ttyrec
index 0aefecb..e7a878b 100644
--- a/bin/ttyrec
+++ b/bin/ttyrec
@@ -7,6 +7,46 @@ use warnings;
 use App::Ttyrec;
 use Getopt::Long;
 
+=head1 SYNOPSIS
+
+  ttyrec foo.ttyrec
+  ttyrec -e 'nethack' nethack.ttyrec
+  ttyrec -a
+
+=head1 DESCRIPTION
+
+This is an implementation of the C<ttyrec> program for recording terminal
+sessions. All data that the program running in the terminal produces is
+recorded, along with timing information, so that it can be replayed later (via
+a ttyrec player such as the C<ttyplay> script distributed with
+C<Term::TtyRec::Plus>).
+
+This program is intended to be mostly a drop-in replacement for the C<ttyrec>
+program distributed L<here|http://0xcc.net/ttyrec/index.html.en>.
+
+=head1 OPTIONS
+
+  ttyrec [-a] [-e <cmd>] [output_file]
+
+=over 4
+
+=item -a
+
+Append to the ttyrec file, rather than overwriting it.
+
+=item -e <cmd>
+
+Execute <cmd>, rather than a shell. Defaults to C<$SHELL> or C</bin/sh>.
+
+=item output_file
+
+The file to write the ttyrec data to. This can be a named pipe. Defaults to
+C<ttyrecord>.
+
+=back
+
+=cut
+
 my $cmd = $ENV{SHELL} || '/bin/sh';
 my $append;
 
@@ -33,3 +73,9 @@ App::Ttyrec->new(
     ttyrec_file => ($ARGV[0] || 'ttyrecord'),
     append      => $append,
 )->run($cmd);
+
+=head1 SEE ALSO
+
+L<http://0xcc.net/ttyrec/index.html.en>
+
+=cut