next up previous 64
Next: About this document ...
Up: ENVIRONMENT VARIABLES AND TOKENS
Previous: Summary of Environment Variables Used


Summary of Message Tokens Used

The following table summarises all the message tokens used by the NDF library in format conversion commands, etc:

Token Value
dir Directory in which the foreign file resides
name Foreign file name (without directory or extension)
type Foreign file extension (with leading `.')
vers Foreign file version number (blank if not supported)
fxs Foreign extension specifier (see §[*] )
fxscl Clean version of fxs (all non-alphanumeric characters replaced by underscores)
fmt Foreign format name (upper case)
ndf Full name of the native NDF format copy of the dataset
xtn Name of the NDF extension (upper case)

Each environment variable which is used to control access to foreign format data, and which permits substitution of the above message tokens, is of the form:

NDF_$<$CTX$>$_...

where $<$CTX$>$ is the name of a ``context'' within which message token substitution takes place. The following table shows which tokens are defined for use within each context:

  Token
  dir name type vers fxs fxscl fmt ndf xtn
  FROM $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\times$
  TO $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\times$
  DEL $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\times$ $\times$
Context KEEP $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\times$ $\times$
  TEMP $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\times$ $\times$
  IMP $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$
  EXP $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$ $\surd$



next up previous 64
Next: About this document ...
Up: ENVIRONMENT VARIABLES AND TOKENS
Previous: Summary of Environment Variables Used

Adding Format Conversion Facilities to the NDF Data Access Library
Starlink System Note 20
R.F.Warren-Smith & D.S.Berry
17th July 2000
E-mail:ussc@star.rl.ac.uk

Copyright © 2010 Science and Technology Facilities Council