PRIMER 22.1

"oa_pref" File Syntax

"oa_pref" file syntax

The syntax used for PRIMER is: primer*<keyword>: <argument> or for a locked pref primer#<keyword>: <argument>

for example:

primer*initial_plot_mode: SHAD

The rules for formatting are:

  • The <programme>*<option>: string must start at column 1;
  • This string must be in lower case, and must not have any spaces in it.
  • The <argument> must be separated from the string by at least one space.
  • Lines starting with a " # " are treated as comments and are ignored.
"Locking" a preference

Normally a preference read from oa_pref file in location A can be modified if the same preference is read later on from oa_pref file in location B. However it it possible to "lock" a preference against being changed by using a "#" rather than a "*" in its syntax. This means that once read it will not be changed if read again from subsequent files.

For example:

primer*initial_plot_mode: SHAD Using a "*" means that this preference can be modified.
primer#initial_plot_mode: SHAD Using a "#" means that it is locked against further changes

This facility enables "company wide" preferences to be set and locked in the top level (eg OA_ADMIN) preference file, thus enforcing their use.