doc/html/node57.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<!--Converted with jLaTeX2HTML 2002 (1.62) JA patch-1.4
patched version by:  Kenshi Muto, Debian Project.
LaTeX2HTML 2002 (1.62),
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>5.3.1 Constructing Runtime Environment Documents</TITLE>
<META NAME="description" CONTENT="5.3.1 Constructing Runtime Environment Documents">
<META NAME="keywords" CONTENT="SCRAM">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="jLaTeX2HTML v2002 JA patch-1.4">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">

<LINK REL="STYLESHEET" HREF="SCRAM.css">

<LINK REL="previous" HREF="node56.html">
<LINK REL="up" HREF="node56.html">
<LINK REL="next" HREF="node58.html">
</HEAD>

<BODY bgcolor="beige" >
<!--Navigation Panel-->
<A NAME="tex2html1148"
  HREF="node58.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
 SRC="file:/usr/share/latex2html/icons/next.png"></A> 
<A NAME="tex2html1142"
  HREF="node56.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
 SRC="file:/usr/share/latex2html/icons/up.png"></A> 
<A NAME="tex2html1138"
  HREF="node56.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
 SRC="file:/usr/share/latex2html/icons/prev.png"></A> 
<A NAME="tex2html1144"
  HREF="node2.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
 SRC="file:/usr/share/latex2html/icons/contents.png"></A> 
<A NAME="tex2html1146"
  HREF="node85.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
 SRC="file:/usr/share/latex2html/icons/index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html1149"
  HREF="node58.html">5.4 Configuration Tools in</A>
<B> Up:</B> <A NAME="tex2html1143"
  HREF="node56.html">5.3 The SCRAM Runtime</A>
<B> Previous:</B> <A NAME="tex2html1139"
  HREF="node56.html">5.3 The SCRAM Runtime</A>
 &nbsp <B>  <A NAME="tex2html1145"
  HREF="node2.html">Contents</A></B> 
 &nbsp <B>  <A NAME="tex2html1147"
  HREF="node85.html">Index</A></B> 
<BR>
<BR>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION00631000000000000000"></A><A NAME="sec:constructingruntimedocs"></A><A NAME="1277"></A>
<A NAME="1278"></A>
<BR>
5.3.1 Constructing Runtime Environment Documents
</H2>
A runtime document can be created for any application with the purpose
of defining any environment variables that might be required to run
the application properly. These might be special switches that control
how an application runs or settings of internal debugging or verbosity
levels.  A variable can be defined in a runtime document using the tag

<P>

<UL>
&lt;<TT>Runtime</TT> name=<I>variable</I> value=<I>value</I> [type=<I>type</I>]&gt; &lt;/<TT>Runtime</TT>&gt; 
</LI>
</UL>
<P>
A good practise is to include some usage information between the
&lt;<TT>Runtime</TT>&gt; tags in the definition of the variable which
can be viewed at any time using the command

<P>
<TT>scram runtime</TT>

  <TT>-sh</TT>&nbsp;(<I>or</I>&nbsp;<TT>-csh</TT>)&nbsp;<TT>filename</TT>

<P>
for all variables defined in file <TT>filename</TT> or for a specific
variable only using

<P>
<TT>scram runtime</TT>

 <TT>-sh</TT>&nbsp;(<I>or</I>&nbsp;<TT>-csh</TT>)&nbsp;<TT>info</TT>&nbsp;<TT>filename</TT>&nbsp;[<I>variable_name</I>]

<P>
To find the file <TT>filename</TT>, the current directory will be
searched first, then the <TT>src</TT> directory of the local area and
finally the <TT>src</TT> directory of the release area.

<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1148"
  HREF="node58.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
 SRC="file:/usr/share/latex2html/icons/next.png"></A> 
<A NAME="tex2html1142"
  HREF="node56.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
 SRC="file:/usr/share/latex2html/icons/up.png"></A> 
<A NAME="tex2html1138"
  HREF="node56.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
 SRC="file:/usr/share/latex2html/icons/prev.png"></A> 
<A NAME="tex2html1144"
  HREF="node2.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
 SRC="file:/usr/share/latex2html/icons/contents.png"></A> 
<A NAME="tex2html1146"
  HREF="node85.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
 SRC="file:/usr/share/latex2html/icons/index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html1149"
  HREF="node58.html">5.4 Configuration Tools in</A>
<B> Up:</B> <A NAME="tex2html1143"
  HREF="node56.html">5.3 The SCRAM Runtime</A>
<B> Previous:</B> <A NAME="tex2html1139"
  HREF="node56.html">5.3 The SCRAM Runtime</A>
 &nbsp <B>  <A NAME="tex2html1145"
  HREF="node2.html">Contents</A></B> 
 &nbsp <B>  <A NAME="tex2html1147"
  HREF="node85.html">Index</A></B> 
