doc/overview/reference.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >Reference</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK
   8 REL="HOME"
   9 TITLE="DejaGnu"
  10 HREF="book1.html"><LINK
  11 REL="PREVIOUS"
  12 TITLE="Special variables used by test cases."
  13 HREF="tvariables.html"><LINK
  14 REL="NEXT"
  15 TITLE="Builtin Procedures"
  16 HREF="builtins.html"></HEAD
  17 ><BODY
  18 ><DIV
  19 CLASS="NAVHEADER"
  20 ><TABLE
  21 WIDTH="100%"
  22 BORDER="0"
  23 CELLPADDING="0"
  24 CELLSPACING="0"
  25 ><TR
  26 ><TH
  27 COLSPAN="3"
  28 ALIGN="center"
  29 >DejaGnu</TH
  30 ></TR
  31 ><TR
  32 ><TD
  33 WIDTH="10%"
  34 ALIGN="left"
  35 VALIGN="bottom"
  36 ><A
  37 HREF="tvariables.html"
  38 >Prev</A
  39 ></TD
  40 ><TD
  41 WIDTH="80%"
  42 ALIGN="center"
  43 VALIGN="bottom"
  44 ></TD
  45 ><TD
  46 WIDTH="10%"
  47 ALIGN="right"
  48 VALIGN="bottom"
  49 ><A
  50 HREF="builtins.html"
  51 >Next</A
  52 ></TD
  53 ></TR
  54 ></TABLE
  55 ><HR
  56 ALIGN="LEFT"
  57 WIDTH="100%"></DIV
  58 ><DIV
  59 CLASS="CHAPTER"
  60 ><H1
  61 ><A
  62 NAME="REFERENCE"
  63 >Chapter 5. Reference</A
  64 ></H1
  65 ><DIV
  66 CLASS="TOC"
  67 ><DL
  68 ><DT
  69 ><B
  70 >Table of Contents</B
  71 ></DT
  72 ><DT
  73 ><A
  74 HREF="reference.html#INSTALLATION"
  75 >Installation</A
  76 ></DT
  77 ><DT
  78 ><A
  79 HREF="builtins.html"
  80 >Builtin Procedures</A
  81 ></DT
  82 ><DT
  83 ><A
  84 HREF="filemap.html"
  85 >File Map</A
  86 ></DT
  87 ></DL
  88 ></DIV
  89 ><DIV
  90 CLASS="SECT1"
  91 ><H1
  92 CLASS="SECT1"
  93 ><A
  94 NAME="INSTALLATION"
  95 >Installation</A
  96 ></H1
  97 ><P
  98 >Once you have the DejaGnu source unpacked and available, you must
  99     first configure the software to specify where it is to run (and the
 100     associated defaults); then you can proceed to installing it.</P
 101 ><DIV
 102 CLASS="SECT2"
 103 ><H2
 104 CLASS="SECT2"
 105 ><A
 106 NAME="CONFIGURING"
 107 >Configuring DejaGnu</A
 108 ></H2
 109 ><P
 110 >It is usually best to configure in a directory separate from the
 111       source tree, specifying where to find the source with the optional
 112       <I
 113 CLASS="EMPHASIS"
 114 >--srcdir</I
 115 > option to
 116       <I
 117 CLASS="EMPHASIS"
 118 >configure</I
 119 >. DejaGnu uses the GNU
 120       <I
 121 CLASS="EMPHASIS"
 122 >autoconf</I
 123 > to configure itself. For more info on using
 124       autoconf, read the GNU autoconf manual. To configure, execute the
 125       <TT
 126 CLASS="FILENAME"
 127 >configure</TT
 128 > program, no other options are
 129       required. For an example, to configure in a seperate tree for objects,
 130       execute the configure script from the source tree like this:</P
 131 ><TABLE
 132 BORDER="0"
 133 BGCOLOR="#E0E0E0"
 134 WIDTH="100%"
 135 ><TR
 136 ><TD
 137 ><PRE
 138 CLASS="SCREEN"
 139 >        ../dejagnu-1.4/configure
 140       </PRE
 141 ></TD
 142 ></TR
 143 ></TABLE
 144 ><P
 145 >DejaGnu doesn't care at config time if it's for testing a native
 146       system or a cross system. That is determined at runtime by using the
 147       config files.</P
 148 ><P
 149 >You may also want to use the <B
 150 CLASS="COMMAND"
 151 >configure</B
 152 > option
 153       <I
 154 CLASS="EMPHASIS"
 155 >--prefix</I
 156 > to specify where you want DejaGnu and its
 157       supporting code installed.  By default, installation is in subdirectories
 158       of <TT
 159 CLASS="FILENAME"
 160 >/usr/local</TT
 161 >, but you can select any alternate
 162       directory <SPAN
 163 CLASS="SYMBOL"
 164 >altdir</SPAN
 165 > by including
 166       <TT
 167 CLASS="OPTION"
 168 >--prefix</TT
 169 >{altdir}} on the
 170       <B
 171 CLASS="COMMAND"
 172 >configure</B
 173 > command line. (This value is captured in
 174       the Makefile variables <I
 175 CLASS="EMPHASIS"
 176 >prefix</I
 177 > and
 178       <I
 179 CLASS="EMPHASIS"
 180 >exec</I
 181 >prefix}.)</P
 182 ><P
 183 >Save for a small number of example tests, the DejaGnu distribution
 184       itself does not include any test suites; these are available
 185       separately. Test suites for the GNU development tools are included in
 186       those releases. After configuring the top-level DejaGnu directory, unpack
 187       and configure the test directories for the tools you want to test; then,
 188       in each test directory, run <I
 189 CLASS="EMPHASIS"
 190 >make check</I
 191 > to build
 192       auxiliary programs required by some of the tests, and run the test
 193       suites.</P
 194 ></DIV
 195 ><DIV
 196 CLASS="SECT2"
 197 ><H2
 198 CLASS="SECT2"
 199 ><A
 200 NAME="INSTALLING"
 201 >Installing DejaGnu</A
 202 ></H2
 203 ><P
 204 >To install DejaGnu in your filesystem (either in
 205       <TT
 206 CLASS="FILENAME"
 207 >/usr/local</TT
 208 >, or as specified by your
 209       <I
 210 CLASS="EMPHASIS"
 211 >--prefix</I
 212 > option to <I
 213 CLASS="EMPHASIS"
 214 >configure</I
 215 >),
 216       execute.</P
 217 ><TABLE
 218 BORDER="0"
 219 BGCOLOR="#E0E0E0"
 220 WIDTH="100%"
 221 ><TR
 222 ><TD
 223 ><PRE
 224 CLASS="SCREEN"
 225 >        eg$ make install
 226       </PRE
 227 ></TD
 228 ></TR
 229 ></TABLE
 230 ><P
 231 ><I
 232 CLASS="EMPHASIS"
 233 >make install</I
 234 >does thes things for
 235       DejaGnu:</P
 236 ><P
 237 ></P
 238 ><UL
 239 ><LI
 240 STYLE="list-style-type: disc"
 241 ><P
 242 >Look in the path specified for executables
 243           <SPAN
 244 CLASS="SYMBOL"
 245 >$exec_prefix</SPAN
 246 >) for directories called
 247           <TT
 248 CLASS="FILENAME"
 249 >lib</TT
 250 > and <TT
 251 CLASS="FILENAME"
 252 >bin</TT
 253 >. If these
 254           directories do not exist, <I
 255 CLASS="EMPHASIS"
 256 >make install</I
 257 > creates
 258           them.</P
 259 ></LI
 260 ><LI
 261 STYLE="list-style-type: disc"
 262 ><P
 263 >Create another directory in the
 264         <TT
 265 CLASS="FILENAME"
 266 >share</TT
 267 > directory, called
 268         <TT
 269 CLASS="FILENAME"
 270 >dejagnu</TT
 271 >, and copy all the library files into
 272         it.</P
 273 ></LI
 274 ><LI
 275 STYLE="list-style-type: disc"
 276 ><P
 277 >Create a directory in the
 278         <TT
 279 CLASS="FILENAME"
 280 >dejagnu/share</TT
 281 > directory, called
 282         <TT
 283 CLASS="FILENAME"
 284 >config</TT
 285 >, and copy all the configuration files into
 286         it.</P
 287 ></LI
 288 ><LI
 289 STYLE="list-style-type: disc"
 290 ><P
 291 >Copy the <I
 292 CLASS="EMPHASIS"
 293 >runtest</I
 294 > shell script into
 295         <TT
 296 CLASS="FILENAME"
 297 >$exec_prefix/bin</TT
 298 >.</P
 299 ></LI
 300 ><LI
 301 STYLE="list-style-type: disc"
 302 ><P
 303 >Copy <TT
 304 CLASS="FILENAME"
 305 >runtest.exp</TT
 306 > into
 307         <TT
 308 CLASS="FILENAME"
 309 >$exec_prefix/lib/dejagnu</TT
 310 >. This is the main Tcl
 311         code implementing DejaGnu.</P
 312 ></LI
 313 ></UL
 314 ></DIV
 315 ></DIV
 316 ></DIV
 317 ><DIV
 318 CLASS="NAVFOOTER"
 319 ><HR
 320 ALIGN="LEFT"
 321 WIDTH="100%"><TABLE
 322 WIDTH="100%"
 323 BORDER="0"
 324 CELLPADDING="0"
 325 CELLSPACING="0"
 326 ><TR
 327 ><TD
 328 WIDTH="33%"
 329 ALIGN="left"
 330 VALIGN="top"
 331 ><A
 332 HREF="tvariables.html"
 333 >Prev</A
 334 ></TD
 335 ><TD
 336 WIDTH="34%"
 337 ALIGN="center"
 338 VALIGN="top"
 339 ><A
 340 HREF="book1.html"
 341 >Home</A
 342 ></TD
 343 ><TD
 344 WIDTH="33%"
 345 ALIGN="right"
 346 VALIGN="top"
 347 ><A
 348 HREF="builtins.html"
 349 >Next</A
 350 ></TD
 351 ></TR
 352 ><TR
 353 ><TD
 354 WIDTH="33%"
 355 ALIGN="left"
 356 VALIGN="top"
 357 >Special variables used by test cases.</TD
 358 ><TD
 359 WIDTH="34%"
 360 ALIGN="center"
 361 VALIGN="top"
 362 >&nbsp;</TD
 363 ><TD
 364 WIDTH="33%"
 365 ALIGN="right"
 366 VALIGN="top"
 367 >Builtin Procedures</TD
 368 ></TR
 369 ></TABLE
 370 ></DIV
 371 ></BODY
 372 ></HTML
 373 >