Documentation Conventions

Text Conventions

Body TextArial font is used in the body of the manual.
PROGRAMnames of programs are in capitals.
VARIABLEnames of CopiaFacts and environment variables are also in capitals, though when used on a command the case is ignored.
keywordskeywords are normally shown in italics.
commandscommands are normally shown in Prestige font in examples.
Warningsimportant warnings are highlighted in red.
obsoletesections applicable only to earlier releases are in green.
Linksinternal and external links are underlined in blue - in the PDF version of this manual, internal links also have a page-number tag.

 

Command Syntax and Program Command-Lines

[ ]square brackets indicate optional elements
x|ya vertical bar separates alternative elements
...ellipsis indicates repeated elements
varnameitalics indicate a variable element

 

Keyword Index Conventions

Commands appear alphabetically at the top of the index, under $.  If you already know which command file the command is in, it may be quicker to locate it via Contents / Commands / Type of Command.

Most variable names are no longer shown as headwords in the index.  If you know a variable name, go direct to Appendix D to find it.

Where possible, index entries leading to variable names, commands or programs show their destination within the index entry, so that you can select the correct destination more quickly.

The following suffices appear in the index entries to show the type of the reference:

[a]Application Support DLL functions
[e]Environment Variable (user variable)
[f]DBF log field name
[k]Keyword
[p]Program Name
[s]Environment Variable (system variable)
[v]CopiaFacts Variable
[CFG]The command-file type in which the command is used