<!--End of Navigation Panel-->
<ADDRESS>
scram-developers@cern.ch
</ADDRESS>
</BODY>
</HTML>
Revision:	1.1
Committed:	Mon Nov 18 17:50:02 2002 UTC (22 years, 6 months ago) by sashby
Content type:	text/html
Branch:	MAIN
CVS Tags:	V1_pre0, V0_19_7
Branch point for:	SCRAM_V1_BRANCH
Log Message:	Generated and added HTML documentation.
#	User	Rev	Content
1	sashby	1.1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2
3			<!--Converted with jLaTeX2HTML 2002 (1.62) JA patch-1.4
4			patched version by: Kenshi Muto, Debian Project.
5			LaTeX2HTML 2002 (1.62),
6			original version by: Nikos Drakos, CBLU, University of Leeds
7			* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
8			* with significant contributions from:
9			Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
10			<HTML>
11			<HEAD>
12			<TITLE>5.3.1 Constructing Runtime Environment Documents</TITLE>
13			<META NAME="description" CONTENT="5.3.1 Constructing Runtime Environment Documents">
14			<META NAME="keywords" CONTENT="SCRAM">
15			<META NAME="resource-type" CONTENT="document">
16			<META NAME="distribution" CONTENT="global">
17
18			<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
19			<META NAME="Generator" CONTENT="jLaTeX2HTML v2002 JA patch-1.4">
20			<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
21
22			<LINK REL="STYLESHEET" HREF="SCRAM.css">
23
24			<LINK REL="previous" HREF="node56.html">
25			<LINK REL="up" HREF="node56.html">
26			<LINK REL="next" HREF="node58.html">
27			</HEAD>
28
29			<BODY bgcolor="beige" >
30			<!--Navigation Panel-->
31			<A NAME="tex2html1148"
32			HREF="node58.html">
33			<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
34			SRC="file:/usr/share/latex2html/icons/next.png"></A>
35			<A NAME="tex2html1142"
36			HREF="node56.html">
37			<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
38			SRC="file:/usr/share/latex2html/icons/up.png"></A>
39			<A NAME="tex2html1138"
40			HREF="node56.html">
41			<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
42			SRC="file:/usr/share/latex2html/icons/prev.png"></A>
43			<A NAME="tex2html1144"
44			HREF="node2.html">
45			<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
46			SRC="file:/usr/share/latex2html/icons/contents.png"></A>
47			<A NAME="tex2html1146"
48			HREF="node85.html">
49			<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
50			SRC="file:/usr/share/latex2html/icons/index.png"></A>
51			<BR>
52			<B> Next:</B> <A NAME="tex2html1149"
53			HREF="node58.html">5.4 Configuration Tools in</A>
54			<B> Up:</B> <A NAME="tex2html1143"
55			HREF="node56.html">5.3 The SCRAM Runtime</A>
56			<B> Previous:</B> <A NAME="tex2html1139"
57			HREF="node56.html">5.3 The SCRAM Runtime</A>
58			&nbsp <B> <A NAME="tex2html1145"
59			HREF="node2.html">Contents</A></B>
60			&nbsp <B> <A NAME="tex2html1147"
61			HREF="node85.html">Index</A></B>
62			<BR>
63			<BR>
64			<!--End of Navigation Panel-->
65
66			<H2><A NAME="SECTION00631000000000000000"></A><A NAME="sec:constructingruntimedocs"></A><A NAME="1277"></A>
67			<A NAME="1278"></A>
68			<BR>
69			5.3.1 Constructing Runtime Environment Documents
70			</H2>
71			A runtime document can be created for any application with the purpose
72			of defining any environment variables that might be required to run
73			the application properly. These might be special switches that control
74			how an application runs or settings of internal debugging or verbosity
75			levels. A variable can be defined in a runtime document using the tag
76
77			<P>
78
79			<UL>
80			<<TT>Runtime</TT> name=<I>variable</I> value=<I>value</I> [type=<I>type</I>]> </<TT>Runtime</TT>>
81			</LI>
82			</UL>
83			<P>
84			A good practise is to include some usage information between the
85			<<TT>Runtime</TT>> tags in the definition of the variable which
86			can be viewed at any time using the command
87
88			<P>
89			<TT>scram runtime</TT>
90
91			<TT>-sh</TT> (<I>or</I> <TT>-csh</TT>) <TT>filename</TT>
92
93			<P>
94			for all variables defined in file <TT>filename</TT> or for a specific
95			variable only using
96
97			<P>
98			<TT>scram runtime</TT>
99
100			<TT>-sh</TT> (<I>or</I> <TT>-csh</TT>) <TT>info</TT> <TT>filename</TT> [<I>variable_name</I>]
101
102			<P>
103			To find the file <TT>filename</TT>, the current directory will be
104			searched first, then the <TT>src</TT> directory of the local area and
105			finally the <TT>src</TT> directory of the release area.
106
107			<P>
108			<HR>
109			<!--Navigation Panel-->
110			<A NAME="tex2html1148"
111			HREF="node58.html">
112			<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
113			SRC="file:/usr/share/latex2html/icons/next.png"></A>
114			<A NAME="tex2html1142"
115			HREF="node56.html">
116			<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
117			SRC="file:/usr/share/latex2html/icons/up.png"></A>
118			<A NAME="tex2html1138"
119			HREF="node56.html">
120			<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
121			SRC="file:/usr/share/latex2html/icons/prev.png"></A>
122			<A NAME="tex2html1144"
123			HREF="node2.html">
124			<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
125			SRC="file:/usr/share/latex2html/icons/contents.png"></A>
126			<A NAME="tex2html1146"
127			HREF="node85.html">
128			<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
129			SRC="file:/usr/share/latex2html/icons/index.png"></A>
130			<BR>
131			<B> Next:</B> <A NAME="tex2html1149"
132			HREF="node58.html">5.4 Configuration Tools in</A>
133			<B> Up:</B> <A NAME="tex2html1143"
134			HREF="node56.html">5.3 The SCRAM Runtime</A>
135			<B> Previous:</B> <A NAME="tex2html1139"
136			HREF="node56.html">5.3 The SCRAM Runtime</A>
137			&nbsp <B> <A NAME="tex2html1145"
138			HREF="node2.html">Contents</A></B>
139			&nbsp <B> <A NAME="tex2html1147"
140			HREF="node85.html">Index</A></B>
141			<!--End of Navigation Panel-->
142			<ADDRESS>
143			scram-developers@cern.ch
144			</ADDRESS>
145			</BODY>
146			</HTML>