summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@derf.homelinux.org>2009-01-02 13:22:50 +0100
committerDaniel Friesel <derf@derf.homelinux.org>2009-01-02 13:22:50 +0100
commit88d4543aa94ed0d51b64a7b94bead73bdd03e3c4 (patch)
treecf1282370174fc45584d63dc0707ddaadfdc9e20
parent5abf0f917b5bf5dac01b922b77252cb98c0c2788 (diff)
tibtoa: Added some documentation
-rwxr-xr-xbin/tibtoa45
1 files changed, 45 insertions, 0 deletions
diff --git a/bin/tibtoa b/bin/tibtoa
index 221c543..b4b3290 100755
--- a/bin/tibtoa
+++ b/bin/tibtoa
@@ -789,3 +789,48 @@ if ($header{type} eq 'program') {
} else {
print STDERR "file type not supported\n";
}
+
+__END__
+
+=head1 NAME
+
+tibtoa - Texas Instruments TI8x Binary to ASCII converter
+
+=head1 SYNOPSIS
+
+B<tibtoa> [ B<-hi> ] I<file>
+
+=head1 DESCRIPTION
+
+B<tibtoa> converts the binary files dumped from a calculator
+(for example by tilp(1)) into human-readable text. The name is not quite right,
+though - for programs, it also uses various unicode chars, not plain ASCII.
+
+B<tibtoa> reads in the file specified on the commandline and prints the result
+to STDOUT. Errors, such as unknown bytes in the source, go to STDERR.
+
+Currently, the following file types are supported:
+
+=over
+
+=item * B<*.8Xp> - program files
+
+=item * B<*.8Xm> - matrix files
+
+=item * B<*.8Xl> - list files
+
+=back
+
+=head1 OPTIONS
+
+=over
+
+=item B<-i>
+
+Indent the content of for, while, if, etc. statements
+
+=item B<-h>
+
+Print the content of the file header before the file content, prefixed by '//'
+
+=back