$Id$

NeSDaC

parameter interface

NAME

parameter interface

SYNOPSIS

Following parameters are present in all StageII parameterfiles and the equivalent switches are honoured by all StageII programs.

A program is directed to obtain its run time parameters from the command line,

entirely ignoring the parameterfile contents,

if the very first command line argument is:

-p

debug-level

debug-level is an optional (integer) number, the higher the number, the more informational messages the program will produce, unfortunatly little effort has been invested in the differentiation of these debuglevels.

Messages are logged onto the standard error file (stderr). This output can be redirected to a file logfile-name by the option

-L

logfile-name

lpp

The optional ",lpp" gives the maximum number of lines per page. A formfeed character and a new header is written to the logfile creating a new page after this many lines. The default value is 0, meaning an infinite pagelength.
(If logfile-name is an empty string, output is written not to stderr but to stdout.)

-i

title

assign title to the FITS keyword TITLE in any output file created. (if title contains space characters, include the entire string in quotes)

The parameterfile key mode is not accessable from the commandline, its value directs the pcl routines how to handle the parameterfile data.

Except for the the initial switch -p (which value is optional), all switches on the commandline are expected to have a value, optionally separated from the switchname by a space-character. If a switch value's first character is '-', ie. the next switchname, it is assumed the switch value is an empty string.
A consequense is that the last switch on the commandline may take its value from what you meant to be the first(non-switch) argument. A special string -- halts any switch processing beyond this string. Preceeding the first argument by -- prevents it from being interpreted as a switchvalue. Command line entries following a -- can never be switches, even if their first character is a -

StageII global parameters summary
switch key value IO description
p debug int i first argumen only, entirely ignore parameterfile, get run time parameters from command line.
value controls diagnostic messages volume.
i title string i file title, description cq. comments.
L logfile string i redirect diagnostic and informational messages.
mode "ql" i is interpreted by (some) parameterfile parsers/readers only.

StageII global parameters summary
switch	key	value	IO	description
p	debug	int	i	first argumen only, entirely ignore parameterfile, get run time parameters from command line. value controls diagnostic messages volume.
i	title	string	i	file title, description cq. comments.
L	logfile	string	i	redirect diagnostic and informational messages.
	mode	"ql"	i	is interpreted by (some) parameterfile parsers/readers only.

Back to:

J.Schuurmans@sron.ruu.nl

$RCSfile$$Date$

Back to: