Common Parameters to MIDAS Utilities: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
; [-e <exptname> ] :specifies the [[MIDAS Experiment Name|MIDAS Experiment]] to connect to (where multiple experiments are defined on the MIDAS host (see [[exptab]]). | ; [-e <exptname> ] :specifies the [[MIDAS Experiment Name|MIDAS Experiment]] to connect to (where multiple experiments are defined on the MIDAS host (see [[exptab]]). | ||
* This option supersedes the default experiment name given by the environment variable [[ | * This option supersedes the default experiment name given by the environment variable [[Environment Variables#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] , if defined. | ||
* If multiple experiments are defined, unless [[ | * If multiple experiments are defined, unless [[Environment Variables#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] is defined or this argument is supplied, the application will request the experiment name. | ||
* If the environment variable [[ | * If the environment variable [[Environment Variables#MIDAS_DIR|MIDAS_DIR]] is defined (i.e. single default experiment), both the ''exptname'' input parameter and environment variable [[Environment Variables#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] will be superseded. | ||
Line 12: | Line 12: | ||
* If ''hostname'' is supplied : | * If ''hostname'' is supplied : | ||
** ''hostname'' must be a valid IP host name. | ** ''hostname'' must be a valid IP host name. | ||
** ''hostname'' supersedes the default hostname given by the environment variable [[ | ** ''hostname'' supersedes the default hostname given by the environment variable [[Environment Variables#MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] , if defined. | ||
** the [[mserver]] utility '''must''' be running on the remote host. | ** the [[mserver]] utility '''must''' be running on the remote host. | ||
* If the environment variable [[ | * If the environment variable [[Environment Variables#MIDAS_DIR|MIDAS_DIR]] is defined (i.e. single default experiment), both the ''hostname'' input parameter and environment variable [[Environment Variables#MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] will be superseded. |
Revision as of 15:49, 28 October 2013
Each of the MIDAS utilities define a number of input parameters. The following parameters are common to many :
- [-e <exptname> ]
- specifies the MIDAS Experiment to connect to (where multiple experiments are defined on the MIDAS host (see exptab).
- This option supersedes the default experiment name given by the environment variable MIDAS_EXPT_NAME , if defined.
- If multiple experiments are defined, unless MIDAS_EXPT_NAME is defined or this argument is supplied, the application will request the experiment name.
- If the environment variable MIDAS_DIR is defined (i.e. single default experiment), both the exptname input parameter and environment variable MIDAS_EXPT_NAME will be superseded.
- [-h <hostname> ]
- specifies the MIDAS Host to connect to when connecting to an experiment running on a remote host. If the experiment is running on the local host, this argument need not be supplied.
- If hostname is supplied :
- hostname must be a valid IP host name.
- hostname supersedes the default hostname given by the environment variable MIDAS_SERVER_HOST , if defined.
- the mserver utility must be running on the remote host.
- If the environment variable MIDAS_DIR is defined (i.e. single default experiment), both the hostname input parameter and environment variable MIDAS_SERVER_HOST will be superseded.