summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJaromil <jaromil@dyne.org>2008-11-07 13:04:11 (GMT)
committer Jaromil <jaromil@dyne.org>2008-11-07 13:04:11 (GMT)
commitd897edd3b4e7b19496c68b9d7c7fd2a011c22ba2 (patch)
tree0ad88effb18dff6bf4d12e785926026d62dfc178
parentcff07db860c624062d8e51576975f8c5d6e69c2e (diff)
better commandline interface and documentation
-rw-r--r--cmdline.cpp28
-rw-r--r--manual.html129
-rw-r--r--tbt.164
3 files changed, 119 insertions, 102 deletions
diff --git a/cmdline.cpp b/cmdline.cpp
index 84a9e7c..4dbbe60 100644
--- a/cmdline.cpp
+++ b/cmdline.cpp
@@ -65,22 +65,22 @@ TBT tbt;
void set_status(SLangWidget *s);
static const char *help =
-"Usage: tbt [options] [file]\n"
-"\n"
+"Synopsis: tbt -(r|p) [options] [file]\n"
+"Commands:\n"
+" -r record\n"
+" -p playback\n"
+"Options:\n"
" -h print this help\n"
" -v version information\n"
" -D debug verbosity level - default 1\n"
" -c console interface mode (S-Lang)\n"
-" -r record tbt - option alias: rectext\n"
-" -p playback tbt - option alias: playtext\n"
-" -m mail composer - option alias: recmail\n"
" -s save format in [ bin | ascii | html ]\n"
#ifdef linux
-" -t timing mode [ posix | rtc ]\n"
+" -t timing mode [ posix | rtc ]\n"
#endif
-" -x convert .tbt file to [ bin | html | ascii]\n";
+" -x convert tbt to [ bin | html | ascii]\n";
-static const char *short_options = "-hvD:crpms:t:x:";
+static const char *short_options = "-hvD:crps:t:x:";
int debug;
char filename[512];
@@ -97,7 +97,7 @@ int timing = POSIX;
// operation modes
#define REC 1
#define PLAY 2
-#define MAIL 3
+
#define CONV 4
int operation = REC;
@@ -129,8 +129,6 @@ void cmdline(int argc, char **argv) {
operation = REC;
else if ( strstr(argv[0],"playtext") )
operation = PLAY;
- else if ( strstr(argv[0],"recmail") )
- operation = MAIL;
do {
@@ -166,10 +164,6 @@ void cmdline(int argc, char **argv) {
operation = PLAY;
break;
- case 'm':
- operation = MAIL;
- break;
-
case 't':
if(strncasecmp(optarg, "rtc", 3) ==0)
timing = RTC;
@@ -414,10 +408,6 @@ int main(int argc, char** argv)
play_console();
break;
- case MAIL:
- error("TODO recmail");
- break;
-
}
// cleanly close the console
diff --git a/manual.html b/manual.html
index 3696292..6567bb7 100644
--- a/manual.html
+++ b/manual.html
@@ -41,27 +41,53 @@ A Web application written in PHP/MySQL and Ajax could be used to publish TBT wri
<P>
In the .tbt format, text is saved with a timestamp for each letter:
-<pre>
- _________ ___________
- | u-int | u-int |
- | 64bit | 64bit | m-seconds = 1/1000 of a second
- --------- -----------
- | char | m-seconds | char = ASCII or higher bit char code
- --------- -----------
- | Total: 128bit |
- ---------------------
-</pre>
+<BR>&nbsp;&nbsp;&nbsp;_________&nbsp;___________&nbsp;
+<BR>&nbsp;&nbsp;|&nbsp;&nbsp;u-int&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;u-int&nbsp;&nbsp;&nbsp;|
+<BR>&nbsp;&nbsp;|&nbsp;&nbsp;64bit&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;64bit&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;m-seconds&nbsp;=&nbsp;1/1000&nbsp;of&nbsp;a&nbsp;second
+<BR>&nbsp;&nbsp;&nbsp;---------&nbsp;-----------
+<BR>&nbsp;&nbsp;|&nbsp;&nbsp;char&nbsp;&nbsp;&nbsp;|&nbsp;m-seconds&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;char&nbsp;=&nbsp;ASCII&nbsp;or&nbsp;higher&nbsp;bit&nbsp;char&nbsp;code
+<BR>&nbsp;&nbsp;&nbsp;---------&nbsp;-----------
+<BR>&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;Total:&nbsp;128bit&nbsp;&nbsp;&nbsp;&nbsp;|
+<BR>&nbsp;&nbsp;&nbsp;---------------------
<P>
However export to different formats is planned including generation of web-ready code in HTML and Javascript, a daemon to provide timed input thru a socket on the network (TCP/IP) and what not.
<P>
Input is captured from the console, but can be extended to intercept any application using some h4x0r keylogging technique on different OS.
<P>
<A NAME="lbAF">&nbsp;</A>
-<H2>OPTIONS</H2>
+<H2>COMMANDS</H2>
<P>
+The main functionalities are exclusive (use one or the other):
+<P>
<B><DL COMPACT>
-<DT>-h<DD>
+<DT>-r<DD>
+</B>
+
+Record a Time Based Text
+<B><DT>-p<DD>
+</B>
+
+Playback a Time Based Text
+<B><DT>-x </B><I>&lt;format_name&gt;</I><DD>
+
+
+convert TBT file to format [ bin | html | ascii ]
+<P>
+The <I>bin</I> mode will store a binary file you can play with the
+playtext command.
+<P>
+The <I>html</I> mode will produce a simple html page, in which your
+text will be played. The distributed script file
+<I>tbt-typewriter.js</I> should be present in the same directory of the
+html file. For further information about the html mode please the the
+README.html file.
+<P>
+The <I>ascii</I> mode produces pure ascii text file, one character per
+line, with the information about the key pressed, and the timestamp.
+<P>
+<P>
+<B><DT>-h<DD>
</B>
Display a help text and quit
@@ -69,7 +95,17 @@ Display a help text and quit
</B>
Display version and quit
-<B><DT>-D </B><I>&lt;number&gt;</I><DD>
+<P>
+<P>
+</DL>
+<A NAME="lbAG">&nbsp;</A>
+<H2>OPTIONS</H2>
+
+<P>
+The following switches are optional:
+<P>
+<B><DL COMPACT>
+<DT>-D </B><I>&lt;number&gt;</I><DD>
Set verbosity level, the default value is 1
@@ -77,14 +113,6 @@ Set verbosity level, the default value is 1
</B>
Use the S-Lang console interface
-<B><DT>-r<DD>
-</B>
-
-record tbt - option alias: rectext
-<B><DT>-p<DD>
-</B>
-
-playback tbt - option alias: playtext
<B><DT>-m<DD>
</B>
@@ -92,17 +120,7 @@ mail composer - option alias: recmail
<B><DT>-s </B><I>&lt;format_name&gt;</I><DD>
-save format in [ bin | ascii | html ]. Default is bin.
-<P>
-The <I>bin</I> mode will store a binary file you can play with the
-playtext command.
-<P>
-The <I>html</I> mode will produce a simple html page, in which your
-text will be played. For further information about the html mode
-please the the README.html file.
-<P>
-The <I>ascii</I> mode produces pure ascii text file, one character per
-line, with the information about the key pressed, and the timestamp.
+save format in [ bin | ascii | html ]. Default is bin (see -x command)
<P>
<B><DT>-t </B><I>&lt;timing mode&gt;</I><DD>
@@ -112,14 +130,10 @@ method used to calculate time: [ posix | rtc ]. Default is posix.
So far a few methods are implemented, posix should be the most compatible,
rtc works only with Linux kernel and requires suid authority.
<P>
-<B><DT>-x </B><I>&lt;format_name&gt;</I><DD>
-
-
-convert a binary .tbt file to another format [ bin | html | ascii] (see -s)
<P>
<P>
</DL>
-<A NAME="lbAG">&nbsp;</A>
+<A NAME="lbAH">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
@@ -128,40 +142,40 @@ convert a binary .tbt file to another format [ bin | html | ascii] (see -s)
</B>
<P>
-$ rectext -s bin mytext.tbt
+$ tbt -c -r mytext.tbt
<P>
<B><DT>Howto play a tbt binary file<DD>
</B>
<P>
-$ playtext mytext.tbt
+$ tbt -c -p mytext.tbt
<P>
<B><DT>Howto record a tbt in ascii mode<DD>
</B>
<P>
-$ rectext -s ascii mytext.txt
+$ tbt -c -r -s ascii mytext.txt
<P>
<B><DT>Howto record a tbt in html mode<DD>
</B>
<P>
-$ rectext -s html mytext.html
+$ tbt -c -r -s html mytext.html
<P>
</DL>
-<A NAME="lbAH">&nbsp;</A>
+<A NAME="lbAI">&nbsp;</A>
<H2>NOTES</H2>
The first integration provided for TBT is with Mutt <I><A HREF="http://www.mutt.org">http://www.mutt.org</A></I> the Mail User Agent popular among text console users.
For further information please read the README.mutt file.
<P>
-<A NAME="lbAI">&nbsp;</A>
+<A NAME="lbAJ">&nbsp;</A>
<H2>BUGS</H2>
Everyone is encouraged to test this software and report bugs!
Send remarks and patches to <A HREF="http://dyne.org/hackers_contact.php">http://dyne.org/hackers_contact.php</A> or get in touch with coders via irc.freenode.net channel #dyne
<P>
-<A NAME="lbAJ">&nbsp;</A>
+<A NAME="lbAK">&nbsp;</A>
<H2>AUTHORS</H2>
Time Based Text software by Denis Roio - <A HREF="http://jaromil.dyne.org">http://jaromil.dyne.org</A>
@@ -176,7 +190,7 @@ PHP/Javascript code by Angelo Failla - pallotron freaknet.org
Webdesign by O.K. Parking - <A HREF="http://www.ok-parking.nl">http://www.ok-parking.nl</A>
<BR>
-Python-GTK graphical interface by Pablo Martines - caedes sindominio.net
+Python-GTK GUI by Pablo Martines - caedes sindominio.net
<BR>
More code and suggestions by Andrea Lo Pumo - alpt freaknet.org
@@ -187,7 +201,7 @@ Development supported by Impakt - <A HREF="http://www.impakt.nl">http://www.impa
Thanks to: Florian Cramer, Annet Dekker, Paul Hendriks
<P>
-<A NAME="lbAK">&nbsp;</A>
+<A NAME="lbAL">&nbsp;</A>
<H2>COPYING</H2>
<P>
@@ -200,14 +214,14 @@ Foundation. Permission is granted to make and distribute verbatim
copies of this manual page provided the above copyright notice and
this permission notice are preserved on all copies.
<P>
-<A NAME="lbAL">&nbsp;</A>
+<A NAME="lbAM">&nbsp;</A>
<H2>AVAILABILITY</H2>
<P>
The most recent version of tbt sourcecode and up to date documentation
is always available for download from <I><A HREF="http://tbt.dyne.org">http://tbt.dyne.org</A></I>.
<P>
-<A NAME="lbAM">&nbsp;</A>
+<A NAME="lbAN">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
@@ -222,19 +236,20 @@ is always available for download from <I><A HREF="http://tbt.dyne.org">http://tb
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">PROTOCOL</A><DD>
-<DT><A HREF="#lbAF">OPTIONS</A><DD>
-<DT><A HREF="#lbAG">EXAMPLES</A><DD>
-<DT><A HREF="#lbAH">NOTES</A><DD>
-<DT><A HREF="#lbAI">BUGS</A><DD>
-<DT><A HREF="#lbAJ">AUTHORS</A><DD>
-<DT><A HREF="#lbAK">COPYING</A><DD>
-<DT><A HREF="#lbAL">AVAILABILITY</A><DD>
-<DT><A HREF="#lbAM">SEE ALSO</A><DD>
+<DT><A HREF="#lbAF">COMMANDS</A><DD>
+<DT><A HREF="#lbAG">OPTIONS</A><DD>
+<DT><A HREF="#lbAH">EXAMPLES</A><DD>
+<DT><A HREF="#lbAI">NOTES</A><DD>
+<DT><A HREF="#lbAJ">BUGS</A><DD>
+<DT><A HREF="#lbAK">AUTHORS</A><DD>
+<DT><A HREF="#lbAL">COPYING</A><DD>
+<DT><A HREF="#lbAM">AVAILABILITY</A><DD>
+<DT><A HREF="#lbAN">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
-Time: 22:40:02 GMT, October 19, 2008
+Time: 20:36:20 GMT, November 04, 2008
</BODY>
</HTML>
diff --git a/tbt.1 b/tbt.1
index c39244f..764adac 100644
--- a/tbt.1
+++ b/tbt.1
@@ -37,7 +37,32 @@ However export to different formats is planned including generation of web-ready
Input is captured from the console, but can be extended to intercept any application using some h4x0r keylogging technique on different OS.
-.SH OPTIONS
+.SH COMMANDS
+
+The main functionalities are exclusive (use one or the other):
+
+.B
+.IP "-r"
+Record a Time Based Text
+.B
+.IP "-p"
+Playback a Time Based Text
+.B
+.IP "-x \fI<format_name>\fR"
+convert TBT file to format [ bin | html | ascii ]
+
+The \fIbin\fR mode will store a binary file you can play with the
+playtext command.
+
+The \fIhtml\fR mode will produce a simple html page, in which your
+text will be played. The distributed script file
+\fItbt-typewriter.js\fR should be present in the same directory of the
+html file. For further information about the html mode please the the
+README.html file.
+
+The \fIascii\fR mode produces pure ascii text file, one character per
+line, with the information about the key pressed, and the timestamp.
+
.B
.IP "-h"
@@ -45,6 +70,12 @@ Display a help text and quit
.B
.IP "-v"
Display version and quit
+
+
+.SH OPTIONS
+
+The following switches are optional:
+
.B
.IP "-D \fI<number>\fR"
Set verbosity level, the default value is 1
@@ -52,27 +83,11 @@ Set verbosity level, the default value is 1
.IP "-c"
Use the S-Lang console interface
.B
-.IP "-r"
-record tbt - option alias: rectext
-.B
-.IP "-p"
-playback tbt - option alias: playtext
-.B
.IP "-m"
mail composer - option alias: recmail
.B
.IP "-s \fI<format_name>\fR"
-save format in [ bin | ascii | html ]. Default is bin.
-
-The \fIbin\fR mode will store a binary file you can play with the
-playtext command.
-
-The \fIhtml\fR mode will produce a simple html page, in which your
-text will be played. For further information about the html mode
-please the the README.html file.
-
-The \fIascii\fR mode produces pure ascii text file, one character per
-line, with the information about the key pressed, and the timestamp.
+save format in [ bin | ascii | html ]. Default is bin (see -x command)
.B
.IP "-t \fI<timing mode>\fR"
@@ -81,9 +96,6 @@ method used to calculate time: [ posix | rtc ]. Default is posix.
So far a few methods are implemented, posix should be the most compatible,
rtc works only with Linux kernel and requires suid authority.
-.B
-.IP "-x \fI<format_name>\fR"
-convert a binary .tbt file to another format [ bin | html | ascii] (see -s)
.SH EXAMPLES
@@ -91,22 +103,22 @@ convert a binary .tbt file to another format [ bin | html | ascii] (see -s)
.B
.IP "Howto record a tbt in binary format"
-$ rectext -s bin mytext.tbt
+$ tbt -c -r mytext.tbt
.B
.IP "Howto play a tbt binary file"
-$ playtext mytext.tbt
+$ tbt -c -p mytext.tbt
.B
.IP "Howto record a tbt in ascii mode"
-$ rectext -s ascii mytext.txt
+$ tbt -c -r -s ascii mytext.txt
.B
.IP "Howto record a tbt in html mode"
-$ rectext -s html mytext.html
+$ tbt -c -r -s html mytext.html
.SH NOTES
The first integration provided for TBT is with Mutt \fIhttp://www.mutt.org\fR the Mail User Agent popular among text console users.
@@ -125,7 +137,7 @@ PHP/Javascript code by Angelo Failla - pallotron freaknet.org
.br
Webdesign by O.K. Parking - http://www.ok-parking.nl
.br
-Python-GTK graphical interface by Pablo Martines - caedes sindominio.net
+Python-GTK GUI by Pablo Martines - caedes sindominio.net
.br
More code and suggestions by Andrea Lo Pumo - alpt freaknet.org
.br