8 Comments on command description

Contents of this section

In the following section each of the available commands in DRP is explained following a certain pattern.

The keyword use: is followed by the form of the runstring that should be used to invoke a given command. If parameters are needed, their required sequence is indicated. Optional, and defaulted, parameters are written in square brackets.

Each parameter is explained in more detail following the parameters: keyword. If a parameter may take several values, these values are shown separated by vertical bars. Values given in typewriter style should be entered literally, whereas slanted parameters indicate, that the user should substitute something for it (often a numerical value).

Optional parameters are explained following the options: keyword. All options are evoked by a minus sign and the appropriate specifier. E.g. all DRP commands understand the -help option, which will produce a one line description of the command together with a list of required and optional parameters.

The purpose of a command and its function are explained following the function: keyword. This may be followed by one or two examples, showing how the command may actually be used.

An example runstring with a short description of its effect may given in a example: section.

Following needs:, it will be indicated which of the three shared areas (CWORK ,CHOLD , CTEMP ) described in section philosophy of this manual, will be effected by this command.

Finally there may be a cross-reference (see also:) to other related DRP commands.

Next Chapter, Previous Chapter

Table of contents of this chapter, General table of contents

Top of the document, Beginning of this Chapter