'\"macro stdmacro
.if n .pH g1.journling @(#)journling	40.2 of 12/29/89
.ig
Revised: D. Bodnar 9/7/89
format -dqm4 -man6 -rs1 journalling.1
..
.\" @(#)journalling.1 9.10 89/06/22 Copyright 1987 Sun Micro
.nr X
.if \nX=0 .ds x} JOURNALLING 1 "14 June 1989" "\&"
.if \nX=1 .ds x} JOURNALLING 1 "14 June 1989"
.if \nX=2 .ds x} JOURNALLING 1 "" "\&"
.if \nX=3 .ds x} JOURNALLING "" "" "\&"
.TH \*(x}
.ds Sd \s-2Ne\h'-0.2n'WS\s+2
.ds Xn X11/Ne\h'-0.2n'WS
.ds Ps P\s-2OST\s+2S\s-2CRIPT\s+2
.\" .IX journalling(1) "" "\fIjournalling\fP(1) \(em record and playback package"
.IX journalling#(1) "" "\fLjournalling\fP(1)
.SH NAME
journalling \- \*(Sd event record and playback package
.SH SYNOPSIS
\fBjournalling\fP
.SH DESCRIPTION
The Journalling package allows you to capture \*(Sd mouse 
and keyboard events onto a file and play the file back.
This results in \*(Sd'
faithfully duplicating the original user actions in real time. 
.sp
This package permits continuous replaying of a given file.
Playback can be interrupted at any time by clicking on the \fBInterrupt\fP button.
.SH "USAGE"
Invoke the journalling program from the \fBDemo Navigator\fP: a
few seconds are required for journalling to initialize.
When initialization is complete, a control panel window appears.
The control panel contains the following items:
.sp
.RS .5i
.B RECORD\fP, 
.B STOP\fP, 
and 
.B PLAY
buttons \(em Pressing
.B RECORD
starts recording onto the current recording file.
Pressing 
.B STOP
terminates recording.  Pressing 
.B PLAY
starts playback from the current playback file. The buttons light up to
indicate what action is currently taking place.
.sp
\fBRecord File\fP \(em This text item allows you to specify the
current file onto which action items are recorded. This can be any valid file on the
server machine. Relative pathnames are taken to be relative to the
directory from which \*(Sd was started.  The default for the \fBRecord File\fP
is \fB/tmp/\s-1N\s+1e\s-1WS\s+1.journal\fP.
.sp
\fBPlayback File\fP \(em This text item allows you to specify
the current file from which recorded action items are played back.  
This can be any valid file on the
server machine. Relative pathnames are taken to be relative to the
directory from which \*(Sd was started.  The default for the \fBPlayback File\fP
is \fB/tmp/\s-1N\s+1e\s-1WS\s+1.journal\fP.
.sp
\fBPlay Forever\fP toggle switch \(em If this switch is on, the action items in the \fBPlayback File\fP
are played back repeatedly without stopping.  The playback can be terminated with the \fBInterrupt\fP
button (see below).
.sp
\fBDone\fP button \(em When the mouse is clicked on this button, all
journalling items are removed from the server, and the control
window is unmapped. (This is equivalent to selecting \fBQuit\fP from the
frame menu.)
.sp
\fBInterrupt\fP button \(em When the mouse is clicked on this button, playback is interrupted. 
The button flashes when selected. 
.RE
.SH "TIPS FOR USING JOURNALLING"
When a journal is created for repeated playback, all windows created after journalling has started
should be removed before journalling ends:  otherwise, the server re-creates the
windows whenever playback begins and eventually runs out of memory.  Thus, at the end
of a journalling session, the state of the screen should be exactly as it was at the beginning.
.sp
Different machines produce a noticeable variation in journalling performance.
Playback of a script recorded on a fast
machine might not work correctly on a slower machine.  Any given
machine has a maximum rate at which \*(Sd events can be handled.
.sp
Care must be taken when recording sequences that contain invocations
of UNIX programs, particularly when starting new applications.  The
mouse must not be clicked until the bounding box is up on the screen.
If the mouse is clicked early, the wrong window-sizing will be made on
playback:  this will lead to unpredictable behavior, due to the window's not
being where it was when recording.
.sp
Always proceed slowly while recording a script. Remember there is
no synchronization. 
For example, when recording a sequence of actions such as
typing `\fBls -l\fP'
into a terminal window and then cutting and pasting the command into another
terminal window, allow the command to complete before cutting and pasting:
otherwise indeterminate results may follow on playback.
.SH FILES
.TP 40n
.B \s-1${OPENWINHOME}\s+1/demo/journalling
.SH BUGS
Do not use the Journalling package for critical functions:
the behavior of playback is unpredictable, due to
the non-deterministic nature of the
UNIX scheduling mechanism.
