In this chapter, each command is explained following a standard outline:
- FORMAT
-
All the arguments and options the command accepts. Arguments that must
be provided are printed like argument. Optional arguments and
keywords are surrounded by square brackets, []. Items that can be
given once or repeated any number of times are surrounded by braces,
like {argument}. Finally, a vertical bar, |, is used to
separate items of which you can choose only one.
Please note that the brackets are not to be typed as part of the
command.
- TEMPLATE
-
A reminder of the command's format. If you type a command followed by
a question mark, the template will appear on the screen.
- PURPOSE
-
A brief explanation of the command's function.
- SPECIFICATION
-
A concise description of the command and all of its arguments.
- EXAMPLE(S)
-
One or more examples showing the use of the command. The command and
any screen output are indented from the main text. A generic 1>
prompt indicates what should be typed at the shell prompt.
- SEE ALSO
-
A list of related commands. This can include the standard AmigaDOS
commands documented in for example ``The AmigaDOS Manual'', 3rd.
Edition, Bantam Books, 1991 and the ``Using The System Software''
manual distributed with Release 2.04.
- UNIX EQUIVALENT
-
Simply tells you where I got the inspiration from. It points you to
the relevant entry in the UNIX SYSTEM V manuals.
There may be other fields as well, but they are pretty
self-explanatory.
For a more complete description of how to use the templates and how to
use patterns to match file names, please refer to the aforementioned
books on AmigaDOS.