doc/overview/configfile.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >Config File Values</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK
   8 REL="HOME"
   9 TITLE="DejaGnu"
  10 HREF="book1.html"><LINK
  11 REL="UP"
  12 TITLE="Customizing DejaGnu"
  13 HREF="customizing.html"><LINK
  14 REL="PREVIOUS"
  15 TITLE="Remote Host Testing"
  16 HREF="releng.html"><LINK
  17 REL="NEXT"
  18 TITLE="Extending DejaGnu"
  19 HREF="extending.html"></HEAD
  20 ><BODY
  21 ><DIV
  22 CLASS="NAVHEADER"
  23 ><TABLE
  24 WIDTH="100%"
  25 BORDER="0"
  26 CELLPADDING="0"
  27 CELLSPACING="0"
  28 ><TR
  29 ><TH
  30 COLSPAN="3"
  31 ALIGN="center"
  32 >DejaGnu: The GNU Testing Framework</TH
  33 ></TR
  34 ><TR
  35 ><TD
  36 WIDTH="10%"
  37 ALIGN="left"
  38 VALIGN="bottom"
  39 ><A
  40 HREF="releng.html"
  41 >Prev</A
  42 ></TD
  43 ><TD
  44 WIDTH="80%"
  45 ALIGN="center"
  46 VALIGN="bottom"
  47 >Chapter 3. Customizing DejaGnu</TD
  48 ><TD
  49 WIDTH="10%"
  50 ALIGN="right"
  51 VALIGN="bottom"
  52 ><A
  53 HREF="extending.html"
  54 >Next</A
  55 ></TD
  56 ></TR
  57 ></TABLE
  58 ><HR
  59 ALIGN="LEFT"
  60 WIDTH="100%"></DIV
  61 ><DIV
  62 CLASS="SECT1"
  63 ><H1
  64 CLASS="SECT1"
  65 ><A
  66 NAME="CONFIGFILE"
  67 >Config File Values</A
  68 ></H1
  69 ><P
  70 >DejaGnu uses a named array in Tcl to hold all the info for
  71       each machine. In the case of a canadian cross, this means host
  72       information as well as target information. The named array is
  73       called <SPAN
  74 CLASS="SYMBOL"
  75 >target_info</SPAN
  76 >, and it has two indices. The
  77       following fields are part of the array.</P
  78 ><DIV
  79 CLASS="SECT2"
  80 ><H2
  81 CLASS="SECT2"
  82 ><A
  83 NAME="OPTIONDEFS"
  84 >Command Line Option Variables</A
  85 ></H2
  86 ><P
  87 >In the user editable second section of the <A
  88 HREF="configfile.html#PERSONAL"
  89 ><I
  90 >Personal Config File</I
  91 ></A
  92 > you can not only override the configuration
  93         variables captured in the first section, but also specify
  94         default values for all on the <B
  95 CLASS="COMMAND"
  96 >runtest</B
  97 >
  98         command line options.  Save for <TT
  99 CLASS="OPTION"
 100 >--debug</TT
 101 >,
 102         <TT
 103 CLASS="OPTION"
 104 >--help</TT
 105 >, and <TT
 106 CLASS="OPTION"
 107 >--version</TT
 108 >, each
 109         command line option has an associated Tcl variable.  Use the
 110         Tcl <B
 111 CLASS="COMMAND"
 112 >set</B
 113 > command to specify a new default
 114         value (as for the configuration variables).  The following
 115         table describes the correspondence between command line
 116         options and variables you can set in
 117         <TT
 118 CLASS="FILENAME"
 119 >site.exp</TT
 120 >.  <A
 121 HREF="runtest.html#INVOKING"
 122 ><I
 123 >Invoking Runtest</I
 124 ></A
 125 >, for
 126         explanations of the command-line options.</P
 127 ><P
 128 ><DIV
 129 CLASS="TABLE"
 130 ><P
 131 ><B
 132 >Table 3-1. Tcl Variables For Command Line Options</B
 133 ></P
 134 ><TABLE
 135 BORDER="1"
 136 CLASS="CALSTABLE"
 137 ><TR
 138 ><TH
 139 ALIGN="LEFT"
 140 VALIGN="TOP"
 141 >runtest</TH
 142 ><TH
 143 ALIGN="LEFT"
 144 VALIGN="TOP"
 145 >Tcl</TH
 146 ><TH
 147 ALIGN="LEFT"
 148 VALIGN="TOP"
 149 >option</TH
 150 ><TH
 151 ALIGN="LEFT"
 152 VALIGN="TOP"
 153 >variable</TH
 154 ><TH
 155 ALIGN="LEFT"
 156 VALIGN="TOP"
 157 >description</TH
 158 ></TR
 159 ><TR
 160 ><TD
 161 ALIGN="LEFT"
 162 VALIGN="TOP"
 163 >--all</TD
 164 ><TD
 165 ALIGN="LEFT"
 166 VALIGN="TOP"
 167 >all_flag</TD
 168 ><TD
 169 ALIGN="LEFT"
 170 VALIGN="TOP"
 171 >display all test results if set</TD
 172 ></TR
 173 ><TR
 174 ><TD
 175 ALIGN="LEFT"
 176 VALIGN="TOP"
 177 >--baud</TD
 178 ><TD
 179 ALIGN="LEFT"
 180 VALIGN="TOP"
 181 >baud</TD
 182 ><TD
 183 ALIGN="LEFT"
 184 VALIGN="TOP"
 185 >set the default baud rate to something other than
 186             9600.</TD
 187 ></TR
 188 ><TR
 189 ><TD
 190 ALIGN="LEFT"
 191 VALIGN="TOP"
 192 >--connect</TD
 193 ><TD
 194 ALIGN="LEFT"
 195 VALIGN="TOP"
 196 >connectmode</TD
 197 ><TD
 198 ALIGN="LEFT"
 199 VALIGN="TOP"
 200 ><B
 201 CLASS="COMMAND"
 202 >rlogin</B
 203 >,
 204             <B
 205 CLASS="COMMAND"
 206 >telnet</B
 207 >, <B
 208 CLASS="COMMAND"
 209 >rsh</B
 210 >,
 211             <B
 212 CLASS="COMMAND"
 213 >kermit</B
 214 >, <B
 215 CLASS="COMMAND"
 216 >tip</B
 217 >, or
 218             <B
 219 CLASS="COMMAND"
 220 >mondfe</B
 221 ></TD
 222 ></TR
 223 ><TR
 224 ><TD
 225 ALIGN="LEFT"
 226 VALIGN="TOP"
 227 >--outdir</TD
 228 ><TD
 229 ALIGN="LEFT"
 230 VALIGN="TOP"
 231 >outdir</TD
 232 ><TD
 233 ALIGN="LEFT"
 234 VALIGN="TOP"
 235 >directory for <TT
 236 CLASS="FILENAME"
 237 >tool.sum</TT
 238 > and
 239             <TT
 240 CLASS="FILENAME"
 241 >tool.log.</TT
 242 ></TD
 243 ></TR
 244 ><TR
 245 ><TD
 246 ALIGN="LEFT"
 247 VALIGN="TOP"
 248 >--objdir</TD
 249 ><TD
 250 ALIGN="LEFT"
 251 VALIGN="TOP"
 252 >objdir</TD
 253 ><TD
 254 ALIGN="LEFT"
 255 VALIGN="TOP"
 256 >directory for pre-compiled binaries</TD
 257 ></TR
 258 ><TR
 259 ><TD
 260 ALIGN="LEFT"
 261 VALIGN="TOP"
 262 >--reboot</TD
 263 ><TD
 264 ALIGN="LEFT"
 265 VALIGN="TOP"
 266 >reboot</TD
 267 ><TD
 268 ALIGN="LEFT"
 269 VALIGN="TOP"
 270 >reboot the target if set to
 271             <I
 272 CLASS="EMPHASIS"
 273 >"1"</I
 274 >; do not reboot if set to
 275             <I
 276 CLASS="EMPHASIS"
 277 >"0"</I
 278 > (the default).</TD
 279 ></TR
 280 ><TR
 281 ><TD
 282 ALIGN="LEFT"
 283 VALIGN="TOP"
 284 >--srcdir</TD
 285 ><TD
 286 ALIGN="LEFT"
 287 VALIGN="TOP"
 288 >srcdir</TD
 289 ><TD
 290 ALIGN="LEFT"
 291 VALIGN="TOP"
 292 >directory of test subdirectories</TD
 293 ></TR
 294 ><TR
 295 ><TD
 296 ALIGN="LEFT"
 297 VALIGN="TOP"
 298 >--strace</TD
 299 ><TD
 300 ALIGN="LEFT"
 301 VALIGN="TOP"
 302 >tracelevel</TD
 303 ><TD
 304 ALIGN="LEFT"
 305 VALIGN="TOP"
 306 >a number: Tcl trace depth</TD
 307 ></TR
 308 ><TR
 309 ><TD
 310 ALIGN="LEFT"
 311 VALIGN="TOP"
 312 >--tool</TD
 313 ><TD
 314 ALIGN="LEFT"
 315 VALIGN="TOP"
 316 >tool</TD
 317 ><TD
 318 ALIGN="LEFT"
 319 VALIGN="TOP"
 320 >name of tool to test; identifies init, test subdir</TD
 321 ></TR
 322 ><TR
 323 ><TD
 324 ALIGN="LEFT"
 325 VALIGN="TOP"
 326 >--verbose</TD
 327 ><TD
 328 ALIGN="LEFT"
 329 VALIGN="TOP"
 330 >verbose</TD
 331 ><TD
 332 ALIGN="LEFT"
 333 VALIGN="TOP"
 334 >verbosity level.  As option, use multiple times; as
 335             variable, set a number, 0 or greater.</TD
 336 ></TR
 337 ><TR
 338 ><TD
 339 ALIGN="LEFT"
 340 VALIGN="TOP"
 341 >--target</TD
 342 ><TD
 343 ALIGN="LEFT"
 344 VALIGN="TOP"
 345 >target_triplet</TD
 346 ><TD
 347 ALIGN="LEFT"
 348 VALIGN="TOP"
 349 >The canonical configuration string for the target.</TD
 350 ></TR
 351 ><TR
 352 ><TD
 353 ALIGN="LEFT"
 354 VALIGN="TOP"
 355 >--host</TD
 356 ><TD
 357 ALIGN="LEFT"
 358 VALIGN="TOP"
 359 >host_triplet</TD
 360 ><TD
 361 ALIGN="LEFT"
 362 VALIGN="TOP"
 363 >The canonical configuration string for the host.</TD
 364 ></TR
 365 ><TR
 366 ><TD
 367 ALIGN="LEFT"
 368 VALIGN="TOP"
 369 >--build</TD
 370 ><TD
 371 ALIGN="LEFT"
 372 VALIGN="TOP"
 373 >build_triplet</TD
 374 ><TD
 375 ALIGN="LEFT"
 376 VALIGN="TOP"
 377 >The canonical configuration string for the build
 378             host.</TD
 379 ></TR
 380 ><TR
 381 ><TD
 382 ALIGN="LEFT"
 383 VALIGN="TOP"
 384 >--mail</TD
 385 ><TD
 386 ALIGN="LEFT"
 387 VALIGN="TOP"
 388 >address</TD
 389 ><TD
 390 ALIGN="LEFT"
 391 VALIGN="TOP"
 392 >Email the output log to the specified address.</TD
 393 ></TR
 394 ></TABLE
 395 ></DIV
 396 >
 397         </P
 398 ></DIV
 399 ><DIV
 400 CLASS="SECT2"
 401 ><H2
 402 CLASS="SECT2"
 403 ><A
 404 NAME="PERSONAL"
 405 >Personal Config File</A
 406 ></H2
 407 ><P
 408 >The personal config file is used to customize
 409       <B
 410 CLASS="COMMAND"
 411 >runtest's</B
 412 > behaviour for each person. It's
 413       typically used to set the user prefered setting for verbosity,
 414       and any experimental Tcl procedures. My personal
 415       <TT
 416 CLASS="FILENAME"
 417 >~/.dejagnurc</TT
 418 > file looks like:</P
 419 ><DIV
 420 CLASS="EXAMPLE"
 421 ><P
 422 ><B
 423 >Example 3-12. Personal Config File</B
 424 ></P
 425 ><TABLE
 426 BORDER="0"
 427 BGCOLOR="#E0E0E0"
 428 WIDTH="100%"
 429 ><TR
 430 ><TD
 431 ><PRE
 432 CLASS="PROGRAMLISTING"
 433 >       set all_flag 1
 434         set RLOGIN /usr/ucb/rlogin
 435         set RSH /usr/local/sbin/ssh
 436         </PRE
 437 ></TD
 438 ></TR
 439 ></TABLE
 440 ></DIV
 441 ><P
 442 >Here I set <SPAN
 443 CLASS="SYMBOL"
 444 >all_flag</SPAN
 445 > so I see all the test
 446       cases that PASS along with the ones that FAIL. I also set
 447       <SPAN
 448 CLASS="SYMBOL"
 449 >RLOGIN</SPAN
 450 > to the BSD version. I have
 451       <SPAN
 452 CLASS="PRODUCTNAME"
 453 >Kerberos</SPAN
 454 > installed, and when I rlogin
 455       to a target board, it usually isn't supported. So I use the non
 456       secure version rather than the default that's in my path. I also
 457       set <SPAN
 458 CLASS="SYMBOL"
 459 >RSH</SPAN
 460 > to the <SPAN
 461 CLASS="PRODUCTNAME"
 462 >SSH</SPAN
 463 >
 464       secure shell, as rsh is mostly used to test unix
 465       machines within a local network here.</P
 466 ></DIV
 467 ></DIV
 468 ><DIV
 469 CLASS="NAVFOOTER"
 470 ><HR
 471 ALIGN="LEFT"
 472 WIDTH="100%"><TABLE
 473 WIDTH="100%"
 474 BORDER="0"
 475 CELLPADDING="0"
 476 CELLSPACING="0"
 477 ><TR
 478 ><TD
 479 WIDTH="33%"
 480 ALIGN="left"
 481 VALIGN="top"
 482 ><A
 483 HREF="releng.html"
 484 >Prev</A
 485 ></TD
 486 ><TD
 487 WIDTH="34%"
 488 ALIGN="center"
 489 VALIGN="top"
 490 ><A
 491 HREF="book1.html"
 492 >Home</A
 493 ></TD
 494 ><TD
 495 WIDTH="33%"
 496 ALIGN="right"
 497 VALIGN="top"
 498 ><A
 499 HREF="extending.html"
 500 >Next</A
 501 ></TD
 502 ></TR
 503 ><TR
 504 ><TD
 505 WIDTH="33%"
 506 ALIGN="left"
 507 VALIGN="top"
 508 >Remote Host Testing</TD
 509 ><TD
 510 WIDTH="34%"
 511 ALIGN="center"
 512 VALIGN="top"
 513 ><A
 514 HREF="customizing.html"
 515 >Up</A
 516 ></TD
 517 ><TD
 518 WIDTH="33%"
 519 ALIGN="right"
 520 VALIGN="top"
 521 >Extending DejaGnu</TD
 522 ></TR
 523 ></TABLE
 524 ></DIV
 525 ></BODY
 526 ></HTML
 527 >