14 |
|
|
15 |
<sect1 id=installation xreflabel="Installation"> |
<sect1 id=installation xreflabel="Installation"> |
16 |
<title>Installation</title> |
<title>Installation</title> |
17 |
|
|
18 |
<para>Once you have the DejaGnu source unpacked and available, you must |
<para>Once you have the DejaGnu source unpacked and available, you must |
19 |
first configure the software to specify where it is to run (and the |
first configure the software to specify where it is to run (and the |
20 |
associated defaults); then you can proceed to installing it.</para> |
associated defaults); then you can proceed to installing it.</para> |
60 |
suites.</para> |
suites.</para> |
61 |
|
|
62 |
</sect2> |
</sect2> |
63 |
|
|
64 |
<sect2 id=installing xreflabel="Installing DejaGnu"> |
<sect2 id=installing xreflabel="Installing DejaGnu"> |
65 |
<title>Installing DejaGnu</title> |
<title>Installing DejaGnu</title> |
66 |
|
|
132 |
|
|
133 |
<para></para> |
<para></para> |
134 |
|
|
135 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
136 |
<funcdef><function>open_logs</function></funcdef> |
<funcdef><function>open_logs</function></funcdef> |
137 |
<paramdef><parameter></parameter</paramdef> |
<paramdef><parameter></parameter</paramdef> |
138 |
</funcsynopsis> |
</funcsynopsis> |
143 |
|
|
144 |
<para></para> |
<para></para> |
145 |
|
|
146 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
147 |
<funcdef><function>close_logs</function></funcdef> |
<funcdef><function>close_logs</function></funcdef> |
148 |
<paramdef><parameter></parameter</paramdef> |
<paramdef><parameter></parameter</paramdef> |
149 |
</funcsynopsis> |
</funcsynopsis> |
162 |
passed a NULL string, then it returns the name of the build canonical |
passed a NULL string, then it returns the name of the build canonical |
163 |
configuration.</para> |
configuration.</para> |
164 |
|
|
165 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
166 |
<funcdef><function>isbuild</function></funcdef> |
<funcdef><function>isbuild</function></funcdef> |
167 |
<paramdef><parameter>pattern</parameter</paramdef> |
<paramdef><parameter>pattern</parameter</paramdef> |
168 |
</funcsynopsis> |
</funcsynopsis> |
179 |
|
|
180 |
<para></para> |
<para></para> |
181 |
|
|
182 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
183 |
<funcdef><function>is_remote</function></funcdef> |
<funcdef><function>is_remote</function></funcdef> |
184 |
<paramdef><parameter>board</parameter</paramdef> |
<paramdef><parameter>board</parameter</paramdef> |
185 |
</funcsynopsis> |
</funcsynopsis> |
199 |
the result is <emphasis>1</emphasis>; otherwise the result is |
the result is <emphasis>1</emphasis>; otherwise the result is |
200 |
<emphasis>0</emphasis>.</para> |
<emphasis>0</emphasis>.</para> |
201 |
|
|
202 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
203 |
<funcdef><function>is3way</function></funcdef> |
<funcdef><function>is3way</function></funcdef> |
204 |
<paramdef><parameter></parameter</paramdef> |
<paramdef><parameter></parameter</paramdef> |
205 |
</funcsynopsis> |
</funcsynopsis> |
216 |
shorter nicknames supported by configure (but you can use wildcard |
shorter nicknames supported by configure (but you can use wildcard |
217 |
characters, using shell syntax, to specify sets of names).</para> |
characters, using shell syntax, to specify sets of names).</para> |
218 |
|
|
219 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
220 |
<funcdef><function>ishost</function></funcdef> |
<funcdef><function>ishost</function></funcdef> |
221 |
<paramdef><parameter>pattern</parameter></paramdef> |
<paramdef><parameter>pattern</parameter></paramdef> |
222 |
</funcsynopsis> |
</funcsynopsis> |
241 |
<emphasis>NULL</emphasis> string, then it returns the name of the |
<emphasis>NULL</emphasis> string, then it returns the name of the |
242 |
build canonical configuration.</para> |
build canonical configuration.</para> |
243 |
|
|
244 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
245 |
<funcdef><function>istarget</function></funcdef> |
<funcdef><function>istarget</function></funcdef> |
246 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
247 |
</funcsynopsis> |
</funcsynopsis> |
261 |
a <emphasis>1</emphasis>; otherwise it returns a |
a <emphasis>1</emphasis>; otherwise it returns a |
262 |
<emphasis>0</emphasis>.</para> |
<emphasis>0</emphasis>.</para> |
263 |
|
|
264 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
265 |
<funcdef><function>isnative</function></funcdef> |
<funcdef><function>isnative</function></funcdef> |
266 |
<paramdef><parameter></parameter</paramdef> |
<paramdef><parameter></parameter</paramdef> |
267 |
</funcsynopsis> |
</funcsynopsis> |
272 |
|
|
273 |
<para></para> |
<para></para> |
274 |
|
|
275 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
276 |
<funcdef><function>unknown</function></funcdef> |
<funcdef><function>unknown</function></funcdef> |
277 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
278 |
</funcsynopsis> |
</funcsynopsis> |
289 |
|
|
290 |
<para></para> |
<para></para> |
291 |
|
|
292 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
293 |
<funcdef><function>clone_output</function></funcdef> |
<funcdef><function>clone_output</function></funcdef> |
294 |
<paramdef><parameter>message</parameter></paramdef> |
<paramdef><parameter>message</parameter></paramdef> |
295 |
</funcsynopsis> |
</funcsynopsis> |
306 |
|
|
307 |
<para></para> |
<para></para> |
308 |
|
|
309 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
310 |
<funcdef><function>reset_vars</function></funcdef> |
<funcdef><function>reset_vars</function></funcdef> |
311 |
<paramdef><parameter></parameter</paramdef> |
<paramdef><parameter></parameter</paramdef> |
312 |
</funcsynopsis> |
</funcsynopsis> |
317 |
|
|
318 |
<para></para> |
<para></para> |
319 |
|
|
320 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
321 |
<funcdef><function>log_and_exit</function></funcdef> |
<funcdef><function>log_and_exit</function></funcdef> |
322 |
<paramdef><parameter></parameter</paramdef> |
<paramdef><parameter></parameter</paramdef> |
323 |
</funcsynopsis> |
</funcsynopsis> |
328 |
|
|
329 |
<para></para> |
<para></para> |
330 |
|
|
331 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
332 |
<funcdef><function>log_summary</function></funcdef> |
<funcdef><function>log_summary</function></funcdef> |
333 |
<paramdef><parameter>args</parameter</paramdef> |
<paramdef><parameter>args</parameter</paramdef> |
334 |
</funcsynopsis> |
</funcsynopsis> |
345 |
|
|
346 |
<para></para> |
<para></para> |
347 |
|
|
348 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
349 |
<funcdef><function>cleanup</function></funcdef> |
<funcdef><function>cleanup</function></funcdef> |
350 |
<paramdef><parameter></parameter</paramdef> |
<paramdef><parameter></parameter</paramdef> |
351 |
</funcsynopsis> |
</funcsynopsis> |
379 |
applies to whatever test runs next, leading to surprising |
applies to whatever test runs next, leading to surprising |
380 |
results.</para></warning> |
results.</para></warning> |
381 |
|
|
382 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
383 |
<funcdef><function>setup_xfail</function></funcdef> |
<funcdef><function>setup_xfail</function></funcdef> |
384 |
<paramdef><parameter>config</parameter> |
<paramdef><parameter>config</parameter> |
385 |
<parameter>bugid</parameter></paramdef> |
<parameter>bugid</parameter></paramdef> |
403 |
|
|
404 |
<para></para> |
<para></para> |
405 |
|
|
406 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
407 |
<funcdef><function>record_test</function></funcdef> |
<funcdef><function>record_test</function></funcdef> |
408 |
<paramdef><parameter>type</parameter> |
<paramdef><parameter>type</parameter> |
409 |
<parameter>message</parameter> |
<parameter>message</parameter> |
434 |
was expected), appending the argument |
was expected), appending the argument |
435 |
<parameter>string</parameter>.</para> |
<parameter>string</parameter>.</para> |
436 |
|
|
437 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
438 |
<funcdef><function>pass</function></funcdef> |
<funcdef><function>pass</function></funcdef> |
439 |
<paramdef><parameter>string</parameter></paramdef> |
<paramdef><parameter>string</parameter></paramdef> |
440 |
</funcsynopsis> |
</funcsynopsis> |
454 |
writes in the log files a message beginning with |
writes in the log files a message beginning with |
455 |
<emphasis>FAIL</emphasis> (or <emphasis>XFAIL</emphasis>, if failure |
<emphasis>FAIL</emphasis> (or <emphasis>XFAIL</emphasis>, if failure |
456 |
was expected), appending the argument |
was expected), appending the argument |
457 |
<parameter>string</parameter>.</para> |
<parameter>string</parameter>.</para> |
458 |
|
|
459 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
460 |
<funcdef><function>fail</function></funcdef> |
<funcdef><function>fail</function></funcdef> |
461 |
<paramdef><parameter>string</parameter></paramdef> |
<paramdef><parameter>string</parameter></paramdef> |
462 |
</funcsynopsis> |
</funcsynopsis> |
479 |
was expected), appending the argument |
was expected), appending the argument |
480 |
<parameter>string</parameter>.</para> |
<parameter>string</parameter>.</para> |
481 |
|
|
482 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
483 |
<funcdef><function>xpass</function></funcdef> |
<funcdef><function>xpass</function></funcdef> |
484 |
<paramdef><parameter>string</parameter></paramdef> |
<paramdef><parameter>string</parameter></paramdef> |
485 |
</funcsynopsis> |
</funcsynopsis> |
496 |
<title>Xfail Procedure</title> |
<title>Xfail Procedure</title> |
497 |
|
|
498 |
<para>Declares a test to have expectably |
<para>Declares a test to have expectably |
499 |
failed. <function>xfail</function> |
failed. <function>xfail</function> |
500 |
writes in the log files a message beginning with |
writes in the log files a message beginning with |
501 |
<emphasis>XFAIL</emphasis> (or <emphasis>PASS</emphasis>, if success |
<emphasis>XFAIL</emphasis> (or <emphasis>PASS</emphasis>, if success |
502 |
was expected), appending the argument |
was expected), appending the argument |
503 |
<parameter>string</parameter>.</para> |
<parameter>string</parameter>.</para> |
504 |
|
|
505 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
506 |
<funcdef><function>xpass</function></funcdef> |
<funcdef><function>xpass</function></funcdef> |
507 |
<paramdef><parameter>string</parameter></paramdef> |
<paramdef><parameter>string</parameter></paramdef> |
508 |
</funcsynopsis> |
</funcsynopsis> |
524 |
<emphasis>PASS</emphasis> or <emphasis>FAIL</emphasis> into an |
<emphasis>PASS</emphasis> or <emphasis>FAIL</emphasis> into an |
525 |
<emphasis>UNRESOLVED</emphasis>.</para> |
<emphasis>UNRESOLVED</emphasis>.</para> |
526 |
|
|
527 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
528 |
<funcdef><function>set_warning_threshold</function></funcdef> |
<funcdef><function>set_warning_threshold</function></funcdef> |
529 |
<paramdef><parameter>threshold</parameter></paramdef> |
<paramdef><parameter>threshold</parameter></paramdef> |
530 |
</funcsynopsis> |
</funcsynopsis> |
545 |
value controls how many <function>warning</function> procedures can |
value controls how many <function>warning</function> procedures can |
546 |
be called before becoming <emphasis>UNRESOLVED</emphasis>.</para> |
be called before becoming <emphasis>UNRESOLVED</emphasis>.</para> |
547 |
|
|
548 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
549 |
<funcdef><function>get_warning_threshold</function></funcdef> |
<funcdef><function>get_warning_threshold</function></funcdef> |
550 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
551 |
</funcsynopsis> |
</funcsynopsis> |
573 |
is <emphasis>0</emphasis>, then there are no further side effects to |
is <emphasis>0</emphasis>, then there are no further side effects to |
574 |
calling this function, and the following test outcome doesn't become |
calling this function, and the following test outcome doesn't become |
575 |
<emphasis>UNRESOLVED</emphasis>. This can be used for errors with no |
<emphasis>UNRESOLVED</emphasis>. This can be used for errors with no |
576 |
known side effects.</para> |
known side effects.</para> |
577 |
|
|
578 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
579 |
<funcdef><function>warning</function></funcdef> |
<funcdef><function>warning</function></funcdef> |
580 |
<paramdef><parameter>string</parameter> |
<paramdef><parameter>string</parameter> |
581 |
<parameter>number</parameter> |
<parameter>number</parameter> |
615 |
doesn't become <emphasis>UNRESOLVED</emphasis>. This can be used for |
doesn't become <emphasis>UNRESOLVED</emphasis>. This can be used for |
616 |
errors with no known side effects.</para> |
errors with no known side effects.</para> |
617 |
|
|
618 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
619 |
<funcdef><function>perror</function></funcdef> |
<funcdef><function>perror</function></funcdef> |
620 |
<paramdef><parameter>string</parameter> |
<paramdef><parameter>string</parameter> |
621 |
<parameter>number</parameter> |
<parameter>number</parameter> |
648 |
such messages, but in cases where a message is needed in the log file |
such messages, but in cases where a message is needed in the log file |
649 |
regardless of the verbosity level use <function>note</function>.</para> |
regardless of the verbosity level use <function>note</function>.</para> |
650 |
|
|
651 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
652 |
<funcdef><function>note</function></funcdef> |
<funcdef><function>note</function></funcdef> |
653 |
<paramdef><parameter>string</parameter></paramdef> |
<paramdef><parameter>string</parameter></paramdef> |
654 |
</funcsynopsis> |
</funcsynopsis> |
669 |
might use this in a dummy test whose only role is to record that a test |
might use this in a dummy test whose only role is to record that a test |
670 |
does not yet exist for some feature.</para> |
does not yet exist for some feature.</para> |
671 |
|
|
672 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
673 |
<funcdef><function>untested</function></funcdef> |
<funcdef><function>untested</function></funcdef> |
674 |
<paramdef><parameter>string</parameter></paramdef> |
<paramdef><parameter>string</parameter></paramdef> |
675 |
</funcsynopsis> |
</funcsynopsis> |
692 |
not execute as expected, and a human being must go over results to |
not execute as expected, and a human being must go over results to |
693 |
determine if it passed or failed (and to improve the test case).</para> |
determine if it passed or failed (and to improve the test case).</para> |
694 |
|
|
695 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
696 |
<funcdef><function>unresolved</function></funcdef> |
<funcdef><function>unresolved</function></funcdef> |
697 |
<paramdef><parameter>string</parameter></paramdef> |
<paramdef><parameter>string</parameter></paramdef> |
698 |
</funcsynopsis> |
</funcsynopsis> |
713 |
writes in the log file a message beginning with |
writes in the log file a message beginning with |
714 |
<emphasis>UNSUPPORTED</emphasis>, appending the argument string.</para> |
<emphasis>UNSUPPORTED</emphasis>, appending the argument string.</para> |
715 |
|
|
716 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
717 |
<funcdef><function>unsupported</function></funcdef> |
<funcdef><function>unsupported</function></funcdef> |
718 |
<paramdef><parameter>string</parameter></paramdef> |
<paramdef><parameter>string</parameter></paramdef> |
719 |
</funcsynopsis> |
</funcsynopsis> |
731 |
|
|
732 |
<para></para> |
<para></para> |
733 |
|
|
734 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
735 |
<funcdef><function>init_testcounts</function></funcdef> |
<funcdef><function>init_testcounts</function></funcdef> |
736 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
737 |
</funcsynopsis> |
</funcsynopsis> |
742 |
|
|
743 |
<para></para> |
<para></para> |
744 |
|
|
745 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
746 |
<funcdef><function>incr_count</function></funcdef> |
<funcdef><function>incr_count</function></funcdef> |
747 |
<paramdef><parameter>name</parameter> |
<paramdef><parameter>name</parameter> |
748 |
<parameter>args</parameter></paramdef> |
<parameter>args</parameter></paramdef> |
768 |
tools are installed using the same naming conventions: For example, |
tools are installed using the same naming conventions: For example, |
769 |
for a cross compiler supporting the <emphasis>m68k-vxworks</emphasis> |
for a cross compiler supporting the <emphasis>m68k-vxworks</emphasis> |
770 |
configuration, the result of transform <command>gcc</command> is |
configuration, the result of transform <command>gcc</command> is |
771 |
<command>m68k-vxworks-gcc</command>.</para> |
<command>m68k-vxworks-gcc</command>.</para> |
772 |
|
|
773 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
774 |
<funcdef><function>transform</function></funcdef> |
<funcdef><function>transform</function></funcdef> |
775 |
<paramdef><parameter>toolname</parameter></paramdef> |
<paramdef><parameter>toolname</parameter></paramdef> |
776 |
</funcsynopsis> |
</funcsynopsis> |
778 |
<varlistentry> |
<varlistentry> |
779 |
<term><parameter>toolname</parameter></term> |
<term><parameter>toolname</parameter></term> |
780 |
<listitem><para>The name of the cross-development program to |
<listitem><para>The name of the cross-development program to |
781 |
transform.</para></listitem> |
transform.</para></listitem> |
782 |
</varlistentry> |
</varlistentry> |
783 |
</variablelist> |
</variablelist> |
784 |
</sect3> |
</sect3> |
804 |
conditional is true, or <emphasis>0</emphasis> if the conditional is |
conditional is true, or <emphasis>0</emphasis> if the conditional is |
805 |
false.</para> |
false.</para> |
806 |
|
|
807 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
808 |
<funcdef><function>check_conditional_xfail</function></funcdef> |
<funcdef><function>check_conditional_xfail</function></funcdef> |
809 |
<paramdef><parameter>message</parameter> |
<paramdef><parameter>message</parameter> |
810 |
<parameter>targets</parameter> |
<parameter>targets</parameter> |
836 |
<listitem><para>This is a list of sets of options to search for in |
<listitem><para>This is a list of sets of options to search for in |
837 |
the compiler options to activate this conditional. If any set of |
the compiler options to activate this conditional. If any set of |
838 |
the options matches, (regardless of whether any of the include sets |
the options matches, (regardless of whether any of the include sets |
839 |
match) then this conditional is de-activated.</para></listitem> |
match) then this conditional is de-activated.</para></listitem> |
840 |
</varlistentry> |
</varlistentry> |
841 |
</variablelist> |
</variablelist> |
842 |
|
|
872 |
of configuration target names. It is only necessary to call |
of configuration target names. It is only necessary to call |
873 |
<command>clear_xfail</command> if a test case ends without calling |
<command>clear_xfail</command> if a test case ends without calling |
874 |
either <command>pass</command> or <command>fail</command>, after |
either <command>pass</command> or <command>fail</command>, after |
875 |
calling <command>setup_xfail</command>.</para> |
calling <command>setup_xfail</command>.</para> |
876 |
|
|
877 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
878 |
<funcdef><function>clear_xfail</function></funcdef> |
<funcdef><function>clear_xfail</function></funcdef> |
879 |
<paramdef><parameter>config</parameter></paramdef> |
<paramdef><parameter>config</parameter></paramdef> |
880 |
</funcsynopsis> |
</funcsynopsis> |
902 |
to print string without a trailing newline. Use the optional |
to print string without a trailing newline. Use the optional |
903 |
<option>--</option> argument if string begins with "-".</para> |
<option>--</option> argument if string begins with "-".</para> |
904 |
|
|
905 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
906 |
<funcdef><function>verbose</function></funcdef> |
<funcdef><function>verbose</function></funcdef> |
907 |
<paramdef><parameter>-log</parameter> |
<paramdef><parameter>-log</parameter> |
908 |
<parameter>-x</parameter> |
<parameter>-x</parameter> |
952 |
duplicate definitions, the last one loaded takes precedence over the |
duplicate definitions, the last one loaded takes precedence over the |
953 |
earlier ones.</para> |
earlier ones.</para> |
954 |
|
|
955 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
956 |
<funcdef><function>load_lib</function></funcdef> |
<funcdef><function>load_lib</function></funcdef> |
957 |
<paramdef><parameter>filespec</parameter></paramdef> |
<paramdef><parameter>filespec</parameter></paramdef> |
958 |
</funcsynopsis> |
</funcsynopsis> |
994 |
|
|
995 |
<para></para> |
<para></para> |
996 |
|
|
997 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
998 |
<funcdef><function>call_remote</function></funcdef> |
<funcdef><function>call_remote</function></funcdef> |
999 |
<paramdef><parameter>type</parameter> |
<paramdef><parameter>type</parameter> |
1000 |
<parameter>proc</parameter> |
<parameter>proc</parameter> |
1023 |
|
|
1024 |
<para></para> |
<para></para> |
1025 |
|
|
1026 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1027 |
<funcdef><function>check_for_board_status</function></funcdef> |
<funcdef><function>check_for_board_status</function></funcdef> |
1028 |
<paramdef><parameter>variable</parameter></paramdef> |
<paramdef><parameter>variable</parameter></paramdef> |
1029 |
</funcsynopsis> |
</funcsynopsis> |
1040 |
|
|
1041 |
<para></para> |
<para></para> |
1042 |
|
|
1043 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1044 |
<funcdef><function>file_on_build</function></funcdef> |
<funcdef><function>file_on_build</function></funcdef> |
1045 |
<paramdef><parameter>op</parameter> |
<paramdef><parameter>op</parameter> |
1046 |
<parameter>file</parameter> |
<parameter>file</parameter> |
1067 |
|
|
1068 |
<para></para> |
<para></para> |
1069 |
|
|
1070 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1071 |
<funcdef><function>file_on_host</function></funcdef> |
<funcdef><function>file_on_host</function></funcdef> |
1072 |
<paramdef><parameter>op</parameter> |
<paramdef><parameter>op</parameter> |
1073 |
<parameter>file</parameter> |
<parameter>file</parameter> |
1094 |
|
|
1095 |
<para></para> |
<para></para> |
1096 |
|
|
1097 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1098 |
<funcdef><function>local_exec</function></funcdef> |
<funcdef><function>local_exec</function></funcdef> |
1099 |
<paramdef><parameter>commandline</parameter> |
<paramdef><parameter>commandline</parameter> |
1100 |
<parameter>inp</parameter> |
<parameter>inp</parameter> |
1122 |
|
|
1123 |
<para></para> |
<para></para> |
1124 |
|
|
1125 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1126 |
<funcdef><function>remote_binary</function></funcdef> |
<funcdef><function>remote_binary</function></funcdef> |
1127 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1128 |
</funcsynopsis> |
</funcsynopsis> |
1139 |
|
|
1140 |
<para></para> |
<para></para> |
1141 |
|
|
1142 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1143 |
<funcdef><function>remote_close</function></funcdef> |
<funcdef><function>remote_close</function></funcdef> |
1144 |
<paramdef><parameter>shellid</parameter></paramdef> |
<paramdef><parameter>shellid</parameter></paramdef> |
1145 |
</funcsynopsis> |
</funcsynopsis> |
1161 |
|
|
1162 |
<para></para> |
<para></para> |
1163 |
|
|
1164 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1165 |
<funcdef><function>remote_download</function></funcdef> |
<funcdef><function>remote_download</function></funcdef> |
1166 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1167 |
<parameter>file</parameter> |
<parameter>file</parameter> |
1188 |
|
|
1189 |
<para></para> |
<para></para> |
1190 |
|
|
1191 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1192 |
<funcdef><function>remote_exec</function></funcdef> |
<funcdef><function>remote_exec</function></funcdef> |
1193 |
<paramdef><parameter>hostname</parameter> |
<paramdef><parameter>hostname</parameter> |
1194 |
<parameter>program</parameter> |
<parameter>program</parameter> |
1215 |
|
|
1216 |
<para></para> |
<para></para> |
1217 |
|
|
1218 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1219 |
<funcdef><function>remote_expect</function></funcdef> |
<funcdef><function>remote_expect</function></funcdef> |
1220 |
<paramdef><parameter>board</parameter> |
<paramdef><parameter>board</parameter> |
1221 |
<parameter>timeout</parameter> |
<parameter>timeout</parameter> |
1242 |
|
|
1243 |
<para></para> |
<para></para> |
1244 |
|
|
1245 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1246 |
<funcdef><function>remote_file</function></funcdef> |
<funcdef><function>remote_file</function></funcdef> |
1247 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1248 |
<parameter>args</parameter</paramdef> |
<parameter>args</parameter</paramdef> |
1264 |
|
|
1265 |
<para></para> |
<para></para> |
1266 |
|
|
1267 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1268 |
<funcdef><function>remote_ld</function></funcdef> |
<funcdef><function>remote_ld</function></funcdef> |
1269 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1270 |
<parameter>prog</parameter></paramdef> |
<parameter>prog</parameter></paramdef> |
1286 |
|
|
1287 |
<para></para> |
<para></para> |
1288 |
|
|
1289 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1290 |
<funcdef><function>remote_load</function></funcdef> |
<funcdef><function>remote_load</function></funcdef> |
1291 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1292 |
<parameter>prog</parameter> |
<parameter>prog</parameter> |
1313 |
|
|
1314 |
<para></para> |
<para></para> |
1315 |
|
|
1316 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1317 |
<funcdef><function>remote_open</function></funcdef> |
<funcdef><function>remote_open</function></funcdef> |
1318 |
<paramdef><parameter>type</parameter></paramdef> |
<paramdef><parameter>type</parameter></paramdef> |
1319 |
</funcsynopsis> |
</funcsynopsis> |
1342 |
|
|
1343 |
<para></para> |
<para></para> |
1344 |
|
|
1345 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1346 |
<funcdef><function>remote_pop_conn</function></funcdef> |
<funcdef><function>remote_pop_conn</function></funcdef> |
1347 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1348 |
</funcsynopsis> |
</funcsynopsis> |
1359 |
|
|
1360 |
<para></para> |
<para></para> |
1361 |
|
|
1362 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1363 |
<funcdef><function>remote_push_conn</function></funcdef> |
<funcdef><function>remote_push_conn</function></funcdef> |
1364 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1365 |
</funcsynopsis> |
</funcsynopsis> |
1376 |
|
|
1377 |
<para></para> |
<para></para> |
1378 |
|
|
1379 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1380 |
<funcdef><function>remote_raw_binary</function></funcdef> |
<funcdef><function>remote_raw_binary</function></funcdef> |
1381 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1382 |
</funcsynopsis> |
</funcsynopsis> |
1393 |
|
|
1394 |
<para></para> |
<para></para> |
1395 |
|
|
1396 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1397 |
<funcdef><function>remote_raw_close</function></funcdef> |
<funcdef><function>remote_raw_close</function></funcdef> |
1398 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1399 |
</funcsynopsis> |
</funcsynopsis> |
1410 |
|
|
1411 |
<para></para> |
<para></para> |
1412 |
|
|
1413 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1414 |
<funcdef><function>remote_raw_file</function></funcdef> |
<funcdef><function>remote_raw_file</function></funcdef> |
1415 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1416 |
<parameter>args</parameter></paramdef> |
<parameter>args</parameter></paramdef> |
1432 |
|
|
1433 |
<para></para> |
<para></para> |
1434 |
|
|
1435 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1436 |
<funcdef><function>remote_raw_ld</function></funcdef> |
<funcdef><function>remote_raw_ld</function></funcdef> |
1437 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1438 |
<parameter>prog</parameter></paramdef> |
<parameter>prog</parameter></paramdef> |
1454 |
|
|
1455 |
<para></para> |
<para></para> |
1456 |
|
|
1457 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1458 |
<funcdef><function>remote_raw_load</function></funcdef> |
<funcdef><function>remote_raw_load</function></funcdef> |
1459 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1460 |
<parameter>prog</parameter> |
<parameter>prog</parameter> |
1481 |
|
|
1482 |
<para></para> |
<para></para> |
1483 |
|
|
1484 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1485 |
<funcdef><function>remote_raw_open</function></funcdef> |
<funcdef><function>remote_raw_open</function></funcdef> |
1486 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
1487 |
</funcsynopsis> |
</funcsynopsis> |
1498 |
|
|
1499 |
<para></para> |
<para></para> |
1500 |
|
|
1501 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1502 |
<funcdef><function>remote_raw_send</function></funcdef> |
<funcdef><function>remote_raw_send</function></funcdef> |
1503 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1504 |
<parameter>string</parameter></paramdef> |
<parameter>string</parameter></paramdef> |
1520 |
|
|
1521 |
<para></para> |
<para></para> |
1522 |
|
|
1523 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1524 |
<funcdef><function>remote_raw_spawn</function></funcdef> |
<funcdef><function>remote_raw_spawn</function></funcdef> |
1525 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1526 |
<parameter>commandline</parameter></paramdef> |
<parameter>commandline</parameter></paramdef> |
1543 |
|
|
1544 |
<para></para> |
<para></para> |
1545 |
|
|
1546 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1547 |
<funcdef><function>remote_raw_transmit</function></funcdef> |
<funcdef><function>remote_raw_transmit</function></funcdef> |
1548 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1549 |
<parameter>file</parameter></paramdef> |
<parameter>file</parameter></paramdef> |
1565 |
|
|
1566 |
<para></para> |
<para></para> |
1567 |
|
|
1568 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1569 |
<funcdef><function>remote_raw_wait</function></funcdef> |
<funcdef><function>remote_raw_wait</function></funcdef> |
1570 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1571 |
<parameter>timeout</parameter></paramdef> |
<parameter>timeout</parameter></paramdef> |
1587 |
|
|
1588 |
<para></para> |
<para></para> |
1589 |
|
|
1590 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1591 |
<funcdef><function>remote_reboot</function></funcdef> |
<funcdef><function>remote_reboot</function></funcdef> |
1592 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1593 |
</funcsynopsis> |
</funcsynopsis> |
1604 |
|
|
1605 |
<para></para> |
<para></para> |
1606 |
|
|
1607 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1608 |
<funcdef><function>remote_send</function></funcdef> |
<funcdef><function>remote_send</function></funcdef> |
1609 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1610 |
<parameter>string</parameter></paramdef> |
<parameter>string</parameter></paramdef> |
1626 |
|
|
1627 |
<para></para> |
<para></para> |
1628 |
|
|
1629 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1630 |
<funcdef><function>remote_spawn</function></funcdef> |
<funcdef><function>remote_spawn</function></funcdef> |
1631 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1632 |
<parameter>commandline</parameter> |
<parameter>commandline</parameter> |
1653 |
|
|
1654 |
<para></para> |
<para></para> |
1655 |
|
|
1656 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1657 |
<funcdef><function>remote_swap_conn</function></funcdef> |
<funcdef><function>remote_swap_conn</function></funcdef> |
1658 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1659 |
</funcsynopsis> |
</funcsynopsis> |
1670 |
|
|
1671 |
<para></para> |
<para></para> |
1672 |
|
|
1673 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1674 |
<funcdef><function>remote_transmit</function></funcdef> |
<funcdef><function>remote_transmit</function></funcdef> |
1675 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1676 |
<parameter>file</parameter></paramdef> |
<parameter>file</parameter></paramdef> |
1692 |
|
|
1693 |
<para></para> |
<para></para> |
1694 |
|
|
1695 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1696 |
<funcdef><function>remote_upload</function></funcdef> |
<funcdef><function>remote_upload</function></funcdef> |
1697 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1698 |
<parameter>srcfile</parameter> |
<parameter>srcfile</parameter> |
1719 |
|
|
1720 |
<para></para> |
<para></para> |
1721 |
|
|
1722 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1723 |
<funcdef><function>remote_wait</function></funcdef> |
<funcdef><function>remote_wait</function></funcdef> |
1724 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1725 |
<parameter>timeout</parameter></paramdef> |
<parameter>timeout</parameter></paramdef> |
1741 |
|
|
1742 |
<para></para> |
<para></para> |
1743 |
|
|
1744 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1745 |
<funcdef><function>standard_close</function></funcdef> |
<funcdef><function>standard_close</function></funcdef> |
1746 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1747 |
</funcsynopsis> |
</funcsynopsis> |
1758 |
|
|
1759 |
<para></para> |
<para></para> |
1760 |
|
|
1761 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1762 |
<funcdef><function>standard_download</function></funcdef> |
<funcdef><function>standard_download</function></funcdef> |
1763 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1764 |
<parameter>file</parameter> |
<parameter>file</parameter> |
1785 |
|
|
1786 |
<para></para> |
<para></para> |
1787 |
|
|
1788 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1789 |
<funcdef><function>standard_exec</function></funcdef> |
<funcdef><function>standard_exec</function></funcdef> |
1790 |
<paramdef><parameter>hostname</parameter> |
<paramdef><parameter>hostname</parameter> |
1791 |
<parameter>args</parameter></paramdef> |
<parameter>args</parameter></paramdef> |
1807 |
|
|
1808 |
<para></para> |
<para></para> |
1809 |
|
|
1810 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1811 |
<funcdef><function>standard_file</function></funcdef> |
<funcdef><function>standard_file</function></funcdef> |
1812 |
<paramdef><parameter>dest</parameter |
<paramdef><parameter>dest</parameter |
1813 |
<parameter>op</parameter |
<parameter>op</parameter |
1826 |
|
|
1827 |
<para></para> |
<para></para> |
1828 |
|
|
1829 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1830 |
<funcdef><function>standard_load</function></funcdef> |
<funcdef><function>standard_load</function></funcdef> |
1831 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1832 |
<parameter>prog</parameter> |
<parameter>prog</parameter> |
1853 |
|
|
1854 |
<para></para> |
<para></para> |
1855 |
|
|
1856 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1857 |
<funcdef><function>standard_reboot</function></funcdef> |
<funcdef><function>standard_reboot</function></funcdef> |
1858 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
1859 |
</funcsynopsis> |
</funcsynopsis> |
1870 |
|
|
1871 |
<para></para> |
<para></para> |
1872 |
|
|
1873 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1874 |
<funcdef><function>standard_send</function></funcdef> |
<funcdef><function>standard_send</function></funcdef> |
1875 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1876 |
<parameter>string</parameter></paramdef> |
<parameter>string</parameter></paramdef> |
1892 |
|
|
1893 |
<para></para> |
<para></para> |
1894 |
|
|
1895 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1896 |
<funcdef><function>standard_spawn</function></funcdef> |
<funcdef><function>standard_spawn</function></funcdef> |
1897 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1898 |
<parameter>commandline</parameter></paramdef> |
<parameter>commandline</parameter></paramdef> |
1914 |
|
|
1915 |
<para></para> |
<para></para> |
1916 |
|
|
1917 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1918 |
<funcdef><function>standard_transmit</function></funcdef> |
<funcdef><function>standard_transmit</function></funcdef> |
1919 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1920 |
<parameter>file</parameter></paramdef> |
<parameter>file</parameter></paramdef> |
1936 |
|
|
1937 |
<para></para> |
<para></para> |
1938 |
|
|
1939 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1940 |
<funcdef><function>standard_upload</function></funcdef> |
<funcdef><function>standard_upload</function></funcdef> |
1941 |
<paramdef><parameter>dest srcfile destfile</parameter></paramdef> |
<paramdef><parameter>dest srcfile destfile</parameter></paramdef> |
1942 |
</funcsynopsis> |
</funcsynopsis> |
1961 |
|
|
1962 |
<para></para> |
<para></para> |
1963 |
|
|
1964 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1965 |
<funcdef><function>standard_wait</function></funcdef> |
<funcdef><function>standard_wait</function></funcdef> |
1966 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1967 |
<parameter>timeout</parameter></paramdef> |
<parameter>timeout</parameter></paramdef> |
1984 |
|
|
1985 |
<para></para> |
<para></para> |
1986 |
|
|
1987 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
1988 |
<funcdef><function>unix_clean_filename</function></funcdef> |
<funcdef><function>unix_clean_filename</function></funcdef> |
1989 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
1990 |
<parameter>file</parameter></paramdef> |
<parameter>file</parameter></paramdef> |
2007 |
|
|
2008 |
<para></para> |
<para></para> |
2009 |
|
|
2010 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2011 |
<funcdef><function>exit_remote_shell</function></funcdef> |
<funcdef><function>exit_remote_shell</function></funcdef> |
2012 |
<paramdef><parameter>spawnid</parameter></paramdef> |
<paramdef><parameter>spawnid</parameter></paramdef> |
2013 |
</funcsynopsis> |
</funcsynopsis> |
2024 |
--> |
--> |
2025 |
|
|
2026 |
</sect2> |
</sect2> |
2027 |
|
|
2028 |
<sect2 id=connprocs xreflabel="connprocs"> |
<sect2 id=connprocs xreflabel="connprocs"> |
2029 |
<title>Procedures For Using Utilities to Connect</title> |
<title>Procedures For Using Utilities to Connect</title> |
2030 |
|
|
2146 |
|
|
2147 |
<para></para> |
<para></para> |
2148 |
|
|
2149 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2150 |
<funcdef><function>kermit_open</function></funcdef> |
<funcdef><function>kermit_open</function></funcdef> |
2151 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
2152 |
<parameter>args</parameter></paramdef> |
<parameter>args</parameter></paramdef> |
2168 |
|
|
2169 |
<para></para> |
<para></para> |
2170 |
|
|
2171 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2172 |
<funcdef><function>kermit_command</function></funcdef> |
<funcdef><function>kermit_command</function></funcdef> |
2173 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
2174 |
<parameter>args</parameter></paramdef> |
<parameter>args</parameter></paramdef> |
2190 |
|
|
2191 |
<para></para> |
<para></para> |
2192 |
|
|
2193 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2194 |
<funcdef><function>kermit_send</function></funcdef> |
<funcdef><function>kermit_send</function></funcdef> |
2195 |
<paramdef><parameter>dest string args</parameter></paramdef> |
<paramdef><parameter>dest string args</parameter></paramdef> |
2196 |
</funcsynopsis> |
</funcsynopsis> |
2215 |
|
|
2216 |
<para></para> |
<para></para> |
2217 |
|
|
2218 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2219 |
<funcdef><function>kermit_transmit</function></funcdef> |
<funcdef><function>kermit_transmit</function></funcdef> |
2220 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
2221 |
<parameter>file</parameter> |
<parameter>file</parameter> |
2242 |
|
|
2243 |
<para></para> |
<para></para> |
2244 |
|
|
2245 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2246 |
<funcdef><function>telnet_open</function></funcdef> |
<funcdef><function>telnet_open</function></funcdef> |
2247 |
<paramdef><parameter>hostname</parameter> |
<paramdef><parameter>hostname</parameter> |
2248 |
<parameter>args</parameter></paramdef> |
<parameter>args</parameter></paramdef> |
2264 |
|
|
2265 |
<para></para> |
<para></para> |
2266 |
|
|
2267 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2268 |
<funcdef><function>telnet_binary</function></funcdef> |
<funcdef><function>telnet_binary</function></funcdef> |
2269 |
<paramdef><parameter>hostname</parameter></paramdef> |
<paramdef><parameter>hostname</parameter></paramdef> |
2270 |
</funcsynopsis> |
</funcsynopsis> |
2281 |
|
|
2282 |
<para></para> |
<para></para> |
2283 |
|
|
2284 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2285 |
<funcdef><function>telnet_transmit</function></funcdef> |
<funcdef><function>telnet_transmit</function></funcdef> |
2286 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
2287 |
<parameter>file</parameter> |
<parameter>file</parameter> |
2308 |
|
|
2309 |
<para></para> |
<para></para> |
2310 |
|
|
2311 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2312 |
<funcdef><function>tip_open</function></funcdef> |
<funcdef><function>tip_open</function></funcdef> |
2313 |
<paramdef><parameter>hostname</parameter></paramdef> |
<paramdef><parameter>hostname</parameter></paramdef> |
2314 |
</funcsynopsis> |
</funcsynopsis> |
2325 |
|
|
2326 |
<para></para> |
<para></para> |
2327 |
|
|
2328 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2329 |
<funcdef><function>rlogin_open</function></funcdef> |
<funcdef><function>rlogin_open</function></funcdef> |
2330 |
<paramdef><parameter>arg</parameter></paramdef> |
<paramdef><parameter>arg</parameter></paramdef> |
2331 |
</funcsynopsis> |
</funcsynopsis> |
2342 |
|
|
2343 |
<para></para> |
<para></para> |
2344 |
|
|
2345 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2346 |
<funcdef><function>rlogin_spawn</function></funcdef> |
<funcdef><function>rlogin_spawn</function></funcdef> |
2347 |
<paramdef><parameter>dest</parameter> |
<paramdef><parameter>dest</parameter> |
2348 |
<parameter>cmdline</parameter></paramdef> |
<parameter>cmdline</parameter></paramdef> |
2364 |
|
|
2365 |
<para></para> |
<para></para> |
2366 |
|
|
2367 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2368 |
<funcdef><function>rsh_open</function></funcdef> |
<funcdef><function>rsh_open</function></funcdef> |
2369 |
<paramdef><parameter>hostname</parameter></paramdef> |
<paramdef><parameter>hostname</parameter></paramdef> |
2370 |
</funcsynopsis> |
</funcsynopsis> |
2381 |
|
|
2382 |
<para></para> |
<para></para> |
2383 |
|
|
2384 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2385 |
<funcdef><function>rsh_download</function></funcdef> |
<funcdef><function>rsh_download</function></funcdef> |
2386 |
<paramdef><parameter>desthost</parameter> |
<paramdef><parameter>desthost</parameter> |
2387 |
<parameter>srcfile</parameter> |
<parameter>srcfile</parameter> |
2408 |
|
|
2409 |
<para></para> |
<para></para> |
2410 |
|
|
2411 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2412 |
<funcdef><function>rsh_upload</function></funcdef> |
<funcdef><function>rsh_upload</function></funcdef> |
2413 |
<paramdef><parameter>desthost</parameter> |
<paramdef><parameter>desthost</parameter> |
2414 |
<parameter>srcfile</parameter> |
<parameter>srcfile</parameter> |
2435 |
|
|
2436 |
<para></para> |
<para></para> |
2437 |
|
|
2438 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2439 |
<funcdef><function>rsh_exec</function></funcdef> |
<funcdef><function>rsh_exec</function></funcdef> |
2440 |
<paramdef><parameter>boardname</parameter> |
<paramdef><parameter>boardname</parameter> |
2441 |
<parameter>cmd</parameter> |
<parameter>cmd</parameter> |
2462 |
|
|
2463 |
<para></para> |
<para></para> |
2464 |
|
|
2465 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2466 |
<funcdef><function>ftp_open</function></funcdef> |
<funcdef><function>ftp_open</function></funcdef> |
2467 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
2468 |
</funcsynopsis> |
</funcsynopsis> |
2479 |
|
|
2480 |
<para></para> |
<para></para> |
2481 |
|
|
2482 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2483 |
<funcdef><function>ftp_upload</function></funcdef> |
<funcdef><function>ftp_upload</function></funcdef> |
2484 |
<paramdef><parameter>host</parameter> |
<paramdef><parameter>host</parameter> |
2485 |
<parameter>remotefile</parameter> |
<parameter>remotefile</parameter> |
2506 |
|
|
2507 |
<para></para> |
<para></para> |
2508 |
|
|
2509 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2510 |
<funcdef><function>ftp_download</function></funcdef> |
<funcdef><function>ftp_download</function></funcdef> |
2511 |
<paramdef><parameter>host</parameter> |
<paramdef><parameter>host</parameter> |
2512 |
<parameter>localfile</parameter> |
<parameter>localfile</parameter> |
2533 |
|
|
2534 |
<para></para> |
<para></para> |
2535 |
|
|
2536 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2537 |
<funcdef><function>ftp_close</function></funcdef> |
<funcdef><function>ftp_close</function></funcdef> |
2538 |
<paramdef><parameter>host</parameter></paramdef> |
<paramdef><parameter>host</parameter></paramdef> |
2539 |
</funcsynopsis> |
</funcsynopsis> |
2550 |
|
|
2551 |
<para></para> |
<para></para> |
2552 |
|
|
2553 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2554 |
<funcdef><function>tip_download</function></funcdef> |
<funcdef><function>tip_download</function></funcdef> |
2555 |
<paramdef><parameter>spawnid</parameter> |
<paramdef><parameter>spawnid</parameter> |
2556 |
<parameter>file</parameter></paramdef> |
<parameter>file</parameter></paramdef> |
2587 |
|
|
2588 |
<para></para> |
<para></para> |
2589 |
|
|
2590 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2591 |
<funcdef><function>default_link</function></funcdef> |
<funcdef><function>default_link</function></funcdef> |
2592 |
<paramdef><parameter>board</parameter> |
<paramdef><parameter>board</parameter> |
2593 |
<parameter>objects</parameter> |
<parameter>objects</parameter> |
2620 |
|
|
2621 |
<para></para> |
<para></para> |
2622 |
|
|
2623 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2624 |
<funcdef><function>default_target_assemble</function></funcdef> |
<funcdef><function>default_target_assemble</function></funcdef> |
2625 |
<paramdef><parameter>source</parameter> |
<paramdef><parameter>source</parameter> |
2626 |
<parameter>destfile</parameter> |
<parameter>destfile</parameter> |
2648 |
|
|
2649 |
<para></para> |
<para></para> |
2650 |
|
|
2651 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2652 |
<funcdef><function>default_target_compile</function></funcdef> |
<funcdef><function>default_target_compile</function></funcdef> |
2653 |
<paramdef><parameter>source</parameter> |
<paramdef><parameter>source</parameter> |
2654 |
<parameter>destfile</parameter> |
<parameter>destfile</parameter> |
2680 |
|
|
2681 |
<para></para> |
<para></para> |
2682 |
|
|
2683 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2684 |
<funcdef><function>pop_config</function></funcdef> |
<funcdef><function>pop_config</function></funcdef> |
2685 |
<paramdef><parameter>type</parameter></paramdef> |
<paramdef><parameter>type</parameter></paramdef> |
2686 |
</funcsynopsis> |
</funcsynopsis> |
2697 |
|
|
2698 |
<para></para> |
<para></para> |
2699 |
|
|
2700 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2701 |
<funcdef><function>prune_warnings</function></funcdef> |
<funcdef><function>prune_warnings</function></funcdef> |
2702 |
<paramdef><parameter>text</parameter></paramdef> |
<paramdef><parameter>text</parameter></paramdef> |
2703 |
</funcsynopsis> |
</funcsynopsis> |
2714 |
|
|
2715 |
<para></para> |
<para></para> |
2716 |
|
|
2717 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2718 |
<funcdef><function>push_build</function></funcdef> |
<funcdef><function>push_build</function></funcdef> |
2719 |
<paramdef><parameter>name</parameter></paramdef> |
<paramdef><parameter>name</parameter></paramdef> |
2720 |
</funcsynopsis> |
</funcsynopsis> |
2731 |
|
|
2732 |
<para></para> |
<para></para> |
2733 |
|
|
2734 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2735 |
<funcdef><function>push_config</function></funcdef> |
<funcdef><function>push_config</function></funcdef> |
2736 |
<paramdef><parameter>type</parameter> |
<paramdef><parameter>type</parameter> |
2737 |
<parameter>name</parameter></paramdef> |
<parameter>name</parameter></paramdef> |
2753 |
|
|
2754 |
<para></para> |
<para></para> |
2755 |
|
|
2756 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2757 |
<funcdef><function>reboot_target</function></funcdef> |
<funcdef><function>reboot_target</function></funcdef> |
2758 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
2759 |
</funcsynopsis> |
</funcsynopsis> |
2764 |
|
|
2765 |
<para></para> |
<para></para> |
2766 |
|
|
2767 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2768 |
<funcdef><function>target_assemble</function></funcdef> |
<funcdef><function>target_assemble</function></funcdef> |
2769 |
<paramdef><parameter>source destfile flags</parameter></paramdef> |
<paramdef><parameter>source destfile flags</parameter></paramdef> |
2770 |
</funcsynopsis> |
</funcsynopsis> |
2789 |
|
|
2790 |
<para></para> |
<para></para> |
2791 |
|
|
2792 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2793 |
<funcdef><function>target_compile</function></funcdef> |
<funcdef><function>target_compile</function></funcdef> |
2794 |
<paramdef><parameter>source</parameter> |
<paramdef><parameter>source</parameter> |
2795 |
<parameter>destfile</parameter> |
<parameter>destfile</parameter> |
2825 |
|
|
2826 |
<para></para> |
<para></para> |
2827 |
|
|
2828 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2829 |
<funcdef><function>board_info</function></funcdef> |
<funcdef><function>board_info</function></funcdef> |
2830 |
<paramdef><parameter>machine</parameter> |
<paramdef><parameter>machine</parameter> |
2831 |
<parameter>op</parameter> |
<parameter>op</parameter> |
2852 |
|
|
2853 |
<para></para> |
<para></para> |
2854 |
|
|
2855 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2856 |
<funcdef><function>host_info</function></funcdef> |
<funcdef><function>host_info</function></funcdef> |
2857 |
<paramdef><parameter>op</parameter> |
<paramdef><parameter>op</parameter> |
2858 |
<parameter>args</parameter></paramdef> |
<parameter>args</parameter></paramdef> |
2874 |
|
|
2875 |
<para></para> |
<para></para> |
2876 |
|
|
2877 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2878 |
<funcdef><function>set_board_info</function></funcdef> |
<funcdef><function>set_board_info</function></funcdef> |
2879 |
<paramdef><parameter>entry</parameter> |
<paramdef><parameter>entry</parameter> |
2880 |
<parameter>value</parameter></paramdef> |
<parameter>value</parameter></paramdef> |
2897 |
|
|
2898 |
<para></para> |
<para></para> |
2899 |
|
|
2900 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2901 |
<funcdef><function>set_currtarget_info</function></funcdef> |
<funcdef><function>set_currtarget_info</function></funcdef> |
2902 |
<paramdef><parameter>entry</parameter> |
<paramdef><parameter>entry</parameter> |
2903 |
<parameter>value</parameter></paramdef> |
<parameter>value</parameter></paramdef> |
2919 |
|
|
2920 |
<para></para> |
<para></para> |
2921 |
|
|
2922 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2923 |
<funcdef><function>target_info</function></funcdef> |
<funcdef><function>target_info</function></funcdef> |
2924 |
<paramdef><parameter>op</parameter> |
<paramdef><parameter>op</parameter> |
2925 |
<parameter>args</parameter></paramdef> |
<parameter>args</parameter></paramdef> |
2941 |
|
|
2942 |
<para></para> |
<para></para> |
2943 |
|
|
2944 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2945 |
<funcdef><function>unset_board_info</function></funcdef> |
<funcdef><function>unset_board_info</function></funcdef> |
2946 |
<paramdef><parameter>entry</parameter></paramdef> |
<paramdef><parameter>entry</parameter></paramdef> |
2947 |
</funcsynopsis> |
</funcsynopsis> |
2959 |
|
|
2960 |
<para></para> |
<para></para> |
2961 |
|
|
2962 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2963 |
<funcdef><function>unset_currtarget_info</function></funcdef> |
<funcdef><function>unset_currtarget_info</function></funcdef> |
2964 |
<paramdef><parameter>entry</parameter></paramdef> |
<paramdef><parameter>entry</parameter></paramdef> |
2965 |
</funcsynopsis> |
</funcsynopsis> |
2979 |
an index into the <symbol>target_info</symbol> array and is set in |
an index into the <symbol>target_info</symbol> array and is set in |
2980 |
the global config file.</para> |
the global config file.</para> |
2981 |
|
|
2982 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
2983 |
<funcdef><function>push_target</function></funcdef> |
<funcdef><function>push_target</function></funcdef> |
2984 |
<paramdef><parameter>name</parameter></paramdef> |
<paramdef><parameter>name</parameter></paramdef> |
2985 |
</funcsynopsis> |
</funcsynopsis> |
2997 |
|
|
2998 |
<para>This unsets the current target connection.</para> |
<para>This unsets the current target connection.</para> |
2999 |
|
|
3000 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3001 |
<funcdef><function>pop_target</function></funcdef> |
<funcdef><function>pop_target</function></funcdef> |
3002 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3003 |
</funcsynopsis> |
</funcsynopsis> |
3009 |
<para>This lists all the supported targets for this |
<para>This lists all the supported targets for this |
3010 |
architecture.</para> |
architecture.</para> |
3011 |
|
|
3012 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3013 |
<funcdef><function>list_targets</function></funcdef> |
<funcdef><function>list_targets</function></funcdef> |
3014 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3015 |
</funcsynopsis> |
</funcsynopsis> |
3024 |
<symbol>target_info</symbol> array and is set in the global config |
<symbol>target_info</symbol> array and is set in the global config |
3025 |
file.</para> |
file.</para> |
3026 |
|
|
3027 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3028 |
<funcdef><function>push_host</function></funcdef> |
<funcdef><function>push_host</function></funcdef> |
3029 |
<paramdef><parameter>name</parameter></paramdef> |
<paramdef><parameter>name</parameter></paramdef> |
3030 |
</funcsynopsis> |
</funcsynopsis> |
3041 |
|
|
3042 |
<para>This unsets the current host connection.</para> |
<para>This unsets the current host connection.</para> |
3043 |
|
|
3044 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3045 |
<funcdef><function>pop_host</function></funcdef> |
<funcdef><function>pop_host</function></funcdef> |
3046 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3047 |
</funcsynopsis> |
</funcsynopsis> |
3050 |
<sect3 id=compile xreflabel="compile procedure"> |
<sect3 id=compile xreflabel="compile procedure"> |
3051 |
<title>Compile Procedure</title> |
<title>Compile Procedure</title> |
3052 |
|
|
3053 |
<para>This invokes the compiler as set by CC to compile the |
<para>This invokes the compiler as set by CC to compile the |
3054 |
file <filename>file</filename>. The default options for many cross |
file <filename>file</filename>. The default options for many cross |
3055 |
compilation targets are <emphasis>guessed</emphasis> by DejaGnu, and |
compilation targets are <emphasis>guessed</emphasis> by DejaGnu, and |
3056 |
these options can be added to by passing in more parameters as |
these options can be added to by passing in more parameters as |
3060 |
then compiler is run on the remote host using |
then compiler is run on the remote host using |
3061 |
<command>execute_anywhere</command>.</para> |
<command>execute_anywhere</command>.</para> |
3062 |
|
|
3063 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3064 |
<funcdef><function>compile</function></funcdef> |
<funcdef><function>compile</function></funcdef> |
3065 |
<paramdef><parameter>file</parameter></paramdef> |
<paramdef><parameter>file</parameter></paramdef> |
3066 |
</funcsynopsis> |
</funcsynopsis> |
3082 |
host is not the same as the build machines, then then archiver is run |
host is not the same as the build machines, then then archiver is run |
3083 |
on the remote host using <command>execute_anywhere</command>.</para> |
on the remote host using <command>execute_anywhere</command>.</para> |
3084 |
|
|
3085 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3086 |
<funcdef><function>archive</function></funcdef> |
<funcdef><function>archive</function></funcdef> |
3087 |
<paramdef><parameter>file</parameter></paramdef> |
<paramdef><parameter>file</parameter></paramdef> |
3088 |
</funcsynopsis> |
</funcsynopsis> |
3101 |
aren't POSIX yet. Any parameters passed to <command>ranlib</command> |
aren't POSIX yet. Any parameters passed to <command>ranlib</command> |
3102 |
are used in for the flags.</para> |
are used in for the flags.</para> |
3103 |
|
|
3104 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3105 |
<funcdef><function>ranlib</function></funcdef> |
<funcdef><function>ranlib</function></funcdef> |
3106 |
<paramdef><parameter>file</parameter></paramdef> |
<paramdef><parameter>file</parameter></paramdef> |
3107 |
</funcsynopsis> |
</funcsynopsis> |
3128 |
output produced when the command was executed. This is used for |
output produced when the command was executed. This is used for |
3129 |
running the tool to be tested, not a test case.</para> |
running the tool to be tested, not a test case.</para> |
3130 |
|
|
3131 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3132 |
<funcdef><function>execute_anywhere</function></funcdef> |
<funcdef><function>execute_anywhere</function></funcdef> |
3133 |
<paramdef><parameter>cmdline</parameter></paramdef> |
<paramdef><parameter>cmdline</parameter></paramdef> |
3134 |
</funcsynopsis> |
</funcsynopsis> |
3193 |
<function>${tool}_start</function> (or makes other |
<function>${tool}_start</function> (or makes other |
3194 |
arrangements to run the tool).</para> |
arrangements to run the tool).</para> |
3195 |
|
|
3196 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3197 |
<funcdef><function>${tool}_start</function></funcdef> |
<funcdef><function>${tool}_start</function></funcdef> |
3198 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3199 |
</funcsynopsis> |
</funcsynopsis> |
3219 |
downloading. Test scripts call |
downloading. Test scripts call |
3220 |
<function>${tool}_load</function>.</para> |
<function>${tool}_load</function>.</para> |
3221 |
|
|
3222 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3223 |
<funcdef><function>${tool}_load</function></funcdef> |
<funcdef><function>${tool}_load</function></funcdef> |
3224 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3225 |
</funcsynopsis> |
</funcsynopsis> |
3233 |
session. You can also use <function>${tool}_exit</function> |
session. You can also use <function>${tool}_exit</function> |
3234 |
to remove any temporary files left over from the |
to remove any temporary files left over from the |
3235 |
tests. <command>runtest</command> calls |
tests. <command>runtest</command> calls |
3236 |
<function>${tool}_exit</function>.</para> |
<function>${tool}_exit</function>.</para> |
3237 |
|
|
3238 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3239 |
<funcdef><function>${tool}_exit</function></funcdef> |
<funcdef><function>${tool}_exit</function></funcdef> |
3240 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3241 |
</funcsynopsis> |
</funcsynopsis> |
3250 |
should consist of the full path name used for the tested |
should consist of the full path name used for the tested |
3251 |
tool, and its version number.</para> |
tool, and its version number.</para> |
3252 |
|
|
3253 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3254 |
<funcdef><function>${tool}_version</function></funcdef> |
<funcdef><function>${tool}_version</function></funcdef> |
3255 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3256 |
</funcsynopsis> |
</funcsynopsis> |
3268 |
directory a single directory that match an optional |
directory a single directory that match an optional |
3269 |
pattern. </para> |
pattern. </para> |
3270 |
|
|
3271 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3272 |
<funcdef><function>getdirs</function></funcdef> |
<funcdef><function>getdirs</function></funcdef> |
3273 |
<paramdef><parameter>rootdir</parameter> |
<paramdef><parameter>rootdir</parameter> |
3274 |
<parameter>pattern</parameter></paramdef> |
<parameter>pattern</parameter></paramdef> |
3302 |
result include all intervening subdirectory names. If no files match |
result include all intervening subdirectory names. If no files match |
3303 |
the pattern, then a NULL string is returned.</para> |
the pattern, then a NULL string is returned.</para> |
3304 |
|
|
3305 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3306 |
<funcdef><function>find</function></funcdef> |
<funcdef><function>find</function></funcdef> |
3307 |
<paramdef><parameter>rootdir</parameter> |
<paramdef><parameter>rootdir</parameter> |
3308 |
<parameter>pattern</parameter></paramdef> |
<parameter>pattern</parameter></paramdef> |
3330 |
<emphasis>PATH</emphasis>. It returns <emphasis>0</emphasis> if the |
<emphasis>PATH</emphasis>. It returns <emphasis>0</emphasis> if the |
3331 |
binary is not in the path, or if there is no <emphasis>PATH</emphasis> |
binary is not in the path, or if there is no <emphasis>PATH</emphasis> |
3332 |
environment variable. If <command>binary</command> is in the path, it |
environment variable. If <command>binary</command> is in the path, it |
3333 |
returns the full path to <command>binary</command>.</para> |
returns the full path to <command>binary</command>.</para> |
3334 |
|
|
3335 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3336 |
<funcdef><function>which</function></funcdef> |
<funcdef><function>which</function></funcdef> |
3337 |
<paramdef><parameter>file</parameter></paramdef> |
<paramdef><parameter>file</parameter></paramdef> |
3338 |
</funcsynopsis> |
</funcsynopsis> |
3353 |
<emphasis>regexp</emphasis>. The result is a list of all the lines that |
<emphasis>regexp</emphasis>. The result is a list of all the lines that |
3354 |
match. If no lines match, the result is an empty string. Specify |
match. If no lines match, the result is an empty string. Specify |
3355 |
<emphasis>regexp</emphasis> using the standard regular expression style |
<emphasis>regexp</emphasis> using the standard regular expression style |
3356 |
used by the Unix utility program grep.</para> |
used by the Unix utility program grep.</para> |
3357 |
|
|
3358 |
<para>Use the optional third argument <emphasis>line</emphasis> to |
<para>Use the optional third argument <emphasis>line</emphasis> to |
3359 |
start lines in the result with the line number in |
start lines in the result with the line number in |
3360 |
<filename>filename</filename>. (This argument is simply an option |
<filename>filename</filename>. (This argument is simply an option |
3361 |
flag; type it just as shown <option>--line</option>.)</para> |
flag; type it just as shown <option>--line</option>.)</para> |
3362 |
|
|
3363 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3364 |
<funcdef><function>grep</function></funcdef> |
<funcdef><function>grep</function></funcdef> |
3365 |
<paramdef><parameter>filename</parameter> |
<paramdef><parameter>filename</parameter> |
3366 |
<parameter>regexp</parameter> |
<parameter>regexp</parameter> |
3375 |
<term><parameter>regexp</parameter></term> |
<term><parameter>regexp</parameter></term> |
3376 |
<listitem><para>The Unix style regular expression (as used by the |
<listitem><para>The Unix style regular expression (as used by the |
3377 |
<command>grep</command> Unix utility) to search |
<command>grep</command> Unix utility) to search |
3378 |
for.</para></listitem> |
for.</para></listitem> |
3379 |
</varlistentry> |
</varlistentry> |
3380 |
<varlistentry> |
<varlistentry> |
3381 |
<term><parameter>--line</parameter></term> |
<term><parameter>--line</parameter></term> |
3382 |
<listitem><para>Prefix the line number to each line where the |
<listitem><para>Prefix the line number to each line where the |
3383 |
regexp matches.</para></listitem> |
regexp matches.</para></listitem> |
3384 |
</varlistentry> |
</varlistentry> |
3385 |
</variablelist> |
</variablelist> |
3386 |
</sect3> |
</sect3> |
3392 |
Elements are fields delimited by spaces. The result is a copy of |
Elements are fields delimited by spaces. The result is a copy of |
3393 |
list, without any elements that match <emphasis>pattern</emphasis>. |
list, without any elements that match <emphasis>pattern</emphasis>. |
3394 |
You can use the common shell wildcard characters to specify the |
You can use the common shell wildcard characters to specify the |
3395 |
pattern.</para> |
pattern.</para> |
3396 |
|
|
3397 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3398 |
<funcdef><function>prune</function></funcdef> |
<funcdef><function>prune</function></funcdef> |
3399 |
<paramdef><parameter>list</parameter> |
<paramdef><parameter>list</parameter> |
3400 |
<parameter>pattern</parameter></paramdef> |
<parameter>pattern</parameter></paramdef> |
3423 |
under Windows if you have Cygwin or another Unix subsystem for Windows |
under Windows if you have Cygwin or another Unix subsystem for Windows |
3424 |
installed.</para> |
installed.</para> |
3425 |
|
|
3426 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3427 |
<funcdef><function>slay</function></funcdef> |
<funcdef><function>slay</function></funcdef> |
3428 |
<paramdef><parameter>name</parameter></paramdef> |
<paramdef><parameter>name</parameter></paramdef> |
3429 |
</funcsynopsis> |
</funcsynopsis> |
3442 |
<para>This procedure takes the relative <emphasis>path</emphasis>, |
<para>This procedure takes the relative <emphasis>path</emphasis>, |
3443 |
and converts it to an absolute path.</para> |
and converts it to an absolute path.</para> |
3444 |
|
|
3445 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3446 |
<funcdef><function>absolute</function></funcdef> |
<funcdef><function>absolute</function></funcdef> |
3447 |
<paramdef><parameter>path</parameter></paramdef> |
<paramdef><parameter>path</parameter></paramdef> |
3448 |
</funcsynopsis> |
</funcsynopsis> |
3462 |
error it returns a <emphasis>1</emphasis>, otherwise it returns a |
error it returns a <emphasis>1</emphasis>, otherwise it returns a |
3463 |
<emphasis>0</emphasis>.</para> |
<emphasis>0</emphasis>.</para> |
3464 |
|
|
3465 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3466 |
<funcdef><function>psource</function></funcdef> |
<funcdef><function>psource</function></funcdef> |
3467 |
<paramdef><parameter>file</parameter></paramdef> |
<paramdef><parameter>file</parameter></paramdef> |
3468 |
</funcsynopsis> |
</funcsynopsis> |
3488 |
pathname of the current testcase under consideration. This is used |
pathname of the current testcase under consideration. This is used |
3489 |
by tools like compilers where each testcase is a file.</para> |
by tools like compilers where each testcase is a file.</para> |
3490 |
|
|
3491 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3492 |
<funcdef><function>runtest_file_p</function></funcdef> |
<funcdef><function>runtest_file_p</function></funcdef> |
3493 |
<paramdef><parameter>runtests</parameter> |
<paramdef><parameter>runtests</parameter> |
3494 |
<parameter>testcase</parameter></paramdef> |
<parameter>testcase</parameter></paramdef> |
3497 |
<varlistentry> |
<varlistentry> |
3498 |
<term><parameter>runtests</parameter></term> |
<term><parameter>runtests</parameter></term> |
3499 |
<listitem><para>The list of patterns to compare against. |
<listitem><para>The list of patterns to compare against. |
3500 |
</para></listitem> |
</para></listitem> |
3501 |
</varlistentry> |
</varlistentry> |
3502 |
<varlistentry> |
<varlistentry> |
3503 |
<term><parameter>testcase</parameter></term> |
<term><parameter>testcase</parameter></term> |
3514 |
<symbol>verbose</symbol> is set, then it'll print the differences to |
<symbol>verbose</symbol> is set, then it'll print the differences to |
3515 |
the screen.</para> |
the screen.</para> |
3516 |
|
|
3517 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3518 |
<funcdef><function>diff</function></funcdef> |
<funcdef><function>diff</function></funcdef> |
3519 |
<paramdef><parameter>file_1</parameter> |
<paramdef><parameter>file_1</parameter> |
3520 |
<parameter>file_2</parameter></paramdef> |
<parameter>file_2</parameter></paramdef> |
3537 |
<para>Sets the environment variable <emphasis>var</emphasis> to the |
<para>Sets the environment variable <emphasis>var</emphasis> to the |
3538 |
value <emphasis>val</emphasis>.</para> |
value <emphasis>val</emphasis>.</para> |
3539 |
|
|
3540 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3541 |
<funcdef><function>setenv</function></funcdef> |
<funcdef><function>setenv</function></funcdef> |
3542 |
<paramdef><parameter>var</parameter> |
<paramdef><parameter>var</parameter> |
3543 |
<parameter>val</parameter></paramdef> |
<parameter>val</parameter></paramdef> |
3560 |
<para>Unsets the environment variable |
<para>Unsets the environment variable |
3561 |
<emphasis>var</emphasis>.</para> |
<emphasis>var</emphasis>.</para> |
3562 |
|
|
3563 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3564 |
<funcdef><function>unsetenv</function></funcdef> |
<funcdef><function>unsetenv</function></funcdef> |
3565 |
<paramdef><parameter>var</parameter></paramdef> |
<paramdef><parameter>var</parameter></paramdef> |
3566 |
</funcsynopsis> |
</funcsynopsis> |
3579 |
<para>Returns the value of <emphasis>var</emphasis> in the |
<para>Returns the value of <emphasis>var</emphasis> in the |
3580 |
environment if it exists, otherwise it returns NULL.</para> |
environment if it exists, otherwise it returns NULL.</para> |
3581 |
|
|
3582 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3583 |
<funcdef><function>getenv</function></funcdef> |
<funcdef><function>getenv</function></funcdef> |
3584 |
<paramdef><parameter>var</parameter></paramdef> |
<paramdef><parameter>var</parameter></paramdef> |
3585 |
</funcsynopsis> |
</funcsynopsis> |
3601 |
is the message that is printed if a shared library is out of |
is the message that is printed if a shared library is out of |
3602 |
date.</para> |
date.</para> |
3603 |
|
|
3604 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3605 |
<funcdef><function>prune_system_crud</function></funcdef> |
<funcdef><function>prune_system_crud</function></funcdef> |
3606 |
<paramdef><parameter>system</parameter> |
<paramdef><parameter>system</parameter> |
3607 |
<parameter>test</parameter></paramdef> |
<parameter>test</parameter></paramdef> |
3634 |
|
|
3635 |
<para></para> |
<para></para> |
3636 |
|
|
3637 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3638 |
<funcdef><function>libgloss_link_flags</function></funcdef> |
<funcdef><function>libgloss_link_flags</function></funcdef> |
3639 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3640 |
</funcsynopsis> |
</funcsynopsis> |
3652 |
|
|
3653 |
<para></para> |
<para></para> |
3654 |
|
|
3655 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3656 |
<funcdef><function>libgloss_include_flags</function></funcdef> |
<funcdef><function>libgloss_include_flags</function></funcdef> |
3657 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3658 |
</funcsynopsis> |
</funcsynopsis> |
3669 |
|
|
3670 |
<para></para> |
<para></para> |
3671 |
|
|
3672 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3673 |
<funcdef><function>newlib_link_flags</function></funcdef> |
<funcdef><function>newlib_link_flags</function></funcdef> |
3674 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3675 |
</funcsynopsis> |
</funcsynopsis> |
3687 |
|
|
3688 |
<para></para> |
<para></para> |
3689 |
|
|
3690 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3691 |
<funcdef><function>newlib_include_flags</function></funcdef> |
<funcdef><function>newlib_include_flags</function></funcdef> |
3692 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3693 |
</funcsynopsis> |
</funcsynopsis> |
3705 |
|
|
3706 |
<para></para> |
<para></para> |
3707 |
|
|
3708 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3709 |
<funcdef><function>libio_include_flags</function></funcdef> |
<funcdef><function>libio_include_flags</function></funcdef> |
3710 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3711 |
</funcsynopsis> |
</funcsynopsis> |
3722 |
|
|
3723 |
<para></para> |
<para></para> |
3724 |
|
|
3725 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3726 |
<funcdef><function>libio_link_flags</function></funcdef> |
<funcdef><function>libio_link_flags</function></funcdef> |
3727 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3728 |
</funcsynopsis> |
</funcsynopsis> |
3739 |
|
|
3740 |
<para></para> |
<para></para> |
3741 |
|
|
3742 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3743 |
<funcdef><function>g++_include_flags</function></funcdef> |
<funcdef><function>g++_include_flags</function></funcdef> |
3744 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3745 |
</funcsynopsis> |
</funcsynopsis> |
3756 |
|
|
3757 |
<para></para> |
<para></para> |
3758 |
|
|
3759 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3760 |
<funcdef><function>g++_link_flags</function></funcdef> |
<funcdef><function>g++_link_flags</function></funcdef> |
3761 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3762 |
</funcsynopsis> |
</funcsynopsis> |
3774 |
|
|
3775 |
<para></para> |
<para></para> |
3776 |
|
|
3777 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3778 |
<funcdef><function>libstdc++_include_flags</function></funcdef> |
<funcdef><function>libstdc++_include_flags</function></funcdef> |
3779 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3780 |
</funcsynopsis> |
</funcsynopsis> |
3792 |
|
|
3793 |
<para></para> |
<para></para> |
3794 |
|
|
3795 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3796 |
<funcdef><function>libstdc++_link_flags</function></funcdef> |
<funcdef><function>libstdc++_link_flags</function></funcdef> |
3797 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3798 |
</funcsynopsis> |
</funcsynopsis> |
3809 |
|
|
3810 |
<para></para> |
<para></para> |
3811 |
|
|
3812 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3813 |
<funcdef><function>get_multilibs</function></funcdef> |
<funcdef><function>get_multilibs</function></funcdef> |
3814 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3815 |
</funcsynopsis> |
</funcsynopsis> |
3826 |
|
|
3827 |
<para></para> |
<para></para> |
3828 |
|
|
3829 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3830 |
<funcdef><function>find_binutils_prog</function></funcdef> |
<funcdef><function>find_binutils_prog</function></funcdef> |
3831 |
<paramdef><parameter>name</parameter></paramdef> |
<paramdef><parameter>name</parameter></paramdef> |
3832 |
</funcsynopsis> |
</funcsynopsis> |
3843 |
|
|
3844 |
<para></para> |
<para></para> |
3845 |
|
|
3846 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3847 |
<funcdef><function>find_gcc</function></funcdef> |
<funcdef><function>find_gcc</function></funcdef> |
3848 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3849 |
</funcsynopsis> |
</funcsynopsis> |
3854 |
|
|
3855 |
<para></para> |
<para></para> |
3856 |
|
|
3857 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3858 |
<funcdef><function>find_gcj</function></funcdef> |
<funcdef><function>find_gcj</function></funcdef> |
3859 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3860 |
</funcsynopsis> |
</funcsynopsis> |
3865 |
|
|
3866 |
<para></para> |
<para></para> |
3867 |
|
|
3868 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3869 |
<funcdef><function>find_g++</function></funcdef> |
<funcdef><function>find_g++</function></funcdef> |
3870 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3871 |
</funcsynopsis> |
</funcsynopsis> |
3876 |
|
|
3877 |
<para></para> |
<para></para> |
3878 |
|
|
3879 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3880 |
<funcdef><function>find_g77</function></funcdef> |
<funcdef><function>find_g77</function></funcdef> |
3881 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3882 |
</funcsynopsis> |
</funcsynopsis> |
3888 |
|
|
3889 |
<para></para> |
<para></para> |
3890 |
|
|
3891 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3892 |
<funcdef><function>process_multilib_options</function></funcdef> |
<funcdef><function>process_multilib_options</function></funcdef> |
3893 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3894 |
</funcsynopsis> |
</funcsynopsis> |
3906 |
|
|
3907 |
<para></para> |
<para></para> |
3908 |
|
|
3909 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3910 |
<funcdef><function>add_multilib_option</function></funcdef> |
<funcdef><function>add_multilib_option</function></funcdef> |
3911 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3912 |
</funcsynopsis> |
</funcsynopsis> |
3923 |
|
|
3924 |
<para></para> |
<para></para> |
3925 |
|
|
3926 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3927 |
<funcdef><function>find_gas</function></funcdef> |
<funcdef><function>find_gas</function></funcdef> |
3928 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3929 |
</funcsynopsis> |
</funcsynopsis> |
3934 |
|
|
3935 |
<para></para> |
<para></para> |
3936 |
|
|
3937 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3938 |
<funcdef><function>find_ld</function></funcdef> |
<funcdef><function>find_ld</function></funcdef> |
3939 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
3940 |
</funcsynopsis> |
</funcsynopsis> |
3945 |
|
|
3946 |
<para></para> |
<para></para> |
3947 |
|
|
3948 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3949 |
<funcdef><function>build_wrapper</function></funcdef> |
<funcdef><function>build_wrapper</function></funcdef> |
3950 |
<paramdef><parameter>gluefile</parameter></paramdef> |
<paramdef><parameter>gluefile</parameter></paramdef> |
3951 |
</funcsynopsis> |
</funcsynopsis> |
3963 |
|
|
3964 |
<para></para> |
<para></para> |
3965 |
|
|
3966 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3967 |
<funcdef><function>winsup_include_flags</function></funcdef> |
<funcdef><function>winsup_include_flags</function></funcdef> |
3968 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3969 |
</funcsynopsis> |
</funcsynopsis> |
3980 |
|
|
3981 |
<para></para> |
<para></para> |
3982 |
|
|
3983 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
3984 |
<funcdef><function>winsup_link_flags</function></funcdef> |
<funcdef><function>winsup_link_flags</function></funcdef> |
3985 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
3986 |
</funcsynopsis> |
</funcsynopsis> |
4006 |
the values of the global variable names that match. It is abbreviated |
the values of the global variable names that match. It is abbreviated |
4007 |
as <emphasis>dv</emphasis>.</para> |
as <emphasis>dv</emphasis>.</para> |
4008 |
|
|
4009 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4010 |
<funcdef><function>dumpvars</function></funcdef> |
<funcdef><function>dumpvars</function></funcdef> |
4011 |
<paramdef><parameter>vars</parameter></paramdef> |
<paramdef><parameter>vars</parameter></paramdef> |
4012 |
</funcsynopsis> |
</funcsynopsis> |
4025 |
prints the values of the local variable names that match. It is |
prints the values of the local variable names that match. It is |
4026 |
abbreviated as <emphasis>dl</emphasis>.</para> |
abbreviated as <emphasis>dl</emphasis>.</para> |
4027 |
|
|
4028 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4029 |
<funcdef><function>dumplocals</function></funcdef> |
<funcdef><function>dumplocals</function></funcdef> |
4030 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
4031 |
</funcsynopsis> |
</funcsynopsis> |
4044 |
prints the body of all procs that match. It is abbreviated as |
prints the body of all procs that match. It is abbreviated as |
4045 |
<emphasis>dp</emphasis>.</para> |
<emphasis>dp</emphasis>.</para> |
4046 |
|
|
4047 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4048 |
<funcdef><function>dumprocs</function></funcdef> |
<funcdef><function>dumprocs</function></funcdef> |
4049 |
<paramdef><parameter>pattern</parameter></paramdef> |
<paramdef><parameter>pattern</parameter></paramdef> |
4050 |
</funcsynopsis> |
</funcsynopsis> |
4064 |
prints all the watchpoints. It is abbreviated as |
prints all the watchpoints. It is abbreviated as |
4065 |
<emphasis>dw</emphasis>.</para> |
<emphasis>dw</emphasis>.</para> |
4066 |
|
|
4067 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4068 |
<funcdef><function>dumpwatch</function></funcdef> |
<funcdef><function>dumpwatch</function></funcdef> |
4069 |
<paramdef><parameter>pattern</parameter></paramdef> |
<paramdef><parameter>pattern</parameter></paramdef> |
4070 |
</funcsynopsis> |
</funcsynopsis> |
4082 |
|
|
4083 |
<para></para> |
<para></para> |
4084 |
|
|
4085 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4086 |
<funcdef><function>watcharray</function></funcdef> |
<funcdef><function>watcharray</function></funcdef> |
4087 |
<paramdef><parameter>element</parameter> |
<paramdef><parameter>element</parameter> |
4088 |
<parameter>type</parameter></paramdef> |
<parameter>type</parameter></paramdef> |
4101 |
|
|
4102 |
<para></para> |
<para></para> |
4103 |
|
|
4104 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4105 |
<funcdef><function>watchvar</function></funcdef> |
<funcdef><function>watchvar</function></funcdef> |
4106 |
<paramdef><parameter>var</parameter> |
<paramdef><parameter>var</parameter> |
4107 |
<parameter>type</parameter></paramdef> |
<parameter>type</parameter></paramdef> |
4121 |
<symbol>var</symbol> is unset. It is abbreviated as |
<symbol>var</symbol> is unset. It is abbreviated as |
4122 |
<emphasis>wu</emphasis>.</para> |
<emphasis>wu</emphasis>.</para> |
4123 |
|
|
4124 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4125 |
<funcdef><function>watchunset</function></funcdef> |
<funcdef><function>watchunset</function></funcdef> |
4126 |
<paramdef><parameter>arg</parameter></paramdef> |
<paramdef><parameter>arg</parameter></paramdef> |
4127 |
</funcsynopsis> |
</funcsynopsis> |
4138 |
|
|
4139 |
<para>This breaks program execution when the variable |
<para>This breaks program execution when the variable |
4140 |
<symbol>var</symbol> is written. It is abbreviated as |
<symbol>var</symbol> is written. It is abbreviated as |
4141 |
<emphasis>ww</emphasis>.</para> |
<emphasis>ww</emphasis>.</para> |
4142 |
|
|
4143 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4144 |
<funcdef><function>watchwrite</function></funcdef> |
<funcdef><function>watchwrite</function></funcdef> |
4145 |
<paramdef><parameter>var</parameter></paramdef> |
<paramdef><parameter>var</parameter></paramdef> |
4146 |
</funcsynopsis> |
</funcsynopsis> |
4159 |
<symbol>var</symbol> is read. It is abbreviated as |
<symbol>var</symbol> is read. It is abbreviated as |
4160 |
<emphasis>wr</emphasis>.</para> |
<emphasis>wr</emphasis>.</para> |
4161 |
|
|
4162 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4163 |
<funcdef><function>watchread</function></funcdef> |
<funcdef><function>watchread</function></funcdef> |
4164 |
<paramdef><parameter>var</parameter></paramdef> |
<paramdef><parameter>var</parameter></paramdef> |
4165 |
</funcsynopsis> |
</funcsynopsis> |
4177 |
<para>This deletes a the watchpoint from the watch list. It is |
<para>This deletes a the watchpoint from the watch list. It is |
4178 |
abbreviated as <emphasis>wd</emphasis>.</para> |
abbreviated as <emphasis>wd</emphasis>.</para> |
4179 |
|
|
4180 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4181 |
<funcdef><function>watchdel</function></funcdef> |
<funcdef><function>watchdel</function></funcdef> |
4182 |
<paramdef><parameter>args</parameter></paramdef> |
<paramdef><parameter>args</parameter></paramdef> |
4183 |
</funcsynopsis> |
</funcsynopsis> |
4196 |
<parameter>var</parameter>. It is abbreviated as |
<parameter>var</parameter>. It is abbreviated as |
4197 |
<emphasis>p</emphasis>.</para> |
<emphasis>p</emphasis>.</para> |
4198 |
|
|
4199 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4200 |
<funcdef><function>print</function></funcdef> |
<funcdef><function>print</function></funcdef> |
4201 |
<paramdef><parameter>var</parameter></paramdef> |
<paramdef><parameter>var</parameter></paramdef> |
4202 |
</funcsynopsis> |
</funcsynopsis> |
4214 |
<para>This makes runtest exit. It is abbreviated as |
<para>This makes runtest exit. It is abbreviated as |
4215 |
<emphasis>q</emphasis>.</para> |
<emphasis>q</emphasis>.</para> |
4216 |
|
|
4217 |
<funcsynopsis role="tcl"> |
<funcsynopsis role="tcl"> |
4218 |
<funcdef><function>quit</function></funcdef> |
<funcdef><function>quit</function></funcdef> |
4219 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
4220 |
</funcsynopsis> |
</funcsynopsis> |
4272 |
|
|
4273 |
<sect1 id=cunit xreflabel="C Unit Testing API"> |
<sect1 id=cunit xreflabel="C Unit Testing API"> |
4274 |
<title>C Unit Testing API</title> |
<title>C Unit Testing API</title> |
4275 |
|
|
4276 |
<para>All of the functions that take a |
<para>All of the functions that take a |
4277 |
<parameter>msg</parameter> parameter use a C char * that is |
<parameter>msg</parameter> parameter use a C char * that is |
4278 |
the message to be dislayed. There currently is no support for |
the message to be dislayed. There currently is no support for |
4281 |
|
|
4282 |
<sect2 id=passfunc xreflabel="pass function"> |
<sect2 id=passfunc xreflabel="pass function"> |
4283 |
<title>Pass Function</title> |
<title>Pass Function</title> |
4284 |
|
|
4285 |
<para>This prints a message for a successful test |
<para>This prints a message for a successful test |
4286 |
completion.</para> |
completion.</para> |
4287 |
|
|
4288 |
<funcsynopsis role="C"> |
<funcsynopsis role="C"> |
4289 |
<funcdef><function>pass</function></funcdef> |
<funcdef><function>pass</function></funcdef> |
4290 |
<paramdef><parameter>msg</parameter></paramdef> |
<paramdef><parameter>msg</parameter></paramdef> |
4291 |
</funcsynopsis> |
</funcsynopsis> |
4294 |
|
|
4295 |
<sect2 id=failfunc xreflabel="fail function"> |
<sect2 id=failfunc xreflabel="fail function"> |
4296 |
<title>Fail Function</title> |
<title>Fail Function</title> |
4297 |
|
|
4298 |
<para>This prints a message for an unsuccessful test |
<para>This prints a message for an unsuccessful test |
4299 |
completion.</para> |
completion.</para> |
4300 |
|
|
4301 |
<funcsynopsis role="C"> |
<funcsynopsis role="C"> |
4302 |
<funcdef><function>fail</function></funcdef> |
<funcdef><function>fail</function></funcdef> |
4303 |
<paramdef><parameter>msg</parameter></paramdef> |
<paramdef><parameter>msg</parameter></paramdef> |
4304 |
</funcsynopsis> |
</funcsynopsis> |
4311 |
<para>This prints a message for an test case that isn't run |
<para>This prints a message for an test case that isn't run |
4312 |
for some technical reason.</para> |
for some technical reason.</para> |
4313 |
|
|
4314 |
<funcsynopsis role="C"> |
<funcsynopsis role="C"> |
4315 |
<funcdef><function>untested</function></funcdef> |
<funcdef><function>untested</function></funcdef> |
4316 |
<paramdef><parameter>msg</parameter></paramdef> |
<paramdef><parameter>msg</parameter></paramdef> |
4317 |
</funcsynopsis> |
</funcsynopsis> |
4325 |
human to look over the results to determine what happened. |
human to look over the results to determine what happened. |
4326 |
</para> |
</para> |
4327 |
|
|
4328 |
<funcsynopsis role="C"> |
<funcsynopsis role="C"> |
4329 |
<funcdef><function>unresolved</function></funcdef> |
<funcdef><function>unresolved</function></funcdef> |
4330 |
<paramdef><parameter>msg</parameter></paramdef> |
<paramdef><parameter>msg</parameter></paramdef> |
4331 |
</funcsynopsis> |
</funcsynopsis> |
4337 |
<para>This prints out the total numbers of all the test |
<para>This prints out the total numbers of all the test |
4338 |
state outputs.</para> |
state outputs.</para> |
4339 |
|
|
4340 |
<funcsynopsis role="C"> |
<funcsynopsis role="C"> |
4341 |
<funcdef><function>totals</function></funcdef> |
<funcdef><function>totals</function></funcdef> |
4342 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
4343 |
</funcsynopsis> |
</funcsynopsis> |
4347 |
|
|
4348 |
<sect1 id=cppunit xreflabel="C++ Unit Testing API"> |
<sect1 id=cppunit xreflabel="C++ Unit Testing API"> |
4349 |
<title>C++ Unit Testing API</title> |
<title>C++ Unit Testing API</title> |
4350 |
|
|
4351 |
<para>All of the methods that take a |
<para>All of the methods that take a |
4352 |
<parameter>msg</parameter> parameter use a C char * |
<parameter>msg</parameter> parameter use a C char * |
4353 |
or STL string, that is the message to be |
or STL string, that is the message to be |
4354 |
dislayed. There currently is no support for variable |
dislayed. There currently is no support for variable |
4355 |
length arguments.</para> |
length arguments.</para> |
4356 |
|
|
4357 |
<sect2 id=passmeth xreflabel="pass method"> |
<sect2 id=passmeth xreflabel="pass method"> |
4358 |
<title>Pass Method</title> |
<title>Pass Method</title> |
4359 |
|
|
4360 |
<para>This prints a message for a successful test |
<para>This prints a message for a successful test |
4361 |
completion.</para> |
completion.</para> |
4362 |
|
|
4363 |
<funcsynopsis role="C++"> |
<funcsynopsis role="C++"> |
4364 |
<funcdef><function>TestState::pass</function></funcdef> |
<funcdef><function>TestState::pass</function></funcdef> |
4365 |
<paramdef><parameter>msg</parameter></paramdef> |
<paramdef><parameter>msg</parameter></paramdef> |
4366 |
</funcsynopsis> |
</funcsynopsis> |
4372 |
<para>This prints a message for an unsuccessful test |
<para>This prints a message for an unsuccessful test |
4373 |
completion.</para> |
completion.</para> |
4374 |
|
|
4375 |
<funcsynopsis role="C++"> |
<funcsynopsis role="C++"> |
4376 |
<funcdef><function>TestState::fail</function></funcdef> |
<funcdef><function>TestState::fail</function></funcdef> |
4377 |
<paramdef><parameter>msg</parameter></paramdef> |
<paramdef><parameter>msg</parameter></paramdef> |
4378 |
</funcsynopsis> |
</funcsynopsis> |
4384 |
<para>This prints a message for an test case that isn't run |
<para>This prints a message for an test case that isn't run |
4385 |
for some technical reason.</para> |
for some technical reason.</para> |
4386 |
|
|
4387 |
<funcsynopsis role="C++"> |
<funcsynopsis role="C++"> |
4388 |
<funcdef><function>TestState::untested</function></funcdef> |
<funcdef><function>TestState::untested</function></funcdef> |
4389 |
<paramdef><parameter>msg</parameter></paramdef> |
<paramdef><parameter>msg</parameter></paramdef> |
4390 |
</funcsynopsis> |
</funcsynopsis> |
4398 |
human to look over the results to determine what happened. |
human to look over the results to determine what happened. |
4399 |
</para> |
</para> |
4400 |
|
|
4401 |
<funcsynopsis role="C++"> |
<funcsynopsis role="C++"> |
4402 |
<funcdef><function>TestState::unresolved</function></funcdef> |
<funcdef><function>TestState::unresolved</function></funcdef> |
4403 |
<paramdef><parameter>msg</parameter></paramdef> |
<paramdef><parameter>msg</parameter></paramdef> |
4404 |
</funcsynopsis> |
</funcsynopsis> |
4410 |
<para>This prints out the total numbers of all the test |
<para>This prints out the total numbers of all the test |
4411 |
state outputs.</para> |
state outputs.</para> |
4412 |
|
|
4413 |
<funcsynopsis role="C++"> |
<funcsynopsis role="C++"> |
4414 |
<funcdef><function>TestState::totals</function></funcdef> |
<funcdef><function>TestState::totals</function></funcdef> |
4415 |
<paramdef><parameter></parameter></paramdef> |
<paramdef><parameter></parameter></paramdef> |
4416 |
</funcsynopsis> |
</funcsynopsis> |