Usage Manuals

The 'usage' manuals can be very useful as a reference as to the function of each command. It's intended function is to show a user what message will be received if he or she misformats a command. The general structure of each 'usage' entry is as follows:

Command: <command>
Purpose: <purpose>
Usage: <usage>
Examples: <example>

The proper format for this command is: 'help manual_usage'.

This will display the usage manual which gives a brief description of the function of most of our commands. For example:

Command: abort
Purpose: to request that the game be cancelled
Usage: abort
Examples: abort

'Manual_vars' is a similar command used to show the usage of the various variable commands. It is a brief listing of each variable and it's function. For example:

v_autoflag

If your 'autoflag' variable is non-zero (whether a number, 'true' or 'on') the server will automatically flag your opponent (that is, claim a win when your opponent runs out of time) when he/she tries to make a move but his/her clock reads 0:00 or less.

SPECIAL NOTES:

(a) Autoflag occurs "BEFORE" any move increment is added (see 'help v_inc'). It is based on the game clock at the time of the move, not the clock after the move.

At the end of each description there is a 'See Also' listing of commands which you may find useful along with the one you are currently researching.

These commands, 'help manual_usage' and 'help manual_vars', will cover the majority of the commands in use. They are quite handy to use when you wish to see the usage of many commands, rather than individual commands.

---

If you would like to look through previous server tips to see what other helpful information you can find, please see the Previous Issues page.

 

<< Back	Top	Next >>
Newsletter Main | Puzzles | FICS vs. Lacashire | Beyond FICS FICS Tournaments | The Academey | Server Tip | Credits | FICS Home