typist(1)

COMMAND LINE OPTIONS

typist understands the following command line options. Only the short form options are available in non-LINUX versions.

-d, --drill_tries

Specifies the maximum number of drill tries permitted. When running through an ordinary typing drill, typist will not proceed past the drill until it is completed without errors, or until the number of tries exceeds drill_tries. The default value is 3, the minimum 1, and the maximum 1000. This value is ignored for one-time typing drills.

-n, --notimer

typist will display the typing speeds in WPM after both drills and speed tests. However, the lessons appear to be written for a program that only does this for speed tests. To make typist behave in a manner that matches the lessons, that is, to suppress WPM reports on drills, use -n, --notimer.

-t, --term_cursor

typist creates its own flashing block cursor on the screen, to help distinguish between the cursor and reverse video error indications. Setting -t or --term_cursor suppresses this, and forces the program to use the terminal's cursor instead.

-f, --curs_flash

The curs_flash value sets the block cursor flash period in tenths of a second. A value of 0 indicates no cursor flashing. The default is 10, and the maximum is 512. This option is ignored if -t or --term_cursor has been set.

-c, --colo[u]rs

In normal operation, typist uses only normal and reverse video attributes in monochrome mode. This option may be used to specify the foreground and background colours on terminals that support colours. The colours are specified as two integers, in the range 0 to 7, separated by commas, setting the foreground and background colours. The colour codes 0 to 7 indicate black, red, green, yellow, blue, magenta, cyan, and white respectively. The default colours string is 7,0 - white on black. The option is ignored if the terminal does not support colours.

-s, --silent

When typist detects a typing error, it will beep the terminal. Use this option to silence the beep.

-q, --quiet

Same as -s, --silent.

-w, --nowpmode

By default, typist will try to mimic a word processor in certain ways when executing an exercise. It will treat space at the end of a line as a correctly typed character, and word wrap. It will treat return at the end of a line as a signal to move to the start of the next paragraph if applicable. It will compress multiple spaces into a single space. And it will skip over hyphens found at the end of a line. This option will turn off these word processor-like actions.

-l, --start_label

Specifies the label in the script_file at which typist begins executing (see SCRIPT FILES AND COMMANDS below for information on labels). If start_label is not given, typist begins execution at the first line of the file.

SCRIPT FILES AND COMMANDS

typist reads in the data for its typing lessons from the script file. With the exception of comments and blank lines, each line in the file is of the format

command_char : command_data

Here, command_char is a single character code that defines an action for for typist to take, and command_data is data for that command. If command_char is a space character, this indicates that the line is a continuation of the preceding non-space command. The ':' separator must be in column two of the line.

Comment lines are lines beginning with a '!' character, and are ignored, as are blank lines. Comment lines may have any format provided that they begin with '!'; other lines must have the above format.

The following is a list of valid command_char values:

B

This command clears the complete screen. If any command_data is present, this is displayed in the one-line banner at the top of the screen, and remains in place until the next B command. This command may not be continued; it is a single line command.

*

This indicates a label in the file. The label may be the target of a G, Y, or N command. Labels may contain any character, including space, and are a single line command.

T

This presents a tutorial, and is a multi line command, up to the available size of the curses screen. Each line in the command is simply printed to the screen. This command clears the screen beneath the top banner line.

I

This presents some instructions to prefix a drill or speed test. At most two lines are permitted. It clears the screen beneath the top banner line.

D

This creates an ordinary typing drill. It is a multi-line command; as many lines may be used as are available to curses.

O

This creates a one-time typing drill. It is a multi-line command; as many lines may be used as are available to curses.

P

This creates a speed test. It is a multi-line command; as many lines may be used as are available to curses.

G

This causes typist to go to the label in command_data, and resume execution of the script there. This is a single line command.

Q

This uses the message line at the bottom of the display to prompt the user for a Yes/No response. command_data is used as the query. Only the 'Y' and 'N' keys may be used to respond.

Y

This is like G, except that the goto is executed only if the result of the last Q command was 'Y'.

N

This is like G, except that the goto is executed only if the result of the last Q command was 'N'.

K

This binds a function key to a label. The format of the data line following this command must be "fkey_number:label", where fkey_number is a function key number in the range 1 to 12, and label is a label to go to when this key is pressed. A value of NULL for label removes any label binding from the key. If function keys are not available on the terminal, Ctrl-<key> combinations can be used. On the top row of letter keys on the keyboard, the keys Ctrl-Q to Ctrl-P may be used as alternatives for F1 to F10, and on the second row of letter keys, Ctrl-A and Ctrl-S as alternatives for F11 and F12. This is also useful where function keys are intercepted by other programs, for example, a window manager.

X

This command causes typist to exit. It is a single line command. Any command data is ignored.