NAME

pget - Get the value of one or more parameters for a specified tool or parameter file.

USAGE

pget [ -f ] tool-or-par-file-name [ parameter-name-list ]

DESCRIPTION

pget retrieves parameter values from the specified task or parameter file and displays them (one per line) on standard output.

The pget program may be used in conjunction with the Unix back-quote facility to control the action of scripts. For example:

   if (`pget ftverify numerrs` == 0) then
      ...
      ...
   endif

Behavior of this task depends upon the value of the PFILES environment variable, which is used to specify the location of parameter files. The PFILES variable uses a semicolon delimiter to separate two types of parameter directories:

     <user>;<system>
The first path ("user") is one or more "local" (writeable) parameter directories (typically $HOME/pfiles for a default HEASoft setup), and the second path ("system") is one or more read-only parameter directories (typically $HEADAS/syspfiles). When both paths are equivalent, one may omit the semicolon and duplicate path (for example, when developing a new task, one might set PFILES="." to use only the current working directory). Multiple colon-delimited directories are allowed in both portions of the PFILES variable:

     <user1>:<user2>;<system1>:<system2>
The default values from the first "system" path are used the first time a task is run, or whenever the default values have been updated more recently than the user's copy of the parameters. The user's copy is created when a task terminates, and retains any learned changes to the parameters.

This task will look for a copy of the specified parameter file (or parameter file for the specified task) in the first "user" parameter directory; if the file does not exist there, it will then search all subsequent directories listed in PFILES.

The "-f" flag may be used to disable searching of directories listed in the PFILES variable, allowing instead for specification of a particular parameter file (with a preceding directory path if the file is not in the current working directory).

EXAMPLES

1. Display the number of errors generated by ftverify (specifying ftverify.par):

    % pget ftverify.par numerrs
    0
2. Display the number of errors and warnings generated by ftverify (specifying only the task name 'ftverify'):

    % pget ftverify numerrs numwrns
    0
    0
3. Display the number of errors generated by ftverify, disabling the default search of directories listed in PFILES and instead providing the path to a specific parameter file:

   % pget -f /local/data/test/ftverify.par numerrs
   0

SEE ALSO

plist, pquery, pquery2, pset, punlearn

LAST MODIFIED

Aug 2016