doc/recorder.n

   1 '\"
   2 '\" Copyright (c) 1996-1999 Christian Werner
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .so man.macros
   8 .TH recorder n 8.0 Ck "Ck Built-In Commands"
   9 .BS
  10 '\" Note:  do not modify the .SH NAME line immediately below!
  11 .SH NAME
  12 recorder \- Simple event recorder/player
  13 .SH SYNOPSIS
  14 \fBrecorder replay \fIfileName\fR
  15 .br
  16 \fBrecorder start \fR?\fI\-withdelay\fR? \fIfileName\fR
  17 .br
  18 \fBrecorder stop\fR
  19 .BE
  20
  21 .SH DESCRIPTION
  22 .PP
  23 This command provides a simple recorder/player for certain kinds
  24 of events. The \fBrecorder start\fR form arranges for recording
  25 events to the event log file \fIfileName\fR. If the \fI\-withdelay\fR
  26 switch is specified, the delays between events are also recorded.
  27 The event log file may be replayed using the \fBrecorder replay\fR
  28 command form. With \fBrecorder stop\fR all recording/playing
  29 activity is stopped and all event log files are closed.
  30 .PP
  31 Each event takes up one line in an event log file. Event types are the
  32 first word in angle brackets in the line. They are followed by parameters
  33 for the event:
  34 .TP
  35 \fB<ButtonPress> \fIwindow button x y rootX rooty\fR
  36 Mouse button \fBbutton\fR (1, 2, or 3) pressed in window \fIwindow\fR at
  37 window coordinate \fIx\fR, \fIy\fR. Root coordinates are in \fIrootX\fR,
  38 \fIrootY\fR.
  39 .TP
  40 \fB<ButtonRelease> \fIwindow button x y rootX rooty\fR
  41 Mouse button released, analogous to \fB<ButtonPress>\fR.
  42 .TP
  43 \fB<Delay> \fImilliseconds\fR
  44 Delay replay for \fImilliseconds\fR.
  45 .TP
  46 \fB<Key> \fIwindow keysym\fR
  47 Key pressed in \fIwindow\fR. \fIKeysym\fR is the symbolic name of the
  48 key, e.g. ``Linefeed'', ``Return'', ``Control-A'', or a hexadecimal
  49 key code like 0xc3.
  50 Note that hexadecimal key codes greater than 0x7f are not portable
  51 accross different systems.
  52 .PP
  53 Lines starting with a hash are treated as comments. All other lines
  54 whose first word does not start with an open angle bracket are
  55 evaluated as normal Tcl commands. As in Tcl source files, newline-backslash
  56 sequences are treated as continuation lines.
  57 .PP
  58 Errors occuring during replay are reported using the background error
  59 mechanism. Upon error, the replay event log file is closed.
  60
  61 .SH KEYWORDS
  62 event, recorder