Common Parameters to MIDAS Utilities: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
mNo edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
 
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/programs/#common-parameters-for-many-midas-programs Common parameters for many midas programs] on the Programs and options page for the new documentation about the command-line parameters that many midas programs share.
 
= Common Input Parameters =
Each of the [[Application listing|MIDAS utilities]] define a number of input parameters. The following parameters are common to many :
 
;  [-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 [[Environment Variables#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] , if defined.
* 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 [[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.
 
 
; [-h <hostname> ]  : connect to midas server [[mserver]] on given host ''hostname'', i.e. specifies the [[MIDAS Host Name |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 [[Environment Variables#MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] , if defined. 
** the [[mserver]] utility '''must''' be running on the remote host.
* If more than one copy of <span style="color:darkcyan;font-style:italic">mserver</span> is running, the  <span style="color:darkcyan;font-style:italic">mserver</span> portname must be specified, e.g.
odbedit -h myhost:1173 -e myexpt -c "ls /Experiment"
 
* 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.
 
[[Category:Utilities]] [[Category:Appendices]]

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See Common parameters for many midas programs on the Programs and options page for the new documentation about the command-line parameters that many midas programs share.

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Common_Parameters_to_MIDAS_Utilities&oldid=3682"