| 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>3.1.3.0.1 Example:</TITLE>
|
| 13 |
<META NAME="description" CONTENT="3.1.3.0.1 Example:">
|
| 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="node23.html">
|
| 25 |
<LINK REL="up" HREF="node23.html">
|
| 26 |
<LINK REL="next" HREF="node25.html">
|
| 27 |
</HEAD>
|
| 28 |
|
| 29 |
<BODY bgcolor="beige" >
|
| 30 |
<!--Navigation Panel-->
|
| 31 |
<A NAME="tex2html675"
|
| 32 |
HREF="node25.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="tex2html669"
|
| 36 |
HREF="node23.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="tex2html665"
|
| 40 |
HREF="node23.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="tex2html671"
|
| 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="tex2html673"
|
| 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="tex2html676"
|
| 53 |
HREF="node25.html">3.2 The SCRAM Build</A>
|
| 54 |
<B> Up:</B> <A NAME="tex2html670"
|
| 55 |
HREF="node23.html">3.1.3 The ToolDoc Class</A>
|
| 56 |
<B> Previous:</B> <A NAME="tex2html666"
|
| 57 |
HREF="node23.html">3.1.3 The ToolDoc Class</A>
|
| 58 |
  <B> <A NAME="tex2html672"
|
| 59 |
HREF="node2.html">Contents</A></B>
|
| 60 |
  <B> <A NAME="tex2html674"
|
| 61 |
HREF="node85.html">Index</A></B>
|
| 62 |
<BR>
|
| 63 |
<BR>
|
| 64 |
<!--End of Navigation Panel-->
|
| 65 |
|
| 66 |
<H4><A NAME="SECTION00413010000000000000">
|
| 67 |
3.1.3.0.1 <I>Example</I>:</A>
|
| 68 |
</H4> Here is an example of a <TT>ToolDoc</TT> for a tool
|
| 69 |
called <TT>CLHEP</TT>: <A NAME="1846"></A>
|
| 70 |
<PRE>
|
| 71 |
<doc type=BuildSystem::ToolDoc version=1.0>
|
| 72 |
<Tool name=CLHEP version=1.7.5.0>
|
| 73 |
<info url=http://wwwinfo.cern.ch/asd/lhc++/clhep></info>
|
| 74 |
<LIB name=CLHEP>
|
| 75 |
<Client>
|
| 76 |
<Environment name=CLHEP_BASE>
|
| 77 |
The top of the standard CLHEP distribution.
|
| 78 |
</Environment>
|
| 79 |
<Environment name=LIBDIR default="$CLHEP_BASE/lib" type=lib>
|
| 80 |
The Library location for the CLHEP distribution
|
| 81 |
</Environment>
|
| 82 |
<Environment name=INCLUDE default="$CLHEP_BASE/include">
|
| 83 |
The header file location for the CLHEP distribution
|
| 84 |
</Environment>
|
| 85 |
</Client>
|
| 86 |
<Environment name=LD_LIBRARY_PATH value=$LIBDIR type=Runtime_path>
|
| 87 |
</Environment>
|
| 88 |
</Tool>
|
| 89 |
</PRE>When this <TT>ToolDoc</TT> is parsed by <SMALL>SCRAM</SMALL> ,
|
| 90 |
<TT>CLHEP_BASE</TT> is set by the configuration manager
|
| 91 |
(either automatically or by prompting the user if necessary), both
|
| 92 |
<TT>LIBDIR</TT> and <TT>INCLUDE</TT> are set to the default
|
| 93 |
values if these paths are found to be valid and, at runtime, the
|
| 94 |
value of the path <TT>$LIBDIR</TT> is appended to the user
|
| 95 |
shell variable <TT>$LD_LIBRARY_PATH</TT> if it exists
|
| 96 |
(otherwise, it is defined automatically).
|
| 97 |
|
| 98 |
<P>
|
| 99 |
<BR><HR>
|
| 100 |
<ADDRESS>
|
| 101 |
scram-developers@cern.ch
|
| 102 |
</ADDRESS>
|
| 103 |
</BODY>
|
| 104 |
</HTML>
|
