next up previous 63
Next: Example
Up: The Parameter Specification
Previous: Example


The KEYWORD Field

This field defines the name by which the parameter is known to the person running the program and which can be used on the command line to specify a value for the parameter. It will also be used to refer to the parameter in prompts and error messages. Case is not significant in keywords - they are always displayed in upper case.

The field is of the form:

KEYWORD  name
where name is a valid keyword3.

This completes the separation between the program's view of parameters, and the user's view of them. It is possible for the programmer to re-write the program using completely different parameter names, but the user's view could be kept the same by just changing the parameter names in the Interface File. Similarly, the user's view of the program can be changed by just changing the KEYWORD fields.

If the KEYWORD field is not specified for a parameter, then the system will use the parameter name as the keyword.





next up previous 63
Next: Example
Up: The Parameter Specification
Previous: Example

ADAM Interface Module Reference Manual
Starlink User Note 115
A J Chipperfield, B D Kelly, S L Wright
3 September 2002
E-mail:ussc@star.rl.ac.uk

Copyright © 2002 Council for the Central Laboratory of the Research Councils