[ Home | What's New | Contents | Overview | Contributors | Distribution | Examples | Documentation | Manual | Publications | Mailing List Archive | Problems ] This page was last updated by Axel Belinfante on 2006-06-30
TorX Test Tool Information
Prev   Next

aniwait(1) - animate progressbar

Table of Contents


aniwait - animate progressbar


aniwait [ -r ] [ -m mcastid ] [ -t title ]
aniwait -exit


aniwait `animates' a progressbar. After start up, aniwait creates a window (with the given title) containing a progressbar, and waits for animation commands on standard input. On end of file on standard input, aniwait waits for the user to remove the window (or press the Quit button), after which it exits.

Actually, aniwait is a shell-level command that uses a running aniwaitsrv to create or reuse a progressbar window, and animate it using animation commands on standard input of aniwait. The connection between aniwait and a running aniwaitsrv will not be closed until the complete standard input of the aniwait command has been processed by aniwaitsrv. If aniwait cannot find a running aniwaitsrv, it will start a new one. In general, it should not be necessary to start aniwaitsrv by hand. However, if startup time of aniwait is an issue, it may be advantageous to start aniwaitsrv (by hand) in advance, because a starting aniwaitsrv may spend some time to check if another aniwaitsrv is already running.

To display a new progressbar, aniwaitsrv will reuse windows that contain a completed animation and have the Reuse toggle activated. If more windows are needed, they are created.

The -r command line option of aniwait will activate the Reuse toggle button for the aniwait window.

The animation commands are expected to be generated using log2aniwait(1), e.g. using a unix command as

log2aniwait < logfile | aniwait
tail -f logfile | log2aniwait | aniwait

Each animation command consists of a single line of text, of the following form:

wait count
freeze [ remains ]
stop [ remains ]
where count and remains are floating point numbers. The wait command starts a countdown of the given count number of seconds. The freeze and stop commands stop the countdown, and add a `step' to the trace of progress times. freeze and stop interpret the optional remains as the time remaining from the count from the countdown command; if no remains is given, the real-time system clock is used. An additional freeze or stop command without preceding wait command has no effect and is ignored. The difference between freeze and stop is in the color of the progressbar: freeze does not change the color, but only `freezes' the animation, whereas stop changes the color of the progressbar to blue.

The animation in the window will follow the animation commands read from standard input. The animation can be be done manually using the left and middle mouse button, and/or with the Step up and down arrow buttons (as discussed below).

In addition, the animation can be remotely controlled. If the -m mcastid command line option is given, or environment variable TORXMCASTID was set, aniwait will attempt to make a remote control connection to the tcp address in mcastid. If it succeeds, it will then interpret lines of text read from the remote control connection consisting of a single number as commands to show the corresponding step in the animation. Additionally, whenever the user uses mouse button and/or navigation commands to show a different step, its step number is written to the remote control connection. The remote control connection allows multiple viewers to show the same test step.

The left mouse button and the right mouse button can be used to ``navigate'' in the animation: the left mouse button will show the ``next'' step in the animation, and the right mouse button will show the ``previous'' step in the animation.

To stop a running aniwaitsrv, invoke aniwait with the -exit command line option.


At the bottom of an aniwait window there are several buttons. The step number of the animation step in the trace is shown in the Step field. Step numbers start at 0, for the initial state. To visualize the animation step for a known step, enter the step number in the Step entry field, and hit the return key. If a step number is present in the Step field, the down and up arrow buttons can be used to step backwards resp. forwards in the animation.
The Reuse toggle button indicates that its window may be reused for a new animation, when end-of-input has been seen for the animation currently displayed in it. While an animation is in progress (so, when end-of-input has not yet been seen) the Reuse button is disabled. (default value: unset, except when overridden by a -r command line option of aniwait).
The Close button closes the window, and, if this was the last remaining aniwait window, exits the progam.
The Quit button closes all aniwait windows and exits the progam.


Error messages and navigation diagnostics appear on standard error.


The environment variable TORX_ROOT is not supported.

See Also

torx-intro(1), log2aniwait(1), torx-logclient(1), tmcs(1), jararacy(1), anifsm(1), mscviewer(1), environ(5)


By Email: <torx_support@cs.utwente.nl>


This manual page documents version 3.9.0 of torx.

Table of Contents

Prev Table of Contents Next
Appendix D: TorX Manual Pages: anifsmsrv(1) Valid HTML 4.01! Appendix D: TorX Manual Pages: aniwaitsrv(1)