← Back to branch summary

~ubuntu-branches/ubuntu/karmic/dejagnu/karmic

« back to all changes in this revision

Viewing changes to doc/html/x1655.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Jacobowitz
  • Date: 2006-12-11 09:06:59 UTC
  • mfrom: (2.1.6 edgy)
  • Revision ID: james.westby@ubuntu.com-20061211090659-w586kgi3giz84053
Tags: 1.4.4.cvs20060709-3
* Acknowledge previous NMUs.
* Fix permissions on /usr/share/dejagnu when building without fakeroot
  (Closes: #392589, #379809).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/x1655.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2
 
<HTML
3
 
><HEAD
4
 
><TITLE
5
 
>Builtin Procedures</TITLE
6
 
><META
7
 
NAME="GENERATOR"
8
 
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
9
 
"><LINK
10
 
REL="HOME"
11
 
TITLE="DejaGnu"
12
 
HREF="book1.html"><LINK
13
 
REL="UP"
14
 
TITLE="Reference"
15
 
HREF="c1593.html"><LINK
16
 
REL="PREVIOUS"
17
 
TITLE="Installation"
18
 
HREF="x1600.html"><LINK
19
 
REL="NEXT"
20
 
TITLE="File Map"
21
 
HREF="x5058.html"></HEAD
22
 
><BODY
23
 
CLASS="SECT1"
24
 
BGCOLOR="#FFFFFF"
25
 
TEXT="#000000"
26
 
LINK="#0000FF"
27
 
VLINK="#840084"
28
 
ALINK="#0000FF"
29
 
><DIV
30
 
CLASS="NAVHEADER"
31
 
><TABLE
32
 
SUMMARY="Header navigation table"
33
 
WIDTH="100%"
34
 
BORDER="0"
35
 
CELLPADDING="0"
36
 
CELLSPACING="0"
37
 
><TR
38
 
><TH
39
 
COLSPAN="3"
40
 
ALIGN="center"
41
 
>DejaGnu: The GNU Testing Framework</TH
42
 
></TR
43
 
><TR
44
 
><TD
45
 
WIDTH="10%"
46
 
ALIGN="left"
47
 
VALIGN="bottom"
48
 
><A
49
 
HREF="x1600.html"
50
 
ACCESSKEY="P"
51
 
>&#60;&#60;&#60; Previous</A
52
 
></TD
53
 
><TD
54
 
WIDTH="80%"
55
 
ALIGN="center"
56
 
VALIGN="bottom"
57
 
>Reference</TD
58
 
><TD
59
 
WIDTH="10%"
60
 
ALIGN="right"
61
 
VALIGN="bottom"
62
 
><A
63
 
HREF="x5058.html"
64
 
ACCESSKEY="N"
65
 
>Next &#62;&#62;&#62;</A
66
 
></TD
67
 
></TR
68
 
></TABLE
69
 
><HR
70
 
ALIGN="LEFT"
71
 
WIDTH="100%"></DIV
72
 
><DIV
73
 
CLASS="SECT1"
74
 
><H1
75
 
CLASS="SECT1"
76
 
><A
77
 
NAME="BUILTINS"
78
 
></A
79
 
>Builtin Procedures</H1
80
 
><P
81
 
>DejaGnu provides these Tcl procedures.</P
82
 
><DIV
83
 
CLASS="SECT2"
84
 
><H2
85
 
CLASS="SECT2"
86
 
><A
87
 
NAME="COREPROCS"
88
 
></A
89
 
>Core Internal Procedures</H2
90
 
><DIV
91
 
CLASS="SECT3"
92
 
><H3
93
 
CLASS="SECT3"
94
 
><A
95
 
NAME="MAILFILE"
96
 
></A
97
 
>Mail_file Procedure</H3
98
 
><DIV
99
 
CLASS="FUNCSYNOPSIS"
100
 
><A
101
 
NAME="AEN1662"
102
 
></A
103
 
><P
104
 
></P
105
 
><CODE
106
 
CLASS="FUNCDEF"
107
 
><TT
108
 
CLASS="FUNCTION"
109
 
>mail_file</TT
110
 
></CODE
111
 
>(<TT
112
 
CLASS="PARAMETER"
113
 
><I
114
 
>file to subject</I
115
 
></TT
116
 
>);<P
117
 
></P
118
 
></DIV
119
 
><P
120
 
></P
121
 
><DIV
122
 
CLASS="VARIABLELIST"
123
 
><DL
124
 
><DT
125
 
><TT
126
 
CLASS="PARAMETER"
127
 
><I
128
 
></I
129
 
></TT
130
 
></DT
131
 
><DD
132
 
><P
133
 
></P
134
 
></DD
135
 
></DL
136
 
></DIV
137
 
></DIV
138
 
><DIV
139
 
CLASS="SECT3"
140
 
><H3
141
 
CLASS="SECT3"
142
 
><A
143
 
NAME="OPENLOGS"
144
 
></A
145
 
>Open_logs Procedure</H3
146
 
><P
147
 
></P
148
 
><DIV
149
 
CLASS="FUNCSYNOPSIS"
150
 
><A
151
 
NAME="AEN1676"
152
 
></A
153
 
><P
154
 
></P
155
 
><CODE
156
 
CLASS="FUNCDEF"
157
 
><TT
158
 
CLASS="FUNCTION"
159
 
>open_logs</TT
160
 
></CODE
161
 
>(<TT
162
 
CLASS="PARAMETER"
163
 
><I
164
 
></I
165
 
></TT
166
 
>);<P
167
 
></P
168
 
></DIV
169
 
></DIV
170
 
><DIV
171
 
CLASS="SECT3"
172
 
><H3
173
 
CLASS="SECT3"
174
 
><A
175
 
NAME="CLOSELOGS"
176
 
></A
177
 
>Close_logs Procedure</H3
178
 
><P
179
 
></P
180
 
><DIV
181
 
CLASS="FUNCSYNOPSIS"
182
 
><A
183
 
NAME="AEN1684"
184
 
></A
185
 
><P
186
 
></P
187
 
><CODE
188
 
CLASS="FUNCDEF"
189
 
><TT
190
 
CLASS="FUNCTION"
191
 
>close_logs</TT
192
 
></CODE
193
 
>(<TT
194
 
CLASS="PARAMETER"
195
 
><I
196
 
></I
197
 
></TT
198
 
>);<P
199
 
></P
200
 
></DIV
201
 
></DIV
202
 
><DIV
203
 
CLASS="SECT3"
204
 
><H3
205
 
CLASS="SECT3"
206
 
><A
207
 
NAME="ISBUILD"
208
 
></A
209
 
>Isbuild Procedure</H3
210
 
><P
211
 
>Tests for a particular build host environment.  If the
212
 
          currently configured host matches the argument string, the result is
213
 
          <I
214
 
CLASS="EMPHASIS"
215
 
>1</I
216
 
>; otherwise the result is
217
 
          <I
218
 
CLASS="EMPHASIS"
219
 
>0</I
220
 
>.  <I
221
 
CLASS="EMPHASIS"
222
 
>host</I
223
 
> must be a full
224
 
          three-part configure host name; in particular, you may not use the
225
 
          shorter nicknames supported by configure (but you can use wildcard
226
 
          characters, using shell syntax, to specify sets of names). If it is
227
 
          passed a NULL string, then it returns the name of the build canonical
228
 
          configuration.</P
229
 
><DIV
230
 
CLASS="FUNCSYNOPSIS"
231
 
><A
232
 
NAME="AEN1695"
233
 
></A
234
 
><P
235
 
></P
236
 
><CODE
237
 
CLASS="FUNCDEF"
238
 
><TT
239
 
CLASS="FUNCTION"
240
 
>isbuild</TT
241
 
></CODE
242
 
>(<TT
243
 
CLASS="PARAMETER"
244
 
><I
245
 
>pattern</I
246
 
></TT
247
 
>);<P
248
 
></P
249
 
></DIV
250
 
><P
251
 
></P
252
 
><DIV
253
 
CLASS="VARIABLELIST"
254
 
><DL
255
 
><DT
256
 
><TT
257
 
CLASS="PARAMETER"
258
 
><I
259
 
>pattern</I
260
 
></TT
261
 
></DT
262
 
><DD
263
 
><P
264
 
></P
265
 
></DD
266
 
></DL
267
 
></DIV
268
 
></DIV
269
 
><DIV
270
 
CLASS="SECT3"
271
 
><H3
272
 
CLASS="SECT3"
273
 
><A
274
 
NAME="ISREMOTE"
275
 
></A
276
 
>Is_remote Procedure</H3
277
 
><P
278
 
></P
279
 
><DIV
280
 
CLASS="FUNCSYNOPSIS"
281
 
><A
282
 
NAME="AEN1709"
283
 
></A
284
 
><P
285
 
></P
286
 
><CODE
287
 
CLASS="FUNCDEF"
288
 
><TT
289
 
CLASS="FUNCTION"
290
 
>is_remote</TT
291
 
></CODE
292
 
>(<TT
293
 
CLASS="PARAMETER"
294
 
><I
295
 
>board</I
296
 
></TT
297
 
>);<P
298
 
></P
299
 
></DIV
300
 
><P
301
 
></P
302
 
><DIV
303
 
CLASS="VARIABLELIST"
304
 
><DL
305
 
><DT
306
 
><TT
307
 
CLASS="PARAMETER"
308
 
><I
309
 
></I
310
 
></TT
311
 
></DT
312
 
><DD
313
 
><P
314
 
></P
315
 
></DD
316
 
></DL
317
 
></DIV
318
 
></DIV
319
 
><DIV
320
 
CLASS="SECT3"
321
 
><H3
322
 
CLASS="SECT3"
323
 
><A
324
 
NAME="IS3WAY"
325
 
></A
326
 
>is3way Procedure</H3
327
 
><P
328
 
>Tests for a canadian cross. This is when the tests will be run
329
 
          on a remotly hosted cross compiler. If it is a canadian cross, then
330
 
          the result is <I
331
 
CLASS="EMPHASIS"
332
 
>1</I
333
 
>; otherwise the result is
334
 
          <I
335
 
CLASS="EMPHASIS"
336
 
>0</I
337
 
>.</P
338
 
><DIV
339
 
CLASS="FUNCSYNOPSIS"
340
 
><A
341
 
NAME="AEN1725"
342
 
></A
343
 
><P
344
 
></P
345
 
><CODE
346
 
CLASS="FUNCDEF"
347
 
><TT
348
 
CLASS="FUNCTION"
349
 
>is3way</TT
350
 
></CODE
351
 
>(<TT
352
 
CLASS="PARAMETER"
353
 
><I
354
 
></I
355
 
></TT
356
 
>);<P
357
 
></P
358
 
></DIV
359
 
></DIV
360
 
><DIV
361
 
CLASS="SECT3"
362
 
><H3
363
 
CLASS="SECT3"
364
 
><A
365
 
NAME="ISHOST"
366
 
></A
367
 
>Ishost Procedure</H3
368
 
><P
369
 
>Tests for a particular host environment.  If the currently
370
 
          configured host matches the argument string, the result is
371
 
          <I
372
 
CLASS="EMPHASIS"
373
 
>1</I
374
 
>; otherwise the result is
375
 
          <I
376
 
CLASS="EMPHASIS"
377
 
>0</I
378
 
>. <I
379
 
CLASS="EMPHASIS"
380
 
>host</I
381
 
> must be a full
382
 
          three-part configure host name; in particular, you may not use the
383
 
          shorter nicknames supported by configure (but you can use wildcard
384
 
          characters, using shell syntax, to specify sets of names).</P
385
 
><DIV
386
 
CLASS="FUNCSYNOPSIS"
387
 
><A
388
 
NAME="AEN1736"
389
 
></A
390
 
><P
391
 
></P
392
 
><CODE
393
 
CLASS="FUNCDEF"
394
 
><TT
395
 
CLASS="FUNCTION"
396
 
>ishost</TT
397
 
></CODE
398
 
>(<TT
399
 
CLASS="PARAMETER"
400
 
><I
401
 
>pattern</I
402
 
></TT
403
 
>);<P
404
 
></P
405
 
></DIV
406
 
><P
407
 
></P
408
 
><DIV
409
 
CLASS="VARIABLELIST"
410
 
><DL
411
 
><DT
412
 
><TT
413
 
CLASS="PARAMETER"
414
 
><I
415
 
></I
416
 
></TT
417
 
></DT
418
 
><DD
419
 
><P
420
 
></P
421
 
></DD
422
 
></DL
423
 
></DIV
424
 
></DIV
425
 
><DIV
426
 
CLASS="SECT3"
427
 
><H3
428
 
CLASS="SECT3"
429
 
><A
430
 
NAME="ISTARGET"
431
 
></A
432
 
>Istarget Procedure</H3
433
 
><P
434
 
>Tests for a particular target environment.  If the currently
435
 
          configured target matches the argument string, the result is
436
 
          <I
437
 
CLASS="EMPHASIS"
438
 
>1</I
439
 
> ; otherwise the result is
440
 
          <I
441
 
CLASS="EMPHASIS"
442
 
>0</I
443
 
>.  target must be a full three-part configure
444
 
          target name; in particular, you may not use the shorter nicknames
445
 
          supported by configure (but you can use wildcard characters, using
446
 
          shell syntax, to specify sets of names). If it is passed a
447
 
          <I
448
 
CLASS="EMPHASIS"
449
 
>NULL</I
450
 
> string, then it returns the name of the
451
 
          build canonical configuration.</P
452
 
><DIV
453
 
CLASS="FUNCSYNOPSIS"
454
 
><A
455
 
NAME="AEN1753"
456
 
></A
457
 
><P
458
 
></P
459
 
><CODE
460
 
CLASS="FUNCDEF"
461
 
><TT
462
 
CLASS="FUNCTION"
463
 
>istarget</TT
464
 
></CODE
465
 
>(<TT
466
 
CLASS="PARAMETER"
467
 
><I
468
 
>args</I
469
 
></TT
470
 
>);<P
471
 
></P
472
 
></DIV
473
 
><P
474
 
></P
475
 
><DIV
476
 
CLASS="VARIABLELIST"
477
 
><DL
478
 
><DT
479
 
><TT
480
 
CLASS="PARAMETER"
481
 
><I
482
 
></I
483
 
></TT
484
 
></DT
485
 
><DD
486
 
><P
487
 
></P
488
 
></DD
489
 
></DL
490
 
></DIV
491
 
></DIV
492
 
><DIV
493
 
CLASS="SECT3"
494
 
><H3
495
 
CLASS="SECT3"
496
 
><A
497
 
NAME="ISNATIVE"
498
 
></A
499
 
>Isnative Procedure</H3
500
 
><P
501
 
>Tests whether the current configuration has the same host and
502
 
          target. When it runs in a native configuration this procedure returns
503
 
          a <I
504
 
CLASS="EMPHASIS"
505
 
>1</I
506
 
>; otherwise it returns a
507
 
          <I
508
 
CLASS="EMPHASIS"
509
 
>0</I
510
 
>.</P
511
 
><DIV
512
 
CLASS="FUNCSYNOPSIS"
513
 
><A
514
 
NAME="AEN1769"
515
 
></A
516
 
><P
517
 
></P
518
 
><CODE
519
 
CLASS="FUNCDEF"
520
 
><TT
521
 
CLASS="FUNCTION"
522
 
>isnative</TT
523
 
></CODE
524
 
>(<TT
525
 
CLASS="PARAMETER"
526
 
><I
527
 
></I
528
 
></TT
529
 
>);<P
530
 
></P
531
 
></DIV
532
 
></DIV
533
 
><DIV
534
 
CLASS="SECT3"
535
 
><H3
536
 
CLASS="SECT3"
537
 
><A
538
 
NAME="UNKNOWN"
539
 
></A
540
 
>Unknown Procedure</H3
541
 
><P
542
 
></P
543
 
><DIV
544
 
CLASS="FUNCSYNOPSIS"
545
 
><A
546
 
NAME="AEN1777"
547
 
></A
548
 
><P
549
 
></P
550
 
><CODE
551
 
CLASS="FUNCDEF"
552
 
><TT
553
 
CLASS="FUNCTION"
554
 
>unknown</TT
555
 
></CODE
556
 
>(<TT
557
 
CLASS="PARAMETER"
558
 
><I
559
 
>args</I
560
 
></TT
561
 
>);<P
562
 
></P
563
 
></DIV
564
 
><P
565
 
></P
566
 
><DIV
567
 
CLASS="VARIABLELIST"
568
 
><DL
569
 
><DT
570
 
><TT
571
 
CLASS="PARAMETER"
572
 
><I
573
 
>args</I
574
 
></TT
575
 
></DT
576
 
><DD
577
 
><P
578
 
></P
579
 
></DD
580
 
></DL
581
 
></DIV
582
 
></DIV
583
 
><DIV
584
 
CLASS="SECT3"
585
 
><H3
586
 
CLASS="SECT3"
587
 
><A
588
 
NAME="CLONEOUTPUT"
589
 
></A
590
 
>Clone_output Procedure</H3
591
 
><P
592
 
></P
593
 
><DIV
594
 
CLASS="FUNCSYNOPSIS"
595
 
><A
596
 
NAME="AEN1791"
597
 
></A
598
 
><P
599
 
></P
600
 
><CODE
601
 
CLASS="FUNCDEF"
602
 
><TT
603
 
CLASS="FUNCTION"
604
 
>clone_output</TT
605
 
></CODE
606
 
>(<TT
607
 
CLASS="PARAMETER"
608
 
><I
609
 
>message</I
610
 
></TT
611
 
>);<P
612
 
></P
613
 
></DIV
614
 
><P
615
 
></P
616
 
><DIV
617
 
CLASS="VARIABLELIST"
618
 
><DL
619
 
><DT
620
 
><TT
621
 
CLASS="PARAMETER"
622
 
><I
623
 
>message</I
624
 
></TT
625
 
></DT
626
 
><DD
627
 
><P
628
 
></P
629
 
></DD
630
 
></DL
631
 
></DIV
632
 
></DIV
633
 
><DIV
634
 
CLASS="SECT3"
635
 
><H3
636
 
CLASS="SECT3"
637
 
><A
638
 
NAME="RESETVARS"
639
 
></A
640
 
>Reset_vars Procedure</H3
641
 
><P
642
 
></P
643
 
><DIV
644
 
CLASS="FUNCSYNOPSIS"
645
 
><A
646
 
NAME="AEN1805"
647
 
></A
648
 
><P
649
 
></P
650
 
><CODE
651
 
CLASS="FUNCDEF"
652
 
><TT
653
 
CLASS="FUNCTION"
654
 
>reset_vars</TT
655
 
></CODE
656
 
>(<TT
657
 
CLASS="PARAMETER"
658
 
><I
659
 
></I
660
 
></TT
661
 
>);<P
662
 
></P
663
 
></DIV
664
 
></DIV
665
 
><DIV
666
 
CLASS="SECT3"
667
 
><H3
668
 
CLASS="SECT3"
669
 
><A
670
 
NAME="LOGANDEXIT"
671
 
></A
672
 
>Log_and_exit Procedure</H3
673
 
><P
674
 
></P
675
 
><DIV
676
 
CLASS="FUNCSYNOPSIS"
677
 
><A
678
 
NAME="AEN1813"
679
 
></A
680
 
><P
681
 
></P
682
 
><CODE
683
 
CLASS="FUNCDEF"
684
 
><TT
685
 
CLASS="FUNCTION"
686
 
>log_and_exit</TT
687
 
></CODE
688
 
>(<TT
689
 
CLASS="PARAMETER"
690
 
><I
691
 
></I
692
 
></TT
693
 
>);<P
694
 
></P
695
 
></DIV
696
 
></DIV
697
 
><DIV
698
 
CLASS="SECT3"
699
 
><H3
700
 
CLASS="SECT3"
701
 
><A
702
 
NAME="LOGSUMMARY"
703
 
></A
704
 
>Log_summary Procedure</H3
705
 
><P
706
 
></P
707
 
><DIV
708
 
CLASS="FUNCSYNOPSIS"
709
 
><A
710
 
NAME="AEN1821"
711
 
></A
712
 
><P
713
 
></P
714
 
><CODE
715
 
CLASS="FUNCDEF"
716
 
><TT
717
 
CLASS="FUNCTION"
718
 
>log_summary</TT
719
 
></CODE
720
 
>(<TT
721
 
CLASS="PARAMETER"
722
 
><I
723
 
>args</I
724
 
></TT
725
 
>);<P
726
 
></P
727
 
></DIV
728
 
><P
729
 
></P
730
 
><DIV
731
 
CLASS="VARIABLELIST"
732
 
><DL
733
 
><DT
734
 
><TT
735
 
CLASS="PARAMETER"
736
 
><I
737
 
>args</I
738
 
></TT
739
 
></DT
740
 
><DD
741
 
><P
742
 
></P
743
 
></DD
744
 
></DL
745
 
></DIV
746
 
></DIV
747
 
><DIV
748
 
CLASS="SECT3"
749
 
><H3
750
 
CLASS="SECT3"
751
 
><A
752
 
NAME="CLEANUP"
753
 
></A
754
 
>Cleanup Procedure</H3
755
 
><P
756
 
></P
757
 
><DIV
758
 
CLASS="FUNCSYNOPSIS"
759
 
><A
760
 
NAME="AEN1835"
761
 
></A
762
 
><P
763
 
></P
764
 
><CODE
765
 
CLASS="FUNCDEF"
766
 
><TT
767
 
CLASS="FUNCTION"
768
 
>cleanup</TT
769
 
></CODE
770
 
>(<TT
771
 
CLASS="PARAMETER"
772
 
><I
773
 
></I
774
 
></TT
775
 
>);<P
776
 
></P
777
 
></DIV
778
 
></DIV
779
 
><DIV
780
 
CLASS="SECT3"
781
 
><H3
782
 
CLASS="SECT3"
783
 
><A
784
 
NAME="SETUPXFAIL"
785
 
></A
786
 
>Setup_xfail Procedure</H3
787
 
><P
788
 
>Declares that the test is expected to fail on a particular set
789
 
          of configurations.  The config argument must be a list of full
790
 
          three-part configure target name; in particular, you may not use the
791
 
          shorter nicknames supported by configure (but you can use the common
792
 
          shell wildcard characters to specify sets of names).  The
793
 
          <I
794
 
CLASS="EMPHASIS"
795
 
>bugid</I
796
 
> argument is optional, and used only in the
797
 
          logging file output; use it as a link to a bug-tracking system such
798
 
          as <SPAN
799
 
CLASS="PRODUCTNAME"
800
 
>GNATS</SPAN
801
 
>.</P
802
 
><P
803
 
>Once you use <TT
804
 
CLASS="FUNCTION"
805
 
>setup_xfail</TT
806
 
>, the
807
 
          <TT
808
 
CLASS="FUNCTION"
809
 
>fail</TT
810
 
> and <TT
811
 
CLASS="FUNCTION"
812
 
>pass</TT
813
 
> procedures
814
 
          produce the messages <I
815
 
CLASS="EMPHASIS"
816
 
>XFAIL</I
817
 
> and
818
 
          <I
819
 
CLASS="EMPHASIS"
820
 
>XPASS</I
821
 
> respectively, allowing you to distinguish
822
 
          expected failures (and unexpected success!) from other test
823
 
          outcomes.</P
824
 
><DIV
825
 
CLASS="WARNING"
826
 
><P
827
 
></P
828
 
><TABLE
829
 
CLASS="WARNING"
830
 
WIDTH="100%"
831
 
BORDER="0"
832
 
><TR
833
 
><TD
834
 
WIDTH="25"
835
 
ALIGN="CENTER"
836
 
VALIGN="TOP"
837
 
><IMG
838
 
SRC="./stylesheet-images/warning.gif"
839
 
HSPACE="5"
840
 
ALT="Warning"></TD
841
 
><TD
842
 
ALIGN="LEFT"
843
 
VALIGN="TOP"
844
 
><P
845
 
>Warning you must clear the expected failure after
846
 
          using setup_xfail in a test case.  Any call to <TT
847
 
CLASS="FUNCTION"
848
 
>pass
849
 
          </TT
850
 
>or <TT
851
 
CLASS="FUNCTION"
852
 
>fail</TT
853
 
>l clears the expected failure
854
 
          implicitly; if the test has some other outcome, e.g. an error, you
855
 
          can call <TT
856
 
CLASS="FUNCTION"
857
 
>clear_xfail</TT
858
 
> to clear the expected
859
 
          failure explicitly.  Otherwise, the expected-failure declaration
860
 
          applies to whatever test runs next, leading to surprising
861
 
          results.</P
862
 
></TD
863
 
></TR
864
 
></TABLE
865
 
></DIV
866
 
><DIV
867
 
CLASS="FUNCSYNOPSIS"
868
 
><A
869
 
NAME="AEN1856"
870
 
></A
871
 
><P
872
 
></P
873
 
><CODE
874
 
CLASS="FUNCDEF"
875
 
><TT
876
 
CLASS="FUNCTION"
877
 
>setup_xfail</TT
878
 
></CODE
879
 
>(<TT
880
 
CLASS="PARAMETER"
881
 
><I
882
 
>config</I
883
 
></TT
884
 
>
885
 
            <TT
886
 
CLASS="PARAMETER"
887
 
><I
888
 
>bugid</I
889
 
></TT
890
 
>);<P
891
 
></P
892
 
></DIV
893
 
><P
894
 
></P
895
 
><DIV
896
 
CLASS="VARIABLELIST"
897
 
><DL
898
 
><DT
899
 
><TT
900
 
CLASS="PARAMETER"
901
 
><I
902
 
>config</I
903
 
></TT
904
 
></DT
905
 
><DD
906
 
><P
907
 
>The config triplet to trigger whether this is an
908
 
            unexpected or expect failure.</P
909
 
></DD
910
 
><DT
911
 
><TT
912
 
CLASS="PARAMETER"
913
 
><I
914
 
>bugid</I
915
 
></TT
916
 
></DT
917
 
><DD
918
 
><P
919
 
>The optional bugid, used to tie it this test case
920
 
            to a bug tracking system.</P
921
 
></DD
922
 
></DL
923
 
></DIV
924
 
></DIV
925
 
><DIV
926
 
CLASS="SECT3"
927
 
><H3
928
 
CLASS="SECT3"
929
 
><A
930
 
NAME="RECORDTEST"
931
 
></A
932
 
>Record_test Procedure</H3
933
 
><P
934
 
></P
935
 
><DIV
936
 
CLASS="FUNCSYNOPSIS"
937
 
><A
938
 
NAME="AEN1876"
939
 
></A
940
 
><P
941
 
></P
942
 
><CODE
943
 
CLASS="FUNCDEF"
944
 
><TT
945
 
CLASS="FUNCTION"
946
 
>record_test</TT
947
 
></CODE
948
 
>(<TT
949
 
CLASS="PARAMETER"
950
 
><I
951
 
>type</I
952
 
></TT
953
 
>
954
 
                <TT
955
 
CLASS="PARAMETER"
956
 
><I
957
 
>message</I
958
 
></TT
959
 
>
960
 
                <TT
961
 
CLASS="PARAMETER"
962
 
><I
963
 
>args</I
964
 
></TT
965
 
>);<P
966
 
></P
967
 
></DIV
968
 
><P
969
 
></P
970
 
><DIV
971
 
CLASS="VARIABLELIST"
972
 
><DL
973
 
><DT
974
 
><TT
975
 
CLASS="PARAMETER"
976
 
><I
977
 
>type</I
978
 
></TT
979
 
></DT
980
 
><DD
981
 
><P
982
 
></P
983
 
></DD
984
 
><DT
985
 
><TT
986
 
CLASS="PARAMETER"
987
 
><I
988
 
>message</I
989
 
></TT
990
 
></DT
991
 
><DD
992
 
><P
993
 
></P
994
 
></DD
995
 
><DT
996
 
><TT
997
 
CLASS="PARAMETER"
998
 
><I
999
 
>args</I
1000
 
></TT
1001
 
></DT
1002
 
><DD
1003
 
><P
1004
 
></P
1005
 
></DD
1006
 
></DL
1007
 
></DIV
1008
 
></DIV
1009
 
><DIV
1010
 
CLASS="SECT3"
1011
 
><H3
1012
 
CLASS="SECT3"
1013
 
><A
1014
 
NAME="PASS"
1015
 
></A
1016
 
>Pass Procedure</H3
1017
 
><P
1018
 
>Declares a test to have passed. <TT
1019
 
CLASS="FUNCTION"
1020
 
>pass</TT
1021
 
>
1022
 
          writes in the log files a message beginning with
1023
 
          <I
1024
 
CLASS="EMPHASIS"
1025
 
>PASS</I
1026
 
> (or <I
1027
 
CLASS="EMPHASIS"
1028
 
>XPASS</I
1029
 
>, if failure
1030
 
          was expected), appending the argument
1031
 
          <TT
1032
 
CLASS="PARAMETER"
1033
 
><I
1034
 
>string</I
1035
 
></TT
1036
 
>.</P
1037
 
><DIV
1038
 
CLASS="FUNCSYNOPSIS"
1039
 
><A
1040
 
NAME="AEN1906"
1041
 
></A
1042
 
><P
1043
 
></P
1044
 
><CODE
1045
 
CLASS="FUNCDEF"
1046
 
><TT
1047
 
CLASS="FUNCTION"
1048
 
>pass</TT
1049
 
></CODE
1050
 
>(<TT
1051
 
CLASS="PARAMETER"
1052
 
><I
1053
 
>string</I
1054
 
></TT
1055
 
>);<P
1056
 
></P
1057
 
></DIV
1058
 
><P
1059
 
></P
1060
 
><DIV
1061
 
CLASS="VARIABLELIST"
1062
 
><DL
1063
 
><DT
1064
 
><TT
1065
 
CLASS="PARAMETER"
1066
 
><I
1067
 
>string</I
1068
 
></TT
1069
 
></DT
1070
 
><DD
1071
 
><P
1072
 
>The string to use for this PASS
1073
 
            message.</P
1074
 
></DD
1075
 
></DL
1076
 
></DIV
1077
 
></DIV
1078
 
><DIV
1079
 
CLASS="SECT3"
1080
 
><H3
1081
 
CLASS="SECT3"
1082
 
><A
1083
 
NAME="FAIL"
1084
 
></A
1085
 
>Fail Procedure</H3
1086
 
><P
1087
 
>Declares a test to have failed.  <TT
1088
 
CLASS="FUNCTION"
1089
 
>fail</TT
1090
 
>
1091
 
          writes in the log files a message beginning with
1092
 
          <I
1093
 
CLASS="EMPHASIS"
1094
 
>FAIL</I
1095
 
> (or <I
1096
 
CLASS="EMPHASIS"
1097
 
>XFAIL</I
1098
 
>, if failure
1099
 
          was expected), appending the argument
1100
 
          <TT
1101
 
CLASS="PARAMETER"
1102
 
><I
1103
 
>string</I
1104
 
></TT
1105
 
>.</P
1106
 
><DIV
1107
 
CLASS="FUNCSYNOPSIS"
1108
 
><A
1109
 
NAME="AEN1924"
1110
 
></A
1111
 
><P
1112
 
></P
1113
 
><CODE
1114
 
CLASS="FUNCDEF"
1115
 
><TT
1116
 
CLASS="FUNCTION"
1117
 
>fail</TT
1118
 
></CODE
1119
 
>(<TT
1120
 
CLASS="PARAMETER"
1121
 
><I
1122
 
>string</I
1123
 
></TT
1124
 
>);<P
1125
 
></P
1126
 
></DIV
1127
 
><P
1128
 
></P
1129
 
><DIV
1130
 
CLASS="VARIABLELIST"
1131
 
><DL
1132
 
><DT
1133
 
><TT
1134
 
CLASS="PARAMETER"
1135
 
><I
1136
 
>string</I
1137
 
></TT
1138
 
></DT
1139
 
><DD
1140
 
><P
1141
 
>The string to use for this FAIL
1142
 
            message.</P
1143
 
></DD
1144
 
></DL
1145
 
></DIV
1146
 
></DIV
1147
 
><DIV
1148
 
CLASS="SECT3"
1149
 
><H3
1150
 
CLASS="SECT3"
1151
 
><A
1152
 
NAME="XPASS"
1153
 
></A
1154
 
>Xpass Procedure</H3
1155
 
><P
1156
 
>Declares a test to have unexpectably passed, when it was
1157
 
          expected to be a failure.  <TT
1158
 
CLASS="FUNCTION"
1159
 
>xpass</TT
1160
 
>
1161
 
          writes in the log files a message beginning with
1162
 
          <I
1163
 
CLASS="EMPHASIS"
1164
 
>XPASS</I
1165
 
> (or <I
1166
 
CLASS="EMPHASIS"
1167
 
>XFAIL</I
1168
 
>, if failure
1169
 
          was expected), appending the argument
1170
 
          <TT
1171
 
CLASS="PARAMETER"
1172
 
><I
1173
 
>string</I
1174
 
></TT
1175
 
>.</P
1176
 
><DIV
1177
 
CLASS="FUNCSYNOPSIS"
1178
 
><A
1179
 
NAME="AEN1942"
1180
 
></A
1181
 
><P
1182
 
></P
1183
 
><CODE
1184
 
CLASS="FUNCDEF"
1185
 
><TT
1186
 
CLASS="FUNCTION"
1187
 
>xpass</TT
1188
 
></CODE
1189
 
>(<TT
1190
 
CLASS="PARAMETER"
1191
 
><I
1192
 
>string</I
1193
 
></TT
1194
 
>);<P
1195
 
></P
1196
 
></DIV
1197
 
><P
1198
 
></P
1199
 
><DIV
1200
 
CLASS="VARIABLELIST"
1201
 
><DL
1202
 
><DT
1203
 
><TT
1204
 
CLASS="PARAMETER"
1205
 
><I
1206
 
>string</I
1207
 
></TT
1208
 
></DT
1209
 
><DD
1210
 
><P
1211
 
>The string to use for this output
1212
 
            state.</P
1213
 
></DD
1214
 
></DL
1215
 
></DIV
1216
 
></DIV
1217
 
><DIV
1218
 
CLASS="SECT3"
1219
 
><H3
1220
 
CLASS="SECT3"
1221
 
><A
1222
 
NAME="XFAIL"
1223
 
></A
1224
 
>Xfail Procedure</H3
1225
 
><P
1226
 
>Declares a test to have expectably
1227
 
          failed. <TT
1228
 
CLASS="FUNCTION"
1229
 
>xfail</TT
1230
 
>
1231
 
          writes in the log files a message beginning with
1232
 
          <I
1233
 
CLASS="EMPHASIS"
1234
 
>XFAIL</I
1235
 
> (or <I
1236
 
CLASS="EMPHASIS"
1237
 
>PASS</I
1238
 
>, if success
1239
 
          was expected), appending the argument
1240
 
          <TT
1241
 
CLASS="PARAMETER"
1242
 
><I
1243
 
>string</I
1244
 
></TT
1245
 
>.</P
1246
 
><DIV
1247
 
CLASS="FUNCSYNOPSIS"
1248
 
><A
1249
 
NAME="AEN1960"
1250
 
></A
1251
 
><P
1252
 
></P
1253
 
><CODE
1254
 
CLASS="FUNCDEF"
1255
 
><TT
1256
 
CLASS="FUNCTION"
1257
 
>xpass</TT
1258
 
></CODE
1259
 
>(<TT
1260
 
CLASS="PARAMETER"
1261
 
><I
1262
 
>string</I
1263
 
></TT
1264
 
>);<P
1265
 
></P
1266
 
></DIV
1267
 
><P
1268
 
></P
1269
 
><DIV
1270
 
CLASS="VARIABLELIST"
1271
 
><DL
1272
 
><DT
1273
 
><TT
1274
 
CLASS="PARAMETER"
1275
 
><I
1276
 
>string</I
1277
 
></TT
1278
 
></DT
1279
 
><DD
1280
 
><P
1281
 
>The string to use for this output
1282
 
            state.</P
1283
 
></DD
1284
 
></DL
1285
 
></DIV
1286
 
></DIV
1287
 
><DIV
1288
 
CLASS="SECT3"
1289
 
><H3
1290
 
CLASS="SECT3"
1291
 
><A
1292
 
NAME="SETWARNINGTHRESHOLD"
1293
 
></A
1294
 
>Set_warning_threshold Procedure</H3
1295
 
><P
1296
 
>Sets the value of <SPAN
1297
 
CLASS="SYMBOL"
1298
 
>warning_threshold</SPAN
1299
 
>. A value
1300
 
          of <I
1301
 
CLASS="EMPHASIS"
1302
 
>0</I
1303
 
> disables it: calls to
1304
 
          <TT
1305
 
CLASS="FUNCTION"
1306
 
>warning</TT
1307
 
> will not turn a
1308
 
          <I
1309
 
CLASS="EMPHASIS"
1310
 
>PASS</I
1311
 
> or <I
1312
 
CLASS="EMPHASIS"
1313
 
>FAIL</I
1314
 
> into an
1315
 
          <I
1316
 
CLASS="EMPHASIS"
1317
 
>UNRESOLVED</I
1318
 
>.</P
1319
 
><DIV
1320
 
CLASS="FUNCSYNOPSIS"
1321
 
><A
1322
 
NAME="AEN1980"
1323
 
></A
1324
 
><P
1325
 
></P
1326
 
><CODE
1327
 
CLASS="FUNCDEF"
1328
 
><TT
1329
 
CLASS="FUNCTION"
1330
 
>set_warning_threshold</TT
1331
 
></CODE
1332
 
>(<TT
1333
 
CLASS="PARAMETER"
1334
 
><I
1335
 
>threshold</I
1336
 
></TT
1337
 
>);<P
1338
 
></P
1339
 
></DIV
1340
 
><P
1341
 
></P
1342
 
><DIV
1343
 
CLASS="VARIABLELIST"
1344
 
><DL
1345
 
><DT
1346
 
><TT
1347
 
CLASS="PARAMETER"
1348
 
><I
1349
 
>threshold</I
1350
 
></TT
1351
 
></DT
1352
 
><DD
1353
 
><P
1354
 
>This is the value of the new warning
1355
 
            threshold.</P
1356
 
></DD
1357
 
></DL
1358
 
></DIV
1359
 
></DIV
1360
 
><DIV
1361
 
CLASS="SECT3"
1362
 
><H3
1363
 
CLASS="SECT3"
1364
 
><A
1365
 
NAME="GETWARNINGTHRESHOLD"
1366
 
></A
1367
 
>Get_warning_threshold Procedure</H3
1368
 
><P
1369
 
>Returns the current value of
1370
 
          <SPAN
1371
 
CLASS="SYMBOL"
1372
 
>{warning_threshold</SPAN
1373
 
>. The default value is 3. This
1374
 
          value controls how many <TT
1375
 
CLASS="FUNCTION"
1376
 
>warning</TT
1377
 
> procedures can
1378
 
          be called before becoming <I
1379
 
CLASS="EMPHASIS"
1380
 
>UNRESOLVED</I
1381
 
>.</P
1382
 
><DIV
1383
 
CLASS="FUNCSYNOPSIS"
1384
 
><A
1385
 
NAME="AEN1997"
1386
 
></A
1387
 
><P
1388
 
></P
1389
 
><CODE
1390
 
CLASS="FUNCDEF"
1391
 
><TT
1392
 
CLASS="FUNCTION"
1393
 
>get_warning_threshold</TT
1394
 
></CODE
1395
 
>(<TT
1396
 
CLASS="PARAMETER"
1397
 
><I
1398
 
></I
1399
 
></TT
1400
 
>);<P
1401
 
></P
1402
 
></DIV
1403
 
></DIV
1404
 
><DIV
1405
 
CLASS="SECT3"
1406
 
><H3
1407
 
CLASS="SECT3"
1408
 
><A
1409
 
NAME="WARNING"
1410
 
></A
1411
 
>Warning Procedure</H3
1412
 
><P
1413
 
>Declares detection of a minor error in the test case
1414
 
        itself. <TT
1415
 
CLASS="FUNCTION"
1416
 
>warning</TT
1417
 
> writes in the log files a message
1418
 
        beginning with <I
1419
 
CLASS="EMPHASIS"
1420
 
>WARNING</I
1421
 
>, appending the argument
1422
 
        <TT
1423
 
CLASS="PARAMETER"
1424
 
><I
1425
 
>string</I
1426
 
></TT
1427
 
>.  Use <TT
1428
 
CLASS="FUNCTION"
1429
 
>warning</TT
1430
 
> rather
1431
 
        than <TT
1432
 
CLASS="FUNCTION"
1433
 
>perror</TT
1434
 
> for cases (such as communication
1435
 
        failure to be followed by a retry) where the test case can recover from
1436
 
        the error. If the optional <TT
1437
 
CLASS="PARAMETER"
1438
 
><I
1439
 
>number</I
1440
 
></TT
1441
 
> is supplied,
1442
 
        then this is used to set the internal count of warnings to that
1443
 
        value.</P
1444
 
><P
1445
 
>As a side effect, <SPAN
1446
 
CLASS="SYMBOL"
1447
 
>warning_threshold</SPAN
1448
 
> or more
1449
 
        calls to warning in a single test case also changes the effect of the
1450
 
        next <TT
1451
 
CLASS="FUNCTION"
1452
 
>pass</TT
1453
 
> or <TT
1454
 
CLASS="FUNCTION"
1455
 
>fail</TT
1456
 
> command:
1457
 
        the test outcome becomes <I
1458
 
CLASS="EMPHASIS"
1459
 
>UNRESOLVED</I
1460
 
> since an
1461
 
        automatic <I
1462
 
CLASS="EMPHASIS"
1463
 
>PASS</I
1464
 
> or <I
1465
 
CLASS="EMPHASIS"
1466
 
>FAIL</I
1467
 
> may
1468
 
        not be trustworthy after many warnings.  If the optional numeric value
1469
 
        is <I
1470
 
CLASS="EMPHASIS"
1471
 
>0</I
1472
 
>, then there are no further side effects to
1473
 
        calling this function, and the following test outcome doesn't become
1474
 
        <I
1475
 
CLASS="EMPHASIS"
1476
 
>UNRESOLVED</I
1477
 
>. This can be used for errors with no
1478
 
        known side effects.</P
1479
 
><DIV
1480
 
CLASS="FUNCSYNOPSIS"
1481
 
><A
1482
 
NAME="AEN2020"
1483
 
></A
1484
 
><P
1485
 
></P
1486
 
><CODE
1487
 
CLASS="FUNCDEF"
1488
 
><TT
1489
 
CLASS="FUNCTION"
1490
 
>warning</TT
1491
 
></CODE
1492
 
>(<TT
1493
 
CLASS="PARAMETER"
1494
 
><I
1495
 
>string</I
1496
 
></TT
1497
 
>
1498
 
            <TT
1499
 
CLASS="PARAMETER"
1500
 
><I
1501
 
>number</I
1502
 
></TT
1503
 
>
1504
 
            );<P
1505
 
></P
1506
 
></DIV
1507
 
><P
1508
 
></P
1509
 
><DIV
1510
 
CLASS="VARIABLELIST"
1511
 
><DL
1512
 
><DT
1513
 
><TT
1514
 
CLASS="PARAMETER"
1515
 
><I
1516
 
>string</I
1517
 
></TT
1518
 
></DT
1519
 
><DD
1520
 
><P
1521
 
></P
1522
 
></DD
1523
 
><DT
1524
 
><TT
1525
 
CLASS="PARAMETER"
1526
 
><I
1527
 
>number</I
1528
 
></TT
1529
 
></DT
1530
 
><DD
1531
 
><P
1532
 
>The optional number to set the error counter. Thius
1533
 
            is only used to fake out the counter when using the
1534
 
            <TT
1535
 
CLASS="FUNCTION"
1536
 
>xfail</TT
1537
 
> procedure to control when it flips the
1538
 
            output over to <I
1539
 
CLASS="EMPHASIS"
1540
 
>UNRESOLVED</I
1541
 
>
1542
 
            state.</P
1543
 
></DD
1544
 
></DL
1545
 
></DIV
1546
 
></DIV
1547
 
><DIV
1548
 
CLASS="SECT3"
1549
 
><H3
1550
 
CLASS="SECT3"
1551
 
><A
1552
 
NAME="PERROR"
1553
 
></A
1554
 
>Perror Procedure</H3
1555
 
><P
1556
 
>Declares a severe error in the testing framework
1557
 
        itself. <TT
1558
 
CLASS="FUNCTION"
1559
 
>perror</TT
1560
 
> writes in the log files a message
1561
 
        beginning with <I
1562
 
CLASS="EMPHASIS"
1563
 
>ERROR</I
1564
 
>, appending the argument
1565
 
        <TT
1566
 
CLASS="PARAMETER"
1567
 
><I
1568
 
>string</I
1569
 
></TT
1570
 
>.</P
1571
 
><P
1572
 
>As a side effect, perror also changes the effect of the next
1573
 
        <TT
1574
 
CLASS="FUNCTION"
1575
 
>pass</TT
1576
 
> or <TT
1577
 
CLASS="FUNCTION"
1578
 
>fail</TT
1579
 
> command: the
1580
 
        test outcome becomes <I
1581
 
CLASS="EMPHASIS"
1582
 
>UNRESOLVED</I
1583
 
>, since an
1584
 
        automatic <I
1585
 
CLASS="EMPHASIS"
1586
 
>PASS</I
1587
 
> or <I
1588
 
CLASS="EMPHASIS"
1589
 
>FAIL</I
1590
 
> cannot
1591
 
        be trusted after a severe error in the test framework.  If the optional
1592
 
        numeric value is <I
1593
 
CLASS="EMPHASIS"
1594
 
>0</I
1595
 
>, then there are no further side
1596
 
        effects to calling this function, and the following test outcome
1597
 
        doesn't become <I
1598
 
CLASS="EMPHASIS"
1599
 
>UNRESOLVED</I
1600
 
>. This can be used for
1601
 
        errors with no known side effects.</P
1602
 
><DIV
1603
 
CLASS="FUNCSYNOPSIS"
1604
 
><A
1605
 
NAME="AEN2053"
1606
 
></A
1607
 
><P
1608
 
></P
1609
 
><CODE
1610
 
CLASS="FUNCDEF"
1611
 
><TT
1612
 
CLASS="FUNCTION"
1613
 
>perror</TT
1614
 
></CODE
1615
 
>(<TT
1616
 
CLASS="PARAMETER"
1617
 
><I
1618
 
>string</I
1619
 
></TT
1620
 
>
1621
 
            <TT
1622
 
CLASS="PARAMETER"
1623
 
><I
1624
 
>number</I
1625
 
></TT
1626
 
>
1627
 
            );<P
1628
 
></P
1629
 
></DIV
1630
 
><P
1631
 
></P
1632
 
><DIV
1633
 
CLASS="VARIABLELIST"
1634
 
><DL
1635
 
><DT
1636
 
><TT
1637
 
CLASS="PARAMETER"
1638
 
><I
1639
 
>string</I
1640
 
></TT
1641
 
></DT
1642
 
><DD
1643
 
><P
1644
 
></P
1645
 
></DD
1646
 
><DT
1647
 
><TT
1648
 
CLASS="PARAMETER"
1649
 
><I
1650
 
>number</I
1651
 
></TT
1652
 
></DT
1653
 
><DD
1654
 
><P
1655
 
>The optional number to set the error counter. Thius
1656
 
            is only used to fake out the counter when using the
1657
 
            <TT
1658
 
CLASS="FUNCTION"
1659
 
>xfail</TT
1660
 
> procedure to control when it flips the
1661
 
            output over to <I
1662
 
CLASS="EMPHASIS"
1663
 
>UNRESOLVED</I
1664
 
>
1665
 
            state.</P
1666
 
></DD
1667
 
></DL
1668
 
></DIV
1669
 
></DIV
1670
 
><DIV
1671
 
CLASS="SECT3"
1672
 
><H3
1673
 
CLASS="SECT3"
1674
 
><A
1675
 
NAME="NOTE"
1676
 
></A
1677
 
>Note Procedure</H3
1678
 
><P
1679
 
>Appends an informational message to the log
1680
 
        file. <TT
1681
 
CLASS="FUNCTION"
1682
 
>note</TT
1683
 
> writes in the log files a message
1684
 
        beginning with <I
1685
 
CLASS="EMPHASIS"
1686
 
>NOTE</I
1687
 
>, appending the argument
1688
 
        <TT
1689
 
CLASS="PARAMETER"
1690
 
><I
1691
 
>string</I
1692
 
></TT
1693
 
>.  Use <TT
1694
 
CLASS="FUNCTION"
1695
 
>note</TT
1696
 
>
1697
 
        sparingly. The <TT
1698
 
CLASS="FUNCTION"
1699
 
>verbose</TT
1700
 
> should be used for most
1701
 
        such messages, but in cases where a message is needed in the log file
1702
 
        regardless of the verbosity level use <TT
1703
 
CLASS="FUNCTION"
1704
 
>note</TT
1705
 
>.</P
1706
 
><DIV
1707
 
CLASS="FUNCSYNOPSIS"
1708
 
><A
1709
 
NAME="AEN2081"
1710
 
></A
1711
 
><P
1712
 
></P
1713
 
><CODE
1714
 
CLASS="FUNCDEF"
1715
 
><TT
1716
 
CLASS="FUNCTION"
1717
 
>note</TT
1718
 
></CODE
1719
 
>(<TT
1720
 
CLASS="PARAMETER"
1721
 
><I
1722
 
>string</I
1723
 
></TT
1724
 
>);<P
1725
 
></P
1726
 
></DIV
1727
 
><P
1728
 
></P
1729
 
><DIV
1730
 
CLASS="VARIABLELIST"
1731
 
><DL
1732
 
><DT
1733
 
><TT
1734
 
CLASS="PARAMETER"
1735
 
><I
1736
 
>string</I
1737
 
></TT
1738
 
></DT
1739
 
><DD
1740
 
><P
1741
 
>The string to use for this note.</P
1742
 
></DD
1743
 
></DL
1744
 
></DIV
1745
 
></DIV
1746
 
><DIV
1747
 
CLASS="SECT3"
1748
 
><H3
1749
 
CLASS="SECT3"
1750
 
><A
1751
 
NAME="UNTESTED"
1752
 
></A
1753
 
>Untested Procedure</H3
1754
 
><P
1755
 
>Declares a test was not run. <TT
1756
 
CLASS="FUNCTION"
1757
 
>untested</TT
1758
 
> writes
1759
 
        in the log file a message beginning with <I
1760
 
CLASS="EMPHASIS"
1761
 
>UNTESTED</I
1762
 
>,
1763
 
        appending the argument <I
1764
 
CLASS="EMPHASIS"
1765
 
>string</I
1766
 
>. For example, you
1767
 
        might use this in a dummy test whose only role is to record that a test
1768
 
        does not yet exist for some feature.</P
1769
 
><DIV
1770
 
CLASS="FUNCSYNOPSIS"
1771
 
><A
1772
 
NAME="AEN2098"
1773
 
></A
1774
 
><P
1775
 
></P
1776
 
><CODE
1777
 
CLASS="FUNCDEF"
1778
 
><TT
1779
 
CLASS="FUNCTION"
1780
 
>untested</TT
1781
 
></CODE
1782
 
>(<TT
1783
 
CLASS="PARAMETER"
1784
 
><I
1785
 
>string</I
1786
 
></TT
1787
 
>);<P
1788
 
></P
1789
 
></DIV
1790
 
><P
1791
 
></P
1792
 
><DIV
1793
 
CLASS="VARIABLELIST"
1794
 
><DL
1795
 
><DT
1796
 
><TT
1797
 
CLASS="PARAMETER"
1798
 
><I
1799
 
>string</I
1800
 
></TT
1801
 
></DT
1802
 
><DD
1803
 
><P
1804
 
>The string to use for this output
1805
 
            state.</P
1806
 
></DD
1807
 
></DL
1808
 
></DIV
1809
 
></DIV
1810
 
><DIV
1811
 
CLASS="SECT3"
1812
 
><H3
1813
 
CLASS="SECT3"
1814
 
><A
1815
 
NAME="UNRESOLVED"
1816
 
></A
1817
 
>Unresolved Procedure</H3
1818
 
><P
1819
 
>Declares a test to have an unresolved
1820
 
        outcome. <TT
1821
 
CLASS="FUNCTION"
1822
 
>unresolved</TT
1823
 
> writes in the log file a
1824
 
        message beginning with <I
1825
 
CLASS="EMPHASIS"
1826
 
>UNRESOLVED</I
1827
 
>, appending the
1828
 
        argument <I
1829
 
CLASS="EMPHASIS"
1830
 
>string</I
1831
 
>.  This usually means the test did
1832
 
        not execute as expected, and a human being must go over results to
1833
 
        determine if it passed or failed (and to improve the test case).</P
1834
 
><DIV
1835
 
CLASS="FUNCSYNOPSIS"
1836
 
><A
1837
 
NAME="AEN2115"
1838
 
></A
1839
 
><P
1840
 
></P
1841
 
><CODE
1842
 
CLASS="FUNCDEF"
1843
 
><TT
1844
 
CLASS="FUNCTION"
1845
 
>unresolved</TT
1846
 
></CODE
1847
 
>(<TT
1848
 
CLASS="PARAMETER"
1849
 
><I
1850
 
>string</I
1851
 
></TT
1852
 
>);<P
1853
 
></P
1854
 
></DIV
1855
 
><P
1856
 
></P
1857
 
><DIV
1858
 
CLASS="VARIABLELIST"
1859
 
><DL
1860
 
><DT
1861
 
><TT
1862
 
CLASS="PARAMETER"
1863
 
><I
1864
 
>string</I
1865
 
></TT
1866
 
></DT
1867
 
><DD
1868
 
><P
1869
 
>The string to use for this output
1870
 
            state.</P
1871
 
></DD
1872
 
></DL
1873
 
></DIV
1874
 
></DIV
1875
 
><DIV
1876
 
CLASS="SECT3"
1877
 
><H3
1878
 
CLASS="SECT3"
1879
 
><A
1880
 
NAME="UNSUPPORTED"
1881
 
></A
1882
 
>Unsupported Procedure</H3
1883
 
><P
1884
 
>Declares that a test case depends on some facility that does not
1885
 
        exist in the testing environment. <TT
1886
 
CLASS="FUNCTION"
1887
 
>unsupported</TT
1888
 
>
1889
 
        writes in the log file a message beginning with
1890
 
        <I
1891
 
CLASS="EMPHASIS"
1892
 
>UNSUPPORTED</I
1893
 
>, appending the argument string.</P
1894
 
><DIV
1895
 
CLASS="FUNCSYNOPSIS"
1896
 
><A
1897
 
NAME="AEN2131"
1898
 
></A
1899
 
><P
1900
 
></P
1901
 
><CODE
1902
 
CLASS="FUNCDEF"
1903
 
><TT
1904
 
CLASS="FUNCTION"
1905
 
>unsupported</TT
1906
 
></CODE
1907
 
>(<TT
1908
 
CLASS="PARAMETER"
1909
 
><I
1910
 
>string</I
1911
 
></TT
1912
 
>);<P
1913
 
></P
1914
 
></DIV
1915
 
><P
1916
 
></P
1917
 
><DIV
1918
 
CLASS="VARIABLELIST"
1919
 
><DL
1920
 
><DT
1921
 
><TT
1922
 
CLASS="PARAMETER"
1923
 
><I
1924
 
>string</I
1925
 
></TT
1926
 
></DT
1927
 
><DD
1928
 
><P
1929
 
>The string to use for this output
1930
 
            state.</P
1931
 
></DD
1932
 
></DL
1933
 
></DIV
1934
 
></DIV
1935
 
><DIV
1936
 
CLASS="SECT3"
1937
 
><H3
1938
 
CLASS="SECT3"
1939
 
><A
1940
 
NAME="INITTESTCOUNTS"
1941
 
></A
1942
 
>Init_testcounts Procedure</H3
1943
 
><P
1944
 
></P
1945
 
><DIV
1946
 
CLASS="FUNCSYNOPSIS"
1947
 
><A
1948
 
NAME="AEN2145"
1949
 
></A
1950
 
><P
1951
 
></P
1952
 
><CODE
1953
 
CLASS="FUNCDEF"
1954
 
><TT
1955
 
CLASS="FUNCTION"
1956
 
>init_testcounts</TT
1957
 
></CODE
1958
 
>(<TT
1959
 
CLASS="PARAMETER"
1960
 
><I
1961
 
></I
1962
 
></TT
1963
 
>);<P
1964
 
></P
1965
 
></DIV
1966
 
></DIV
1967
 
><DIV
1968
 
CLASS="SECT3"
1969
 
><H3
1970
 
CLASS="SECT3"
1971
 
><A
1972
 
NAME="INCRCOUNT"
1973
 
></A
1974
 
>Incr_count Procedure</H3
1975
 
><P
1976
 
></P
1977
 
><DIV
1978
 
CLASS="FUNCSYNOPSIS"
1979
 
><A
1980
 
NAME="AEN2153"
1981
 
></A
1982
 
><P
1983
 
></P
1984
 
><CODE
1985
 
CLASS="FUNCDEF"
1986
 
><TT
1987
 
CLASS="FUNCTION"
1988
 
>incr_count</TT
1989
 
></CODE
1990
 
>(<TT
1991
 
CLASS="PARAMETER"
1992
 
><I
1993
 
>name</I
1994
 
></TT
1995
 
>
1996
 
                <TT
1997
 
CLASS="PARAMETER"
1998
 
><I
1999
 
>args</I
2000
 
></TT
2001
 
>);<P
2002
 
></P
2003
 
></DIV
2004
 
><P
2005
 
></P
2006
 
><DIV
2007
 
CLASS="VARIABLELIST"
2008
 
><DL
2009
 
><DT
2010
 
><TT
2011
 
CLASS="PARAMETER"
2012
 
><I
2013
 
>name</I
2014
 
></TT
2015
 
></DT
2016
 
><DD
2017
 
><P
2018
 
></P
2019
 
></DD
2020
 
><DT
2021
 
><TT
2022
 
CLASS="PARAMETER"
2023
 
><I
2024
 
>args</I
2025
 
></TT
2026
 
></DT
2027
 
><DD
2028
 
><P
2029
 
></P
2030
 
></DD
2031
 
></DL
2032
 
></DIV
2033
 
></DIV
2034
 
><DIV
2035
 
CLASS="SECT3"
2036
 
><H3
2037
 
CLASS="SECT3"
2038
 
><A
2039
 
NAME="TRANSFORM"
2040
 
></A
2041
 
>transform Procedure</H3
2042
 
><P
2043
 
>Generates a string for the name of a tool as it was configured
2044
 
          and installed, given its native name (as the argument
2045
 
          <TT
2046
 
CLASS="PARAMETER"
2047
 
><I
2048
 
>toolname</I
2049
 
></TT
2050
 
>). This makes the assumption that all
2051
 
          tools are installed using the same naming conventions: For example,
2052
 
          for a cross compiler supporting the <I
2053
 
CLASS="EMPHASIS"
2054
 
>m68k-vxworks</I
2055
 
>
2056
 
          configuration, the result of transform <B
2057
 
CLASS="COMMAND"
2058
 
>gcc</B
2059
 
> is
2060
 
          <B
2061
 
CLASS="COMMAND"
2062
 
>m68k-vxworks-gcc</B
2063
 
>.</P
2064
 
><DIV
2065
 
CLASS="FUNCSYNOPSIS"
2066
 
><A
2067
 
NAME="AEN2177"
2068
 
></A
2069
 
><P
2070
 
></P
2071
 
><CODE
2072
 
CLASS="FUNCDEF"
2073
 
><TT
2074
 
CLASS="FUNCTION"
2075
 
>transform</TT
2076
 
></CODE
2077
 
>(<TT
2078
 
CLASS="PARAMETER"
2079
 
><I
2080
 
>toolname</I
2081
 
></TT
2082
 
>);<P
2083
 
></P
2084
 
></DIV
2085
 
><P
2086
 
></P
2087
 
><DIV
2088
 
CLASS="VARIABLELIST"
2089
 
><DL
2090
 
><DT
2091
 
><TT
2092
 
CLASS="PARAMETER"
2093
 
><I
2094
 
>toolname</I
2095
 
></TT
2096
 
></DT
2097
 
><DD
2098
 
><P
2099
 
>The name of the cross-development program to
2100
 
            transform.</P
2101
 
></DD
2102
 
></DL
2103
 
></DIV
2104
 
></DIV
2105
 
><DIV
2106
 
CLASS="SECT3"
2107
 
><H3
2108
 
CLASS="SECT3"
2109
 
><A
2110
 
NAME="CHECKCONDITIONALXFAIL"
2111
 
></A
2112
 
>Check_conditional_xfail Procedure</H3
2113
 
><P
2114
 
>This procedure adds a conditional xfail, based on compiler
2115
 
          options used to create a test case executable. If an include options
2116
 
          is found in the compiler flags, and it's the right architecture,
2117
 
          it'll trigger an <I
2118
 
CLASS="EMPHASIS"
2119
 
>XFAIL</I
2120
 
>. Otherwise it'll produce
2121
 
          an ordinary <I
2122
 
CLASS="EMPHASIS"
2123
 
>FAIL</I
2124
 
>. You can also specify flags to
2125
 
          exclude. This makes a result be a <I
2126
 
CLASS="EMPHASIS"
2127
 
>FAIL</I
2128
 
>, even if
2129
 
          the included options are found. To set the conditional, set
2130
 
          the variable <SPAN
2131
 
CLASS="SYMBOL"
2132
 
>compiler_conditional_xfail_data</SPAN
2133
 
> to the
2134
 
          fields <TABLE
2135
 
BORDER="0"
2136
 
BGCOLOR="#E0E0E0"
2137
 
WIDTH="100%"
2138
 
><TR
2139
 
><TD
2140
 
><PRE
2141
 
CLASS="PROGRAMLISTING"
2142
 
>"[message string] [targets list] [includes
2143
 
          list] [excludes list]"</PRE
2144
 
></TD
2145
 
></TR
2146
 
></TABLE
2147
 
> (descriptions below). This is
2148
 
          the checked at pass/fail decision time, so there is no need to call
2149
 
          the procedure yourself, unless you wish to know if it gets
2150
 
          triggered. After a pass/fail, the variable is reset, so it doesn't
2151
 
          effect other tests. It returns <I
2152
 
CLASS="EMPHASIS"
2153
 
>1</I
2154
 
> if the
2155
 
          conditional is true, or <I
2156
 
CLASS="EMPHASIS"
2157
 
>0</I
2158
 
> if the conditional is
2159
 
          false.</P
2160
 
><DIV
2161
 
CLASS="FUNCSYNOPSIS"
2162
 
><A
2163
 
NAME="AEN2198"
2164
 
></A
2165
 
><P
2166
 
></P
2167
 
><CODE
2168
 
CLASS="FUNCDEF"
2169
 
><TT
2170
 
CLASS="FUNCTION"
2171
 
>check_conditional_xfail</TT
2172
 
></CODE
2173
 
>(<TT
2174
 
CLASS="PARAMETER"
2175
 
><I
2176
 
>message</I
2177
 
></TT
2178
 
>
2179
 
            <TT
2180
 
CLASS="PARAMETER"
2181
 
><I
2182
 
>targets</I
2183
 
></TT
2184
 
>
2185
 
            <TT
2186
 
CLASS="PARAMETER"
2187
 
><I
2188
 
>includes</I
2189
 
></TT
2190
 
>
2191
 
            <TT
2192
 
CLASS="PARAMETER"
2193
 
><I
2194
 
>excludes</I
2195
 
></TT
2196
 
>);<P
2197
 
></P
2198
 
></DIV
2199
 
><P
2200
 
></P
2201
 
><DIV
2202
 
CLASS="VARIABLELIST"
2203
 
><DL
2204
 
><DT
2205
 
><TT
2206
 
CLASS="PARAMETER"
2207
 
><I
2208
 
>message</I
2209
 
></TT
2210
 
></DT
2211
 
><DD
2212
 
><P
2213
 
>This is the message to print with the normal test
2214
 
            result.</P
2215
 
></DD
2216
 
><DT
2217
 
><TT
2218
 
CLASS="PARAMETER"
2219
 
><I
2220
 
>targets</I
2221
 
></TT
2222
 
></DT
2223
 
><DD
2224
 
><P
2225
 
>This is a string with the list targets to activate
2226
 
            this conditional on.</P
2227
 
></DD
2228
 
><DT
2229
 
><TT
2230
 
CLASS="PARAMETER"
2231
 
><I
2232
 
>includes</I
2233
 
></TT
2234
 
></DT
2235
 
><DD
2236
 
><P
2237
 
>This is a list of sets of options to search for in
2238
 
            the compiler options to activate this conditional.  If the list of
2239
 
            sets of options is empty or if any set of the options matches,
2240
 
            then this conditional is true.  (It may be useful to specify an
2241
 
            empty list of include sets if the conditional is always true
2242
 
            unless one of the exclude sets matches.)</P
2243
 
></DD
2244
 
><DT
2245
 
><TT
2246
 
CLASS="PARAMETER"
2247
 
><I
2248
 
>excludes</I
2249
 
></TT
2250
 
></DT
2251
 
><DD
2252
 
><P
2253
 
>This is a list of sets of options to search for in
2254
 
            the compiler options to activate this conditional. If any set of
2255
 
            the options matches, (regardless of whether any of the include sets
2256
 
            match) then this conditional is de-activated.</P
2257
 
></DD
2258
 
></DL
2259
 
></DIV
2260
 
><DIV
2261
 
CLASS="EXAMPLE"
2262
 
><A
2263
 
NAME="AEN2227"
2264
 
></A
2265
 
><P
2266
 
><B
2267
 
>Example 1. Specifying the conditional xfail data</B
2268
 
></P
2269
 
><TABLE
2270
 
BORDER="0"
2271
 
BGCOLOR="#E0E0E0"
2272
 
WIDTH="100%"
2273
 
><TR
2274
 
><TD
2275
 
><PRE
2276
 
CLASS="PROGRAMLISTING"
2277
 
>         set compiler_conditional_xfail_data { \
2278
 
               "I sure wish I knew why this was hosed" \
2279
 
               "sparc*-sun*-* *-pc-*-*" \
2280
 
               {"-Wall -v" "-O3"} \
2281
 
               {"-O1" "-Map"} \
2282
 
          }
2283
 
          </PRE
2284
 
></TD
2285
 
></TR
2286
 
></TABLE
2287
 
></DIV
2288
 
><P
2289
 
>What this does is it matches only for these two targets if
2290
 
          "-Wall -v" or  "-O3" is set, but neither "-O1" or "-Map" is set. For
2291
 
          a set to match, the options specified are searched for independantly
2292
 
          of each other, so a "-Wall -v" matches either "-Wall -v" or "-v
2293
 
          -Wall". A space seperates the options in the string. Glob-style
2294
 
          regular expressions are also permitted.</P
2295
 
></DIV
2296
 
><DIV
2297
 
CLASS="SECT3"
2298
 
><H3
2299
 
CLASS="SECT3"
2300
 
><A
2301
 
NAME="CLEARXFAIL"
2302
 
></A
2303
 
>Clear_xfail Procedure</H3
2304
 
><P
2305
 
>Cancel an expected failure (previously declared with
2306
 
          <B
2307
 
CLASS="COMMAND"
2308
 
>setup_xfail</B
2309
 
>) for a particular set of
2310
 
          configurations.  The <TT
2311
 
CLASS="PARAMETER"
2312
 
><I
2313
 
>config</I
2314
 
></TT
2315
 
> argument is a list
2316
 
          of configuration target names.  It is only necessary to call
2317
 
          <B
2318
 
CLASS="COMMAND"
2319
 
>clear_xfail</B
2320
 
> if a test case ends without calling
2321
 
          either <B
2322
 
CLASS="COMMAND"
2323
 
>pass</B
2324
 
> or <B
2325
 
CLASS="COMMAND"
2326
 
>fail</B
2327
 
>, after
2328
 
          calling <B
2329
 
CLASS="COMMAND"
2330
 
>setup_xfail</B
2331
 
>.</P
2332
 
><DIV
2333
 
CLASS="FUNCSYNOPSIS"
2334
 
><A
2335
 
NAME="AEN2240"
2336
 
></A
2337
 
><P
2338
 
></P
2339
 
><CODE
2340
 
CLASS="FUNCDEF"
2341
 
><TT
2342
 
CLASS="FUNCTION"
2343
 
>clear_xfail</TT
2344
 
></CODE
2345
 
>(<TT
2346
 
CLASS="PARAMETER"
2347
 
><I
2348
 
>config</I
2349
 
></TT
2350
 
>);<P
2351
 
></P
2352
 
></DIV
2353
 
><P
2354
 
></P
2355
 
><DIV
2356
 
CLASS="VARIABLELIST"
2357
 
><DL
2358
 
><DT
2359
 
><TT
2360
 
CLASS="PARAMETER"
2361
 
><I
2362
 
>config</I
2363
 
></TT
2364
 
></DT
2365
 
><DD
2366
 
><P
2367
 
>The configuration triplets to
2368
 
            clear.</P
2369
 
></DD
2370
 
></DL
2371
 
></DIV
2372
 
></DIV
2373
 
><DIV
2374
 
CLASS="SECT3"
2375
 
><H3
2376
 
CLASS="SECT3"
2377
 
><A
2378
 
NAME="VERBOSE"
2379
 
></A
2380
 
>Verbose Procedure</H3
2381
 
><P
2382
 
>Test cases can use this function to issue helpful messages
2383
 
          depending on the number of <TT
2384
 
CLASS="OPTION"
2385
 
>--verbose</TT
2386
 
> options on the
2387
 
          runtest command line.  It prints string if the value of the variable
2388
 
          <SPAN
2389
 
CLASS="SYMBOL"
2390
 
>verbose</SPAN
2391
 
> is higher than or equal to the optional
2392
 
          number. The default value for number is <I
2393
 
CLASS="EMPHASIS"
2394
 
>1</I
2395
 
>.  Use
2396
 
          the optional <TT
2397
 
CLASS="OPTION"
2398
 
>-log</TT
2399
 
> argument to cause string to always
2400
 
          be added to the log file, even if it won't be printed.  Use the
2401
 
          optional <TT
2402
 
CLASS="OPTION"
2403
 
>-x</TT
2404
 
> argument to log the test results into
2405
 
          a parsable XML file.  Use the optional <TT
2406
 
CLASS="OPTION"
2407
 
>-n</TT
2408
 
> argument
2409
 
          to print string without a trailing newline.  Use the optional
2410
 
          <TT
2411
 
CLASS="OPTION"
2412
 
>--</TT
2413
 
> argument if string begins with "-".</P
2414
 
><DIV
2415
 
CLASS="FUNCSYNOPSIS"
2416
 
><A
2417
 
NAME="AEN2261"
2418
 
></A
2419
 
><P
2420
 
></P
2421
 
><CODE
2422
 
CLASS="FUNCDEF"
2423
 
><TT
2424
 
CLASS="FUNCTION"
2425
 
>verbose</TT
2426
 
></CODE
2427
 
>(<TT
2428
 
CLASS="PARAMETER"
2429
 
><I
2430
 
>-log</I
2431
 
></TT
2432
 
>
2433
 
            <TT
2434
 
CLASS="PARAMETER"
2435
 
><I
2436
 
>-x</I
2437
 
></TT
2438
 
>
2439
 
            <TT
2440
 
CLASS="PARAMETER"
2441
 
><I
2442
 
>-n</I
2443
 
></TT
2444
 
>
2445
 
            <TT
2446
 
CLASS="PARAMETER"
2447
 
><I
2448
 
>-r</I
2449
 
></TT
2450
 
>
2451
 
            <TT
2452
 
CLASS="PARAMETER"
2453
 
><I
2454
 
>string</I
2455
 
></TT
2456
 
>
2457
 
            <TT
2458
 
CLASS="PARAMETER"
2459
 
><I
2460
 
>number</I
2461
 
></TT
2462
 
>);<P
2463
 
></P
2464
 
></DIV
2465
 
><P
2466
 
></P
2467
 
><DIV
2468
 
CLASS="VARIABLELIST"
2469
 
><DL
2470
 
><DT
2471
 
><TT
2472
 
CLASS="PARAMETER"
2473
 
><I
2474
 
>-x</I
2475
 
></TT
2476
 
></DT
2477
 
><DD
2478
 
><P
2479
 
></P
2480
 
></DD
2481
 
><DT
2482
 
><TT
2483
 
CLASS="PARAMETER"
2484
 
><I
2485
 
>-log</I
2486
 
></TT
2487
 
></DT
2488
 
><DD
2489
 
><P
2490
 
></P
2491
 
></DD
2492
 
><DT
2493
 
><TT
2494
 
CLASS="PARAMETER"
2495
 
><I
2496
 
>-n</I
2497
 
></TT
2498
 
></DT
2499
 
><DD
2500
 
><P
2501
 
></P
2502
 
></DD
2503
 
><DT
2504
 
><TT
2505
 
CLASS="PARAMETER"
2506
 
><I
2507
 
>--</I
2508
 
></TT
2509
 
></DT
2510
 
><DD
2511
 
><P
2512
 
></P
2513
 
></DD
2514
 
><DT
2515
 
><TT
2516
 
CLASS="PARAMETER"
2517
 
><I
2518
 
>string</I
2519
 
></TT
2520
 
></DT
2521
 
><DD
2522
 
><P
2523
 
></P
2524
 
></DD
2525
 
><DT
2526
 
><TT
2527
 
CLASS="PARAMETER"
2528
 
><I
2529
 
>number</I
2530
 
></TT
2531
 
></DT
2532
 
><DD
2533
 
><P
2534
 
></P
2535
 
></DD
2536
 
></DL
2537
 
></DIV
2538
 
></DIV
2539
 
><DIV
2540
 
CLASS="SECT3"
2541
 
><H3
2542
 
CLASS="SECT3"
2543
 
><A
2544
 
NAME="LOADLIB"
2545
 
></A
2546
 
>Load_lib Procedure</H3
2547
 
><P
2548
 
>Loads a DejaGnu library file by searching a fixed path built
2549
 
          into DejaGnu. If DejaGnu has been installed, it looks in a path
2550
 
          starting with the installed library directory.  If you are running
2551
 
          DejaGnu directly from a source directory, without first running
2552
 
          <B
2553
 
CLASS="COMMAND"
2554
 
>make install</B
2555
 
>, this path defaults to the current
2556
 
          directory.  In either case, it then looks in the current directory
2557
 
          for a directory called <TT
2558
 
CLASS="FILENAME"
2559
 
>lib</TT
2560
 
>.  If there are
2561
 
          duplicate definitions, the last one loaded takes precedence over the
2562
 
          earlier ones.</P
2563
 
><DIV
2564
 
CLASS="FUNCSYNOPSIS"
2565
 
><A
2566
 
NAME="AEN2307"
2567
 
></A
2568
 
><P
2569
 
></P
2570
 
><CODE
2571
 
CLASS="FUNCDEF"
2572
 
><TT
2573
 
CLASS="FUNCTION"
2574
 
>load_lib</TT
2575
 
></CODE
2576
 
>(<TT
2577
 
CLASS="PARAMETER"
2578
 
><I
2579
 
>filespec</I
2580
 
></TT
2581
 
>);<P
2582
 
></P
2583
 
></DIV
2584
 
><P
2585
 
></P
2586
 
><DIV
2587
 
CLASS="VARIABLELIST"
2588
 
><DL
2589
 
><DT
2590
 
><TT
2591
 
CLASS="PARAMETER"
2592
 
><I
2593
 
>filespec</I
2594
 
></TT
2595
 
></DT
2596
 
><DD
2597
 
><P
2598
 
>The name of the DejaGnu library file to
2599
 
            load.</P
2600
 
></DD
2601
 
></DL
2602
 
></DIV
2603
 
></DIV
2604
 
></DIV
2605
 
><DIV
2606
 
CLASS="SECT2"
2607
 
><H2
2608
 
CLASS="SECT2"
2609
 
><A
2610
 
NAME="REMOTEPROCS"
2611
 
></A
2612
 
>Procedures For Remote Communication</H2
2613
 
><P
2614
 
><TT
2615
 
CLASS="FILENAME"
2616
 
>lib/remote.exp</TT
2617
 
> defines these
2618
 
        functions, for establishing and managing communications. Each
2619
 
        of these procedures tries to establish the connection up to
2620
 
        three times before returning. Warnings (if retries will
2621
 
        continue) or errors (if the attempt is abandoned) report on
2622
 
        communication failures.  The result for any of these
2623
 
        procedures is either <I
2624
 
CLASS="EMPHASIS"
2625
 
>-1</I
2626
 
>, when the
2627
 
        connection cannot be established, or the spawn ID returned by
2628
 
        the <SPAN
2629
 
CLASS="PRODUCTNAME"
2630
 
>Expect</SPAN
2631
 
> command
2632
 
        <B
2633
 
CLASS="COMMAND"
2634
 
>spawn</B
2635
 
>.</P
2636
 
><P
2637
 
>It use the value of the <SPAN
2638
 
CLASS="SYMBOL"
2639
 
>connect</SPAN
2640
 
> field
2641
 
        in the <SPAN
2642
 
CLASS="SYMBOL"
2643
 
>target_info</SPAN
2644
 
> array (was
2645
 
        <SPAN
2646
 
CLASS="SYMBOL"
2647
 
>connectmode</SPAN
2648
 
> as the type of connection to
2649
 
        make. Current supported connection types are tip, kermit,
2650
 
        telnet, rsh, rlogin, and netdata. If the <TT
2651
 
CLASS="OPTION"
2652
 
>--reboot</TT
2653
 
>
2654
 
        option was used on the runtest command line, then the target
2655
 
        is rebooted before the connection is made.</P
2656
 
><DIV
2657
 
CLASS="SECT3"
2658
 
><H3
2659
 
CLASS="SECT3"
2660
 
><A
2661
 
NAME="CALLREMOTE"
2662
 
></A
2663
 
>Call_remote Procedure</H3
2664
 
><P
2665
 
></P
2666
 
><DIV
2667
 
CLASS="FUNCSYNOPSIS"
2668
 
><A
2669
 
NAME="AEN2333"
2670
 
></A
2671
 
><P
2672
 
></P
2673
 
><CODE
2674
 
CLASS="FUNCDEF"
2675
 
><TT
2676
 
CLASS="FUNCTION"
2677
 
>call_remote</TT
2678
 
></CODE
2679
 
>(<TT
2680
 
CLASS="PARAMETER"
2681
 
><I
2682
 
>type</I
2683
 
></TT
2684
 
>
2685
 
                <TT
2686
 
CLASS="PARAMETER"
2687
 
><I
2688
 
>proc</I
2689
 
></TT
2690
 
>
2691
 
                <TT
2692
 
CLASS="PARAMETER"
2693
 
><I
2694
 
>dest</I
2695
 
></TT
2696
 
>
2697
 
                <TT
2698
 
CLASS="PARAMETER"
2699
 
><I
2700
 
>args</I
2701
 
></TT
2702
 
>);<P
2703
 
></P
2704
 
></DIV
2705
 
><P
2706
 
></P
2707
 
><DIV
2708
 
CLASS="VARIABLELIST"
2709
 
><DL
2710
 
><DT
2711
 
><TT
2712
 
CLASS="PARAMETER"
2713
 
><I
2714
 
>proc</I
2715
 
></TT
2716
 
></DT
2717
 
><DD
2718
 
><P
2719
 
></P
2720
 
></DD
2721
 
><DT
2722
 
><TT
2723
 
CLASS="PARAMETER"
2724
 
><I
2725
 
>dest</I
2726
 
></TT
2727
 
></DT
2728
 
><DD
2729
 
><P
2730
 
></P
2731
 
></DD
2732
 
><DT
2733
 
><TT
2734
 
CLASS="PARAMETER"
2735
 
><I
2736
 
>args</I
2737
 
></TT
2738
 
></DT
2739
 
><DD
2740
 
><P
2741
 
></P
2742
 
></DD
2743
 
></DL
2744
 
></DIV
2745
 
></DIV
2746
 
><DIV
2747
 
CLASS="SECT3"
2748
 
><H3
2749
 
CLASS="SECT3"
2750
 
><A
2751
 
NAME="CHECKFORBOARDSTATUS"
2752
 
></A
2753
 
>Check_for_board_status Procedure</H3
2754
 
><P
2755
 
></P
2756
 
><DIV
2757
 
CLASS="FUNCSYNOPSIS"
2758
 
><A
2759
 
NAME="AEN2360"
2760
 
></A
2761
 
><P
2762
 
></P
2763
 
><CODE
2764
 
CLASS="FUNCDEF"
2765
 
><TT
2766
 
CLASS="FUNCTION"
2767
 
>check_for_board_status</TT
2768
 
></CODE
2769
 
>(<TT
2770
 
CLASS="PARAMETER"
2771
 
><I
2772
 
>variable</I
2773
 
></TT
2774
 
>);<P
2775
 
></P
2776
 
></DIV
2777
 
><P
2778
 
></P
2779
 
><DIV
2780
 
CLASS="VARIABLELIST"
2781
 
><DL
2782
 
><DT
2783
 
><TT
2784
 
CLASS="PARAMETER"
2785
 
><I
2786
 
>variable</I
2787
 
></TT
2788
 
></DT
2789
 
><DD
2790
 
><P
2791
 
></P
2792
 
></DD
2793
 
></DL
2794
 
></DIV
2795
 
></DIV
2796
 
><DIV
2797
 
CLASS="SECT3"
2798
 
><H3
2799
 
CLASS="SECT3"
2800
 
><A
2801
 
NAME="FILEONBUILD"
2802
 
></A
2803
 
>File_on_build Procedure</H3
2804
 
><P
2805
 
></P
2806
 
><DIV
2807
 
CLASS="FUNCSYNOPSIS"
2808
 
><A
2809
 
NAME="AEN2374"
2810
 
></A
2811
 
><P
2812
 
></P
2813
 
><CODE
2814
 
CLASS="FUNCDEF"
2815
 
><TT
2816
 
CLASS="FUNCTION"
2817
 
>file_on_build</TT
2818
 
></CODE
2819
 
>(<TT
2820
 
CLASS="PARAMETER"
2821
 
><I
2822
 
>op</I
2823
 
></TT
2824
 
>
2825
 
                <TT
2826
 
CLASS="PARAMETER"
2827
 
><I
2828
 
>file</I
2829
 
></TT
2830
 
>
2831
 
                <TT
2832
 
CLASS="PARAMETER"
2833
 
><I
2834
 
>args</I
2835
 
></TT
2836
 
>);<P
2837
 
></P
2838
 
></DIV
2839
 
><P
2840
 
></P
2841
 
><DIV
2842
 
CLASS="VARIABLELIST"
2843
 
><DL
2844
 
><DT
2845
 
><TT
2846
 
CLASS="PARAMETER"
2847
 
><I
2848
 
>op</I
2849
 
></TT
2850
 
></DT
2851
 
><DD
2852
 
><P
2853
 
></P
2854
 
></DD
2855
 
><DT
2856
 
><TT
2857
 
CLASS="PARAMETER"
2858
 
><I
2859
 
>file</I
2860
 
></TT
2861
 
></DT
2862
 
><DD
2863
 
><P
2864
 
></P
2865
 
></DD
2866
 
><DT
2867
 
><TT
2868
 
CLASS="PARAMETER"
2869
 
><I
2870
 
>args</I
2871
 
></TT
2872
 
></DT
2873
 
><DD
2874
 
><P
2875
 
></P
2876
 
></DD
2877
 
></DL
2878
 
></DIV
2879
 
></DIV
2880
 
><DIV
2881
 
CLASS="SECT3"
2882
 
><H3
2883
 
CLASS="SECT3"
2884
 
><A
2885
 
NAME="FILEONHOST"
2886
 
></A
2887
 
>File_on_host Procedure</H3
2888
 
><P
2889
 
></P
2890
 
><DIV
2891
 
CLASS="FUNCSYNOPSIS"
2892
 
><A
2893
 
NAME="AEN2400"
2894
 
></A
2895
 
><P
2896
 
></P
2897
 
><CODE
2898
 
CLASS="FUNCDEF"
2899
 
><TT
2900
 
CLASS="FUNCTION"
2901
 
>file_on_host</TT
2902
 
></CODE
2903
 
>(<TT
2904
 
CLASS="PARAMETER"
2905
 
><I
2906
 
>op</I
2907
 
></TT
2908
 
>
2909
 
                <TT
2910
 
CLASS="PARAMETER"
2911
 
><I
2912
 
>file</I
2913
 
></TT
2914
 
>
2915
 
                <TT
2916
 
CLASS="PARAMETER"
2917
 
><I
2918
 
>args</I
2919
 
></TT
2920
 
>);<P
2921
 
></P
2922
 
></DIV
2923
 
><P
2924
 
></P
2925
 
><DIV
2926
 
CLASS="VARIABLELIST"
2927
 
><DL
2928
 
><DT
2929
 
><TT
2930
 
CLASS="PARAMETER"
2931
 
><I
2932
 
>op</I
2933
 
></TT
2934
 
></DT
2935
 
><DD
2936
 
><P
2937
 
></P
2938
 
></DD
2939
 
><DT
2940
 
><TT
2941
 
CLASS="PARAMETER"
2942
 
><I
2943
 
>file</I
2944
 
></TT
2945
 
></DT
2946
 
><DD
2947
 
><P
2948
 
></P
2949
 
></DD
2950
 
><DT
2951
 
><TT
2952
 
CLASS="PARAMETER"
2953
 
><I
2954
 
>args</I
2955
 
></TT
2956
 
></DT
2957
 
><DD
2958
 
><P
2959
 
></P
2960
 
></DD
2961
 
></DL
2962
 
></DIV
2963
 
></DIV
2964
 
><DIV
2965
 
CLASS="SECT3"
2966
 
><H3
2967
 
CLASS="SECT3"
2968
 
><A
2969
 
NAME="LOCALEXEC"
2970
 
></A
2971
 
>Local_exec Procedure</H3
2972
 
><P
2973
 
></P
2974
 
><DIV
2975
 
CLASS="FUNCSYNOPSIS"
2976
 
><A
2977
 
NAME="AEN2426"
2978
 
></A
2979
 
><P
2980
 
></P
2981
 
><CODE
2982
 
CLASS="FUNCDEF"
2983
 
><TT
2984
 
CLASS="FUNCTION"
2985
 
>local_exec</TT
2986
 
></CODE
2987
 
>(<TT
2988
 
CLASS="PARAMETER"
2989
 
><I
2990
 
>commandline</I
2991
 
></TT
2992
 
>
2993
 
                <TT
2994
 
CLASS="PARAMETER"
2995
 
><I
2996
 
>inp</I
2997
 
></TT
2998
 
>
2999
 
                <TT
3000
 
CLASS="PARAMETER"
3001
 
><I
3002
 
>outp</I
3003
 
></TT
3004
 
>
3005
 
                <TT
3006
 
CLASS="PARAMETER"
3007
 
><I
3008
 
>timeout</I
3009
 
></TT
3010
 
>);<P
3011
 
></P
3012
 
></DIV
3013
 
><P
3014
 
></P
3015
 
><DIV
3016
 
CLASS="VARIABLELIST"
3017
 
><DL
3018
 
><DT
3019
 
><TT
3020
 
CLASS="PARAMETER"
3021
 
><I
3022
 
>inp</I
3023
 
></TT
3024
 
></DT
3025
 
><DD
3026
 
><P
3027
 
></P
3028
 
></DD
3029
 
><DT
3030
 
><TT
3031
 
CLASS="PARAMETER"
3032
 
><I
3033
 
>outp</I
3034
 
></TT
3035
 
></DT
3036
 
><DD
3037
 
><P
3038
 
></P
3039
 
></DD
3040
 
><DT
3041
 
><TT
3042
 
CLASS="PARAMETER"
3043
 
><I
3044
 
>timeout</I
3045
 
></TT
3046
 
></DT
3047
 
><DD
3048
 
><P
3049
 
></P
3050
 
></DD
3051
 
></DL
3052
 
></DIV
3053
 
></DIV
3054
 
><DIV
3055
 
CLASS="SECT3"
3056
 
><H3
3057
 
CLASS="SECT3"
3058
 
><A
3059
 
NAME="REMOTEBINARY"
3060
 
></A
3061
 
>Remote_binary Procedure</H3
3062
 
><P
3063
 
></P
3064
 
><DIV
3065
 
CLASS="FUNCSYNOPSIS"
3066
 
><A
3067
 
NAME="AEN2453"
3068
 
></A
3069
 
><P
3070
 
></P
3071
 
><CODE
3072
 
CLASS="FUNCDEF"
3073
 
><TT
3074
 
CLASS="FUNCTION"
3075
 
>remote_binary</TT
3076
 
></CODE
3077
 
>(<TT
3078
 
CLASS="PARAMETER"
3079
 
><I
3080
 
>host</I
3081
 
></TT
3082
 
>);<P
3083
 
></P
3084
 
></DIV
3085
 
><P
3086
 
></P
3087
 
><DIV
3088
 
CLASS="VARIABLELIST"
3089
 
><DL
3090
 
><DT
3091
 
><TT
3092
 
CLASS="PARAMETER"
3093
 
><I
3094
 
>host</I
3095
 
></TT
3096
 
></DT
3097
 
><DD
3098
 
><P
3099
 
></P
3100
 
></DD
3101
 
></DL
3102
 
></DIV
3103
 
></DIV
3104
 
><DIV
3105
 
CLASS="SECT3"
3106
 
><H3
3107
 
CLASS="SECT3"
3108
 
><A
3109
 
NAME="REMOTECLOSE"
3110
 
></A
3111
 
>Remote_close Procedure</H3
3112
 
><P
3113
 
></P
3114
 
><DIV
3115
 
CLASS="FUNCSYNOPSIS"
3116
 
><A
3117
 
NAME="AEN2467"
3118
 
></A
3119
 
><P
3120
 
></P
3121
 
><CODE
3122
 
CLASS="FUNCDEF"
3123
 
><TT
3124
 
CLASS="FUNCTION"
3125
 
>remote_close</TT
3126
 
></CODE
3127
 
>(<TT
3128
 
CLASS="PARAMETER"
3129
 
><I
3130
 
>shellid</I
3131
 
></TT
3132
 
>);<P
3133
 
></P
3134
 
></DIV
3135
 
><P
3136
 
></P
3137
 
><DIV
3138
 
CLASS="VARIABLELIST"
3139
 
><DL
3140
 
><DT
3141
 
><TT
3142
 
CLASS="PARAMETER"
3143
 
><I
3144
 
>shellid</I
3145
 
></TT
3146
 
></DT
3147
 
><DD
3148
 
><P
3149
 
>This is the value returned by a call
3150
 
                to <TT
3151
 
CLASS="FUNCTION"
3152
 
>remote_open</TT
3153
 
>. This closes the
3154
 
                connection to the target so resources can be used by
3155
 
                others. This parameter can be left off if the
3156
 
                <SPAN
3157
 
CLASS="SYMBOL"
3158
 
>fileid</SPAN
3159
 
> field in the
3160
 
                <SPAN
3161
 
CLASS="SYMBOL"
3162
 
>target_info</SPAN
3163
 
> array is set.</P
3164
 
></DD
3165
 
></DL
3166
 
></DIV
3167
 
></DIV
3168
 
><DIV
3169
 
CLASS="SECT3"
3170
 
><H3
3171
 
CLASS="SECT3"
3172
 
><A
3173
 
NAME="REMOTEDOWNLOAD"
3174
 
></A
3175
 
>Remote_download Procedure</H3
3176
 
><P
3177
 
></P
3178
 
><DIV
3179
 
CLASS="FUNCSYNOPSIS"
3180
 
><A
3181
 
NAME="AEN2484"
3182
 
></A
3183
 
><P
3184
 
></P
3185
 
><CODE
3186
 
CLASS="FUNCDEF"
3187
 
><TT
3188
 
CLASS="FUNCTION"
3189
 
>remote_download</TT
3190
 
></CODE
3191
 
>(<TT
3192
 
CLASS="PARAMETER"
3193
 
><I
3194
 
>dest</I
3195
 
></TT
3196
 
>
3197
 
                <TT
3198
 
CLASS="PARAMETER"
3199
 
><I
3200
 
>file</I
3201
 
></TT
3202
 
>
3203
 
                <TT
3204
 
CLASS="PARAMETER"
3205
 
><I
3206
 
>args</I
3207
 
></TT
3208
 
>);<P
3209
 
></P
3210
 
></DIV
3211
 
><P
3212
 
></P
3213
 
><DIV
3214
 
CLASS="VARIABLELIST"
3215
 
><DL
3216
 
><DT
3217
 
><TT
3218
 
CLASS="PARAMETER"
3219
 
><I
3220
 
>dest</I
3221
 
></TT
3222
 
></DT
3223
 
><DD
3224
 
><P
3225
 
></P
3226
 
></DD
3227
 
><DT
3228
 
><TT
3229
 
CLASS="PARAMETER"
3230
 
><I
3231
 
>file</I
3232
 
></TT
3233
 
></DT
3234
 
><DD
3235
 
><P
3236
 
></P
3237
 
></DD
3238
 
><DT
3239
 
><TT
3240
 
CLASS="PARAMETER"
3241
 
><I
3242
 
>args</I
3243
 
></TT
3244
 
></DT
3245
 
><DD
3246
 
><P
3247
 
></P
3248
 
></DD
3249
 
></DL
3250
 
></DIV
3251
 
></DIV
3252
 
><DIV
3253
 
CLASS="SECT3"
3254
 
><H3
3255
 
CLASS="SECT3"
3256
 
><A
3257
 
NAME="REMOTEEXEC"
3258
 
></A
3259
 
>Remote_exec Procedure</H3
3260
 
><P
3261
 
></P
3262
 
><DIV
3263
 
CLASS="FUNCSYNOPSIS"
3264
 
><A
3265
 
NAME="AEN2510"
3266
 
></A
3267
 
><P
3268
 
></P
3269
 
><CODE
3270
 
CLASS="FUNCDEF"
3271
 
><TT
3272
 
CLASS="FUNCTION"
3273
 
>remote_exec</TT
3274
 
></CODE
3275
 
>(<TT
3276
 
CLASS="PARAMETER"
3277
 
><I
3278
 
>hostname</I
3279
 
></TT
3280
 
>
3281
 
                <TT
3282
 
CLASS="PARAMETER"
3283
 
><I
3284
 
>program</I
3285
 
></TT
3286
 
>
3287
 
                <TT
3288
 
CLASS="PARAMETER"
3289
 
><I
3290
 
>args</I
3291
 
></TT
3292
 
>);<P
3293
 
></P
3294
 
></DIV
3295
 
><P
3296
 
></P
3297
 
><DIV
3298
 
CLASS="VARIABLELIST"
3299
 
><DL
3300
 
><DT
3301
 
><TT
3302
 
CLASS="PARAMETER"
3303
 
><I
3304
 
>hostname</I
3305
 
></TT
3306
 
></DT
3307
 
><DD
3308
 
><P
3309
 
></P
3310
 
></DD
3311
 
><DT
3312
 
><TT
3313
 
CLASS="PARAMETER"
3314
 
><I
3315
 
>program</I
3316
 
></TT
3317
 
></DT
3318
 
><DD
3319
 
><P
3320
 
></P
3321
 
></DD
3322
 
><DT
3323
 
><TT
3324
 
CLASS="PARAMETER"
3325
 
><I
3326
 
>args</I
3327
 
></TT
3328
 
></DT
3329
 
><DD
3330
 
><P
3331
 
></P
3332
 
></DD
3333
 
></DL
3334
 
></DIV
3335
 
></DIV
3336
 
><DIV
3337
 
CLASS="SECT3"
3338
 
><H3
3339
 
CLASS="SECT3"
3340
 
><A
3341
 
NAME="REMOTEEXPECT"
3342
 
></A
3343
 
>Remote_expect Procedure</H3
3344
 
><P
3345
 
></P
3346
 
><DIV
3347
 
CLASS="FUNCSYNOPSIS"
3348
 
><A
3349
 
NAME="AEN2536"
3350
 
></A
3351
 
><P
3352
 
></P
3353
 
><CODE
3354
 
CLASS="FUNCDEF"
3355
 
><TT
3356
 
CLASS="FUNCTION"
3357
 
>remote_expect</TT
3358
 
></CODE
3359
 
>(<TT
3360
 
CLASS="PARAMETER"
3361
 
><I
3362
 
>board</I
3363
 
></TT
3364
 
>
3365
 
                <TT
3366
 
CLASS="PARAMETER"
3367
 
><I
3368
 
>timeout</I
3369
 
></TT
3370
 
>
3371
 
                <TT
3372
 
CLASS="PARAMETER"
3373
 
><I
3374
 
>args</I
3375
 
></TT
3376
 
>);<P
3377
 
></P
3378
 
></DIV
3379
 
><P
3380
 
></P
3381
 
><DIV
3382
 
CLASS="VARIABLELIST"
3383
 
><DL
3384
 
><DT
3385
 
><TT
3386
 
CLASS="PARAMETER"
3387
 
><I
3388
 
>board</I
3389
 
></TT
3390
 
></DT
3391
 
><DD
3392
 
><P
3393
 
></P
3394
 
></DD
3395
 
><DT
3396
 
><TT
3397
 
CLASS="PARAMETER"
3398
 
><I
3399
 
>timeout</I
3400
 
></TT
3401
 
></DT
3402
 
><DD
3403
 
><P
3404
 
></P
3405
 
></DD
3406
 
><DT
3407
 
><TT
3408
 
CLASS="PARAMETER"
3409
 
><I
3410
 
>args</I
3411
 
></TT
3412
 
></DT
3413
 
><DD
3414
 
><P
3415
 
></P
3416
 
></DD
3417
 
></DL
3418
 
></DIV
3419
 
></DIV
3420
 
><DIV
3421
 
CLASS="SECT3"
3422
 
><H3
3423
 
CLASS="SECT3"
3424
 
><A
3425
 
NAME="REMOTEFILE"
3426
 
></A
3427
 
>Remote_file Procedure</H3
3428
 
><P
3429
 
></P
3430
 
><DIV
3431
 
CLASS="FUNCSYNOPSIS"
3432
 
><A
3433
 
NAME="AEN2562"
3434
 
></A
3435
 
><P
3436
 
></P
3437
 
><CODE
3438
 
CLASS="FUNCDEF"
3439
 
><TT
3440
 
CLASS="FUNCTION"
3441
 
>remote_file</TT
3442
 
></CODE
3443
 
>(<TT
3444
 
CLASS="PARAMETER"
3445
 
><I
3446
 
>dest</I
3447
 
></TT
3448
 
>
3449
 
                <TT
3450
 
CLASS="PARAMETER"
3451
 
><I
3452
 
>args</I
3453
 
></TT
3454
 
>);<P
3455
 
></P
3456
 
></DIV
3457
 
><P
3458
 
></P
3459
 
><DIV
3460
 
CLASS="VARIABLELIST"
3461
 
><DL
3462
 
><DT
3463
 
><TT
3464
 
CLASS="PARAMETER"
3465
 
><I
3466
 
>dest</I
3467
 
></TT
3468
 
></DT
3469
 
><DD
3470
 
><P
3471
 
></P
3472
 
></DD
3473
 
><DT
3474
 
><TT
3475
 
CLASS="PARAMETER"
3476
 
><I
3477
 
>args</I
3478
 
></TT
3479
 
></DT
3480
 
><DD
3481
 
><P
3482
 
></P
3483
 
></DD
3484
 
></DL
3485
 
></DIV
3486
 
></DIV
3487
 
><DIV
3488
 
CLASS="SECT3"
3489
 
><H3
3490
 
CLASS="SECT3"
3491
 
><A
3492
 
NAME="REMOTELD"
3493
 
></A
3494
 
>Remote_ld Procedure</H3
3495
 
><P
3496
 
></P
3497
 
><DIV
3498
 
CLASS="FUNCSYNOPSIS"
3499
 
><A
3500
 
NAME="AEN2582"
3501
 
></A
3502
 
><P
3503
 
></P
3504
 
><CODE
3505
 
CLASS="FUNCDEF"
3506
 
><TT
3507
 
CLASS="FUNCTION"
3508
 
>remote_ld</TT
3509
 
></CODE
3510
 
>(<TT
3511
 
CLASS="PARAMETER"
3512
 
><I
3513
 
>dest</I
3514
 
></TT
3515
 
>
3516
 
                <TT
3517
 
CLASS="PARAMETER"
3518
 
><I
3519
 
>prog</I
3520
 
></TT
3521
 
>);<P
3522
 
></P
3523
 
></DIV
3524
 
><P
3525
 
></P
3526
 
><DIV
3527
 
CLASS="VARIABLELIST"
3528
 
><DL
3529
 
><DT
3530
 
><TT
3531
 
CLASS="PARAMETER"
3532
 
><I
3533
 
>dest</I
3534
 
></TT
3535
 
></DT
3536
 
><DD
3537
 
><P
3538
 
></P
3539
 
></DD
3540
 
><DT
3541
 
><TT
3542
 
CLASS="PARAMETER"
3543
 
><I
3544
 
>prog</I
3545
 
></TT
3546
 
></DT
3547
 
><DD
3548
 
><P
3549
 
></P
3550
 
></DD
3551
 
></DL
3552
 
></DIV
3553
 
></DIV
3554
 
><DIV
3555
 
CLASS="SECT3"
3556
 
><H3
3557
 
CLASS="SECT3"
3558
 
><A
3559
 
NAME="REMOTELOAD"
3560
 
></A
3561
 
>Remote_load Procedure</H3
3562
 
><P
3563
 
></P
3564
 
><DIV
3565
 
CLASS="FUNCSYNOPSIS"
3566
 
><A
3567
 
NAME="AEN2602"
3568
 
></A
3569
 
><P
3570
 
></P
3571
 
><CODE
3572
 
CLASS="FUNCDEF"
3573
 
><TT
3574
 
CLASS="FUNCTION"
3575
 
>remote_load</TT
3576
 
></CODE
3577
 
>(<TT
3578
 
CLASS="PARAMETER"
3579
 
><I
3580
 
>dest</I
3581
 
></TT
3582
 
>
3583
 
                <TT
3584
 
CLASS="PARAMETER"
3585
 
><I
3586
 
>prog</I
3587
 
></TT
3588
 
>
3589
 
                <TT
3590
 
CLASS="PARAMETER"
3591
 
><I
3592
 
>args</I
3593
 
></TT
3594
 
>);<P
3595
 
></P
3596
 
></DIV
3597
 
><P
3598
 
></P
3599
 
><DIV
3600
 
CLASS="VARIABLELIST"
3601
 
><DL
3602
 
><DT
3603
 
><TT
3604
 
CLASS="PARAMETER"
3605
 
><I
3606
 
>dest</I
3607
 
></TT
3608
 
></DT
3609
 
><DD
3610
 
><P
3611
 
></P
3612
 
></DD
3613
 
><DT
3614
 
><TT
3615
 
CLASS="PARAMETER"
3616
 
><I
3617
 
>prog</I
3618
 
></TT
3619
 
></DT
3620
 
><DD
3621
 
><P
3622
 
></P
3623
 
></DD
3624
 
><DT
3625
 
><TT
3626
 
CLASS="PARAMETER"
3627
 
><I
3628
 
>args</I
3629
 
></TT
3630
 
></DT
3631
 
><DD
3632
 
><P
3633
 
></P
3634
 
></DD
3635
 
></DL
3636
 
></DIV
3637
 
></DIV
3638
 
><DIV
3639
 
CLASS="SECT3"
3640
 
><H3
3641
 
CLASS="SECT3"
3642
 
><A
3643
 
NAME="REMOTEOPEN"
3644
 
></A
3645
 
>Remote_open Procedure</H3
3646
 
><P
3647
 
></P
3648
 
><DIV
3649
 
CLASS="FUNCSYNOPSIS"
3650
 
><A
3651
 
NAME="AEN2628"
3652
 
></A
3653
 
><P
3654
 
></P
3655
 
><CODE
3656
 
CLASS="FUNCDEF"
3657
 
><TT
3658
 
CLASS="FUNCTION"
3659
 
>remote_open</TT
3660
 
></CODE
3661
 
>(<TT
3662
 
CLASS="PARAMETER"
3663
 
><I
3664
 
>type</I
3665
 
></TT
3666
 
>);<P
3667
 
></P
3668
 
></DIV
3669
 
><P
3670
 
></P
3671
 
><DIV
3672
 
CLASS="VARIABLELIST"
3673
 
><DL
3674
 
><DT
3675
 
><TT
3676
 
CLASS="PARAMETER"
3677
 
><I
3678
 
>type</I
3679
 
></TT
3680
 
></DT
3681
 
><DD
3682
 
><P
3683
 
>This is passed <TT
3684
 
CLASS="OPTION"
3685
 
>host</TT
3686
 
> or
3687
 
                <TT
3688
 
CLASS="OPTION"
3689
 
>target</TT
3690
 
>. Host or target refers to
3691
 
              whether it is a connection to a remote target, or a
3692
 
              remote host. This opens the connection to the desired
3693
 
              target or host using the default values in the
3694
 
              configuration system. It returns that
3695
 
              <SPAN
3696
 
CLASS="SYMBOL"
3697
 
>spawn_id</SPAN
3698
 
> of the process that manages
3699
 
              the connection. This value can be used in
3700
 
              <SPAN
3701
 
CLASS="PRODUCTNAME"
3702
 
>Expect</SPAN
3703
 
> or
3704
 
              <B
3705
 
CLASS="COMMAND"
3706
 
>exp_send</B
3707
 
> statements, or passed to
3708
 
              other procedures that need the connection process's
3709
 
              id. This also sets the <SPAN
3710
 
CLASS="SYMBOL"
3711
 
>fileid</SPAN
3712
 
> field in
3713
 
              the <SPAN
3714
 
CLASS="SYMBOL"
3715
 
>target_info</SPAN
3716
 
> array.</P
3717
 
></DD
3718
 
></DL
3719
 
></DIV
3720
 
></DIV
3721
 
><DIV
3722
 
CLASS="SECT3"
3723
 
><H3
3724
 
CLASS="SECT3"
3725
 
><A
3726
 
NAME="REMOTEPOPCONN"
3727
 
></A
3728
 
>Remote_pop_conn Procedure</H3
3729
 
><P
3730
 
></P
3731
 
><DIV
3732
 
CLASS="FUNCSYNOPSIS"
3733
 
><A
3734
 
NAME="AEN2649"
3735
 
></A
3736
 
><P
3737
 
></P
3738
 
><CODE
3739
 
CLASS="FUNCDEF"
3740
 
><TT
3741
 
CLASS="FUNCTION"
3742
 
>remote_pop_conn</TT
3743
 
></CODE
3744
 
>(<TT
3745
 
CLASS="PARAMETER"
3746
 
><I
3747
 
>host</I
3748
 
></TT
3749
 
>);<P
3750
 
></P
3751
 
></DIV
3752
 
><P
3753
 
></P
3754
 
><DIV
3755
 
CLASS="VARIABLELIST"
3756
 
><DL
3757
 
><DT
3758
 
><TT
3759
 
CLASS="PARAMETER"
3760
 
><I
3761
 
>host</I
3762
 
></TT
3763
 
></DT
3764
 
><DD
3765
 
><P
3766
 
></P
3767
 
></DD
3768
 
></DL
3769
 
></DIV
3770
 
></DIV
3771
 
><DIV
3772
 
CLASS="SECT3"
3773
 
><H3
3774
 
CLASS="SECT3"
3775
 
><A
3776
 
NAME="REMOTEPUSHCONN"
3777
 
></A
3778
 
>Remote_push_conn Procedure</H3
3779
 
><P
3780
 
></P
3781
 
><DIV
3782
 
CLASS="FUNCSYNOPSIS"
3783
 
><A
3784
 
NAME="AEN2663"
3785
 
></A
3786
 
><P
3787
 
></P
3788
 
><CODE
3789
 
CLASS="FUNCDEF"
3790
 
><TT
3791
 
CLASS="FUNCTION"
3792
 
>remote_push_conn</TT
3793
 
></CODE
3794
 
>(<TT
3795
 
CLASS="PARAMETER"
3796
 
><I
3797
 
>host</I
3798
 
></TT
3799
 
>);<P
3800
 
></P
3801
 
></DIV
3802
 
><P
3803
 
></P
3804
 
><DIV
3805
 
CLASS="VARIABLELIST"
3806
 
><DL
3807
 
><DT
3808
 
><TT
3809
 
CLASS="PARAMETER"
3810
 
><I
3811
 
>host</I
3812
 
></TT
3813
 
></DT
3814
 
><DD
3815
 
><P
3816
 
></P
3817
 
></DD
3818
 
></DL
3819
 
></DIV
3820
 
></DIV
3821
 
><DIV
3822
 
CLASS="SECT3"
3823
 
><H3
3824
 
CLASS="SECT3"
3825
 
><A
3826
 
NAME="REMOTERAWBINARY"
3827
 
></A
3828
 
>Remote_raw_binary Procedure</H3
3829
 
><P
3830
 
></P
3831
 
><DIV
3832
 
CLASS="FUNCSYNOPSIS"
3833
 
><A
3834
 
NAME="AEN2677"
3835
 
></A
3836
 
><P
3837
 
></P
3838
 
><CODE
3839
 
CLASS="FUNCDEF"
3840
 
><TT
3841
 
CLASS="FUNCTION"
3842
 
>remote_raw_binary</TT
3843
 
></CODE
3844
 
>(<TT
3845
 
CLASS="PARAMETER"
3846
 
><I
3847
 
>host</I
3848
 
></TT
3849
 
>);<P
3850
 
></P
3851
 
></DIV
3852
 
><P
3853
 
></P
3854
 
><DIV
3855
 
CLASS="VARIABLELIST"
3856
 
><DL
3857
 
><DT
3858
 
><TT
3859
 
CLASS="PARAMETER"
3860
 
><I
3861
 
>host</I
3862
 
></TT
3863
 
></DT
3864
 
><DD
3865
 
><P
3866
 
></P
3867
 
></DD
3868
 
></DL
3869
 
></DIV
3870
 
></DIV
3871
 
><DIV
3872
 
CLASS="SECT3"
3873
 
><H3
3874
 
CLASS="SECT3"
3875
 
><A
3876
 
NAME="REMOTERAWCLOSE"
3877
 
></A
3878
 
>Remote_raw_close Procedure</H3
3879
 
><P
3880
 
></P
3881
 
><DIV
3882
 
CLASS="FUNCSYNOPSIS"
3883
 
><A
3884
 
NAME="AEN2691"
3885
 
></A
3886
 
><P
3887
 
></P
3888
 
><CODE
3889
 
CLASS="FUNCDEF"
3890
 
><TT
3891
 
CLASS="FUNCTION"
3892
 
>remote_raw_close</TT
3893
 
></CODE
3894
 
>(<TT
3895
 
CLASS="PARAMETER"
3896
 
><I
3897
 
>host</I
3898
 
></TT
3899
 
>);<P
3900
 
></P
3901
 
></DIV
3902
 
><P
3903
 
></P
3904
 
><DIV
3905
 
CLASS="VARIABLELIST"
3906
 
><DL
3907
 
><DT
3908
 
><TT
3909
 
CLASS="PARAMETER"
3910
 
><I
3911
 
>host</I
3912
 
></TT
3913
 
></DT
3914
 
><DD
3915
 
><P
3916
 
></P
3917
 
></DD
3918
 
></DL
3919
 
></DIV
3920
 
></DIV
3921
 
><DIV
3922
 
CLASS="SECT3"
3923
 
><H3
3924
 
CLASS="SECT3"
3925
 
><A
3926
 
NAME="REMOTERAWFILE"
3927
 
></A
3928
 
>Remote_raw_file Procedure</H3
3929
 
><P
3930
 
></P
3931
 
><DIV
3932
 
CLASS="FUNCSYNOPSIS"
3933
 
><A
3934
 
NAME="AEN2705"
3935
 
></A
3936
 
><P
3937
 
></P
3938
 
><CODE
3939
 
CLASS="FUNCDEF"
3940
 
><TT
3941
 
CLASS="FUNCTION"
3942
 
>remote_raw_file</TT
3943
 
></CODE
3944
 
>(<TT
3945
 
CLASS="PARAMETER"
3946
 
><I
3947
 
>dest</I
3948
 
></TT
3949
 
>
3950
 
                <TT
3951
 
CLASS="PARAMETER"
3952
 
><I
3953
 
>args</I
3954
 
></TT
3955
 
>);<P
3956
 
></P
3957
 
></DIV
3958
 
><P
3959
 
></P
3960
 
><DIV
3961
 
CLASS="VARIABLELIST"
3962
 
><DL
3963
 
><DT
3964
 
><TT
3965
 
CLASS="PARAMETER"
3966
 
><I
3967
 
>dest</I
3968
 
></TT
3969
 
></DT
3970
 
><DD
3971
 
><P
3972
 
></P
3973
 
></DD
3974
 
><DT
3975
 
><TT
3976
 
CLASS="PARAMETER"
3977
 
><I
3978
 
>args</I
3979
 
></TT
3980
 
></DT
3981
 
><DD
3982
 
><P
3983
 
></P
3984
 
></DD
3985
 
></DL
3986
 
></DIV
3987
 
></DIV
3988
 
><DIV
3989
 
CLASS="SECT3"
3990
 
><H3
3991
 
CLASS="SECT3"
3992
 
><A
3993
 
NAME="REMOTERAWLD"
3994
 
></A
3995
 
>remote_raw_ld Procedure</H3
3996
 
><P
3997
 
></P
3998
 
><DIV
3999
 
CLASS="FUNCSYNOPSIS"
4000
 
><A
4001
 
NAME="AEN2725"
4002
 
></A
4003
 
><P
4004
 
></P
4005
 
><CODE
4006
 
CLASS="FUNCDEF"
4007
 
><TT
4008
 
CLASS="FUNCTION"
4009
 
>remote_raw_ld</TT
4010
 
></CODE
4011
 
>(<TT
4012
 
CLASS="PARAMETER"
4013
 
><I
4014
 
>dest</I
4015
 
></TT
4016
 
>
4017
 
                <TT
4018
 
CLASS="PARAMETER"
4019
 
><I
4020
 
>prog</I
4021
 
></TT
4022
 
>);<P
4023
 
></P
4024
 
></DIV
4025
 
><P
4026
 
></P
4027
 
><DIV
4028
 
CLASS="VARIABLELIST"
4029
 
><DL
4030
 
><DT
4031
 
><TT
4032
 
CLASS="PARAMETER"
4033
 
><I
4034
 
>dest</I
4035
 
></TT
4036
 
></DT
4037
 
><DD
4038
 
><P
4039
 
></P
4040
 
></DD
4041
 
><DT
4042
 
><TT
4043
 
CLASS="PARAMETER"
4044
 
><I
4045
 
>prog</I
4046
 
></TT
4047
 
></DT
4048
 
><DD
4049
 
><P
4050
 
></P
4051
 
></DD
4052
 
></DL
4053
 
></DIV
4054
 
></DIV
4055
 
><DIV
4056
 
CLASS="SECT3"
4057
 
><H3
4058
 
CLASS="SECT3"
4059
 
><A
4060
 
NAME="REMOTERAWLOAD"
4061
 
></A
4062
 
>Remote_raw_load Procedure</H3
4063
 
><P
4064
 
></P
4065
 
><DIV
4066
 
CLASS="FUNCSYNOPSIS"
4067
 
><A
4068
 
NAME="AEN2745"
4069
 
></A
4070
 
><P
4071
 
></P
4072
 
><CODE
4073
 
CLASS="FUNCDEF"
4074
 
><TT
4075
 
CLASS="FUNCTION"
4076
 
>remote_raw_load</TT
4077
 
></CODE
4078
 
>(<TT
4079
 
CLASS="PARAMETER"
4080
 
><I
4081
 
>dest</I
4082
 
></TT
4083
 
>
4084
 
                <TT
4085
 
CLASS="PARAMETER"
4086
 
><I
4087
 
>prog</I
4088
 
></TT
4089
 
>
4090
 
                <TT
4091
 
CLASS="PARAMETER"
4092
 
><I
4093
 
>args</I
4094
 
></TT
4095
 
>);<P
4096
 
></P
4097
 
></DIV
4098
 
><P
4099
 
></P
4100
 
><DIV
4101
 
CLASS="VARIABLELIST"
4102
 
><DL
4103
 
><DT
4104
 
><TT
4105
 
CLASS="PARAMETER"
4106
 
><I
4107
 
>dest</I
4108
 
></TT
4109
 
></DT
4110
 
><DD
4111
 
><P
4112
 
></P
4113
 
></DD
4114
 
><DT
4115
 
><TT
4116
 
CLASS="PARAMETER"
4117
 
><I
4118
 
>prog</I
4119
 
></TT
4120
 
></DT
4121
 
><DD
4122
 
><P
4123
 
></P
4124
 
></DD
4125
 
><DT
4126
 
><TT
4127
 
CLASS="PARAMETER"
4128
 
><I
4129
 
>args</I
4130
 
></TT
4131
 
></DT
4132
 
><DD
4133
 
><P
4134
 
></P
4135
 
></DD
4136
 
></DL
4137
 
></DIV
4138
 
></DIV
4139
 
><DIV
4140
 
CLASS="SECT3"
4141
 
><H3
4142
 
CLASS="SECT3"
4143
 
><A
4144
 
NAME="REMOTERAWOPEN"
4145
 
></A
4146
 
>Remote_raw_open Procedure</H3
4147
 
><P
4148
 
></P
4149
 
><DIV
4150
 
CLASS="FUNCSYNOPSIS"
4151
 
><A
4152
 
NAME="AEN2771"
4153
 
></A
4154
 
><P
4155
 
></P
4156
 
><CODE
4157
 
CLASS="FUNCDEF"
4158
 
><TT
4159
 
CLASS="FUNCTION"
4160
 
>remote_raw_open</TT
4161
 
></CODE
4162
 
>(<TT
4163
 
CLASS="PARAMETER"
4164
 
><I
4165
 
>args</I
4166
 
></TT
4167
 
>);<P
4168
 
></P
4169
 
></DIV
4170
 
><P
4171
 
></P
4172
 
><DIV
4173
 
CLASS="VARIABLELIST"
4174
 
><DL
4175
 
><DT
4176
 
><TT
4177
 
CLASS="PARAMETER"
4178
 
><I
4179
 
>args</I
4180
 
></TT
4181
 
></DT
4182
 
><DD
4183
 
><P
4184
 
></P
4185
 
></DD
4186
 
></DL
4187
 
></DIV
4188
 
></DIV
4189
 
><DIV
4190
 
CLASS="SECT3"
4191
 
><H3
4192
 
CLASS="SECT3"
4193
 
><A
4194
 
NAME="REMOTERAWSEND"
4195
 
></A
4196
 
>Remote_raw_send Procedure</H3
4197
 
><P
4198
 
></P
4199
 
><DIV
4200
 
CLASS="FUNCSYNOPSIS"
4201
 
><A
4202
 
NAME="AEN2785"
4203
 
></A
4204
 
><P
4205
 
></P
4206
 
><CODE
4207
 
CLASS="FUNCDEF"
4208
 
><TT
4209
 
CLASS="FUNCTION"
4210
 
>remote_raw_send</TT
4211
 
></CODE
4212
 
>(<TT
4213
 
CLASS="PARAMETER"
4214
 
><I
4215
 
>dest</I
4216
 
></TT
4217
 
>
4218
 
                <TT
4219
 
CLASS="PARAMETER"
4220
 
><I
4221
 
>string</I
4222
 
></TT
4223
 
>);<P
4224
 
></P
4225
 
></DIV
4226
 
><P
4227
 
></P
4228
 
><DIV
4229
 
CLASS="VARIABLELIST"
4230
 
><DL
4231
 
><DT
4232
 
><TT
4233
 
CLASS="PARAMETER"
4234
 
><I
4235
 
>dest</I
4236
 
></TT
4237
 
></DT
4238
 
><DD
4239
 
><P
4240
 
></P
4241
 
></DD
4242
 
><DT
4243
 
><TT
4244
 
CLASS="PARAMETER"
4245
 
><I
4246
 
>string</I
4247
 
></TT
4248
 
></DT
4249
 
><DD
4250
 
><P
4251
 
></P
4252
 
></DD
4253
 
></DL
4254
 
></DIV
4255
 
></DIV
4256
 
><DIV
4257
 
CLASS="SECT3"
4258
 
><H3
4259
 
CLASS="SECT3"
4260
 
><A
4261
 
NAME="REMOTERAWSPAWN"
4262
 
></A
4263
 
>Remote_raw_spawn Procedure</H3
4264
 
><P
4265
 
></P
4266
 
><DIV
4267
 
CLASS="FUNCSYNOPSIS"
4268
 
><A
4269
 
NAME="AEN2805"
4270
 
></A
4271
 
><P
4272
 
></P
4273
 
><CODE
4274
 
CLASS="FUNCDEF"
4275
 
><TT
4276
 
CLASS="FUNCTION"
4277
 
>remote_raw_spawn</TT
4278
 
></CODE
4279
 
>(<TT
4280
 
CLASS="PARAMETER"
4281
 
><I
4282
 
>dest</I
4283
 
></TT
4284
 
>
4285
 
                <TT
4286
 
CLASS="PARAMETER"
4287
 
><I
4288
 
>commandline</I
4289
 
></TT
4290
 
>);<P
4291
 
></P
4292
 
></DIV
4293
 
><P
4294
 
></P
4295
 
><DIV
4296
 
CLASS="VARIABLELIST"
4297
 
><DL
4298
 
><DT
4299
 
><TT
4300
 
CLASS="PARAMETER"
4301
 
><I
4302
 
>dest</I
4303
 
></TT
4304
 
></DT
4305
 
><DD
4306
 
><P
4307
 
></P
4308
 
></DD
4309
 
><DT
4310
 
><TT
4311
 
CLASS="PARAMETER"
4312
 
><I
4313
 
>commandline</I
4314
 
></TT
4315
 
></DT
4316
 
><DD
4317
 
><P
4318
 
></P
4319
 
></DD
4320
 
></DL
4321
 
></DIV
4322
 
></DIV
4323
 
><DIV
4324
 
CLASS="SECT3"
4325
 
><H3
4326
 
CLASS="SECT3"
4327
 
><A
4328
 
NAME="REMOTERAWTRANSMIT"
4329
 
></A
4330
 
>Remote_raw_transmit Procedure</H3
4331
 
><P
4332
 
></P
4333
 
><DIV
4334
 
CLASS="FUNCSYNOPSIS"
4335
 
><A
4336
 
NAME="AEN2825"
4337
 
></A
4338
 
><P
4339
 
></P
4340
 
><CODE
4341
 
CLASS="FUNCDEF"
4342
 
><TT
4343
 
CLASS="FUNCTION"
4344
 
>remote_raw_transmit</TT
4345
 
></CODE
4346
 
>(<TT
4347
 
CLASS="PARAMETER"
4348
 
><I
4349
 
>dest</I
4350
 
></TT
4351
 
>
4352
 
                <TT
4353
 
CLASS="PARAMETER"
4354
 
><I
4355
 
>file</I
4356
 
></TT
4357
 
>);<P
4358
 
></P
4359
 
></DIV
4360
 
><P
4361
 
></P
4362
 
><DIV
4363
 
CLASS="VARIABLELIST"
4364
 
><DL
4365
 
><DT
4366
 
><TT
4367
 
CLASS="PARAMETER"
4368
 
><I
4369
 
>dest</I
4370
 
></TT
4371
 
></DT
4372
 
><DD
4373
 
><P
4374
 
></P
4375
 
></DD
4376
 
><DT
4377
 
><TT
4378
 
CLASS="PARAMETER"
4379
 
><I
4380
 
>file</I
4381
 
></TT
4382
 
></DT
4383
 
><DD
4384
 
><P
4385
 
></P
4386
 
></DD
4387
 
></DL
4388
 
></DIV
4389
 
></DIV
4390
 
><DIV
4391
 
CLASS="SECT3"
4392
 
><H3
4393
 
CLASS="SECT3"
4394
 
><A
4395
 
NAME="REMOTERAWWAIT"
4396
 
></A
4397
 
>Remote_raw_wait Procedure</H3
4398
 
><P
4399
 
></P
4400
 
><DIV
4401
 
CLASS="FUNCSYNOPSIS"
4402
 
><A
4403
 
NAME="AEN2845"
4404
 
></A
4405
 
><P
4406
 
></P
4407
 
><CODE
4408
 
CLASS="FUNCDEF"
4409
 
><TT
4410
 
CLASS="FUNCTION"
4411
 
>remote_raw_wait</TT
4412
 
></CODE
4413
 
>(<TT
4414
 
CLASS="PARAMETER"
4415
 
><I
4416
 
>dest</I
4417
 
></TT
4418
 
>
4419
 
                <TT
4420
 
CLASS="PARAMETER"
4421
 
><I
4422
 
>timeout</I
4423
 
></TT
4424
 
>);<P
4425
 
></P
4426
 
></DIV
4427
 
><P
4428
 
></P
4429
 
><DIV
4430
 
CLASS="VARIABLELIST"
4431
 
><DL
4432
 
><DT
4433
 
><TT
4434
 
CLASS="PARAMETER"
4435
 
><I
4436
 
>dest</I
4437
 
></TT
4438
 
></DT
4439
 
><DD
4440
 
><P
4441
 
></P
4442
 
></DD
4443
 
><DT
4444
 
><TT
4445
 
CLASS="PARAMETER"
4446
 
><I
4447
 
>timeout</I
4448
 
></TT
4449
 
></DT
4450
 
><DD
4451
 
><P
4452
 
></P
4453
 
></DD
4454
 
></DL
4455
 
></DIV
4456
 
></DIV
4457
 
><DIV
4458
 
CLASS="SECT3"
4459
 
><H3
4460
 
CLASS="SECT3"
4461
 
><A
4462
 
NAME="REMOTEREBOOT"
4463
 
></A
4464
 
>Remote_reboot Procedure</H3
4465
 
><P
4466
 
></P
4467
 
><DIV
4468
 
CLASS="FUNCSYNOPSIS"
4469
 
><A
4470
 
NAME="AEN2865"
4471
 
></A
4472
 
><P
4473
 
></P
4474
 
><CODE
4475
 
CLASS="FUNCDEF"
4476
 
><TT
4477
 
CLASS="FUNCTION"
4478
 
>remote_reboot</TT
4479
 
></CODE
4480
 
>(<TT
4481
 
CLASS="PARAMETER"
4482
 
><I
4483
 
>host</I
4484
 
></TT
4485
 
>);<P
4486
 
></P
4487
 
></DIV
4488
 
><P
4489
 
></P
4490
 
><DIV
4491
 
CLASS="VARIABLELIST"
4492
 
><DL
4493
 
><DT
4494
 
><TT
4495
 
CLASS="PARAMETER"
4496
 
><I
4497
 
>host</I
4498
 
></TT
4499
 
></DT
4500
 
><DD
4501
 
><P
4502
 
></P
4503
 
></DD
4504
 
></DL
4505
 
></DIV
4506
 
></DIV
4507
 
><DIV
4508
 
CLASS="SECT3"
4509
 
><H3
4510
 
CLASS="SECT3"
4511
 
><A
4512
 
NAME="REMOTESEND"
4513
 
></A
4514
 
>Remote_send Procedure</H3
4515
 
><P
4516
 
></P
4517
 
><DIV
4518
 
CLASS="FUNCSYNOPSIS"
4519
 
><A
4520
 
NAME="AEN2879"
4521
 
></A
4522
 
><P
4523
 
></P
4524
 
><CODE
4525
 
CLASS="FUNCDEF"
4526
 
><TT
4527
 
CLASS="FUNCTION"
4528
 
>remote_send</TT
4529
 
></CODE
4530
 
>(<TT
4531
 
CLASS="PARAMETER"
4532
 
><I
4533
 
>dest</I
4534
 
></TT
4535
 
>
4536
 
                <TT
4537
 
CLASS="PARAMETER"
4538
 
><I
4539
 
>string</I
4540
 
></TT
4541
 
>);<P
4542
 
></P
4543
 
></DIV
4544
 
><P
4545
 
></P
4546
 
><DIV
4547
 
CLASS="VARIABLELIST"
4548
 
><DL
4549
 
><DT
4550
 
><TT
4551
 
CLASS="PARAMETER"
4552
 
><I
4553
 
>dest</I
4554
 
></TT
4555
 
></DT
4556
 
><DD
4557
 
><P
4558
 
></P
4559
 
></DD
4560
 
><DT
4561
 
><TT
4562
 
CLASS="PARAMETER"
4563
 
><I
4564
 
>string</I
4565
 
></TT
4566
 
></DT
4567
 
><DD
4568
 
><P
4569
 
></P
4570
 
></DD
4571
 
></DL
4572
 
></DIV
4573
 
></DIV
4574
 
><DIV
4575
 
CLASS="SECT3"
4576
 
><H3
4577
 
CLASS="SECT3"
4578
 
><A
4579
 
NAME="REMOTESPAWN"
4580
 
></A
4581
 
>Remote_spawn Procedure</H3
4582
 
><P
4583
 
></P
4584
 
><DIV
4585
 
CLASS="FUNCSYNOPSIS"
4586
 
><A
4587
 
NAME="AEN2899"
4588
 
></A
4589
 
><P
4590
 
></P
4591
 
><CODE
4592
 
CLASS="FUNCDEF"
4593
 
><TT
4594
 
CLASS="FUNCTION"
4595
 
>remote_spawn</TT
4596
 
></CODE
4597
 
>(<TT
4598
 
CLASS="PARAMETER"
4599
 
><I
4600
 
>dest</I
4601
 
></TT
4602
 
>
4603
 
                <TT
4604
 
CLASS="PARAMETER"
4605
 
><I
4606
 
>commandline</I
4607
 
></TT
4608
 
>
4609
 
                <TT
4610
 
CLASS="PARAMETER"
4611
 
><I
4612
 
>args</I
4613
 
></TT
4614
 
>);<P
4615
 
></P
4616
 
></DIV
4617
 
><P
4618
 
></P
4619
 
><DIV
4620
 
CLASS="VARIABLELIST"
4621
 
><DL
4622
 
><DT
4623
 
><TT
4624
 
CLASS="PARAMETER"
4625
 
><I
4626
 
>dest</I
4627
 
></TT
4628
 
></DT
4629
 
><DD
4630
 
><P
4631
 
></P
4632
 
></DD
4633
 
><DT
4634
 
><TT
4635
 
CLASS="PARAMETER"
4636
 
><I
4637
 
>commandline</I
4638
 
></TT
4639
 
></DT
4640
 
><DD
4641
 
><P
4642
 
></P
4643
 
></DD
4644
 
><DT
4645
 
><TT
4646
 
CLASS="PARAMETER"
4647
 
><I
4648
 
>args</I
4649
 
></TT
4650
 
></DT
4651
 
><DD
4652
 
><P
4653
 
></P
4654
 
></DD
4655
 
></DL
4656
 
></DIV
4657
 
></DIV
4658
 
><DIV
4659
 
CLASS="SECT3"
4660
 
><H3
4661
 
CLASS="SECT3"
4662
 
><A
4663
 
NAME="REMOTESWAPCONN"
4664
 
></A
4665
 
>Remote_swap_conn Procedure</H3
4666
 
><P
4667
 
></P
4668
 
><DIV
4669
 
CLASS="FUNCSYNOPSIS"
4670
 
><A
4671
 
NAME="AEN2925"
4672
 
></A
4673
 
><P
4674
 
></P
4675
 
><CODE
4676
 
CLASS="FUNCDEF"
4677
 
><TT
4678
 
CLASS="FUNCTION"
4679
 
>remote_swap_conn</TT
4680
 
></CODE
4681
 
>(<TT
4682
 
CLASS="PARAMETER"
4683
 
><I
4684
 
>host</I
4685
 
></TT
4686
 
>);<P
4687
 
></P
4688
 
></DIV
4689
 
><P
4690
 
></P
4691
 
><DIV
4692
 
CLASS="VARIABLELIST"
4693
 
><DL
4694
 
><DT
4695
 
><TT
4696
 
CLASS="PARAMETER"
4697
 
><I
4698
 
></I
4699
 
></TT
4700
 
></DT
4701
 
><DD
4702
 
><P
4703
 
></P
4704
 
></DD
4705
 
></DL
4706
 
></DIV
4707
 
></DIV
4708
 
><DIV
4709
 
CLASS="SECT3"
4710
 
><H3
4711
 
CLASS="SECT3"
4712
 
><A
4713
 
NAME="REMOTETRANSMIT"
4714
 
></A
4715
 
>Remote_transmit Procedure</H3
4716
 
><P
4717
 
></P
4718
 
><DIV
4719
 
CLASS="FUNCSYNOPSIS"
4720
 
><A
4721
 
NAME="AEN2939"
4722
 
></A
4723
 
><P
4724
 
></P
4725
 
><CODE
4726
 
CLASS="FUNCDEF"
4727
 
><TT
4728
 
CLASS="FUNCTION"
4729
 
>remote_transmit</TT
4730
 
></CODE
4731
 
>(<TT
4732
 
CLASS="PARAMETER"
4733
 
><I
4734
 
>dest</I
4735
 
></TT
4736
 
>
4737
 
                <TT
4738
 
CLASS="PARAMETER"
4739
 
><I
4740
 
>file</I
4741
 
></TT
4742
 
>);<P
4743
 
></P
4744
 
></DIV
4745
 
><P
4746
 
></P
4747
 
><DIV
4748
 
CLASS="VARIABLELIST"
4749
 
><DL
4750
 
><DT
4751
 
><TT
4752
 
CLASS="PARAMETER"
4753
 
><I
4754
 
>dest</I
4755
 
></TT
4756
 
></DT
4757
 
><DD
4758
 
><P
4759
 
></P
4760
 
></DD
4761
 
><DT
4762
 
><TT
4763
 
CLASS="PARAMETER"
4764
 
><I
4765
 
>file</I
4766
 
></TT
4767
 
></DT
4768
 
><DD
4769
 
><P
4770
 
></P
4771
 
></DD
4772
 
></DL
4773
 
></DIV
4774
 
></DIV
4775
 
><DIV
4776
 
CLASS="SECT3"
4777
 
><H3
4778
 
CLASS="SECT3"
4779
 
><A
4780
 
NAME="REMOTEUPLOAD"
4781
 
></A
4782
 
>Remote_upload Procedure</H3
4783
 
><P
4784
 
></P
4785
 
><DIV
4786
 
CLASS="FUNCSYNOPSIS"
4787
 
><A
4788
 
NAME="AEN2959"
4789
 
></A
4790
 
><P
4791
 
></P
4792
 
><CODE
4793
 
CLASS="FUNCDEF"
4794
 
><TT
4795
 
CLASS="FUNCTION"
4796
 
>remote_upload</TT
4797
 
></CODE
4798
 
>(<TT
4799
 
CLASS="PARAMETER"
4800
 
><I
4801
 
>dest</I
4802
 
></TT
4803
 
>
4804
 
                <TT
4805
 
CLASS="PARAMETER"
4806
 
><I
4807
 
>srcfile</I
4808
 
></TT
4809
 
>
4810
 
                <TT
4811
 
CLASS="PARAMETER"
4812
 
><I
4813
 
>arg</I
4814
 
></TT
4815
 
>);<P
4816
 
></P
4817
 
></DIV
4818
 
><P
4819
 
></P
4820
 
><DIV
4821
 
CLASS="VARIABLELIST"
4822
 
><DL
4823
 
><DT
4824
 
><TT
4825
 
CLASS="PARAMETER"
4826
 
><I
4827
 
>dest</I
4828
 
></TT
4829
 
></DT
4830
 
><DD
4831
 
><P
4832
 
></P
4833
 
></DD
4834
 
><DT
4835
 
><TT
4836
 
CLASS="PARAMETER"
4837
 
><I
4838
 
>srcfile</I
4839
 
></TT
4840
 
></DT
4841
 
><DD
4842
 
><P
4843
 
></P
4844
 
></DD
4845
 
><DT
4846
 
><TT
4847
 
CLASS="PARAMETER"
4848
 
><I
4849
 
>arg</I
4850
 
></TT
4851
 
></DT
4852
 
><DD
4853
 
><P
4854
 
></P
4855
 
></DD
4856
 
></DL
4857
 
></DIV
4858
 
></DIV
4859
 
><DIV
4860
 
CLASS="SECT3"
4861
 
><H3
4862
 
CLASS="SECT3"
4863
 
><A
4864
 
NAME="REMOTEWAIT"
4865
 
></A
4866
 
>Remote_wait Procedure</H3
4867
 
><P
4868
 
></P
4869
 
><DIV
4870
 
CLASS="FUNCSYNOPSIS"
4871
 
><A
4872
 
NAME="AEN2985"
4873
 
></A
4874
 
><P
4875
 
></P
4876
 
><CODE
4877
 
CLASS="FUNCDEF"
4878
 
><TT
4879
 
CLASS="FUNCTION"
4880
 
>remote_wait</TT
4881
 
></CODE
4882
 
>(<TT
4883
 
CLASS="PARAMETER"
4884
 
><I
4885
 
>dest</I
4886
 
></TT
4887
 
>
4888
 
                <TT
4889
 
CLASS="PARAMETER"
4890
 
><I
4891
 
>timeout</I
4892
 
></TT
4893
 
>);<P
4894
 
></P
4895
 
></DIV
4896
 
><P
4897
 
></P
4898
 
><DIV
4899
 
CLASS="VARIABLELIST"
4900
 
><DL
4901
 
><DT
4902
 
><TT
4903
 
CLASS="PARAMETER"
4904
 
><I
4905
 
>dest</I
4906
 
></TT
4907
 
></DT
4908
 
><DD
4909
 
><P
4910
 
></P
4911
 
></DD
4912
 
><DT
4913
 
><TT
4914
 
CLASS="PARAMETER"
4915
 
><I
4916
 
>timeout</I
4917
 
></TT
4918
 
></DT
4919
 
><DD
4920
 
><P
4921
 
></P
4922
 
></DD
4923
 
></DL
4924
 
></DIV
4925
 
></DIV
4926
 
><DIV
4927
 
CLASS="SECT3"
4928
 
><H3
4929
 
CLASS="SECT3"
4930
 
><A
4931
 
NAME="STANDARDCLOSE"
4932
 
></A
4933
 
>Standard_close Procedure</H3
4934
 
><P
4935
 
></P
4936
 
><DIV
4937
 
CLASS="FUNCSYNOPSIS"
4938
 
><A
4939
 
NAME="AEN3005"
4940
 
></A
4941
 
><P
4942
 
></P
4943
 
><CODE
4944
 
CLASS="FUNCDEF"
4945
 
><TT
4946
 
CLASS="FUNCTION"
4947
 
>standard_close</TT
4948
 
></CODE
4949
 
>(<TT
4950
 
CLASS="PARAMETER"
4951
 
><I
4952
 
>host</I
4953
 
></TT
4954
 
>);<P
4955
 
></P
4956
 
></DIV
4957
 
><P
4958
 
></P
4959
 
><DIV
4960
 
CLASS="VARIABLELIST"
4961
 
><DL
4962
 
><DT
4963
 
><TT
4964
 
CLASS="PARAMETER"
4965
 
><I
4966
 
>host</I
4967
 
></TT
4968
 
></DT
4969
 
><DD
4970
 
><P
4971
 
></P
4972
 
></DD
4973
 
></DL
4974
 
></DIV
4975
 
></DIV
4976
 
><DIV
4977
 
CLASS="SECT3"
4978
 
><H3
4979
 
CLASS="SECT3"
4980
 
><A
4981
 
NAME="STANDARDDOWNLOAD"
4982
 
></A
4983
 
>Standard_download Procedure</H3
4984
 
><P
4985
 
></P
4986
 
><DIV
4987
 
CLASS="FUNCSYNOPSIS"
4988
 
><A
4989
 
NAME="AEN3019"
4990
 
></A
4991
 
><P
4992
 
></P
4993
 
><CODE
4994
 
CLASS="FUNCDEF"
4995
 
><TT
4996
 
CLASS="FUNCTION"
4997
 
>standard_download</TT
4998
 
></CODE
4999
 
>(<TT
5000
 
CLASS="PARAMETER"
5001
 
><I
5002
 
>dest</I
5003
 
></TT
5004
 
>
5005
 
                <TT
5006
 
CLASS="PARAMETER"
5007
 
><I
5008
 
>file</I
5009
 
></TT
5010
 
>
5011
 
                <TT
5012
 
CLASS="PARAMETER"
5013
 
><I
5014
 
>destfile</I
5015
 
></TT
5016
 
>);<P
5017
 
></P
5018
 
></DIV
5019
 
><P
5020
 
></P
5021
 
><DIV
5022
 
CLASS="VARIABLELIST"
5023
 
><DL
5024
 
><DT
5025
 
><TT
5026
 
CLASS="PARAMETER"
5027
 
><I
5028
 
>dest</I
5029
 
></TT
5030
 
></DT
5031
 
><DD
5032
 
><P
5033
 
></P
5034
 
></DD
5035
 
><DT
5036
 
><TT
5037
 
CLASS="PARAMETER"
5038
 
><I
5039
 
>file</I
5040
 
></TT
5041
 
></DT
5042
 
><DD
5043
 
><P
5044
 
></P
5045
 
></DD
5046
 
><DT
5047
 
><TT
5048
 
CLASS="PARAMETER"
5049
 
><I
5050
 
>destfile</I
5051
 
></TT
5052
 
></DT
5053
 
><DD
5054
 
><P
5055
 
></P
5056
 
></DD
5057
 
></DL
5058
 
></DIV
5059
 
></DIV
5060
 
><DIV
5061
 
CLASS="SECT3"
5062
 
><H3
5063
 
CLASS="SECT3"
5064
 
><A
5065
 
NAME="STANDARDEXEC"
5066
 
></A
5067
 
>Standard_exec Procedure</H3
5068
 
><P
5069
 
></P
5070
 
><DIV
5071
 
CLASS="FUNCSYNOPSIS"
5072
 
><A
5073
 
NAME="AEN3045"
5074
 
></A
5075
 
><P
5076
 
></P
5077
 
><CODE
5078
 
CLASS="FUNCDEF"
5079
 
><TT
5080
 
CLASS="FUNCTION"
5081
 
>standard_exec</TT
5082
 
></CODE
5083
 
>(<TT
5084
 
CLASS="PARAMETER"
5085
 
><I
5086
 
>hostname</I
5087
 
></TT
5088
 
>
5089
 
                <TT
5090
 
CLASS="PARAMETER"
5091
 
><I
5092
 
>args</I
5093
 
></TT
5094
 
>);<P
5095
 
></P
5096
 
></DIV
5097
 
><P
5098
 
></P
5099
 
><DIV
5100
 
CLASS="VARIABLELIST"
5101
 
><DL
5102
 
><DT
5103
 
><TT
5104
 
CLASS="PARAMETER"
5105
 
><I
5106
 
>hostname</I
5107
 
></TT
5108
 
></DT
5109
 
><DD
5110
 
><P
5111
 
></P
5112
 
></DD
5113
 
><DT
5114
 
><TT
5115
 
CLASS="PARAMETER"
5116
 
><I
5117
 
>args</I
5118
 
></TT
5119
 
></DT
5120
 
><DD
5121
 
><P
5122
 
></P
5123
 
></DD
5124
 
></DL
5125
 
></DIV
5126
 
></DIV
5127
 
><DIV
5128
 
CLASS="SECT3"
5129
 
><H3
5130
 
CLASS="SECT3"
5131
 
><A
5132
 
NAME="STANDARDFILE"
5133
 
></A
5134
 
>Standard_file Procedure</H3
5135
 
><P
5136
 
></P
5137
 
><DIV
5138
 
CLASS="FUNCSYNOPSIS"
5139
 
><A
5140
 
NAME="AEN3065"
5141
 
></A
5142
 
><P
5143
 
></P
5144
 
><CODE
5145
 
CLASS="FUNCDEF"
5146
 
><TT
5147
 
CLASS="FUNCTION"
5148
 
>standard_file</TT
5149
 
></CODE
5150
 
>(<TT
5151
 
CLASS="PARAMETER"
5152
 
><I
5153
 
>dest</I
5154
 
></TT
5155
 
><TT
5156
 
CLASS="PARAMETER"
5157
 
><I
5158
 
>op</I
5159
 
></TT
5160
 
><TT
5161
 
CLASS="PARAMETER"
5162
 
><I
5163
 
>args</I
5164
 
></TT
5165
 
>);<P
5166
 
></P
5167
 
></DIV
5168
 
><P
5169
 
></P
5170
 
><DIV
5171
 
CLASS="VARIABLELIST"
5172
 
><DL
5173
 
><DT
5174
 
><TT
5175
 
CLASS="PARAMETER"
5176
 
><I
5177
 
></I
5178
 
></TT
5179
 
></DT
5180
 
><DD
5181
 
><P
5182
 
></P
5183
 
></DD
5184
 
></DL
5185
 
></DIV
5186
 
></DIV
5187
 
><DIV
5188
 
CLASS="SECT3"
5189
 
><H3
5190
 
CLASS="SECT3"
5191
 
><A
5192
 
NAME="STANDARDLOAD"
5193
 
></A
5194
 
>Standard_load Procedure</H3
5195
 
><P
5196
 
></P
5197
 
><DIV
5198
 
CLASS="FUNCSYNOPSIS"
5199
 
><A
5200
 
NAME="AEN3081"
5201
 
></A
5202
 
><P
5203
 
></P
5204
 
><CODE
5205
 
CLASS="FUNCDEF"
5206
 
><TT
5207
 
CLASS="FUNCTION"
5208
 
>standard_load</TT
5209
 
></CODE
5210
 
>(<TT
5211
 
CLASS="PARAMETER"
5212
 
><I
5213
 
>dest</I
5214
 
></TT
5215
 
>
5216
 
                <TT
5217
 
CLASS="PARAMETER"
5218
 
><I
5219
 
>prog</I
5220
 
></TT
5221
 
>
5222
 
                <TT
5223
 
CLASS="PARAMETER"
5224
 
><I
5225
 
>args</I
5226
 
></TT
5227
 
>);<P
5228
 
></P
5229
 
></DIV
5230
 
><P
5231
 
></P
5232
 
><DIV
5233
 
CLASS="VARIABLELIST"
5234
 
><DL
5235
 
><DT
5236
 
><TT
5237
 
CLASS="PARAMETER"
5238
 
><I
5239
 
>dest</I
5240
 
></TT
5241
 
></DT
5242
 
><DD
5243
 
><P
5244
 
></P
5245
 
></DD
5246
 
><DT
5247
 
><TT
5248
 
CLASS="PARAMETER"
5249
 
><I
5250
 
>prog</I
5251
 
></TT
5252
 
></DT
5253
 
><DD
5254
 
><P
5255
 
></P
5256
 
></DD
5257
 
><DT
5258
 
><TT
5259
 
CLASS="PARAMETER"
5260
 
><I
5261
 
>args</I
5262
 
></TT
5263
 
></DT
5264
 
><DD
5265
 
><P
5266
 
></P
5267
 
></DD
5268
 
></DL
5269
 
></DIV
5270
 
></DIV
5271
 
><DIV
5272
 
CLASS="SECT3"
5273
 
><H3
5274
 
CLASS="SECT3"
5275
 
><A
5276
 
NAME="STANDARDREBOOT"
5277
 
></A
5278
 
>Standard_reboot Procedure</H3
5279
 
><P
5280
 
></P
5281
 
><DIV
5282
 
CLASS="FUNCSYNOPSIS"
5283
 
><A
5284
 
NAME="AEN3107"
5285
 
></A
5286
 
><P
5287
 
></P
5288
 
><CODE
5289
 
CLASS="FUNCDEF"
5290
 
><TT
5291
 
CLASS="FUNCTION"
5292
 
>standard_reboot</TT
5293
 
></CODE
5294
 
>(<TT
5295
 
CLASS="PARAMETER"
5296
 
><I
5297
 
>host</I
5298
 
></TT
5299
 
>);<P
5300
 
></P
5301
 
></DIV
5302
 
><P
5303
 
></P
5304
 
><DIV
5305
 
CLASS="VARIABLELIST"
5306
 
><DL
5307
 
><DT
5308
 
><TT
5309
 
CLASS="PARAMETER"
5310
 
><I
5311
 
>host</I
5312
 
></TT
5313
 
></DT
5314
 
><DD
5315
 
><P
5316
 
></P
5317
 
></DD
5318
 
></DL
5319
 
></DIV
5320
 
></DIV
5321
 
><DIV
5322
 
CLASS="SECT3"
5323
 
><H3
5324
 
CLASS="SECT3"
5325
 
><A
5326
 
NAME="STANDARDSEND"
5327
 
></A
5328
 
>Standard_send Procedure</H3
5329
 
><P
5330
 
></P
5331
 
><DIV
5332
 
CLASS="FUNCSYNOPSIS"
5333
 
><A
5334
 
NAME="AEN3121"
5335
 
></A
5336
 
><P
5337
 
></P
5338
 
><CODE
5339
 
CLASS="FUNCDEF"
5340
 
><TT
5341
 
CLASS="FUNCTION"
5342
 
>standard_send</TT
5343
 
></CODE
5344
 
>(<TT
5345
 
CLASS="PARAMETER"
5346
 
><I
5347
 
>dest</I
5348
 
></TT
5349
 
>
5350
 
                <TT
5351
 
CLASS="PARAMETER"
5352
 
><I
5353
 
>string</I
5354
 
></TT
5355
 
>);<P
5356
 
></P
5357
 
></DIV
5358
 
><P
5359
 
></P
5360
 
><DIV
5361
 
CLASS="VARIABLELIST"
5362
 
><DL
5363
 
><DT
5364
 
><TT
5365
 
CLASS="PARAMETER"
5366
 
><I
5367
 
>dest</I
5368
 
></TT
5369
 
></DT
5370
 
><DD
5371
 
><P
5372
 
></P
5373
 
></DD
5374
 
><DT
5375
 
><TT
5376
 
CLASS="PARAMETER"
5377
 
><I
5378
 
>string</I
5379
 
></TT
5380
 
></DT
5381
 
><DD
5382
 
><P
5383
 
></P
5384
 
></DD
5385
 
></DL
5386
 
></DIV
5387
 
></DIV
5388
 
><DIV
5389
 
CLASS="SECT3"
5390
 
><H3
5391
 
CLASS="SECT3"
5392
 
><A
5393
 
NAME="STANDARDSPAWN"
5394
 
></A
5395
 
>Standard_spawn Procedure</H3
5396
 
><P
5397
 
></P
5398
 
><DIV
5399
 
CLASS="FUNCSYNOPSIS"
5400
 
><A
5401
 
NAME="AEN3141"
5402
 
></A
5403
 
><P
5404
 
></P
5405
 
><CODE
5406
 
CLASS="FUNCDEF"
5407
 
><TT
5408
 
CLASS="FUNCTION"
5409
 
>standard_spawn</TT
5410
 
></CODE
5411
 
>(<TT
5412
 
CLASS="PARAMETER"
5413
 
><I
5414
 
>dest</I
5415
 
></TT
5416
 
>
5417
 
                <TT
5418
 
CLASS="PARAMETER"
5419
 
><I
5420
 
>commandline</I
5421
 
></TT
5422
 
>);<P
5423
 
></P
5424
 
></DIV
5425
 
><P
5426
 
></P
5427
 
><DIV
5428
 
CLASS="VARIABLELIST"
5429
 
><DL
5430
 
><DT
5431
 
><TT
5432
 
CLASS="PARAMETER"
5433
 
><I
5434
 
>dest</I
5435
 
></TT
5436
 
></DT
5437
 
><DD
5438
 
><P
5439
 
></P
5440
 
></DD
5441
 
><DT
5442
 
><TT
5443
 
CLASS="PARAMETER"
5444
 
><I
5445
 
>commndline</I
5446
 
></TT
5447
 
></DT
5448
 
><DD
5449
 
><P
5450
 
></P
5451
 
></DD
5452
 
></DL
5453
 
></DIV
5454
 
></DIV
5455
 
><DIV
5456
 
CLASS="SECT3"
5457
 
><H3
5458
 
CLASS="SECT3"
5459
 
><A
5460
 
NAME="STANDARDTRANSMIT"
5461
 
></A
5462
 
>Standard_transmit Procedure</H3
5463
 
><P
5464
 
></P
5465
 
><DIV
5466
 
CLASS="FUNCSYNOPSIS"
5467
 
><A
5468
 
NAME="AEN3161"
5469
 
></A
5470
 
><P
5471
 
></P
5472
 
><CODE
5473
 
CLASS="FUNCDEF"
5474
 
><TT
5475
 
CLASS="FUNCTION"
5476
 
>standard_transmit</TT
5477
 
></CODE
5478
 
>(<TT
5479
 
CLASS="PARAMETER"
5480
 
><I
5481
 
>dest</I
5482
 
></TT
5483
 
>
5484
 
                <TT
5485
 
CLASS="PARAMETER"
5486
 
><I
5487
 
>file</I
5488
 
></TT
5489
 
>);<P
5490
 
></P
5491
 
></DIV
5492
 
><P
5493
 
></P
5494
 
><DIV
5495
 
CLASS="VARIABLELIST"
5496
 
><DL
5497
 
><DT
5498
 
><TT
5499
 
CLASS="PARAMETER"
5500
 
><I
5501
 
>dest</I
5502
 
></TT
5503
 
></DT
5504
 
><DD
5505
 
><P
5506
 
></P
5507
 
></DD
5508
 
><DT
5509
 
><TT
5510
 
CLASS="PARAMETER"
5511
 
><I
5512
 
>file</I
5513
 
></TT
5514
 
></DT
5515
 
><DD
5516
 
><P
5517
 
></P
5518
 
></DD
5519
 
></DL
5520
 
></DIV
5521
 
></DIV
5522
 
><DIV
5523
 
CLASS="SECT3"
5524
 
><H3
5525
 
CLASS="SECT3"
5526
 
><A
5527
 
NAME="STANDARDUPLOAD"
5528
 
></A
5529
 
>Standard_upload Procedure</H3
5530
 
><P
5531
 
></P
5532
 
><DIV
5533
 
CLASS="FUNCSYNOPSIS"
5534
 
><A
5535
 
NAME="AEN3181"
5536
 
></A
5537
 
><P
5538
 
></P
5539
 
><CODE
5540
 
CLASS="FUNCDEF"
5541
 
><TT
5542
 
CLASS="FUNCTION"
5543
 
>standard_upload</TT
5544
 
></CODE
5545
 
>(<TT
5546
 
CLASS="PARAMETER"
5547
 
><I
5548
 
>dest srcfile destfile</I
5549
 
></TT
5550
 
>);<P
5551
 
></P
5552
 
></DIV
5553
 
><P
5554
 
></P
5555
 
><DIV
5556
 
CLASS="VARIABLELIST"
5557
 
><DL
5558
 
><DT
5559
 
><TT
5560
 
CLASS="PARAMETER"
5561
 
><I
5562
 
>dest</I
5563
 
></TT
5564
 
></DT
5565
 
><DD
5566
 
><P
5567
 
></P
5568
 
></DD
5569
 
><DT
5570
 
><TT
5571
 
CLASS="PARAMETER"
5572
 
><I
5573
 
>srcfile</I
5574
 
></TT
5575
 
></DT
5576
 
><DD
5577
 
><P
5578
 
></P
5579
 
></DD
5580
 
><DT
5581
 
><TT
5582
 
CLASS="PARAMETER"
5583
 
><I
5584
 
>destfile</I
5585
 
></TT
5586
 
></DT
5587
 
><DD
5588
 
><P
5589
 
></P
5590
 
></DD
5591
 
></DL
5592
 
></DIV
5593
 
></DIV
5594
 
><DIV
5595
 
CLASS="SECT3"
5596
 
><H3
5597
 
CLASS="SECT3"
5598
 
><A
5599
 
NAME="STANDARDWAIT"
5600
 
></A
5601
 
>Standard_wait Procedure</H3
5602
 
><P
5603
 
></P
5604
 
><DIV
5605
 
CLASS="FUNCSYNOPSIS"
5606
 
><A
5607
 
NAME="AEN3205"
5608
 
></A
5609
 
><P
5610
 
></P
5611
 
><CODE
5612
 
CLASS="FUNCDEF"
5613
 
><TT
5614
 
CLASS="FUNCTION"
5615
 
>standard_wait</TT
5616
 
></CODE
5617
 
>(<TT
5618
 
CLASS="PARAMETER"
5619
 
><I
5620
 
>dest</I
5621
 
></TT
5622
 
>
5623
 
                <TT
5624
 
CLASS="PARAMETER"
5625
 
><I
5626
 
>timeout</I
5627
 
></TT
5628
 
>);<P
5629
 
></P
5630
 
></DIV
5631
 
><P
5632
 
></P
5633
 
><DIV
5634
 
CLASS="VARIABLELIST"
5635
 
><DL
5636
 
><DT
5637
 
><TT
5638
 
CLASS="PARAMETER"
5639
 
><I
5640
 
>dest</I
5641
 
></TT
5642
 
></DT
5643
 
><DD
5644
 
><P
5645
 
></P
5646
 
></DD
5647
 
><DT
5648
 
><TT
5649
 
CLASS="PARAMETER"
5650
 
><I
5651
 
>timeout</I
5652
 
></TT
5653
 
></DT
5654
 
><DD
5655
 
><P
5656
 
></P
5657
 
></DD
5658
 
></DL
5659
 
></DIV
5660
 
></DIV
5661
 
><DIV
5662
 
CLASS="SECT3"
5663
 
><H3
5664
 
CLASS="SECT3"
5665
 
><A
5666
 
NAME="UNIXCLEANFILENAME"
5667
 
></A
5668
 
>Unix_clean_filename Procedure</H3
5669
 
><P
5670
 
></P
5671
 
><DIV
5672
 
CLASS="FUNCSYNOPSIS"
5673
 
><A
5674
 
NAME="AEN3225"
5675
 
></A
5676
 
><P
5677
 
></P
5678
 
><CODE
5679
 
CLASS="FUNCDEF"
5680
 
><TT
5681
 
CLASS="FUNCTION"
5682
 
>unix_clean_filename</TT
5683
 
></CODE
5684
 
>(<TT
5685
 
CLASS="PARAMETER"
5686
 
><I
5687
 
>dest</I
5688
 
></TT
5689
 
>
5690
 
                <TT
5691
 
CLASS="PARAMETER"
5692
 
><I
5693
 
>file</I
5694
 
></TT
5695
 
>);<P
5696
 
></P
5697
 
></DIV
5698
 
><P
5699
 
></P
5700
 
><DIV
5701
 
CLASS="VARIABLELIST"
5702
 
><DL
5703
 
><DT
5704
 
><TT
5705
 
CLASS="PARAMETER"
5706
 
><I
5707
 
>dest</I
5708
 
></TT
5709
 
></DT
5710
 
><DD
5711
 
><P
5712
 
></P
5713
 
></DD
5714
 
><DT
5715
 
><TT
5716
 
CLASS="PARAMETER"
5717
 
><I
5718
 
>file</I
5719
 
></TT
5720
 
></DT
5721
 
><DD
5722
 
><P
5723
 
></P
5724
 
></DD
5725
 
></DL
5726
 
></DIV
5727
 
></DIV
5728
 
></DIV
5729
 
><DIV
5730
 
CLASS="SECT2"
5731
 
><H2
5732
 
CLASS="SECT2"
5733
 
><A
5734
 
NAME="CONNPROCS"
5735
 
></A
5736
 
>Procedures For Using Utilities to Connect</H2
5737
 
><P
5738
 
>telnet, rsh, tip, kermit</P
5739
 
><DIV
5740
 
CLASS="SECT3"
5741
 
><H3
5742
 
CLASS="SECT3"
5743
 
><A
5744
 
NAME="TELNET"
5745
 
></A
5746
 
>telnet Procedure</H3
5747
 
><P
5748
 
></P
5749
 
><DIV
5750
 
CLASS="FUNCSYNOPSIS"
5751
 
><A
5752
 
NAME="AEN3248"
5753
 
></A
5754
 
><P
5755
 
></P
5756
 
><CODE
5757
 
CLASS="FUNCDEF"
5758
 
><TT
5759
 
CLASS="FUNCTION"
5760
 
>telnet</TT
5761
 
></CODE
5762
 
>(<TT
5763
 
CLASS="PARAMETER"
5764
 
><I
5765
 
>hostname</I
5766
 
></TT
5767
 
>
5768
 
            <TT
5769
 
CLASS="PARAMETER"
5770
 
><I
5771
 
>port</I
5772
 
></TT
5773
 
>);<P
5774
 
></P
5775
 
></DIV
5776
 
><DIV
5777
 
CLASS="FUNCSYNOPSIS"
5778
 
><A
5779
 
NAME="AEN3254"
5780
 
></A
5781
 
><P
5782
 
></P
5783
 
><CODE
5784
 
CLASS="FUNCDEF"
5785
 
><TT
5786
 
CLASS="FUNCTION"
5787
 
>rlogin</TT
5788
 
></CODE
5789
 
>(<TT
5790
 
CLASS="PARAMETER"
5791
 
><I
5792
 
>hostname</I
5793
 
></TT
5794
 
>);<P
5795
 
></P
5796
 
></DIV
5797
 
></DIV
5798
 
><DIV
5799
 
CLASS="SECT3"
5800
 
><H3
5801
 
CLASS="SECT3"
5802
 
><A
5803
 
NAME="RSH"
5804
 
></A
5805
 
>rsh Procedure</H3
5806
 
><P
5807
 
></P
5808
 
><DIV
5809
 
CLASS="FUNCSYNOPSIS"
5810
 
><A
5811
 
NAME="AEN3262"
5812
 
></A
5813
 
><P
5814
 
></P
5815
 
><CODE
5816
 
CLASS="FUNCDEF"
5817
 
><TT
5818
 
CLASS="FUNCTION"
5819
 
>rsh</TT
5820
 
></CODE
5821
 
>(<TT
5822
 
CLASS="PARAMETER"
5823
 
><I
5824
 
>hostname</I
5825
 
></TT
5826
 
>);<P
5827
 
></P
5828
 
></DIV
5829
 
><P
5830
 
></P
5831
 
><DIV
5832
 
CLASS="VARIABLELIST"
5833
 
><DL
5834
 
><DT
5835
 
><TT
5836
 
CLASS="PARAMETER"
5837
 
><I
5838
 
>hostname</I
5839
 
></TT
5840
 
></DT
5841
 
><DD
5842
 
><P
5843
 
>This refers to the IP address or name
5844
 
                (for example, an entry in
5845
 
                <TT
5846
 
CLASS="FILENAME"
5847
 
>/etc/hosts</TT
5848
 
>) for this target. The
5849
 
                procedure names reflect the Unix utility used to
5850
 
                establish a connection. The optional
5851
 
                <TT
5852
 
CLASS="PARAMETER"
5853
 
><I
5854
 
>port</I
5855
 
></TT
5856
 
> is used to specify the IP
5857
 
                port number. The value of the
5858
 
                <TT
5859
 
CLASS="PARAMETER"
5860
 
><I
5861
 
>netport</I
5862
 
></TT
5863
 
> field in the
5864
 
                <SPAN
5865
 
CLASS="SYMBOL"
5866
 
>target_info</SPAN
5867
 
> array is used. (was
5868
 
                <SPAN
5869
 
CLASS="SYMBOL"
5870
 
>$netport</SPAN
5871
 
>) This value has two parts,
5872
 
                the hostname and the port number, seperated by a
5873
 
                <I
5874
 
CLASS="EMPHASIS"
5875
 
>:</I
5876
 
>. If host or target is used in
5877
 
                the <SPAN
5878
 
CLASS="SYMBOL"
5879
 
>hostname</SPAN
5880
 
> field, than the
5881
 
                config array is used for all information.</P
5882
 
></DD
5883
 
></DL
5884
 
></DIV
5885
 
></DIV
5886
 
><DIV
5887
 
CLASS="SECT3"
5888
 
><H3
5889
 
CLASS="SECT3"
5890
 
><A
5891
 
NAME="TIP"
5892
 
></A
5893
 
>Tip Procedure</H3
5894
 
><P
5895
 
></P
5896
 
><DIV
5897
 
CLASS="FUNCSYNOPSIS"
5898
 
><A
5899
 
NAME="AEN3283"
5900
 
></A
5901
 
><P
5902
 
></P
5903
 
><CODE
5904
 
CLASS="FUNCDEF"
5905
 
><TT
5906
 
CLASS="FUNCTION"
5907
 
>tip</TT
5908
 
></CODE
5909
 
>(<TT
5910
 
CLASS="PARAMETER"
5911
 
><I
5912
 
>port</I
5913
 
></TT
5914
 
>);<P
5915
 
></P
5916
 
></DIV
5917
 
><P
5918
 
></P
5919
 
><DIV
5920
 
CLASS="VARIABLELIST"
5921
 
><DL
5922
 
><DT
5923
 
><TT
5924
 
CLASS="PARAMETER"
5925
 
><I
5926
 
>port</I
5927
 
></TT
5928
 
></DT
5929
 
><DD
5930
 
><P
5931
 
>Connect using the Unix utility
5932
 
               <B
5933
 
CLASS="COMMAND"
5934
 
>tip</B
5935
 
>. <TT
5936
 
CLASS="PARAMETER"
5937
 
><I
5938
 
>Port</I
5939
 
></TT
5940
 
>must
5941
 
               be a name from the <SPAN
5942
 
CLASS="PRODUCTNAME"
5943
 
>tip</SPAN
5944
 
>
5945
 
               configuration file
5946
 
               <TT
5947
 
CLASS="FILENAME"
5948
 
>/etc/remote</TT
5949
 
>. Often, this is called
5950
 
               <SPAN
5951
 
CLASS="SYMBOL"
5952
 
>hardwire</SPAN
5953
 
>, or something like
5954
 
               <SPAN
5955
 
CLASS="SYMBOL"
5956
 
>ttya</SPAN
5957
 
>. This file holds all the
5958
 
               configuration data for the serial port. The value of
5959
 
               the <SPAN
5960
 
CLASS="SYMBOL"
5961
 
>serial</SPAN
5962
 
> field in the
5963
 
               <SPAN
5964
 
CLASS="SYMBOL"
5965
 
>target_info</SPAN
5966
 
> array is used. (was
5967
 
               <SPAN
5968
 
CLASS="SYMBOL"
5969
 
>$serialport</SPAN
5970
 
>) If <TT
5971
 
CLASS="OPTION"
5972
 
>host</TT
5973
 
>
5974
 
               or <TT
5975
 
CLASS="OPTION"
5976
 
>target</TT
5977
 
> is used in the
5978
 
               <TT
5979
 
CLASS="PARAMETER"
5980
 
><I
5981
 
>port</I
5982
 
></TT
5983
 
> field, than the config
5984
 
               array is used for all information. the
5985
 
               config array is used for all information.</P
5986
 
></DD
5987
 
></DL
5988
 
></DIV
5989
 
></DIV
5990
 
><DIV
5991
 
CLASS="SECT3"
5992
 
><H3
5993
 
CLASS="SECT3"
5994
 
><A
5995
 
NAME="KERMIT"
5996
 
></A
5997
 
>Kermit Procedure</H3
5998
 
><P
5999
 
></P
6000
 
><DIV
6001
 
CLASS="FUNCSYNOPSIS"
6002
 
><A
6003
 
NAME="AEN3309"
6004
 
></A
6005
 
><P
6006
 
></P
6007
 
><CODE
6008
 
CLASS="FUNCDEF"
6009
 
><TT
6010
 
CLASS="FUNCTION"
6011
 
>kermit</TT
6012
 
></CODE
6013
 
>(<TT
6014
 
CLASS="PARAMETER"
6015
 
><I
6016
 
>port</I
6017
 
></TT
6018
 
>
6019
 
            <TT
6020
 
CLASS="PARAMETER"
6021
 
><I
6022
 
>bps</I
6023
 
></TT
6024
 
>);<P
6025
 
></P
6026
 
></DIV
6027
 
><P
6028
 
></P
6029
 
><DIV
6030
 
CLASS="VARIABLELIST"
6031
 
><DL
6032
 
><DT
6033
 
><TT
6034
 
CLASS="PARAMETER"
6035
 
><I
6036
 
>port</I
6037
 
></TT
6038
 
></DT
6039
 
><DD
6040
 
><P
6041
 
>Connect using the program
6042
 
               <B
6043
 
CLASS="COMMAND"
6044
 
>kermit</B
6045
 
>. <TT
6046
 
CLASS="PARAMETER"
6047
 
><I
6048
 
>Port</I
6049
 
></TT
6050
 
>
6051
 
               is the device name,
6052
 
               e.g. <TT
6053
 
CLASS="FILENAME"
6054
 
>/dev/ttyb</TT
6055
 
>.
6056
 
               </P
6057
 
></DD
6058
 
><DT
6059
 
><TT
6060
 
CLASS="PARAMETER"
6061
 
><I
6062
 
>bps</I
6063
 
></TT
6064
 
></DT
6065
 
><DD
6066
 
><P
6067
 
><TT
6068
 
CLASS="PARAMETER"
6069
 
><I
6070
 
>bps</I
6071
 
></TT
6072
 
> is the line
6073
 
               speed to use (in its per second) for the
6074
 
               connection. The value of the <SPAN
6075
 
CLASS="SYMBOL"
6076
 
>serial</SPAN
6077
 
>
6078
 
               field in the <SPAN
6079
 
CLASS="SYMBOL"
6080
 
>target_info</SPAN
6081
 
> array is
6082
 
               used.  (was <SPAN
6083
 
CLASS="SYMBOL"
6084
 
>$serialport</SPAN
6085
 
>) If
6086
 
               <TT
6087
 
CLASS="OPTION"
6088
 
>host</TT
6089
 
> or <TT
6090
 
CLASS="OPTION"
6091
 
>target</TT
6092
 
> is
6093
 
               used in the <TT
6094
 
CLASS="PARAMETER"
6095
 
><I
6096
 
>port</I
6097
 
></TT
6098
 
> field, than the
6099
 
               config array is used for all information. the
6100
 
               config array is used for all information.</P
6101
 
></DD
6102
 
></DL
6103
 
></DIV
6104
 
></DIV
6105
 
><DIV
6106
 
CLASS="SECT3"
6107
 
><H3
6108
 
CLASS="SECT3"
6109
 
><A
6110
 
NAME="KERMITOPEN"
6111
 
></A
6112
 
>kermit_open Procedure</H3
6113
 
><P
6114
 
></P
6115
 
><DIV
6116
 
CLASS="FUNCSYNOPSIS"
6117
 
><A
6118
 
NAME="AEN3339"
6119
 
></A
6120
 
><P
6121
 
></P
6122
 
><CODE
6123
 
CLASS="FUNCDEF"
6124
 
><TT
6125
 
CLASS="FUNCTION"
6126
 
>kermit_open</TT
6127
 
></CODE
6128
 
>(<TT
6129
 
CLASS="PARAMETER"
6130
 
><I
6131
 
>dest</I
6132
 
></TT
6133
 
>
6134
 
                <TT
6135
 
CLASS="PARAMETER"
6136
 
><I
6137
 
>args</I
6138
 
></TT
6139
 
>);<P
6140
 
></P
6141
 
></DIV
6142
 
><P
6143
 
></P
6144
 
><DIV
6145
 
CLASS="VARIABLELIST"
6146
 
><DL
6147
 
><DT
6148
 
><TT
6149
 
CLASS="PARAMETER"
6150
 
><I
6151
 
>dest</I
6152
 
></TT
6153
 
></DT
6154
 
><DD
6155
 
><P
6156
 
></P
6157
 
></DD
6158
 
><DT
6159
 
><TT
6160
 
CLASS="PARAMETER"
6161
 
><I
6162
 
>args</I
6163
 
></TT
6164
 
></DT
6165
 
><DD
6166
 
><P
6167
 
></P
6168
 
></DD
6169
 
></DL
6170
 
></DIV
6171
 
></DIV
6172
 
><DIV
6173
 
CLASS="SECT3"
6174
 
><H3
6175
 
CLASS="SECT3"
6176
 
><A
6177
 
NAME="KERMITCOMMAND"
6178
 
></A
6179
 
>Kermit_command Procedure</H3
6180
 
><P
6181
 
></P
6182
 
><DIV
6183
 
CLASS="FUNCSYNOPSIS"
6184
 
><A
6185
 
NAME="AEN3359"
6186
 
></A
6187
 
><P
6188
 
></P
6189
 
><CODE
6190
 
CLASS="FUNCDEF"
6191
 
><TT
6192
 
CLASS="FUNCTION"
6193
 
>kermit_command</TT
6194
 
></CODE
6195
 
>(<TT
6196
 
CLASS="PARAMETER"
6197
 
><I
6198
 
>dest</I
6199
 
></TT
6200
 
>
6201
 
                <TT
6202
 
CLASS="PARAMETER"
6203
 
><I
6204
 
>args</I
6205
 
></TT
6206
 
>);<P
6207
 
></P
6208
 
></DIV
6209
 
><P
6210
 
></P
6211
 
><DIV
6212
 
CLASS="VARIABLELIST"
6213
 
><DL
6214
 
><DT
6215
 
><TT
6216
 
CLASS="PARAMETER"
6217
 
><I
6218
 
>dest</I
6219
 
></TT
6220
 
></DT
6221
 
><DD
6222
 
><P
6223
 
></P
6224
 
></DD
6225
 
><DT
6226
 
><TT
6227
 
CLASS="PARAMETER"
6228
 
><I
6229
 
>args</I
6230
 
></TT
6231
 
></DT
6232
 
><DD
6233
 
><P
6234
 
></P
6235
 
></DD
6236
 
></DL
6237
 
></DIV
6238
 
></DIV
6239
 
><DIV
6240
 
CLASS="SECT3"
6241
 
><H3
6242
 
CLASS="SECT3"
6243
 
><A
6244
 
NAME="KERMITSEND"
6245
 
></A
6246
 
>Kermit_send Procedure</H3
6247
 
><P
6248
 
></P
6249
 
><DIV
6250
 
CLASS="FUNCSYNOPSIS"
6251
 
><A
6252
 
NAME="AEN3379"
6253
 
></A
6254
 
><P
6255
 
></P
6256
 
><CODE
6257
 
CLASS="FUNCDEF"
6258
 
><TT
6259
 
CLASS="FUNCTION"
6260
 
>kermit_send</TT
6261
 
></CODE
6262
 
>(<TT
6263
 
CLASS="PARAMETER"
6264
 
><I
6265
 
>dest string args</I
6266
 
></TT
6267
 
>);<P
6268
 
></P
6269
 
></DIV
6270
 
><P
6271
 
></P
6272
 
><DIV
6273
 
CLASS="VARIABLELIST"
6274
 
><DL
6275
 
><DT
6276
 
><TT
6277
 
CLASS="PARAMETER"
6278
 
><I
6279
 
>dest</I
6280
 
></TT
6281
 
></DT
6282
 
><DD
6283
 
><P
6284
 
></P
6285
 
></DD
6286
 
><DT
6287
 
><TT
6288
 
CLASS="PARAMETER"
6289
 
><I
6290
 
>string</I
6291
 
></TT
6292
 
></DT
6293
 
><DD
6294
 
><P
6295
 
></P
6296
 
></DD
6297
 
><DT
6298
 
><TT
6299
 
CLASS="PARAMETER"
6300
 
><I
6301
 
>args</I
6302
 
></TT
6303
 
></DT
6304
 
><DD
6305
 
><P
6306
 
></P
6307
 
></DD
6308
 
></DL
6309
 
></DIV
6310
 
></DIV
6311
 
><DIV
6312
 
CLASS="SECT3"
6313
 
><H3
6314
 
CLASS="SECT3"
6315
 
><A
6316
 
NAME="KERMITTRANSMIT"
6317
 
></A
6318
 
>Kermit_transmit Procedure</H3
6319
 
><P
6320
 
></P
6321
 
><DIV
6322
 
CLASS="FUNCSYNOPSIS"
6323
 
><A
6324
 
NAME="AEN3403"
6325
 
></A
6326
 
><P
6327
 
></P
6328
 
><CODE
6329
 
CLASS="FUNCDEF"
6330
 
><TT
6331
 
CLASS="FUNCTION"
6332
 
>kermit_transmit</TT
6333
 
></CODE
6334
 
>(<TT
6335
 
CLASS="PARAMETER"
6336
 
><I
6337
 
>dest</I
6338
 
></TT
6339
 
>
6340
 
                <TT
6341
 
CLASS="PARAMETER"
6342
 
><I
6343
 
>file</I
6344
 
></TT
6345
 
>
6346
 
                <TT
6347
 
CLASS="PARAMETER"
6348
 
><I
6349
 
>args</I
6350
 
></TT
6351
 
>);<P
6352
 
></P
6353
 
></DIV
6354
 
><P
6355
 
></P
6356
 
><DIV
6357
 
CLASS="VARIABLELIST"
6358
 
><DL
6359
 
><DT
6360
 
><TT
6361
 
CLASS="PARAMETER"
6362
 
><I
6363
 
>dest</I
6364
 
></TT
6365
 
></DT
6366
 
><DD
6367
 
><P
6368
 
></P
6369
 
></DD
6370
 
><DT
6371
 
><TT
6372
 
CLASS="PARAMETER"
6373
 
><I
6374
 
>file</I
6375
 
></TT
6376
 
></DT
6377
 
><DD
6378
 
><P
6379
 
></P
6380
 
></DD
6381
 
><DT
6382
 
><TT
6383
 
CLASS="PARAMETER"
6384
 
><I
6385
 
>args</I
6386
 
></TT
6387
 
></DT
6388
 
><DD
6389
 
><P
6390
 
></P
6391
 
></DD
6392
 
></DL
6393
 
></DIV
6394
 
></DIV
6395
 
><DIV
6396
 
CLASS="SECT3"
6397
 
><H3
6398
 
CLASS="SECT3"
6399
 
><A
6400
 
NAME="TELNETOPEN"
6401
 
></A
6402
 
>Telnet_open Procedure</H3
6403
 
><P
6404
 
></P
6405
 
><DIV
6406
 
CLASS="FUNCSYNOPSIS"
6407
 
><A
6408
 
NAME="AEN3429"
6409
 
></A
6410
 
><P
6411
 
></P
6412
 
><CODE
6413
 
CLASS="FUNCDEF"
6414
 
><TT
6415
 
CLASS="FUNCTION"
6416
 
>telnet_open</TT
6417
 
></CODE
6418
 
>(<TT
6419
 
CLASS="PARAMETER"
6420
 
><I
6421
 
>hostname</I
6422
 
></TT
6423
 
>
6424
 
                <TT
6425
 
CLASS="PARAMETER"
6426
 
><I
6427
 
>args</I
6428
 
></TT
6429
 
>);<P
6430
 
></P
6431
 
></DIV
6432
 
><P
6433
 
></P
6434
 
><DIV
6435
 
CLASS="VARIABLELIST"
6436
 
><DL
6437
 
><DT
6438
 
><TT
6439
 
CLASS="PARAMETER"
6440
 
><I
6441
 
>hostname</I
6442
 
></TT
6443
 
></DT
6444
 
><DD
6445
 
><P
6446
 
></P
6447
 
></DD
6448
 
><DT
6449
 
><TT
6450
 
CLASS="PARAMETER"
6451
 
><I
6452
 
>args</I
6453
 
></TT
6454
 
></DT
6455
 
><DD
6456
 
><P
6457
 
></P
6458
 
></DD
6459
 
></DL
6460
 
></DIV
6461
 
></DIV
6462
 
><DIV
6463
 
CLASS="SECT3"
6464
 
><H3
6465
 
CLASS="SECT3"
6466
 
><A
6467
 
NAME="TELNETBINARY"
6468
 
></A
6469
 
>Telnet_binary Procedure</H3
6470
 
><P
6471
 
></P
6472
 
><DIV
6473
 
CLASS="FUNCSYNOPSIS"
6474
 
><A
6475
 
NAME="AEN3449"
6476
 
></A
6477
 
><P
6478
 
></P
6479
 
><CODE
6480
 
CLASS="FUNCDEF"
6481
 
><TT
6482
 
CLASS="FUNCTION"
6483
 
>telnet_binary</TT
6484
 
></CODE
6485
 
>(<TT
6486
 
CLASS="PARAMETER"
6487
 
><I
6488
 
>hostname</I
6489
 
></TT
6490
 
>);<P
6491
 
></P
6492
 
></DIV
6493
 
><P
6494
 
></P
6495
 
><DIV
6496
 
CLASS="VARIABLELIST"
6497
 
><DL
6498
 
><DT
6499
 
><TT
6500
 
CLASS="PARAMETER"
6501
 
><I
6502
 
>hostname</I
6503
 
></TT
6504
 
></DT
6505
 
><DD
6506
 
><P
6507
 
></P
6508
 
></DD
6509
 
></DL
6510
 
></DIV
6511
 
></DIV
6512
 
><DIV
6513
 
CLASS="SECT3"
6514
 
><H3
6515
 
CLASS="SECT3"
6516
 
><A
6517
 
NAME="TELNETTRANSMIT"
6518
 
></A
6519
 
>Telnet_transmit Procedure</H3
6520
 
><P
6521
 
></P
6522
 
><DIV
6523
 
CLASS="FUNCSYNOPSIS"
6524
 
><A
6525
 
NAME="AEN3463"
6526
 
></A
6527
 
><P
6528
 
></P
6529
 
><CODE
6530
 
CLASS="FUNCDEF"
6531
 
><TT
6532
 
CLASS="FUNCTION"
6533
 
>telnet_transmit</TT
6534
 
></CODE
6535
 
>(<TT
6536
 
CLASS="PARAMETER"
6537
 
><I
6538
 
>dest</I
6539
 
></TT
6540
 
>
6541
 
                <TT
6542
 
CLASS="PARAMETER"
6543
 
><I
6544
 
>file</I
6545
 
></TT
6546
 
>
6547
 
                <TT
6548
 
CLASS="PARAMETER"
6549
 
><I
6550
 
>args</I
6551
 
></TT
6552
 
>);<P
6553
 
></P
6554
 
></DIV
6555
 
><P
6556
 
></P
6557
 
><DIV
6558
 
CLASS="VARIABLELIST"
6559
 
><DL
6560
 
><DT
6561
 
><TT
6562
 
CLASS="PARAMETER"
6563
 
><I
6564
 
>dest</I
6565
 
></TT
6566
 
></DT
6567
 
><DD
6568
 
><P
6569
 
></P
6570
 
></DD
6571
 
><DT
6572
 
><TT
6573
 
CLASS="PARAMETER"
6574
 
><I
6575
 
>file</I
6576
 
></TT
6577
 
></DT
6578
 
><DD
6579
 
><P
6580
 
></P
6581
 
></DD
6582
 
><DT
6583
 
><TT
6584
 
CLASS="PARAMETER"
6585
 
><I
6586
 
>args</I
6587
 
></TT
6588
 
></DT
6589
 
><DD
6590
 
><P
6591
 
></P
6592
 
></DD
6593
 
></DL
6594
 
></DIV
6595
 
></DIV
6596
 
><DIV
6597
 
CLASS="SECT3"
6598
 
><H3
6599
 
CLASS="SECT3"
6600
 
><A
6601
 
NAME="TIPOPEN"
6602
 
></A
6603
 
>Tip_open Procedure</H3
6604
 
><P
6605
 
></P
6606
 
><DIV
6607
 
CLASS="FUNCSYNOPSIS"
6608
 
><A
6609
 
NAME="AEN3489"
6610
 
></A
6611
 
><P
6612
 
></P
6613
 
><CODE
6614
 
CLASS="FUNCDEF"
6615
 
><TT
6616
 
CLASS="FUNCTION"
6617
 
>tip_open</TT
6618
 
></CODE
6619
 
>(<TT
6620
 
CLASS="PARAMETER"
6621
 
><I
6622
 
>hostname</I
6623
 
></TT
6624
 
>);<P
6625
 
></P
6626
 
></DIV
6627
 
><P
6628
 
></P
6629
 
><DIV
6630
 
CLASS="VARIABLELIST"
6631
 
><DL
6632
 
><DT
6633
 
><TT
6634
 
CLASS="PARAMETER"
6635
 
><I
6636
 
>hostname</I
6637
 
></TT
6638
 
></DT
6639
 
><DD
6640
 
><P
6641
 
></P
6642
 
></DD
6643
 
></DL
6644
 
></DIV
6645
 
></DIV
6646
 
><DIV
6647
 
CLASS="SECT3"
6648
 
><H3
6649
 
CLASS="SECT3"
6650
 
><A
6651
 
NAME="RLOGINOPEN"
6652
 
></A
6653
 
>Rlogin_open Procedure</H3
6654
 
><P
6655
 
></P
6656
 
><DIV
6657
 
CLASS="FUNCSYNOPSIS"
6658
 
><A
6659
 
NAME="AEN3503"
6660
 
></A
6661
 
><P
6662
 
></P
6663
 
><CODE
6664
 
CLASS="FUNCDEF"
6665
 
><TT
6666
 
CLASS="FUNCTION"
6667
 
>rlogin_open</TT
6668
 
></CODE
6669
 
>(<TT
6670
 
CLASS="PARAMETER"
6671
 
><I
6672
 
>arg</I
6673
 
></TT
6674
 
>);<P
6675
 
></P
6676
 
></DIV
6677
 
><P
6678
 
></P
6679
 
><DIV
6680
 
CLASS="VARIABLELIST"
6681
 
><DL
6682
 
><DT
6683
 
><TT
6684
 
CLASS="PARAMETER"
6685
 
><I
6686
 
>arg</I
6687
 
></TT
6688
 
></DT
6689
 
><DD
6690
 
><P
6691
 
></P
6692
 
></DD
6693
 
></DL
6694
 
></DIV
6695
 
></DIV
6696
 
><DIV
6697
 
CLASS="SECT3"
6698
 
><H3
6699
 
CLASS="SECT3"
6700
 
><A
6701
 
NAME="RLOGINSPAWN"
6702
 
></A
6703
 
>Rlogin_spawn Procedure</H3
6704
 
><P
6705
 
></P
6706
 
><DIV
6707
 
CLASS="FUNCSYNOPSIS"
6708
 
><A
6709
 
NAME="AEN3517"
6710
 
></A
6711
 
><P
6712
 
></P
6713
 
><CODE
6714
 
CLASS="FUNCDEF"
6715
 
><TT
6716
 
CLASS="FUNCTION"
6717
 
>rlogin_spawn</TT
6718
 
></CODE
6719
 
>(<TT
6720
 
CLASS="PARAMETER"
6721
 
><I
6722
 
>dest</I
6723
 
></TT
6724
 
>
6725
 
                <TT
6726
 
CLASS="PARAMETER"
6727
 
><I
6728
 
>cmdline</I
6729
 
></TT
6730
 
>);<P
6731
 
></P
6732
 
></DIV
6733
 
><P
6734
 
></P
6735
 
><DIV
6736
 
CLASS="VARIABLELIST"
6737
 
><DL
6738
 
><DT
6739
 
><TT
6740
 
CLASS="PARAMETER"
6741
 
><I
6742
 
>dest</I
6743
 
></TT
6744
 
></DT
6745
 
><DD
6746
 
><P
6747
 
></P
6748
 
></DD
6749
 
><DT
6750
 
><TT
6751
 
CLASS="PARAMETER"
6752
 
><I
6753
 
>cmdline</I
6754
 
></TT
6755
 
></DT
6756
 
><DD
6757
 
><P
6758
 
></P
6759
 
></DD
6760
 
></DL
6761
 
></DIV
6762
 
></DIV
6763
 
><DIV
6764
 
CLASS="SECT3"
6765
 
><H3
6766
 
CLASS="SECT3"
6767
 
><A
6768
 
NAME="RSHOPEN"
6769
 
></A
6770
 
>Rsh_open Procedure</H3
6771
 
><P
6772
 
></P
6773
 
><DIV
6774
 
CLASS="FUNCSYNOPSIS"
6775
 
><A
6776
 
NAME="AEN3537"
6777
 
></A
6778
 
><P
6779
 
></P
6780
 
><CODE
6781
 
CLASS="FUNCDEF"
6782
 
><TT
6783
 
CLASS="FUNCTION"
6784
 
>rsh_open</TT
6785
 
></CODE
6786
 
>(<TT
6787
 
CLASS="PARAMETER"
6788
 
><I
6789
 
>hostname</I
6790
 
></TT
6791
 
>);<P
6792
 
></P
6793
 
></DIV
6794
 
><P
6795
 
></P
6796
 
><DIV
6797
 
CLASS="VARIABLELIST"
6798
 
><DL
6799
 
><DT
6800
 
><TT
6801
 
CLASS="PARAMETER"
6802
 
><I
6803
 
>hostname</I
6804
 
></TT
6805
 
></DT
6806
 
><DD
6807
 
><P
6808
 
></P
6809
 
></DD
6810
 
></DL
6811
 
></DIV
6812
 
></DIV
6813
 
><DIV
6814
 
CLASS="SECT3"
6815
 
><H3
6816
 
CLASS="SECT3"
6817
 
><A
6818
 
NAME="RSHDOWNLOAD"
6819
 
></A
6820
 
>Rsh_download Procedure</H3
6821
 
><P
6822
 
></P
6823
 
><DIV
6824
 
CLASS="FUNCSYNOPSIS"
6825
 
><A
6826
 
NAME="AEN3551"
6827
 
></A
6828
 
><P
6829
 
></P
6830
 
><CODE
6831
 
CLASS="FUNCDEF"
6832
 
><TT
6833
 
CLASS="FUNCTION"
6834
 
>rsh_download</TT
6835
 
></CODE
6836
 
>(<TT
6837
 
CLASS="PARAMETER"
6838
 
><I
6839
 
>desthost</I
6840
 
></TT
6841
 
>
6842
 
                <TT
6843
 
CLASS="PARAMETER"
6844
 
><I
6845
 
>srcfile</I
6846
 
></TT
6847
 
>
6848
 
                <TT
6849
 
CLASS="PARAMETER"
6850
 
><I
6851
 
>destfile</I
6852
 
></TT
6853
 
>);<P
6854
 
></P
6855
 
></DIV
6856
 
><P
6857
 
></P
6858
 
><DIV
6859
 
CLASS="VARIABLELIST"
6860
 
><DL
6861
 
><DT
6862
 
><TT
6863
 
CLASS="PARAMETER"
6864
 
><I
6865
 
>desthost</I
6866
 
></TT
6867
 
></DT
6868
 
><DD
6869
 
><P
6870
 
></P
6871
 
></DD
6872
 
><DT
6873
 
><TT
6874
 
CLASS="PARAMETER"
6875
 
><I
6876
 
>srcfile</I
6877
 
></TT
6878
 
></DT
6879
 
><DD
6880
 
><P
6881
 
></P
6882
 
></DD
6883
 
><DT
6884
 
><TT
6885
 
CLASS="PARAMETER"
6886
 
><I
6887
 
>destfile</I
6888
 
></TT
6889
 
></DT
6890
 
><DD
6891
 
><P
6892
 
></P
6893
 
></DD
6894
 
></DL
6895
 
></DIV
6896
 
></DIV
6897
 
><DIV
6898
 
CLASS="SECT3"
6899
 
><H3
6900
 
CLASS="SECT3"
6901
 
><A
6902
 
NAME="RSHUPLOAD"
6903
 
></A
6904
 
>Rsh_upload Procedure</H3
6905
 
><P
6906
 
></P
6907
 
><DIV
6908
 
CLASS="FUNCSYNOPSIS"
6909
 
><A
6910
 
NAME="AEN3577"
6911
 
></A
6912
 
><P
6913
 
></P
6914
 
><CODE
6915
 
CLASS="FUNCDEF"
6916
 
><TT
6917
 
CLASS="FUNCTION"
6918
 
>rsh_upload</TT
6919
 
></CODE
6920
 
>(<TT
6921
 
CLASS="PARAMETER"
6922
 
><I
6923
 
>desthost</I
6924
 
></TT
6925
 
>
6926
 
                <TT
6927
 
CLASS="PARAMETER"
6928
 
><I
6929
 
>srcfile</I
6930
 
></TT
6931
 
>
6932
 
                <TT
6933
 
CLASS="PARAMETER"
6934
 
><I
6935
 
>destfile</I
6936
 
></TT
6937
 
>);<P
6938
 
></P
6939
 
></DIV
6940
 
><P
6941
 
></P
6942
 
><DIV
6943
 
CLASS="VARIABLELIST"
6944
 
><DL
6945
 
><DT
6946
 
><TT
6947
 
CLASS="PARAMETER"
6948
 
><I
6949
 
>desthost</I
6950
 
></TT
6951
 
></DT
6952
 
><DD
6953
 
><P
6954
 
></P
6955
 
></DD
6956
 
><DT
6957
 
><TT
6958
 
CLASS="PARAMETER"
6959
 
><I
6960
 
>srcfile</I
6961
 
></TT
6962
 
></DT
6963
 
><DD
6964
 
><P
6965
 
></P
6966
 
></DD
6967
 
><DT
6968
 
><TT
6969
 
CLASS="PARAMETER"
6970
 
><I
6971
 
>destfile</I
6972
 
></TT
6973
 
></DT
6974
 
><DD
6975
 
><P
6976
 
></P
6977
 
></DD
6978
 
></DL
6979
 
></DIV
6980
 
></DIV
6981
 
><DIV
6982
 
CLASS="SECT3"
6983
 
><H3
6984
 
CLASS="SECT3"
6985
 
><A
6986
 
NAME="RSHEXEC"
6987
 
></A
6988
 
>Rsh_exec Procedure</H3
6989
 
><P
6990
 
></P
6991
 
><DIV
6992
 
CLASS="FUNCSYNOPSIS"
6993
 
><A
6994
 
NAME="AEN3603"
6995
 
></A
6996
 
><P
6997
 
></P
6998
 
><CODE
6999
 
CLASS="FUNCDEF"
7000
 
><TT
7001
 
CLASS="FUNCTION"
7002
 
>rsh_exec</TT
7003
 
></CODE
7004
 
>(<TT
7005
 
CLASS="PARAMETER"
7006
 
><I
7007
 
>boardname</I
7008
 
></TT
7009
 
>
7010
 
                <TT
7011
 
CLASS="PARAMETER"
7012
 
><I
7013
 
>cmd</I
7014
 
></TT
7015
 
>
7016
 
                <TT
7017
 
CLASS="PARAMETER"
7018
 
><I
7019
 
>args</I
7020
 
></TT
7021
 
>);<P
7022
 
></P
7023
 
></DIV
7024
 
><P
7025
 
></P
7026
 
><DIV
7027
 
CLASS="VARIABLELIST"
7028
 
><DL
7029
 
><DT
7030
 
><TT
7031
 
CLASS="PARAMETER"
7032
 
><I
7033
 
>boardname</I
7034
 
></TT
7035
 
></DT
7036
 
><DD
7037
 
><P
7038
 
></P
7039
 
></DD
7040
 
><DT
7041
 
><TT
7042
 
CLASS="PARAMETER"
7043
 
><I
7044
 
>cmd</I
7045
 
></TT
7046
 
></DT
7047
 
><DD
7048
 
><P
7049
 
></P
7050
 
></DD
7051
 
><DT
7052
 
><TT
7053
 
CLASS="PARAMETER"
7054
 
><I
7055
 
>args</I
7056
 
></TT
7057
 
></DT
7058
 
><DD
7059
 
><P
7060
 
></P
7061
 
></DD
7062
 
></DL
7063
 
></DIV
7064
 
></DIV
7065
 
><DIV
7066
 
CLASS="SECT3"
7067
 
><H3
7068
 
CLASS="SECT3"
7069
 
><A
7070
 
NAME="FTPOPEN"
7071
 
></A
7072
 
>Ftp_open Procedure</H3
7073
 
><P
7074
 
></P
7075
 
><DIV
7076
 
CLASS="FUNCSYNOPSIS"
7077
 
><A
7078
 
NAME="AEN3629"
7079
 
></A
7080
 
><P
7081
 
></P
7082
 
><CODE
7083
 
CLASS="FUNCDEF"
7084
 
><TT
7085
 
CLASS="FUNCTION"
7086
 
>ftp_open</TT
7087
 
></CODE
7088
 
>(<TT
7089
 
CLASS="PARAMETER"
7090
 
><I
7091
 
>host</I
7092
 
></TT
7093
 
>);<P
7094
 
></P
7095
 
></DIV
7096
 
><P
7097
 
></P
7098
 
><DIV
7099
 
CLASS="VARIABLELIST"
7100
 
><DL
7101
 
><DT
7102
 
><TT
7103
 
CLASS="PARAMETER"
7104
 
><I
7105
 
>host</I
7106
 
></TT
7107
 
></DT
7108
 
><DD
7109
 
><P
7110
 
></P
7111
 
></DD
7112
 
></DL
7113
 
></DIV
7114
 
></DIV
7115
 
><DIV
7116
 
CLASS="SECT3"
7117
 
><H3
7118
 
CLASS="SECT3"
7119
 
><A
7120
 
NAME="FTPUPLOAD"
7121
 
></A
7122
 
>Ftp_upload Procedure</H3
7123
 
><P
7124
 
></P
7125
 
><DIV
7126
 
CLASS="FUNCSYNOPSIS"
7127
 
><A
7128
 
NAME="AEN3643"
7129
 
></A
7130
 
><P
7131
 
></P
7132
 
><CODE
7133
 
CLASS="FUNCDEF"
7134
 
><TT
7135
 
CLASS="FUNCTION"
7136
 
>ftp_upload</TT
7137
 
></CODE
7138
 
>(<TT
7139
 
CLASS="PARAMETER"
7140
 
><I
7141
 
>host</I
7142
 
></TT
7143
 
>
7144
 
                <TT
7145
 
CLASS="PARAMETER"
7146
 
><I
7147
 
>remotefile</I
7148
 
></TT
7149
 
>
7150
 
                <TT
7151
 
CLASS="PARAMETER"
7152
 
><I
7153
 
>localfile</I
7154
 
></TT
7155
 
>);<P
7156
 
></P
7157
 
></DIV
7158
 
><P
7159
 
></P
7160
 
><DIV
7161
 
CLASS="VARIABLELIST"
7162
 
><DL
7163
 
><DT
7164
 
><TT
7165
 
CLASS="PARAMETER"
7166
 
><I
7167
 
>host</I
7168
 
></TT
7169
 
></DT
7170
 
><DD
7171
 
><P
7172
 
></P
7173
 
></DD
7174
 
><DT
7175
 
><TT
7176
 
CLASS="PARAMETER"
7177
 
><I
7178
 
>remotefile</I
7179
 
></TT
7180
 
></DT
7181
 
><DD
7182
 
><P
7183
 
></P
7184
 
></DD
7185
 
><DT
7186
 
><TT
7187
 
CLASS="PARAMETER"
7188
 
><I
7189
 
>localfile</I
7190
 
></TT
7191
 
></DT
7192
 
><DD
7193
 
><P
7194
 
></P
7195
 
></DD
7196
 
></DL
7197
 
></DIV
7198
 
></DIV
7199
 
><DIV
7200
 
CLASS="SECT3"
7201
 
><H3
7202
 
CLASS="SECT3"
7203
 
><A
7204
 
NAME="FTPDOWNLOAD"
7205
 
></A
7206
 
>Ftp_download Procedure</H3
7207
 
><P
7208
 
></P
7209
 
><DIV
7210
 
CLASS="FUNCSYNOPSIS"
7211
 
><A
7212
 
NAME="AEN3669"
7213
 
></A
7214
 
><P
7215
 
></P
7216
 
><CODE
7217
 
CLASS="FUNCDEF"
7218
 
><TT
7219
 
CLASS="FUNCTION"
7220
 
>ftp_download</TT
7221
 
></CODE
7222
 
>(<TT
7223
 
CLASS="PARAMETER"
7224
 
><I
7225
 
>host</I
7226
 
></TT
7227
 
>
7228
 
                <TT
7229
 
CLASS="PARAMETER"
7230
 
><I
7231
 
>localfile</I
7232
 
></TT
7233
 
>
7234
 
                <TT
7235
 
CLASS="PARAMETER"
7236
 
><I
7237
 
>remotefile</I
7238
 
></TT
7239
 
>);<P
7240
 
></P
7241
 
></DIV
7242
 
><P
7243
 
></P
7244
 
><DIV
7245
 
CLASS="VARIABLELIST"
7246
 
><DL
7247
 
><DT
7248
 
><TT
7249
 
CLASS="PARAMETER"
7250
 
><I
7251
 
>host</I
7252
 
></TT
7253
 
></DT
7254
 
><DD
7255
 
><P
7256
 
></P
7257
 
></DD
7258
 
><DT
7259
 
><TT
7260
 
CLASS="PARAMETER"
7261
 
><I
7262
 
>localfile</I
7263
 
></TT
7264
 
></DT
7265
 
><DD
7266
 
><P
7267
 
></P
7268
 
></DD
7269
 
><DT
7270
 
><TT
7271
 
CLASS="PARAMETER"
7272
 
><I
7273
 
>remotefile</I
7274
 
></TT
7275
 
></DT
7276
 
><DD
7277
 
><P
7278
 
></P
7279
 
></DD
7280
 
></DL
7281
 
></DIV
7282
 
></DIV
7283
 
><DIV
7284
 
CLASS="SECT3"
7285
 
><H3
7286
 
CLASS="SECT3"
7287
 
><A
7288
 
NAME="FTPCLOSE"
7289
 
></A
7290
 
>Ftp_close Procedure</H3
7291
 
><P
7292
 
></P
7293
 
><DIV
7294
 
CLASS="FUNCSYNOPSIS"
7295
 
><A
7296
 
NAME="AEN3695"
7297
 
></A
7298
 
><P
7299
 
></P
7300
 
><CODE
7301
 
CLASS="FUNCDEF"
7302
 
><TT
7303
 
CLASS="FUNCTION"
7304
 
>ftp_close</TT
7305
 
></CODE
7306
 
>(<TT
7307
 
CLASS="PARAMETER"
7308
 
><I
7309
 
>host</I
7310
 
></TT
7311
 
>);<P
7312
 
></P
7313
 
></DIV
7314
 
><P
7315
 
></P
7316
 
><DIV
7317
 
CLASS="VARIABLELIST"
7318
 
><DL
7319
 
><DT
7320
 
><TT
7321
 
CLASS="PARAMETER"
7322
 
><I
7323
 
>host</I
7324
 
></TT
7325
 
></DT
7326
 
><DD
7327
 
><P
7328
 
></P
7329
 
></DD
7330
 
></DL
7331
 
></DIV
7332
 
></DIV
7333
 
><DIV
7334
 
CLASS="SECT3"
7335
 
><H3
7336
 
CLASS="SECT3"
7337
 
><A
7338
 
NAME="TIPDOWNLOAD"
7339
 
></A
7340
 
>Tip_download Procedure</H3
7341
 
><P
7342
 
></P
7343
 
><DIV
7344
 
CLASS="FUNCSYNOPSIS"
7345
 
><A
7346
 
NAME="AEN3709"
7347
 
></A
7348
 
><P
7349
 
></P
7350
 
><CODE
7351
 
CLASS="FUNCDEF"
7352
 
><TT
7353
 
CLASS="FUNCTION"
7354
 
>tip_download</TT
7355
 
></CODE
7356
 
>(<TT
7357
 
CLASS="PARAMETER"
7358
 
><I
7359
 
>spawnid</I
7360
 
></TT
7361
 
>
7362
 
              <TT
7363
 
CLASS="PARAMETER"
7364
 
><I
7365
 
>file</I
7366
 
></TT
7367
 
>);<P
7368
 
></P
7369
 
></DIV
7370
 
><P
7371
 
></P
7372
 
><DIV
7373
 
CLASS="VARIABLELIST"
7374
 
><DL
7375
 
><DT
7376
 
><TT
7377
 
CLASS="PARAMETER"
7378
 
><I
7379
 
>spawnid</I
7380
 
></TT
7381
 
></DT
7382
 
><DD
7383
 
><P
7384
 
>Download <TT
7385
 
CLASS="OPTION"
7386
 
>file</TT
7387
 
> to the
7388
 
                process <SPAN
7389
 
CLASS="SYMBOL"
7390
 
>spawnid</SPAN
7391
 
> (the value returned
7392
 
                when the connection was established), using the
7393
 
                <B
7394
 
CLASS="COMMAND"
7395
 
>~put</B
7396
 
> command under
7397
 
                <SPAN
7398
 
CLASS="PRODUCTNAME"
7399
 
>tip</SPAN
7400
 
>.  Most often used for
7401
 
                single board computers that require downloading
7402
 
                programs in ASCII S-records.  Returns
7403
 
                <I
7404
 
CLASS="EMPHASIS"
7405
 
>1</I
7406
 
> if an error occurs,
7407
 
                <I
7408
 
CLASS="EMPHASIS"
7409
 
>0</I
7410
 
> otherwise.</P
7411
 
></DD
7412
 
><DT
7413
 
><TT
7414
 
CLASS="PARAMETER"
7415
 
><I
7416
 
>file</I
7417
 
></TT
7418
 
></DT
7419
 
><DD
7420
 
><P
7421
 
>This is the filename to
7422
 
                downlaod.</P
7423
 
></DD
7424
 
></DL
7425
 
></DIV
7426
 
></DIV
7427
 
></DIV
7428
 
><DIV
7429
 
CLASS="SECT2"
7430
 
><H2
7431
 
CLASS="SECT2"
7432
 
><A
7433
 
NAME="TARGETPROCS"
7434
 
></A
7435
 
>Procedures For Target Boards</H2
7436
 
><P
7437
 
></P
7438
 
><DIV
7439
 
CLASS="SECT3"
7440
 
><H3
7441
 
CLASS="SECT3"
7442
 
><A
7443
 
NAME="DEFAULTLINK"
7444
 
></A
7445
 
>Default_link Procedure</H3
7446
 
><P
7447
 
></P
7448
 
><DIV
7449
 
CLASS="FUNCSYNOPSIS"
7450
 
><A
7451
 
NAME="AEN3738"
7452
 
></A
7453
 
><P
7454
 
></P
7455
 
><CODE
7456
 
CLASS="FUNCDEF"
7457
 
><TT
7458
 
CLASS="FUNCTION"
7459
 
>default_link</TT
7460
 
></CODE
7461
 
>(<TT
7462
 
CLASS="PARAMETER"
7463
 
><I
7464
 
>board</I
7465
 
></TT
7466
 
>
7467
 
            <TT
7468
 
CLASS="PARAMETER"
7469
 
><I
7470
 
>objects</I
7471
 
></TT
7472
 
>
7473
 
            <TT
7474
 
CLASS="PARAMETER"
7475
 
><I
7476
 
>destfile</I
7477
 
></TT
7478
 
>
7479
 
            <TT
7480
 
CLASS="PARAMETER"
7481
 
><I
7482
 
>flags</I
7483
 
></TT
7484
 
>);<P
7485
 
></P
7486
 
></DIV
7487
 
><P
7488
 
></P
7489
 
><DIV
7490
 
CLASS="VARIABLELIST"
7491
 
><DL
7492
 
><DT
7493
 
><TT
7494
 
CLASS="PARAMETER"
7495
 
><I
7496
 
>board</I
7497
 
></TT
7498
 
></DT
7499
 
><DD
7500
 
><P
7501
 
></P
7502
 
></DD
7503
 
><DT
7504
 
><TT
7505
 
CLASS="PARAMETER"
7506
 
><I
7507
 
>objects</I
7508
 
></TT
7509
 
></DT
7510
 
><DD
7511
 
><P
7512
 
></P
7513
 
></DD
7514
 
><DT
7515
 
><TT
7516
 
CLASS="PARAMETER"
7517
 
><I
7518
 
>destfile</I
7519
 
></TT
7520
 
></DT
7521
 
><DD
7522
 
><P
7523
 
></P
7524
 
></DD
7525
 
><DT
7526
 
><TT
7527
 
CLASS="PARAMETER"
7528
 
><I
7529
 
>flags</I
7530
 
></TT
7531
 
></DT
7532
 
><DD
7533
 
><P
7534
 
></P
7535
 
></DD
7536
 
></DL
7537
 
></DIV
7538
 
></DIV
7539
 
><DIV
7540
 
CLASS="SECT3"
7541
 
><H3
7542
 
CLASS="SECT3"
7543
 
><A
7544
 
NAME="DEFAULTTARGETASSEMBLE"
7545
 
></A
7546
 
>Default_target_assemble Procedure</H3
7547
 
><P
7548
 
></P
7549
 
><DIV
7550
 
CLASS="FUNCSYNOPSIS"
7551
 
><A
7552
 
NAME="AEN3770"
7553
 
></A
7554
 
><P
7555
 
></P
7556
 
><CODE
7557
 
CLASS="FUNCDEF"
7558
 
><TT
7559
 
CLASS="FUNCTION"
7560
 
>default_target_assemble</TT
7561
 
></CODE
7562
 
>(<TT
7563
 
CLASS="PARAMETER"
7564
 
><I
7565
 
>source</I
7566
 
></TT
7567
 
>
7568
 
            <TT
7569
 
CLASS="PARAMETER"
7570
 
><I
7571
 
>destfile</I
7572
 
></TT
7573
 
>
7574
 
            <TT
7575
 
CLASS="PARAMETER"
7576
 
><I
7577
 
>flags</I
7578
 
></TT
7579
 
>);<P
7580
 
></P
7581
 
></DIV
7582
 
><P
7583
 
></P
7584
 
><DIV
7585
 
CLASS="VARIABLELIST"
7586
 
><DL
7587
 
><DT
7588
 
><TT
7589
 
CLASS="PARAMETER"
7590
 
><I
7591
 
>source</I
7592
 
></TT
7593
 
></DT
7594
 
><DD
7595
 
><P
7596
 
></P
7597
 
></DD
7598
 
><DT
7599
 
><TT
7600
 
CLASS="PARAMETER"
7601
 
><I
7602
 
>destfile</I
7603
 
></TT
7604
 
></DT
7605
 
><DD
7606
 
><P
7607
 
></P
7608
 
></DD
7609
 
><DT
7610
 
><TT
7611
 
CLASS="PARAMETER"
7612
 
><I
7613
 
>flags</I
7614
 
></TT
7615
 
></DT
7616
 
><DD
7617
 
><P
7618
 
></P
7619
 
></DD
7620
 
></DL
7621
 
></DIV
7622
 
></DIV
7623
 
><DIV
7624
 
CLASS="SECT3"
7625
 
><H3
7626
 
CLASS="SECT3"
7627
 
><A
7628
 
NAME="DEFAULTTARGETCOMPILE"
7629
 
></A
7630
 
>default_target_compile Procedure</H3
7631
 
><P
7632
 
></P
7633
 
><DIV
7634
 
CLASS="FUNCSYNOPSIS"
7635
 
><A
7636
 
NAME="AEN3796"
7637
 
></A
7638
 
><P
7639
 
></P
7640
 
><CODE
7641
 
CLASS="FUNCDEF"
7642
 
><TT
7643
 
CLASS="FUNCTION"
7644
 
>default_target_compile</TT
7645
 
></CODE
7646
 
>(<TT
7647
 
CLASS="PARAMETER"
7648
 
><I
7649
 
>source</I
7650
 
></TT
7651
 
>
7652
 
            <TT
7653
 
CLASS="PARAMETER"
7654
 
><I
7655
 
>destfile</I
7656
 
></TT
7657
 
>
7658
 
            <TT
7659
 
CLASS="PARAMETER"
7660
 
><I
7661
 
>type</I
7662
 
></TT
7663
 
>
7664
 
            <TT
7665
 
CLASS="PARAMETER"
7666
 
><I
7667
 
>options</I
7668
 
></TT
7669
 
>);<P
7670
 
></P
7671
 
></DIV
7672
 
><P
7673
 
></P
7674
 
><DIV
7675
 
CLASS="VARIABLELIST"
7676
 
><DL
7677
 
><DT
7678
 
><TT
7679
 
CLASS="PARAMETER"
7680
 
><I
7681
 
>source</I
7682
 
></TT
7683
 
></DT
7684
 
><DD
7685
 
><P
7686
 
></P
7687
 
></DD
7688
 
><DT
7689
 
><TT
7690
 
CLASS="PARAMETER"
7691
 
><I
7692
 
>destfile</I
7693
 
></TT
7694
 
></DT
7695
 
><DD
7696
 
><P
7697
 
></P
7698
 
></DD
7699
 
><DT
7700
 
><TT
7701
 
CLASS="PARAMETER"
7702
 
><I
7703
 
>type</I
7704
 
></TT
7705
 
></DT
7706
 
><DD
7707
 
><P
7708
 
></P
7709
 
></DD
7710
 
><DT
7711
 
><TT
7712
 
CLASS="PARAMETER"
7713
 
><I
7714
 
>options</I
7715
 
></TT
7716
 
></DT
7717
 
><DD
7718
 
><P
7719
 
></P
7720
 
></DD
7721
 
></DL
7722
 
></DIV
7723
 
></DIV
7724
 
><DIV
7725
 
CLASS="SECT3"
7726
 
><H3
7727
 
CLASS="SECT3"
7728
 
><A
7729
 
NAME="POPCONFIG"
7730
 
></A
7731
 
>Pop_config Procedure</H3
7732
 
><P
7733
 
></P
7734
 
><DIV
7735
 
CLASS="FUNCSYNOPSIS"
7736
 
><A
7737
 
NAME="AEN3828"
7738
 
></A
7739
 
><P
7740
 
></P
7741
 
><CODE
7742
 
CLASS="FUNCDEF"
7743
 
><TT
7744
 
CLASS="FUNCTION"
7745
 
>pop_config</TT
7746
 
></CODE
7747
 
>(<TT
7748
 
CLASS="PARAMETER"
7749
 
><I
7750
 
>type</I
7751
 
></TT
7752
 
>);<P
7753
 
></P
7754
 
></DIV
7755
 
><P
7756
 
></P
7757
 
><DIV
7758
 
CLASS="VARIABLELIST"
7759
 
><DL
7760
 
><DT
7761
 
><TT
7762
 
CLASS="PARAMETER"
7763
 
><I
7764
 
>type</I
7765
 
></TT
7766
 
></DT
7767
 
><DD
7768
 
><P
7769
 
></P
7770
 
></DD
7771
 
></DL
7772
 
></DIV
7773
 
></DIV
7774
 
><DIV
7775
 
CLASS="SECT3"
7776
 
><H3
7777
 
CLASS="SECT3"
7778
 
><A
7779
 
NAME="PRUNEWARNINGS"
7780
 
></A
7781
 
>Prune_warnings Procedure</H3
7782
 
><P
7783
 
></P
7784
 
><DIV
7785
 
CLASS="FUNCSYNOPSIS"
7786
 
><A
7787
 
NAME="AEN3842"
7788
 
></A
7789
 
><P
7790
 
></P
7791
 
><CODE
7792
 
CLASS="FUNCDEF"
7793
 
><TT
7794
 
CLASS="FUNCTION"
7795
 
>prune_warnings</TT
7796
 
></CODE
7797
 
>(<TT
7798
 
CLASS="PARAMETER"
7799
 
><I
7800
 
>text</I
7801
 
></TT
7802
 
>);<P
7803
 
></P
7804
 
></DIV
7805
 
><P
7806
 
></P
7807
 
><DIV
7808
 
CLASS="VARIABLELIST"
7809
 
><DL
7810
 
><DT
7811
 
><TT
7812
 
CLASS="PARAMETER"
7813
 
><I
7814
 
>text</I
7815
 
></TT
7816
 
></DT
7817
 
><DD
7818
 
><P
7819
 
></P
7820
 
></DD
7821
 
></DL
7822
 
></DIV
7823
 
></DIV
7824
 
><DIV
7825
 
CLASS="SECT3"
7826
 
><H3
7827
 
CLASS="SECT3"
7828
 
><A
7829
 
NAME="PUSHBUILD"
7830
 
></A
7831
 
>Push_build Procedure</H3
7832
 
><P
7833
 
></P
7834
 
><DIV
7835
 
CLASS="FUNCSYNOPSIS"
7836
 
><A
7837
 
NAME="AEN3856"
7838
 
></A
7839
 
><P
7840
 
></P
7841
 
><CODE
7842
 
CLASS="FUNCDEF"
7843
 
><TT
7844
 
CLASS="FUNCTION"
7845
 
>push_build</TT
7846
 
></CODE
7847
 
>(<TT
7848
 
CLASS="PARAMETER"
7849
 
><I
7850
 
>name</I
7851
 
></TT
7852
 
>);<P
7853
 
></P
7854
 
></DIV
7855
 
><P
7856
 
></P
7857
 
><DIV
7858
 
CLASS="VARIABLELIST"
7859
 
><DL
7860
 
><DT
7861
 
><TT
7862
 
CLASS="PARAMETER"
7863
 
><I
7864
 
>name</I
7865
 
></TT
7866
 
></DT
7867
 
><DD
7868
 
><P
7869
 
></P
7870
 
></DD
7871
 
></DL
7872
 
></DIV
7873
 
></DIV
7874
 
><DIV
7875
 
CLASS="SECT3"
7876
 
><H3
7877
 
CLASS="SECT3"
7878
 
><A
7879
 
NAME="PUSHCONFIG"
7880
 
></A
7881
 
>push_config Procedure</H3
7882
 
><P
7883
 
></P
7884
 
><DIV
7885
 
CLASS="FUNCSYNOPSIS"
7886
 
><A
7887
 
NAME="AEN3870"
7888
 
></A
7889
 
><P
7890
 
></P
7891
 
><CODE
7892
 
CLASS="FUNCDEF"
7893
 
><TT
7894
 
CLASS="FUNCTION"
7895
 
>push_config</TT
7896
 
></CODE
7897
 
>(<TT
7898
 
CLASS="PARAMETER"
7899
 
><I
7900
 
>type</I
7901
 
></TT
7902
 
>
7903
 
            <TT
7904
 
CLASS="PARAMETER"
7905
 
><I
7906
 
>name</I
7907
 
></TT
7908
 
>);<P
7909
 
></P
7910
 
></DIV
7911
 
><P
7912
 
></P
7913
 
><DIV
7914
 
CLASS="VARIABLELIST"
7915
 
><DL
7916
 
><DT
7917
 
><TT
7918
 
CLASS="PARAMETER"
7919
 
><I
7920
 
>type</I
7921
 
></TT
7922
 
></DT
7923
 
><DD
7924
 
><P
7925
 
></P
7926
 
></DD
7927
 
><DT
7928
 
><TT
7929
 
CLASS="PARAMETER"
7930
 
><I
7931
 
>name</I
7932
 
></TT
7933
 
></DT
7934
 
><DD
7935
 
><P
7936
 
></P
7937
 
></DD
7938
 
></DL
7939
 
></DIV
7940
 
></DIV
7941
 
><DIV
7942
 
CLASS="SECT3"
7943
 
><H3
7944
 
CLASS="SECT3"
7945
 
><A
7946
 
NAME="REBOOTTARGET"
7947
 
></A
7948
 
>Reboot_target Procedure</H3
7949
 
><P
7950
 
></P
7951
 
><DIV
7952
 
CLASS="FUNCSYNOPSIS"
7953
 
><A
7954
 
NAME="AEN3890"
7955
 
></A
7956
 
><P
7957
 
></P
7958
 
><CODE
7959
 
CLASS="FUNCDEF"
7960
 
><TT
7961
 
CLASS="FUNCTION"
7962
 
>reboot_target</TT
7963
 
></CODE
7964
 
>(<TT
7965
 
CLASS="PARAMETER"
7966
 
><I
7967
 
></I
7968
 
></TT
7969
 
>);<P
7970
 
></P
7971
 
></DIV
7972
 
></DIV
7973
 
><DIV
7974
 
CLASS="SECT3"
7975
 
><H3
7976
 
CLASS="SECT3"
7977
 
><A
7978
 
NAME="TARGETASSEMBLE"
7979
 
></A
7980
 
>Target_assemble Procedure</H3
7981
 
><P
7982
 
></P
7983
 
><DIV
7984
 
CLASS="FUNCSYNOPSIS"
7985
 
><A
7986
 
NAME="AEN3898"
7987
 
></A
7988
 
><P
7989
 
></P
7990
 
><CODE
7991
 
CLASS="FUNCDEF"
7992
 
><TT
7993
 
CLASS="FUNCTION"
7994
 
>target_assemble</TT
7995
 
></CODE
7996
 
>(<TT
7997
 
CLASS="PARAMETER"
7998
 
><I
7999
 
>source destfile flags</I
8000
 
></TT
8001
 
>);<P
8002
 
></P
8003
 
></DIV
8004
 
><P
8005
 
></P
8006
 
><DIV
8007
 
CLASS="VARIABLELIST"
8008
 
><DL
8009
 
><DT
8010
 
><TT
8011
 
CLASS="PARAMETER"
8012
 
><I
8013
 
>source</I
8014
 
></TT
8015
 
></DT
8016
 
><DD
8017
 
><P
8018
 
></P
8019
 
></DD
8020
 
><DT
8021
 
><TT
8022
 
CLASS="PARAMETER"
8023
 
><I
8024
 
>destfile</I
8025
 
></TT
8026
 
></DT
8027
 
><DD
8028
 
><P
8029
 
></P
8030
 
></DD
8031
 
><DT
8032
 
><TT
8033
 
CLASS="PARAMETER"
8034
 
><I
8035
 
>flags</I
8036
 
></TT
8037
 
></DT
8038
 
><DD
8039
 
><P
8040
 
></P
8041
 
></DD
8042
 
></DL
8043
 
></DIV
8044
 
></DIV
8045
 
><DIV
8046
 
CLASS="SECT3"
8047
 
><H3
8048
 
CLASS="SECT3"
8049
 
><A
8050
 
NAME="TARGETCOMPILE"
8051
 
></A
8052
 
>Target_compile Procedure</H3
8053
 
><P
8054
 
></P
8055
 
><DIV
8056
 
CLASS="FUNCSYNOPSIS"
8057
 
><A
8058
 
NAME="AEN3922"
8059
 
></A
8060
 
><P
8061
 
></P
8062
 
><CODE
8063
 
CLASS="FUNCDEF"
8064
 
><TT
8065
 
CLASS="FUNCTION"
8066
 
>target_compile</TT
8067
 
></CODE
8068
 
>(<TT
8069
 
CLASS="PARAMETER"
8070
 
><I
8071
 
>source</I
8072
 
></TT
8073
 
>
8074
 
            <TT
8075
 
CLASS="PARAMETER"
8076
 
><I
8077
 
>destfile</I
8078
 
></TT
8079
 
>
8080
 
            <TT
8081
 
CLASS="PARAMETER"
8082
 
><I
8083
 
>type</I
8084
 
></TT
8085
 
>
8086
 
            <TT
8087
 
CLASS="PARAMETER"
8088
 
><I
8089
 
>options</I
8090
 
></TT
8091
 
>);<P
8092
 
></P
8093
 
></DIV
8094
 
><P
8095
 
></P
8096
 
><DIV
8097
 
CLASS="VARIABLELIST"
8098
 
><DL
8099
 
><DT
8100
 
><TT
8101
 
CLASS="PARAMETER"
8102
 
><I
8103
 
>source</I
8104
 
></TT
8105
 
></DT
8106
 
><DD
8107
 
><P
8108
 
></P
8109
 
></DD
8110
 
><DT
8111
 
><TT
8112
 
CLASS="PARAMETER"
8113
 
><I
8114
 
>destfile</I
8115
 
></TT
8116
 
></DT
8117
 
><DD
8118
 
><P
8119
 
></P
8120
 
></DD
8121
 
><DT
8122
 
><TT
8123
 
CLASS="PARAMETER"
8124
 
><I
8125
 
>type</I
8126
 
></TT
8127
 
></DT
8128
 
><DD
8129
 
><P
8130
 
></P
8131
 
></DD
8132
 
><DT
8133
 
><TT
8134
 
CLASS="PARAMETER"
8135
 
><I
8136
 
>options</I
8137
 
></TT
8138
 
></DT
8139
 
><DD
8140
 
><P
8141
 
></P
8142
 
></DD
8143
 
></DL
8144
 
></DIV
8145
 
></DIV
8146
 
></DIV
8147
 
><DIV
8148
 
CLASS="SECT2"
8149
 
><H2
8150
 
CLASS="SECT2"
8151
 
><A
8152
 
NAME="TARGETDB"
8153
 
></A
8154
 
>Target Database Procedures</H2
8155
 
><DIV
8156
 
CLASS="SECT3"
8157
 
><H3
8158
 
CLASS="SECT3"
8159
 
><A
8160
 
NAME="BOARDINFO"
8161
 
></A
8162
 
>Board_info Procedure</H3
8163
 
><P
8164
 
></P
8165
 
><DIV
8166
 
CLASS="FUNCSYNOPSIS"
8167
 
><A
8168
 
NAME="AEN3956"
8169
 
></A
8170
 
><P
8171
 
></P
8172
 
><CODE
8173
 
CLASS="FUNCDEF"
8174
 
><TT
8175
 
CLASS="FUNCTION"
8176
 
>board_info</TT
8177
 
></CODE
8178
 
>(<TT
8179
 
CLASS="PARAMETER"
8180
 
><I
8181
 
>machine</I
8182
 
></TT
8183
 
>
8184
 
            <TT
8185
 
CLASS="PARAMETER"
8186
 
><I
8187
 
>op</I
8188
 
></TT
8189
 
>
8190
 
            <TT
8191
 
CLASS="PARAMETER"
8192
 
><I
8193
 
>args</I
8194
 
></TT
8195
 
>);<P
8196
 
></P
8197
 
></DIV
8198
 
><P
8199
 
></P
8200
 
><DIV
8201
 
CLASS="VARIABLELIST"
8202
 
><DL
8203
 
><DT
8204
 
><TT
8205
 
CLASS="PARAMETER"
8206
 
><I
8207
 
>machine</I
8208
 
></TT
8209
 
></DT
8210
 
><DD
8211
 
><P
8212
 
></P
8213
 
></DD
8214
 
><DT
8215
 
><TT
8216
 
CLASS="PARAMETER"
8217
 
><I
8218
 
>op</I
8219
 
></TT
8220
 
></DT
8221
 
><DD
8222
 
><P
8223
 
></P
8224
 
></DD
8225
 
><DT
8226
 
><TT
8227
 
CLASS="PARAMETER"
8228
 
><I
8229
 
>args</I
8230
 
></TT
8231
 
></DT
8232
 
><DD
8233
 
><P
8234
 
></P
8235
 
></DD
8236
 
></DL
8237
 
></DIV
8238
 
></DIV
8239
 
><DIV
8240
 
CLASS="SECT3"
8241
 
><H3
8242
 
CLASS="SECT3"
8243
 
><A
8244
 
NAME="HOSTINFO"
8245
 
></A
8246
 
>Host_info Procedure</H3
8247
 
><P
8248
 
></P
8249
 
><DIV
8250
 
CLASS="FUNCSYNOPSIS"
8251
 
><A
8252
 
NAME="AEN3982"
8253
 
></A
8254
 
><P
8255
 
></P
8256
 
><CODE
8257
 
CLASS="FUNCDEF"
8258
 
><TT
8259
 
CLASS="FUNCTION"
8260
 
>host_info</TT
8261
 
></CODE
8262
 
>(<TT
8263
 
CLASS="PARAMETER"
8264
 
><I
8265
 
>op</I
8266
 
></TT
8267
 
>
8268
 
            <TT
8269
 
CLASS="PARAMETER"
8270
 
><I
8271
 
>args</I
8272
 
></TT
8273
 
>);<P
8274
 
></P
8275
 
></DIV
8276
 
><P
8277
 
></P
8278
 
><DIV
8279
 
CLASS="VARIABLELIST"
8280
 
><DL
8281
 
><DT
8282
 
><TT
8283
 
CLASS="PARAMETER"
8284
 
><I
8285
 
>op</I
8286
 
></TT
8287
 
></DT
8288
 
><DD
8289
 
><P
8290
 
></P
8291
 
></DD
8292
 
><DT
8293
 
><TT
8294
 
CLASS="PARAMETER"
8295
 
><I
8296
 
>args</I
8297
 
></TT
8298
 
></DT
8299
 
><DD
8300
 
><P
8301
 
></P
8302
 
></DD
8303
 
></DL
8304
 
></DIV
8305
 
></DIV
8306
 
><DIV
8307
 
CLASS="SECT3"
8308
 
><H3
8309
 
CLASS="SECT3"
8310
 
><A
8311
 
NAME="SETBOARDINFO"
8312
 
></A
8313
 
>Set_board_info Procedure</H3
8314
 
><P
8315
 
></P
8316
 
><DIV
8317
 
CLASS="FUNCSYNOPSIS"
8318
 
><A
8319
 
NAME="AEN4002"
8320
 
></A
8321
 
><P
8322
 
></P
8323
 
><CODE
8324
 
CLASS="FUNCDEF"
8325
 
><TT
8326
 
CLASS="FUNCTION"
8327
 
>set_board_info</TT
8328
 
></CODE
8329
 
>(<TT
8330
 
CLASS="PARAMETER"
8331
 
><I
8332
 
>entry</I
8333
 
></TT
8334
 
>
8335
 
            <TT
8336
 
CLASS="PARAMETER"
8337
 
><I
8338
 
>value</I
8339
 
></TT
8340
 
>);<P
8341
 
></P
8342
 
></DIV
8343
 
><P
8344
 
></P
8345
 
><DIV
8346
 
CLASS="VARIABLELIST"
8347
 
><DL
8348
 
><DT
8349
 
><TT
8350
 
CLASS="PARAMETER"
8351
 
><I
8352
 
>entry</I
8353
 
></TT
8354
 
></DT
8355
 
><DD
8356
 
><P
8357
 
></P
8358
 
></DD
8359
 
><DT
8360
 
><TT
8361
 
CLASS="PARAMETER"
8362
 
><I
8363
 
>value</I
8364
 
></TT
8365
 
></DT
8366
 
><DD
8367
 
><P
8368
 
></P
8369
 
></DD
8370
 
></DL
8371
 
></DIV
8372
 
></DIV
8373
 
><DIV
8374
 
CLASS="SECT3"
8375
 
><H3
8376
 
CLASS="SECT3"
8377
 
><A
8378
 
NAME="SETCURRTARGETINFO"
8379
 
></A
8380
 
>Set_currtarget_info Procedure</H3
8381
 
><P
8382
 
></P
8383
 
><DIV
8384
 
CLASS="FUNCSYNOPSIS"
8385
 
><A
8386
 
NAME="AEN4022"
8387
 
></A
8388
 
><P
8389
 
></P
8390
 
><CODE
8391
 
CLASS="FUNCDEF"
8392
 
><TT
8393
 
CLASS="FUNCTION"
8394
 
>set_currtarget_info</TT
8395
 
></CODE
8396
 
>(<TT
8397
 
CLASS="PARAMETER"
8398
 
><I
8399
 
>entry</I
8400
 
></TT
8401
 
>
8402
 
            <TT
8403
 
CLASS="PARAMETER"
8404
 
><I
8405
 
>value</I
8406
 
></TT
8407
 
>);<P
8408
 
></P
8409
 
></DIV
8410
 
><P
8411
 
></P
8412
 
><DIV
8413
 
CLASS="VARIABLELIST"
8414
 
><DL
8415
 
><DT
8416
 
><TT
8417
 
CLASS="PARAMETER"
8418
 
><I
8419
 
>entry</I
8420
 
></TT
8421
 
></DT
8422
 
><DD
8423
 
><P
8424
 
></P
8425
 
></DD
8426
 
><DT
8427
 
><TT
8428
 
CLASS="PARAMETER"
8429
 
><I
8430
 
>value</I
8431
 
></TT
8432
 
></DT
8433
 
><DD
8434
 
><P
8435
 
></P
8436
 
></DD
8437
 
></DL
8438
 
></DIV
8439
 
></DIV
8440
 
><DIV
8441
 
CLASS="SECT3"
8442
 
><H3
8443
 
CLASS="SECT3"
8444
 
><A
8445
 
NAME="TARGETINFO"
8446
 
></A
8447
 
>Target_info Procedure</H3
8448
 
><P
8449
 
></P
8450
 
><DIV
8451
 
CLASS="FUNCSYNOPSIS"
8452
 
><A
8453
 
NAME="AEN4042"
8454
 
></A
8455
 
><P
8456
 
></P
8457
 
><CODE
8458
 
CLASS="FUNCDEF"
8459
 
><TT
8460
 
CLASS="FUNCTION"
8461
 
>target_info</TT
8462
 
></CODE
8463
 
>(<TT
8464
 
CLASS="PARAMETER"
8465
 
><I
8466
 
>op</I
8467
 
></TT
8468
 
>
8469
 
            <TT
8470
 
CLASS="PARAMETER"
8471
 
><I
8472
 
>args</I
8473
 
></TT
8474
 
>);<P
8475
 
></P
8476
 
></DIV
8477
 
><P
8478
 
></P
8479
 
><DIV
8480
 
CLASS="VARIABLELIST"
8481
 
><DL
8482
 
><DT
8483
 
><TT
8484
 
CLASS="PARAMETER"
8485
 
><I
8486
 
>op</I
8487
 
></TT
8488
 
></DT
8489
 
><DD
8490
 
><P
8491
 
></P
8492
 
></DD
8493
 
><DT
8494
 
><TT
8495
 
CLASS="PARAMETER"
8496
 
><I
8497
 
>args</I
8498
 
></TT
8499
 
></DT
8500
 
><DD
8501
 
><P
8502
 
></P
8503
 
></DD
8504
 
></DL
8505
 
></DIV
8506
 
></DIV
8507
 
><DIV
8508
 
CLASS="SECT3"
8509
 
><H3
8510
 
CLASS="SECT3"
8511
 
><A
8512
 
NAME="UNSETBOARDINFO"
8513
 
></A
8514
 
>Unset_board_info Procedure</H3
8515
 
><P
8516
 
></P
8517
 
><DIV
8518
 
CLASS="FUNCSYNOPSIS"
8519
 
><A
8520
 
NAME="AEN4062"
8521
 
></A
8522
 
><P
8523
 
></P
8524
 
><CODE
8525
 
CLASS="FUNCDEF"
8526
 
><TT
8527
 
CLASS="FUNCTION"
8528
 
>unset_board_info</TT
8529
 
></CODE
8530
 
>(<TT
8531
 
CLASS="PARAMETER"
8532
 
><I
8533
 
>entry</I
8534
 
></TT
8535
 
>);<P
8536
 
></P
8537
 
></DIV
8538
 
><P
8539
 
></P
8540
 
><DIV
8541
 
CLASS="VARIABLELIST"
8542
 
><DL
8543
 
><DT
8544
 
><TT
8545
 
CLASS="PARAMETER"
8546
 
><I
8547
 
>entry</I
8548
 
></TT
8549
 
></DT
8550
 
><DD
8551
 
><P
8552
 
></P
8553
 
></DD
8554
 
></DL
8555
 
></DIV
8556
 
></DIV
8557
 
><DIV
8558
 
CLASS="SECT3"
8559
 
><H3
8560
 
CLASS="SECT3"
8561
 
><A
8562
 
NAME="UNSETCURRTARGETINFO"
8563
 
></A
8564
 
>Unset_currtarget_info Procedure</H3
8565
 
><P
8566
 
></P
8567
 
><DIV
8568
 
CLASS="FUNCSYNOPSIS"
8569
 
><A
8570
 
NAME="AEN4076"
8571
 
></A
8572
 
><P
8573
 
></P
8574
 
><CODE
8575
 
CLASS="FUNCDEF"
8576
 
><TT
8577
 
CLASS="FUNCTION"
8578
 
>unset_currtarget_info</TT
8579
 
></CODE
8580
 
>(<TT
8581
 
CLASS="PARAMETER"
8582
 
><I
8583
 
>entry</I
8584
 
></TT
8585
 
>);<P
8586
 
></P
8587
 
></DIV
8588
 
><P
8589
 
></P
8590
 
><DIV
8591
 
CLASS="VARIABLELIST"
8592
 
><DL
8593
 
><DT
8594
 
><TT
8595
 
CLASS="PARAMETER"
8596
 
><I
8597
 
>entry</I
8598
 
></TT
8599
 
></DT
8600
 
><DD
8601
 
><P
8602
 
></P
8603
 
></DD
8604
 
></DL
8605
 
></DIV
8606
 
></DIV
8607
 
><DIV
8608
 
CLASS="SECT3"
8609
 
><H3
8610
 
CLASS="SECT3"
8611
 
><A
8612
 
NAME="PUSHTARGET"
8613
 
></A
8614
 
>Push_target Procedure</H3
8615
 
><P
8616
 
>This makes the target named <I
8617
 
CLASS="EMPHASIS"
8618
 
>name</I
8619
 
> be the
8620
 
          current target connection. The value of <I
8621
 
CLASS="EMPHASIS"
8622
 
>name</I
8623
 
> is
8624
 
          an index into the <SPAN
8625
 
CLASS="SYMBOL"
8626
 
>target_info</SPAN
8627
 
> array and is set in
8628
 
          the global config file.</P
8629
 
><DIV
8630
 
CLASS="FUNCSYNOPSIS"
8631
 
><A
8632
 
NAME="AEN4093"
8633
 
></A
8634
 
><P
8635
 
></P
8636
 
><CODE
8637
 
CLASS="FUNCDEF"
8638
 
><TT
8639
 
CLASS="FUNCTION"
8640
 
>push_target</TT
8641
 
></CODE
8642
 
>(<TT
8643
 
CLASS="PARAMETER"
8644
 
><I
8645
 
>name</I
8646
 
></TT
8647
 
>);<P
8648
 
></P
8649
 
></DIV
8650
 
><P
8651
 
></P
8652
 
><DIV
8653
 
CLASS="VARIABLELIST"
8654
 
><DL
8655
 
><DT
8656
 
><TT
8657
 
CLASS="PARAMETER"
8658
 
><I
8659
 
>name</I
8660
 
></TT
8661
 
></DT
8662
 
><DD
8663
 
><P
8664
 
>The name of the target to make current
8665
 
            connection.</P
8666
 
></DD
8667
 
></DL
8668
 
></DIV
8669
 
></DIV
8670
 
><DIV
8671
 
CLASS="SECT3"
8672
 
><H3
8673
 
CLASS="SECT3"
8674
 
><A
8675
 
NAME="POPTARGET"
8676
 
></A
8677
 
>Pop_target Procedure</H3
8678
 
><P
8679
 
>This unsets the current target connection.</P
8680
 
><DIV
8681
 
CLASS="FUNCSYNOPSIS"
8682
 
><A
8683
 
NAME="AEN4107"
8684
 
></A
8685
 
><P
8686
 
></P
8687
 
><CODE
8688
 
CLASS="FUNCDEF"
8689
 
><TT
8690
 
CLASS="FUNCTION"
8691
 
>pop_target</TT
8692
 
></CODE
8693
 
>(<TT
8694
 
CLASS="PARAMETER"
8695
 
><I
8696
 
></I
8697
 
></TT
8698
 
>);<P
8699
 
></P
8700
 
></DIV
8701
 
></DIV
8702
 
><DIV
8703
 
CLASS="SECT3"
8704
 
><H3
8705
 
CLASS="SECT3"
8706
 
><A
8707
 
NAME="LISTTARGETS"
8708
 
></A
8709
 
>List_targets Procedure</H3
8710
 
><P
8711
 
>This lists all the supported targets for this
8712
 
          architecture.</P
8713
 
><DIV
8714
 
CLASS="FUNCSYNOPSIS"
8715
 
><A
8716
 
NAME="AEN4115"
8717
 
></A
8718
 
><P
8719
 
></P
8720
 
><CODE
8721
 
CLASS="FUNCDEF"
8722
 
><TT
8723
 
CLASS="FUNCTION"
8724
 
>list_targets</TT
8725
 
></CODE
8726
 
>(<TT
8727
 
CLASS="PARAMETER"
8728
 
><I
8729
 
></I
8730
 
></TT
8731
 
>);<P
8732
 
></P
8733
 
></DIV
8734
 
></DIV
8735
 
><DIV
8736
 
CLASS="SECT3"
8737
 
><H3
8738
 
CLASS="SECT3"
8739
 
><A
8740
 
NAME="PUSHHOST"
8741
 
></A
8742
 
>Push_host Procedure</H3
8743
 
><P
8744
 
>This makes the host named <I
8745
 
CLASS="EMPHASIS"
8746
 
>name</I
8747
 
> be the
8748
 
          current remote host connection. The value of
8749
 
          <I
8750
 
CLASS="EMPHASIS"
8751
 
>name</I
8752
 
> is an index into the
8753
 
          <SPAN
8754
 
CLASS="SYMBOL"
8755
 
>target_info</SPAN
8756
 
> array and is set in the global config
8757
 
          file.</P
8758
 
><DIV
8759
 
CLASS="FUNCSYNOPSIS"
8760
 
><A
8761
 
NAME="AEN4126"
8762
 
></A
8763
 
><P
8764
 
></P
8765
 
><CODE
8766
 
CLASS="FUNCDEF"
8767
 
><TT
8768
 
CLASS="FUNCTION"
8769
 
>push_host</TT
8770
 
></CODE
8771
 
>(<TT
8772
 
CLASS="PARAMETER"
8773
 
><I
8774
 
>name</I
8775
 
></TT
8776
 
>);<P
8777
 
></P
8778
 
></DIV
8779
 
><P
8780
 
></P
8781
 
><DIV
8782
 
CLASS="VARIABLELIST"
8783
 
><DL
8784
 
><DT
8785
 
><TT
8786
 
CLASS="PARAMETER"
8787
 
><I
8788
 
>name</I
8789
 
></TT
8790
 
></DT
8791
 
><DD
8792
 
><P
8793
 
></P
8794
 
></DD
8795
 
></DL
8796
 
></DIV
8797
 
></DIV
8798
 
><DIV
8799
 
CLASS="SECT3"
8800
 
><H3
8801
 
CLASS="SECT3"
8802
 
><A
8803
 
NAME="POPHOST"
8804
 
></A
8805
 
>Pop_host Procedure</H3
8806
 
><P
8807
 
>This unsets the current host connection.</P
8808
 
><DIV
8809
 
CLASS="FUNCSYNOPSIS"
8810
 
><A
8811
 
NAME="AEN4140"
8812
 
></A
8813
 
><P
8814
 
></P
8815
 
><CODE
8816
 
CLASS="FUNCDEF"
8817
 
><TT
8818
 
CLASS="FUNCTION"
8819
 
>pop_host</TT
8820
 
></CODE
8821
 
>(<TT
8822
 
CLASS="PARAMETER"
8823
 
><I
8824
 
></I
8825
 
></TT
8826
 
>);<P
8827
 
></P
8828
 
></DIV
8829
 
></DIV
8830
 
><DIV
8831
 
CLASS="SECT3"
8832
 
><H3
8833
 
CLASS="SECT3"
8834
 
><A
8835
 
NAME="COMPILE"
8836
 
></A
8837
 
>Compile Procedure</H3
8838
 
><P
8839
 
>This invokes the compiler as set by CC to compile the
8840
 
          file <TT
8841
 
CLASS="FILENAME"
8842
 
>file</TT
8843
 
>. The default options for many cross
8844
 
          compilation targets are <I
8845
 
CLASS="EMPHASIS"
8846
 
>guessed</I
8847
 
> by DejaGnu, and
8848
 
          these options can be added to by passing in more parameters as
8849
 
          arguments to <B
8850
 
CLASS="COMMAND"
8851
 
>compile</B
8852
 
>. Optionally, this will also
8853
 
          use the value of the <I
8854
 
CLASS="EMPHASIS"
8855
 
>cflags</I
8856
 
> field in the target
8857
 
          config array. If the host is not the same as the build machines, then
8858
 
          then compiler is run on the remote host using
8859
 
          <B
8860
 
CLASS="COMMAND"
8861
 
>execute_anywhere</B
8862
 
>.</P
8863
 
><DIV
8864
 
CLASS="FUNCSYNOPSIS"
8865
 
><A
8866
 
NAME="AEN4153"
8867
 
></A
8868
 
><P
8869
 
></P
8870
 
><CODE
8871
 
CLASS="FUNCDEF"
8872
 
><TT
8873
 
CLASS="FUNCTION"
8874
 
>compile</TT
8875
 
></CODE
8876
 
>(<TT
8877
 
CLASS="PARAMETER"
8878
 
><I
8879
 
>file</I
8880
 
></TT
8881
 
>);<P
8882
 
></P
8883
 
></DIV
8884
 
><P
8885
 
></P
8886
 
><DIV
8887
 
CLASS="VARIABLELIST"
8888
 
><DL
8889
 
><DT
8890
 
><TT
8891
 
CLASS="PARAMETER"
8892
 
><I
8893
 
>file</I
8894
 
></TT
8895
 
></DT
8896
 
><DD
8897
 
><P
8898
 
></P
8899
 
></DD
8900
 
></DL
8901
 
></DIV
8902
 
></DIV
8903
 
><DIV
8904
 
CLASS="SECT3"
8905
 
><H3
8906
 
CLASS="SECT3"
8907
 
><A
8908
 
NAME="ARCHIVE"
8909
 
></A
8910
 
>Archive Procedure</H3
8911
 
><P
8912
 
>This produces an archive file. Any parameters passed to
8913
 
          <B
8914
 
CLASS="COMMAND"
8915
 
>archive</B
8916
 
> are used in addition to the default
8917
 
          flags. Optionally, this will also use the value of the
8918
 
          <I
8919
 
CLASS="EMPHASIS"
8920
 
>arflags</I
8921
 
> field in the target config array. If the
8922
 
          host is not the same as the build machines, then then archiver is run
8923
 
          on the remote host using <B
8924
 
CLASS="COMMAND"
8925
 
>execute_anywhere</B
8926
 
>.</P
8927
 
><DIV
8928
 
CLASS="FUNCSYNOPSIS"
8929
 
><A
8930
 
NAME="AEN4170"
8931
 
></A
8932
 
><P
8933
 
></P
8934
 
><CODE
8935
 
CLASS="FUNCDEF"
8936
 
><TT
8937
 
CLASS="FUNCTION"
8938
 
>archive</TT
8939
 
></CODE
8940
 
>(<TT
8941
 
CLASS="PARAMETER"
8942
 
><I
8943
 
>file</I
8944
 
></TT
8945
 
>);<P
8946
 
></P
8947
 
></DIV
8948
 
><P
8949
 
></P
8950
 
><DIV
8951
 
CLASS="VARIABLELIST"
8952
 
><DL
8953
 
><DT
8954
 
><TT
8955
 
CLASS="PARAMETER"
8956
 
><I
8957
 
>file</I
8958
 
></TT
8959
 
></DT
8960
 
><DD
8961
 
><P
8962
 
></P
8963
 
></DD
8964
 
></DL
8965
 
></DIV
8966
 
></DIV
8967
 
><DIV
8968
 
CLASS="SECT3"
8969
 
><H3
8970
 
CLASS="SECT3"
8971
 
><A
8972
 
NAME="RANLIB"
8973
 
></A
8974
 
>Ranlib Procedure</H3
8975
 
><P
8976
 
>This generates an index for the archive file for systems that
8977
 
          aren't POSIX yet. Any parameters passed to <B
8978
 
CLASS="COMMAND"
8979
 
>ranlib</B
8980
 
>
8981
 
          are used in for the flags.</P
8982
 
><DIV
8983
 
CLASS="FUNCSYNOPSIS"
8984
 
><A
8985
 
NAME="AEN4185"
8986
 
></A
8987
 
><P
8988
 
></P
8989
 
><CODE
8990
 
CLASS="FUNCDEF"
8991
 
><TT
8992
 
CLASS="FUNCTION"
8993
 
>ranlib</TT
8994
 
></CODE
8995
 
>(<TT
8996
 
CLASS="PARAMETER"
8997
 
><I
8998
 
>file</I
8999
 
></TT
9000
 
>);<P
9001
 
></P
9002
 
></DIV
9003
 
><P
9004
 
></P
9005
 
><DIV
9006
 
CLASS="VARIABLELIST"
9007
 
><DL
9008
 
><DT
9009
 
><TT
9010
 
CLASS="PARAMETER"
9011
 
><I
9012
 
>file</I
9013
 
></TT
9014
 
></DT
9015
 
><DD
9016
 
><P
9017
 
></P
9018
 
></DD
9019
 
></DL
9020
 
></DIV
9021
 
></DIV
9022
 
><DIV
9023
 
CLASS="SECT3"
9024
 
><H3
9025
 
CLASS="SECT3"
9026
 
><A
9027
 
NAME="EXECUTEANYWHERE"
9028
 
></A
9029
 
>Execute_anywhere Procedure</H3
9030
 
><P
9031
 
>This executes the <I
9032
 
CLASS="EMPHASIS"
9033
 
>cmdline</I
9034
 
> on the proper
9035
 
          host. This should be used as a replacement for the Tcl command
9036
 
          <B
9037
 
CLASS="COMMAND"
9038
 
>exec</B
9039
 
> as this version utilizes the target config
9040
 
          info to execute this command on the build machine or a remote
9041
 
          host. All config information for the remote host must be setup to
9042
 
          have this command work. If this is a canadian cross, (where we test a
9043
 
          cross compiler that runs on a different host then where DejaGnu is
9044
 
          running) then a connection is made to the remote host and the command
9045
 
          is executed there. It returns either REMOTERROR (for an error) or the
9046
 
          output produced when the command was executed. This is used for
9047
 
          running the tool to be tested, not a test case.</P
9048
 
><DIV
9049
 
CLASS="FUNCSYNOPSIS"
9050
 
><A
9051
 
NAME="AEN4201"
9052
 
></A
9053
 
><P
9054
 
></P
9055
 
><CODE
9056
 
CLASS="FUNCDEF"
9057
 
><TT
9058
 
CLASS="FUNCTION"
9059
 
>execute_anywhere</TT
9060
 
></CODE
9061
 
>(<TT
9062
 
CLASS="PARAMETER"
9063
 
><I
9064
 
>cmdline</I
9065
 
></TT
9066
 
>);<P
9067
 
></P
9068
 
></DIV
9069
 
><P
9070
 
></P
9071
 
><DIV
9072
 
CLASS="VARIABLELIST"
9073
 
><DL
9074
 
><DT
9075
 
><TT
9076
 
CLASS="PARAMETER"
9077
 
><I
9078
 
>cmdline</I
9079
 
></TT
9080
 
></DT
9081
 
><DD
9082
 
><P
9083
 
></P
9084
 
></DD
9085
 
></DL
9086
 
></DIV
9087
 
></DIV
9088
 
></DIV
9089
 
><DIV
9090
 
CLASS="SECT2"
9091
 
><H2
9092
 
CLASS="SECT2"
9093
 
><A
9094
 
NAME="PLATFORMPROCS"
9095
 
></A
9096
 
>Platform Dependant Procedures</H2
9097
 
><P
9098
 
>Each combination of target and tool requires some
9099
 
      target-dependent procedures.  The names of these procedures have
9100
 
      a common form: the tool name, followed by an underbar
9101
 
      <I
9102
 
CLASS="EMPHASIS"
9103
 
>_</I
9104
 
>, and finally a suffix describing the
9105
 
      procedure's purpose.  For example, a procedure to extract the
9106
 
      version from <SPAN
9107
 
CLASS="PRODUCTNAME"
9108
 
>GDB</SPAN
9109
 
> is called
9110
 
      <SPAN
9111
 
CLASS="SYMBOL"
9112
 
>gdb_version</SPAN
9113
 
>.</P
9114
 
><P
9115
 
><B
9116
 
CLASS="COMMAND"
9117
 
>runtest</B
9118
 
> itself calls only two of these
9119
 
      procedures, <SPAN
9120
 
CLASS="SYMBOL"
9121
 
>${tool}_exit</SPAN
9122
 
> and
9123
 
      <SPAN
9124
 
CLASS="SYMBOL"
9125
 
>${tool}_version</SPAN
9126
 
>; these procedures use no
9127
 
      arguments.</P
9128
 
><P
9129
 
>The other two procedures, <SPAN
9130
 
CLASS="SYMBOL"
9131
 
>${tool}_start</SPAN
9132
 
>
9133
 
      and <SPAN
9134
 
CLASS="SYMBOL"
9135
 
>${tool}_load</SPAN
9136
 
>}, are only called by the test
9137
 
      suites themselves (or by testsuite-specific initialization
9138
 
      code); they may take arguments  or not, depending on the
9139
 
      conventions used within each testsuite.</P
9140
 
><P
9141
 
>The usual convention for return codes from any of these
9142
 
      procedures (although it is not required by
9143
 
      <B
9144
 
CLASS="COMMAND"
9145
 
>runtest</B
9146
 
>) is to return <I
9147
 
CLASS="EMPHASIS"
9148
 
>0</I
9149
 
>
9150
 
      if the procedure succeeded, <I
9151
 
CLASS="EMPHASIS"
9152
 
>1</I
9153
 
> if it failed,
9154
 
      and <I
9155
 
CLASS="EMPHASIS"
9156
 
>-1</I
9157
 
> if there was a communication error.</P
9158
 
><DIV
9159
 
CLASS="SECT3"
9160
 
><H3
9161
 
CLASS="SECT3"
9162
 
><A
9163
 
NAME="TOOLSTART"
9164
 
></A
9165
 
>${tool}_start Procedure</H3
9166
 
><P
9167
 
>Starts a particular tool.  For an interactive tool,
9168
 
          <TT
9169
 
CLASS="FUNCTION"
9170
 
>${tool}_start</TT
9171
 
> starts and initializes the
9172
 
          tool, leaving the tool up and running for the test cases; an
9173
 
          example is <TT
9174
 
CLASS="FUNCTION"
9175
 
>gdb_start</TT
9176
 
>, the start function
9177
 
          for GDB. For a batch oriented tool,
9178
 
          <TT
9179
 
CLASS="FUNCTION"
9180
 
>${tool}_start</TT
9181
 
> is optional; the recommended
9182
 
          convention is to let <TT
9183
 
CLASS="FUNCTION"
9184
 
>${tool}_start</TT
9185
 
> run the
9186
 
          tool, leaving the output in a variable called
9187
 
          <TT
9188
 
CLASS="FUNCTION"
9189
 
>comp_output</TT
9190
 
>.  Test scripts can then analyze
9191
 
          <TT
9192
 
CLASS="FUNCTION"
9193
 
>$comp_output</TT
9194
 
> to determine the test results.
9195
 
          An example of this second kind of start function is
9196
 
          <TT
9197
 
CLASS="FUNCTION"
9198
 
>gcc_start</TT
9199
 
>, the start function for GCC.</P
9200
 
><P
9201
 
>DejaGnu itself does not call
9202
 
          <TT
9203
 
CLASS="FUNCTION"
9204
 
>${tool}_start</TT
9205
 
>.  The initialization
9206
 
          module <TT
9207
 
CLASS="FUNCTION"
9208
 
>${tool}_init.exp</TT
9209
 
> must call
9210
 
          <TT
9211
 
CLASS="FUNCTION"
9212
 
>${tool}_start</TT
9213
 
> for interactive tools;
9214
 
          for batch-oriented tools, each individual test script calls
9215
 
          <TT
9216
 
CLASS="FUNCTION"
9217
 
>${tool}_start</TT
9218
 
> (or makes other
9219
 
          arrangements to run the tool).</P
9220
 
><DIV
9221
 
CLASS="FUNCSYNOPSIS"
9222
 
><A
9223
 
NAME="AEN4245"
9224
 
></A
9225
 
><P
9226
 
></P
9227
 
><CODE
9228
 
CLASS="FUNCDEF"
9229
 
><TT
9230
 
CLASS="FUNCTION"
9231
 
>${tool}_start</TT
9232
 
></CODE
9233
 
>(<TT
9234
 
CLASS="PARAMETER"
9235
 
><I
9236
 
></I
9237
 
></TT
9238
 
>);<P
9239
 
></P
9240
 
></DIV
9241
 
></DIV
9242
 
><DIV
9243
 
CLASS="SECT3"
9244
 
><H3
9245
 
CLASS="SECT3"
9246
 
><A
9247
 
NAME="TOOLLOAD"
9248
 
></A
9249
 
>${tool}_load Procedure</H3
9250
 
><P
9251
 
>Loads something into a tool. For an interactive tool,
9252
 
          this conditions the tool for a particular test case; for
9253
 
          example, <TT
9254
 
CLASS="FUNCTION"
9255
 
>gdb_load</TT
9256
 
> loads a new
9257
 
          executable file into the debugger. For batch oriented tools,
9258
 
          <TT
9259
 
CLASS="FUNCTION"
9260
 
>${tool}_load</TT
9261
 
> may do nothing---though,
9262
 
          for example, the GCC support uses
9263
 
          <TT
9264
 
CLASS="FUNCTION"
9265
 
>gcc_load</TT
9266
 
> to load and run a binary on
9267
 
          the target environment.  Conventionally,
9268
 
          <TT
9269
 
CLASS="FUNCTION"
9270
 
>${tool}_load</TT
9271
 
> leaves the output of any
9272
 
          program it runs in a variable called
9273
 
          <SPAN
9274
 
CLASS="SYMBOL"
9275
 
>$exec_output</SPAN
9276
 
>. Writing
9277
 
          <TT
9278
 
CLASS="FUNCTION"
9279
 
>${tool}_load</TT
9280
 
> can be the most complex
9281
 
          part of extending DejaGnu to a new tool or a new target, if
9282
 
          it requires much communication coding or file
9283
 
          downloading. Test scripts call
9284
 
          <TT
9285
 
CLASS="FUNCTION"
9286
 
>${tool}_load</TT
9287
 
>.</P
9288
 
><DIV
9289
 
CLASS="FUNCSYNOPSIS"
9290
 
><A
9291
 
NAME="AEN4260"
9292
 
></A
9293
 
><P
9294
 
></P
9295
 
><CODE
9296
 
CLASS="FUNCDEF"
9297
 
><TT
9298
 
CLASS="FUNCTION"
9299
 
>${tool}_load</TT
9300
 
></CODE
9301
 
>(<TT
9302
 
CLASS="PARAMETER"
9303
 
><I
9304
 
></I
9305
 
></TT
9306
 
>);<P
9307
 
></P
9308
 
></DIV
9309
 
></DIV
9310
 
><DIV
9311
 
CLASS="SECT3"
9312
 
><H3
9313
 
CLASS="SECT3"
9314
 
><A
9315
 
NAME="TOOLEXIT"
9316
 
></A
9317
 
>${tool}_exit Procedure</H3
9318
 
><P
9319
 
>Cleans up (if necessary) before DejaGnu exits. For
9320
 
          interactive tools, this usually ends the interactive
9321
 
          session.  You can also use <TT
9322
 
CLASS="FUNCTION"
9323
 
>${tool}_exit</TT
9324
 
>
9325
 
          to remove any temporary files left over from the
9326
 
          tests. <B
9327
 
CLASS="COMMAND"
9328
 
>runtest</B
9329
 
> calls
9330
 
          <TT
9331
 
CLASS="FUNCTION"
9332
 
>${tool}_exit</TT
9333
 
>.</P
9334
 
><DIV
9335
 
CLASS="FUNCSYNOPSIS"
9336
 
><A
9337
 
NAME="AEN4271"
9338
 
></A
9339
 
><P
9340
 
></P
9341
 
><CODE
9342
 
CLASS="FUNCDEF"
9343
 
><TT
9344
 
CLASS="FUNCTION"
9345
 
>${tool}_exit</TT
9346
 
></CODE
9347
 
>(<TT
9348
 
CLASS="PARAMETER"
9349
 
><I
9350
 
></I
9351
 
></TT
9352
 
>);<P
9353
 
></P
9354
 
></DIV
9355
 
></DIV
9356
 
><DIV
9357
 
CLASS="SECT3"
9358
 
><H3
9359
 
CLASS="SECT3"
9360
 
><A
9361
 
NAME="TOOLVERSION"
9362
 
></A
9363
 
>${tool}_version Procedure</H3
9364
 
><P
9365
 
>Prints the version label and number for
9366
 
          <SPAN
9367
 
CLASS="SYMBOL"
9368
 
>${tool}</SPAN
9369
 
>.  This is called by the DejaGnu
9370
 
          procedure that prints the final summary report.  The output
9371
 
          should consist of the full path name used for the tested
9372
 
          tool, and its version number.</P
9373
 
><DIV
9374
 
CLASS="FUNCSYNOPSIS"
9375
 
><A
9376
 
NAME="AEN4280"
9377
 
></A
9378
 
><P
9379
 
></P
9380
 
><CODE
9381
 
CLASS="FUNCDEF"
9382
 
><TT
9383
 
CLASS="FUNCTION"
9384
 
>${tool}_version</TT
9385
 
></CODE
9386
 
>(<TT
9387
 
CLASS="PARAMETER"
9388
 
><I
9389
 
></I
9390
 
></TT
9391
 
>);<P
9392
 
></P
9393
 
></DIV
9394
 
></DIV
9395
 
></DIV
9396
 
><DIV
9397
 
CLASS="SECT2"
9398
 
><H2
9399
 
CLASS="SECT2"
9400
 
><A
9401
 
NAME="UTILPROCS"
9402
 
></A
9403
 
>Utility Procedures</H2
9404
 
><DIV
9405
 
CLASS="SECT3"
9406
 
><H3
9407
 
CLASS="SECT3"
9408
 
><A
9409
 
NAME="GETDIRS"
9410
 
></A
9411
 
>Getdirs Procedure</H3
9412
 
><P
9413
 
>Returns a list of all the directories in the single
9414
 
        directory a single directory that match an optional
9415
 
        pattern. </P
9416
 
><DIV
9417
 
CLASS="FUNCSYNOPSIS"
9418
 
><A
9419
 
NAME="AEN4290"
9420
 
></A
9421
 
><P
9422
 
></P
9423
 
><CODE
9424
 
CLASS="FUNCDEF"
9425
 
><TT
9426
 
CLASS="FUNCTION"
9427
 
>getdirs</TT
9428
 
></CODE
9429
 
>(<TT
9430
 
CLASS="PARAMETER"
9431
 
><I
9432
 
>rootdir</I
9433
 
></TT
9434
 
>
9435
 
                <TT
9436
 
CLASS="PARAMETER"
9437
 
><I
9438
 
>pattern</I
9439
 
></TT
9440
 
>);<P
9441
 
></P
9442
 
></DIV
9443
 
><P
9444
 
></P
9445
 
><DIV
9446
 
CLASS="VARIABLELIST"
9447
 
><DL
9448
 
><DT
9449
 
><TT
9450
 
CLASS="PARAMETER"
9451
 
><I
9452
 
>args</I
9453
 
></TT
9454
 
></DT
9455
 
><DD
9456
 
><P
9457
 
></P
9458
 
></DD
9459
 
><DT
9460
 
><TT
9461
 
CLASS="PARAMETER"
9462
 
><I
9463
 
>pattern</I
9464
 
></TT
9465
 
></DT
9466
 
><DD
9467
 
><P
9468
 
>If you do not specify
9469
 
            <TT
9470
 
CLASS="PARAMETER"
9471
 
><I
9472
 
>pattern</I
9473
 
></TT
9474
 
>,
9475
 
            <TT
9476
 
CLASS="FUNCTION"
9477
 
>Getdirs</TT
9478
 
> assumes a default pattern of
9479
 
            <I
9480
 
CLASS="EMPHASIS"
9481
 
>*</I
9482
 
>. You may use the common shell
9483
 
            wildcard characters in the pattern. If no directories
9484
 
            match the pattern, then a NULL string is
9485
 
            returned</P
9486
 
></DD
9487
 
></DL
9488
 
></DIV
9489
 
></DIV
9490
 
><DIV
9491
 
CLASS="SECT3"
9492
 
><H3
9493
 
CLASS="SECT3"
9494
 
><A
9495
 
NAME="FIND"
9496
 
></A
9497
 
>Find Procedure</H3
9498
 
><P
9499
 
>Search for files whose names match <I
9500
 
CLASS="EMPHASIS"
9501
 
>pattern</I
9502
 
>
9503
 
        (using shell wildcard characters for filename expansion).  Search
9504
 
        subdirectories recursively, starting at
9505
 
        <I
9506
 
CLASS="EMPHASIS"
9507
 
>rootdir</I
9508
 
>. The result is the list of files whose
9509
 
        names match; if no files match, the result is empty.  Filenames in the
9510
 
        result include all intervening subdirectory names. If no files match
9511
 
        the pattern, then a NULL string is returned.</P
9512
 
><DIV
9513
 
CLASS="FUNCSYNOPSIS"
9514
 
><A
9515
 
NAME="AEN4315"
9516
 
></A
9517
 
><P
9518
 
></P
9519
 
><CODE
9520
 
CLASS="FUNCDEF"
9521
 
><TT
9522
 
CLASS="FUNCTION"
9523
 
>find</TT
9524
 
></CODE
9525
 
>(<TT
9526
 
CLASS="PARAMETER"
9527
 
><I
9528
 
>rootdir</I
9529
 
></TT
9530
 
>
9531
 
            <TT
9532
 
CLASS="PARAMETER"
9533
 
><I
9534
 
>pattern</I
9535
 
></TT
9536
 
>);<P
9537
 
></P
9538
 
></DIV
9539
 
><P
9540
 
></P
9541
 
><DIV
9542
 
CLASS="VARIABLELIST"
9543
 
><DL
9544
 
><DT
9545
 
><TT
9546
 
CLASS="PARAMETER"
9547
 
><I
9548
 
>rootdir</I
9549
 
></TT
9550
 
></DT
9551
 
><DD
9552
 
><P
9553
 
>The top level directory to search the search
9554
 
            from.</P
9555
 
></DD
9556
 
><DT
9557
 
><TT
9558
 
CLASS="PARAMETER"
9559
 
><I
9560
 
>pattern</I
9561
 
></TT
9562
 
></DT
9563
 
><DD
9564
 
><P
9565
 
>A csh "glob" style regular expression reprsenting
9566
 
            the files to find.</P
9567
 
></DD
9568
 
></DL
9569
 
></DIV
9570
 
></DIV
9571
 
><DIV
9572
 
CLASS="SECT3"
9573
 
><H3
9574
 
CLASS="SECT3"
9575
 
><A
9576
 
NAME="WHICH"
9577
 
></A
9578
 
>Which Procedure</H3
9579
 
><P
9580
 
>Searches the execution path for an executable file
9581
 
        <I
9582
 
CLASS="EMPHASIS"
9583
 
>binary</I
9584
 
>, like the the BSD <B
9585
 
CLASS="COMMAND"
9586
 
>which</B
9587
 
>
9588
 
        utility.  This procedure uses the shell environment variable
9589
 
        <I
9590
 
CLASS="EMPHASIS"
9591
 
>PATH</I
9592
 
>. It returns <I
9593
 
CLASS="EMPHASIS"
9594
 
>0</I
9595
 
> if the
9596
 
        binary is not in the path, or if there is no <I
9597
 
CLASS="EMPHASIS"
9598
 
>PATH</I
9599
 
>
9600
 
        environment variable. If <B
9601
 
CLASS="COMMAND"
9602
 
>binary</B
9603
 
> is in the path, it
9604
 
        returns the full path to <B
9605
 
CLASS="COMMAND"
9606
 
>binary</B
9607
 
>.</P
9608
 
><DIV
9609
 
CLASS="FUNCSYNOPSIS"
9610
 
><A
9611
 
NAME="AEN4342"
9612
 
></A
9613
 
><P
9614
 
></P
9615
 
><CODE
9616
 
CLASS="FUNCDEF"
9617
 
><TT
9618
 
CLASS="FUNCTION"
9619
 
>which</TT
9620
 
></CODE
9621
 
>(<TT
9622
 
CLASS="PARAMETER"
9623
 
><I
9624
 
>file</I
9625
 
></TT
9626
 
>);<P
9627
 
></P
9628
 
></DIV
9629
 
><P
9630
 
></P
9631
 
><DIV
9632
 
CLASS="VARIABLELIST"
9633
 
><DL
9634
 
><DT
9635
 
><TT
9636
 
CLASS="PARAMETER"
9637
 
><I
9638
 
>binary</I
9639
 
></TT
9640
 
></DT
9641
 
><DD
9642
 
><P
9643
 
>The executable program or shell script to look
9644
 
            for.</P
9645
 
></DD
9646
 
></DL
9647
 
></DIV
9648
 
></DIV
9649
 
><DIV
9650
 
CLASS="SECT3"
9651
 
><H3
9652
 
CLASS="SECT3"
9653
 
><A
9654
 
NAME="GREP"
9655
 
></A
9656
 
>Grep Procedure</H3
9657
 
><P
9658
 
>Search the file called <TT
9659
 
CLASS="FILENAME"
9660
 
>filename</TT
9661
 
> (a fully
9662
 
        specified path) for lines that contain a match for regular expression
9663
 
        <I
9664
 
CLASS="EMPHASIS"
9665
 
>regexp</I
9666
 
>. The result is a list of all the lines that
9667
 
        match.  If no lines match, the result is an empty string.  Specify
9668
 
        <I
9669
 
CLASS="EMPHASIS"
9670
 
>regexp</I
9671
 
> using the standard regular expression style
9672
 
        used by the Unix utility program grep.</P
9673
 
><P
9674
 
>Use the optional third argument <I
9675
 
CLASS="EMPHASIS"
9676
 
>line</I
9677
 
> to
9678
 
        start lines in the result with the line number in
9679
 
        <TT
9680
 
CLASS="FILENAME"
9681
 
>filename</TT
9682
 
>.  (This argument is simply an option
9683
 
        flag; type it just as shown <TT
9684
 
CLASS="OPTION"
9685
 
>--line</TT
9686
 
>.)</P
9687
 
><DIV
9688
 
CLASS="FUNCSYNOPSIS"
9689
 
><A
9690
 
NAME="AEN4363"
9691
 
></A
9692
 
><P
9693
 
></P
9694
 
><CODE
9695
 
CLASS="FUNCDEF"
9696
 
><TT
9697
 
CLASS="FUNCTION"
9698
 
>grep</TT
9699
 
></CODE
9700
 
>(<TT
9701
 
CLASS="PARAMETER"
9702
 
><I
9703
 
>filename</I
9704
 
></TT
9705
 
>
9706
 
            <TT
9707
 
CLASS="PARAMETER"
9708
 
><I
9709
 
>regexp</I
9710
 
></TT
9711
 
>
9712
 
            <TT
9713
 
CLASS="PARAMETER"
9714
 
><I
9715
 
>--line</I
9716
 
></TT
9717
 
>);<P
9718
 
></P
9719
 
></DIV
9720
 
><P
9721
 
></P
9722
 
><DIV
9723
 
CLASS="VARIABLELIST"
9724
 
><DL
9725
 
><DT
9726
 
><TT
9727
 
CLASS="PARAMETER"
9728
 
><I
9729
 
>filename</I
9730
 
></TT
9731
 
></DT
9732
 
><DD
9733
 
><P
9734
 
>The file to search.</P
9735
 
></DD
9736
 
><DT
9737
 
><TT
9738
 
CLASS="PARAMETER"
9739
 
><I
9740
 
>regexp</I
9741
 
></TT
9742
 
></DT
9743
 
><DD
9744
 
><P
9745
 
>The Unix style regular expression (as used by the
9746
 
            <B
9747
 
CLASS="COMMAND"
9748
 
>grep</B
9749
 
> Unix utility) to search
9750
 
            for.</P
9751
 
></DD
9752
 
><DT
9753
 
><TT
9754
 
CLASS="PARAMETER"
9755
 
><I
9756
 
>--line</I
9757
 
></TT
9758
 
></DT
9759
 
><DD
9760
 
><P
9761
 
>Prefix the line number to each line where the
9762
 
            regexp matches.</P
9763
 
></DD
9764
 
></DL
9765
 
></DIV
9766
 
></DIV
9767
 
><DIV
9768
 
CLASS="SECT3"
9769
 
><H3
9770
 
CLASS="SECT3"
9771
 
><A
9772
 
NAME="PRUNE"
9773
 
></A
9774
 
>Prune Procedure</H3
9775
 
><P
9776
 
>Remove elements of the Tcl list <I
9777
 
CLASS="EMPHASIS"
9778
 
>list</I
9779
 
>.
9780
 
          Elements are fields delimited by spaces.  The result is a copy of
9781
 
          list, without any elements that match <I
9782
 
CLASS="EMPHASIS"
9783
 
>pattern</I
9784
 
>.
9785
 
          You can use the common shell wildcard characters to specify the
9786
 
          pattern.</P
9787
 
><DIV
9788
 
CLASS="FUNCSYNOPSIS"
9789
 
><A
9790
 
NAME="AEN4392"
9791
 
></A
9792
 
><P
9793
 
></P
9794
 
><CODE
9795
 
CLASS="FUNCDEF"
9796
 
><TT
9797
 
CLASS="FUNCTION"
9798
 
>prune</TT
9799
 
></CODE
9800
 
>(<TT
9801
 
CLASS="PARAMETER"
9802
 
><I
9803
 
>list</I
9804
 
></TT
9805
 
>
9806
 
            <TT
9807
 
CLASS="PARAMETER"
9808
 
><I
9809
 
>pattern</I
9810
 
></TT
9811
 
>);<P
9812
 
></P
9813
 
></DIV
9814
 
><P
9815
 
></P
9816
 
><DIV
9817
 
CLASS="VARIABLELIST"
9818
 
><DL
9819
 
><DT
9820
 
><TT
9821
 
CLASS="PARAMETER"
9822
 
><I
9823
 
>list</I
9824
 
></TT
9825
 
></DT
9826
 
><DD
9827
 
><P
9828
 
>A Tcl list containing the original data. Commonly
9829
 
            this is the output of a batch executed command, like running a
9830
 
            compiler.</P
9831
 
></DD
9832
 
><DT
9833
 
><TT
9834
 
CLASS="PARAMETER"
9835
 
><I
9836
 
>pattern</I
9837
 
></TT
9838
 
></DT
9839
 
><DD
9840
 
><P
9841
 
>The csh shell "glob" style pattern to search
9842
 
            for.</P
9843
 
></DD
9844
 
></DL
9845
 
></DIV
9846
 
></DIV
9847
 
><DIV
9848
 
CLASS="SECT3"
9849
 
><H3
9850
 
CLASS="SECT3"
9851
 
><A
9852
 
NAME="SLAY"
9853
 
></A
9854
 
>Slay Procedure</H3
9855
 
><P
9856
 
>This look in the process table for <I
9857
 
CLASS="EMPHASIS"
9858
 
>name</I
9859
 
>
9860
 
          and send it a unix SIGINT, killing the process. This will only work
9861
 
          under Windows if you have Cygwin or another Unix subsystem for Windows
9862
 
          installed.</P
9863
 
><DIV
9864
 
CLASS="FUNCSYNOPSIS"
9865
 
><A
9866
 
NAME="AEN4413"
9867
 
></A
9868
 
><P
9869
 
></P
9870
 
><CODE
9871
 
CLASS="FUNCDEF"
9872
 
><TT
9873
 
CLASS="FUNCTION"
9874
 
>slay</TT
9875
 
></CODE
9876
 
>(<TT
9877
 
CLASS="PARAMETER"
9878
 
><I
9879
 
>name</I
9880
 
></TT
9881
 
>);<P
9882
 
></P
9883
 
></DIV
9884
 
><P
9885
 
></P
9886
 
><DIV
9887
 
CLASS="VARIABLELIST"
9888
 
><DL
9889
 
><DT
9890
 
><TT
9891
 
CLASS="PARAMETER"
9892
 
><I
9893
 
>name</I
9894
 
></TT
9895
 
></DT
9896
 
><DD
9897
 
><P
9898
 
>The name of the program to kill.</P
9899
 
></DD
9900
 
></DL
9901
 
></DIV
9902
 
></DIV
9903
 
><DIV
9904
 
CLASS="SECT3"
9905
 
><H3
9906
 
CLASS="SECT3"
9907
 
><A
9908
 
NAME="ABSOLUTE"
9909
 
></A
9910
 
>Absolute Procedure</H3
9911
 
><P
9912
 
>This procedure takes the relative <I
9913
 
CLASS="EMPHASIS"
9914
 
>path</I
9915
 
>,
9916
 
          and converts it to an absolute path.</P
9917
 
><DIV
9918
 
CLASS="FUNCSYNOPSIS"
9919
 
><A
9920
 
NAME="AEN4428"
9921
 
></A
9922
 
><P
9923
 
></P
9924
 
><CODE
9925
 
CLASS="FUNCDEF"
9926
 
><TT
9927
 
CLASS="FUNCTION"
9928
 
>absolute</TT
9929
 
></CODE
9930
 
>(<TT
9931
 
CLASS="PARAMETER"
9932
 
><I
9933
 
>path</I
9934
 
></TT
9935
 
>);<P
9936
 
></P
9937
 
></DIV
9938
 
><P
9939
 
></P
9940
 
><DIV
9941
 
CLASS="VARIABLELIST"
9942
 
><DL
9943
 
><DT
9944
 
><TT
9945
 
CLASS="PARAMETER"
9946
 
><I
9947
 
>path</I
9948
 
></TT
9949
 
></DT
9950
 
><DD
9951
 
><P
9952
 
>The path to convert.</P
9953
 
></DD
9954
 
></DL
9955
 
></DIV
9956
 
></DIV
9957
 
><DIV
9958
 
CLASS="SECT3"
9959
 
><H3
9960
 
CLASS="SECT3"
9961
 
><A
9962
 
NAME="PSOURCE"
9963
 
></A
9964
 
>Psource Procedure</H3
9965
 
><P
9966
 
>This sources the file <I
9967
 
CLASS="EMPHASIS"
9968
 
>filename</I
9969
 
>, and traps
9970
 
          all errors. It also ignores all extraneous output. If there was an
9971
 
          error it returns a <I
9972
 
CLASS="EMPHASIS"
9973
 
>1</I
9974
 
>, otherwise it returns a
9975
 
          <I
9976
 
CLASS="EMPHASIS"
9977
 
>0</I
9978
 
>.</P
9979
 
><DIV
9980
 
CLASS="FUNCSYNOPSIS"
9981
 
><A
9982
 
NAME="AEN4445"
9983
 
></A
9984
 
><P
9985
 
></P
9986
 
><CODE
9987
 
CLASS="FUNCDEF"
9988
 
><TT
9989
 
CLASS="FUNCTION"
9990
 
>psource</TT
9991
 
></CODE
9992
 
>(<TT
9993
 
CLASS="PARAMETER"
9994
 
><I
9995
 
>file</I
9996
 
></TT
9997
 
>);<P
9998
 
></P
9999
 
></DIV
10000
 
><P
10001
 
></P
10002
 
><DIV
10003
 
CLASS="VARIABLELIST"
10004
 
><DL
10005
 
><DT
10006
 
><TT
10007
 
CLASS="PARAMETER"
10008
 
><I
10009
 
>filename</I
10010
 
></TT
10011
 
></DT
10012
 
><DD
10013
 
><P
10014
 
>The filename to Tcl script to
10015
 
            source.</P
10016
 
></DD
10017
 
></DL
10018
 
></DIV
10019
 
></DIV
10020
 
><DIV
10021
 
CLASS="SECT3"
10022
 
><H3
10023
 
CLASS="SECT3"
10024
 
><A
10025
 
NAME="RUNTESTFILEP"
10026
 
></A
10027
 
>Runtest_file_p Procedure</H3
10028
 
><P
10029
 
>Search <I
10030
 
CLASS="EMPHASIS"
10031
 
>runtest</I
10032
 
>s for
10033
 
          <I
10034
 
CLASS="EMPHASIS"
10035
 
>testcase</I
10036
 
> and return <I
10037
 
CLASS="EMPHASIS"
10038
 
>1</I
10039
 
> if
10040
 
          found, <I
10041
 
CLASS="EMPHASIS"
10042
 
>0</I
10043
 
> if not. <I
10044
 
CLASS="EMPHASIS"
10045
 
>runtests</I
10046
 
>
10047
 
          is a list of two elements.  The first is a copy of what was on
10048
 
          the right side of the <I
10049
 
CLASS="EMPHASIS"
10050
 
>=</I
10051
 
> if    
10052
 
          <TABLE
10053
 
BORDER="0"
10054
 
BGCOLOR="#E0E0E0"
10055
 
WIDTH="100%"
10056
 
><TR
10057
 
><TD
10058
 
><PRE
10059
 
CLASS="PROGRAMLISTING"
10060
 
>foo.exp="..."</PRE
10061
 
></TD
10062
 
></TR
10063
 
></TABLE
10064
 
>" was specified, or
10065
 
          an empty string if no such argument is present. The second is the
10066
 
          pathname of the current testcase under consideration. This is used
10067
 
          by tools like compilers where each testcase is a file.</P
10068
 
><DIV
10069
 
CLASS="FUNCSYNOPSIS"
10070
 
><A
10071
 
NAME="AEN4466"
10072
 
></A
10073
 
><P
10074
 
></P
10075
 
><CODE
10076
 
CLASS="FUNCDEF"
10077
 
><TT
10078
 
CLASS="FUNCTION"
10079
 
>runtest_file_p</TT
10080
 
></CODE
10081
 
>(<TT
10082
 
CLASS="PARAMETER"
10083
 
><I
10084
 
>runtests</I
10085
 
></TT
10086
 
>
10087
 
            <TT
10088
 
CLASS="PARAMETER"
10089
 
><I
10090
 
>testcase</I
10091
 
></TT
10092
 
>);<P
10093
 
></P
10094
 
></DIV
10095
 
><P
10096
 
></P
10097
 
><DIV
10098
 
CLASS="VARIABLELIST"
10099
 
><DL
10100
 
><DT
10101
 
><TT
10102
 
CLASS="PARAMETER"
10103
 
><I
10104
 
>runtests</I
10105
 
></TT
10106
 
></DT
10107
 
><DD
10108
 
><P
10109
 
>The list of patterns to compare against.
10110
 
              </P
10111
 
></DD
10112
 
><DT
10113
 
><TT
10114
 
CLASS="PARAMETER"
10115
 
><I
10116
 
>testcase</I
10117
 
></TT
10118
 
></DT
10119
 
><DD
10120
 
><P
10121
 
>The test case filename.</P
10122
 
></DD
10123
 
></DL
10124
 
></DIV
10125
 
></DIV
10126
 
><DIV
10127
 
CLASS="SECT3"
10128
 
><H3
10129
 
CLASS="SECT3"
10130
 
><A
10131
 
NAME="DIFF"
10132
 
></A
10133
 
>Diff Procedure</H3
10134
 
><P
10135
 
>Compares the two files and returns a <I
10136
 
CLASS="EMPHASIS"
10137
 
>1</I
10138
 
> if
10139
 
          they match, or a <I
10140
 
CLASS="EMPHASIS"
10141
 
>0</I
10142
 
> if they don't. If
10143
 
          <SPAN
10144
 
CLASS="SYMBOL"
10145
 
>verbose</SPAN
10146
 
> is set, then it'll print the differences to
10147
 
          the screen.</P
10148
 
><DIV
10149
 
CLASS="FUNCSYNOPSIS"
10150
 
><A
10151
 
NAME="AEN4489"
10152
 
></A
10153
 
><P
10154
 
></P
10155
 
><CODE
10156
 
CLASS="FUNCDEF"
10157
 
><TT
10158
 
CLASS="FUNCTION"
10159
 
>diff</TT
10160
 
></CODE
10161
 
>(<TT
10162
 
CLASS="PARAMETER"
10163
 
><I
10164
 
>file_1</I
10165
 
></TT
10166
 
>
10167
 
            <TT
10168
 
CLASS="PARAMETER"
10169
 
><I
10170
 
>file_2</I
10171
 
></TT
10172
 
>);<P
10173
 
></P
10174
 
></DIV
10175
 
><P
10176
 
></P
10177
 
><DIV
10178
 
CLASS="VARIABLELIST"
10179
 
><DL
10180
 
><DT
10181
 
><TT
10182
 
CLASS="PARAMETER"
10183
 
><I
10184
 
>file_1</I
10185
 
></TT
10186
 
></DT
10187
 
><DD
10188
 
><P
10189
 
>The first file to compare.</P
10190
 
></DD
10191
 
><DT
10192
 
><TT
10193
 
CLASS="PARAMETER"
10194
 
><I
10195
 
>file_2</I
10196
 
></TT
10197
 
></DT
10198
 
><DD
10199
 
><P
10200
 
>The second file to compare.</P
10201
 
></DD
10202
 
></DL
10203
 
></DIV
10204
 
></DIV
10205
 
><DIV
10206
 
CLASS="SECT3"
10207
 
><H3
10208
 
CLASS="SECT3"
10209
 
><A
10210
 
NAME="SETENV"
10211
 
></A
10212
 
>Setenv Procedure</H3
10213
 
><P
10214
 
>Sets the environment variable <I
10215
 
CLASS="EMPHASIS"
10216
 
>var</I
10217
 
> to the
10218
 
          value <I
10219
 
CLASS="EMPHASIS"
10220
 
>val</I
10221
 
>.</P
10222
 
><DIV
10223
 
CLASS="FUNCSYNOPSIS"
10224
 
><A
10225
 
NAME="AEN4511"
10226
 
></A
10227
 
><P
10228
 
></P
10229
 
><CODE
10230
 
CLASS="FUNCDEF"
10231
 
><TT
10232
 
CLASS="FUNCTION"
10233
 
>setenv</TT
10234
 
></CODE
10235
 
>(<TT
10236
 
CLASS="PARAMETER"
10237
 
><I
10238
 
>var</I
10239
 
></TT
10240
 
>
10241
 
            <TT
10242
 
CLASS="PARAMETER"
10243
 
><I
10244
 
>val</I
10245
 
></TT
10246
 
>);<P
10247
 
></P
10248
 
></DIV
10249
 
><P
10250
 
></P
10251
 
><DIV
10252
 
CLASS="VARIABLELIST"
10253
 
><DL
10254
 
><DT
10255
 
><TT
10256
 
CLASS="PARAMETER"
10257
 
><I
10258
 
>var</I
10259
 
></TT
10260
 
></DT
10261
 
><DD
10262
 
><P
10263
 
>The environment variable to set.</P
10264
 
></DD
10265
 
><DT
10266
 
><TT
10267
 
CLASS="PARAMETER"
10268
 
><I
10269
 
>val</I
10270
 
></TT
10271
 
></DT
10272
 
><DD
10273
 
><P
10274
 
>The value to set the variable to.</P
10275
 
></DD
10276
 
></DL
10277
 
></DIV
10278
 
></DIV
10279
 
><DIV
10280
 
CLASS="SECT3"
10281
 
><H3
10282
 
CLASS="SECT3"
10283
 
><A
10284
 
NAME="UNSETENV"
10285
 
></A
10286
 
>unsetenv Procedure</H3
10287
 
><P
10288
 
>Unsets the environment variable
10289
 
          <I
10290
 
CLASS="EMPHASIS"
10291
 
>var</I
10292
 
>.</P
10293
 
><DIV
10294
 
CLASS="FUNCSYNOPSIS"
10295
 
><A
10296
 
NAME="AEN4532"
10297
 
></A
10298
 
><P
10299
 
></P
10300
 
><CODE
10301
 
CLASS="FUNCDEF"
10302
 
><TT
10303
 
CLASS="FUNCTION"
10304
 
>unsetenv</TT
10305
 
></CODE
10306
 
>(<TT
10307
 
CLASS="PARAMETER"
10308
 
><I
10309
 
>var</I
10310
 
></TT
10311
 
>);<P
10312
 
></P
10313
 
></DIV
10314
 
><P
10315
 
></P
10316
 
><DIV
10317
 
CLASS="VARIABLELIST"
10318
 
><DL
10319
 
><DT
10320
 
><TT
10321
 
CLASS="PARAMETER"
10322
 
><I
10323
 
>var</I
10324
 
></TT
10325
 
></DT
10326
 
><DD
10327
 
><P
10328
 
>The environment variable to
10329
 
            unset.</P
10330
 
></DD
10331
 
></DL
10332
 
></DIV
10333
 
></DIV
10334
 
><DIV
10335
 
CLASS="SECT3"
10336
 
><H3
10337
 
CLASS="SECT3"
10338
 
><A
10339
 
NAME="GETENV"
10340
 
></A
10341
 
>Getenv Procedure</H3
10342
 
><P
10343
 
>Returns the value of <I
10344
 
CLASS="EMPHASIS"
10345
 
>var</I
10346
 
> in the
10347
 
          environment if it exists, otherwise it returns NULL.</P
10348
 
><DIV
10349
 
CLASS="FUNCSYNOPSIS"
10350
 
><A
10351
 
NAME="AEN4547"
10352
 
></A
10353
 
><P
10354
 
></P
10355
 
><CODE
10356
 
CLASS="FUNCDEF"
10357
 
><TT
10358
 
CLASS="FUNCTION"
10359
 
>getenv</TT
10360
 
></CODE
10361
 
>(<TT
10362
 
CLASS="PARAMETER"
10363
 
><I
10364
 
>var</I
10365
 
></TT
10366
 
>);<P
10367
 
></P
10368
 
></DIV
10369
 
><P
10370
 
></P
10371
 
><DIV
10372
 
CLASS="VARIABLELIST"
10373
 
><DL
10374
 
><DT
10375
 
><TT
10376
 
CLASS="PARAMETER"
10377
 
><I
10378
 
>var</I
10379
 
></TT
10380
 
></DT
10381
 
><DD
10382
 
><P
10383
 
>The environment variable to get the value
10384
 
            of.</P
10385
 
></DD
10386
 
></DL
10387
 
></DIV
10388
 
></DIV
10389
 
><DIV
10390
 
CLASS="SECT3"
10391
 
><H3
10392
 
CLASS="SECT3"
10393
 
><A
10394
 
NAME="PRUNESYSTEMCRUD"
10395
 
></A
10396
 
>Prune_system_crud Procedure</H3
10397
 
><P
10398
 
>For system <I
10399
 
CLASS="EMPHASIS"
10400
 
>system</I
10401
 
>, delete text the host or
10402
 
          target operating system might issue that will interfere with pattern
10403
 
          matching of program output in <I
10404
 
CLASS="EMPHASIS"
10405
 
>text</I
10406
 
>.  An example
10407
 
          is the message that is printed if a shared library is out of
10408
 
          date.</P
10409
 
><DIV
10410
 
CLASS="FUNCSYNOPSIS"
10411
 
><A
10412
 
NAME="AEN4563"
10413
 
></A
10414
 
><P
10415
 
></P
10416
 
><CODE
10417
 
CLASS="FUNCDEF"
10418
 
><TT
10419
 
CLASS="FUNCTION"
10420
 
>prune_system_crud</TT
10421
 
></CODE
10422
 
>(<TT
10423
 
CLASS="PARAMETER"
10424
 
><I
10425
 
>system</I
10426
 
></TT
10427
 
>
10428
 
            <TT
10429
 
CLASS="PARAMETER"
10430
 
><I
10431
 
>test</I
10432
 
></TT
10433
 
>);<P
10434
 
></P
10435
 
></DIV
10436
 
><P
10437
 
></P
10438
 
><DIV
10439
 
CLASS="VARIABLELIST"
10440
 
><DL
10441
 
><DT
10442
 
><TT
10443
 
CLASS="PARAMETER"
10444
 
><I
10445
 
>system</I
10446
 
></TT
10447
 
></DT
10448
 
><DD
10449
 
><P
10450
 
>The system error messages to look for to screen out
10451
 
           .</P
10452
 
></DD
10453
 
><DT
10454
 
><TT
10455
 
CLASS="PARAMETER"
10456
 
><I
10457
 
>text</I
10458
 
></TT
10459
 
></DT
10460
 
><DD
10461
 
><P
10462
 
>The Tcl variable containing the
10463
 
            text.</P
10464
 
></DD
10465
 
></DL
10466
 
></DIV
10467
 
></DIV
10468
 
></DIV
10469
 
><DIV
10470
 
CLASS="SECT2"
10471
 
><H2
10472
 
CLASS="SECT2"
10473
 
><A
10474
 
NAME="LIBGLOSS"
10475
 
></A
10476
 
>Libgloss, A Free BSP</H2
10477
 
><P
10478
 
>Libgloss is a free <I
10479
 
CLASS="FIRSTTERM"
10480
 
>BSP</I
10481
 
> (Board Support
10482
 
      Package) commonly used with GCC and G++ to produce a fully linked
10483
 
      executable image for an embedded systems.</P
10484
 
><DIV
10485
 
CLASS="SECT3"
10486
 
><H3
10487
 
CLASS="SECT3"
10488
 
><A
10489
 
NAME="LIBGLOSSLINKFLAGS"
10490
 
></A
10491
 
>Libgloss_link_flags Procedure</H3
10492
 
><P
10493
 
></P
10494
 
><DIV
10495
 
CLASS="FUNCSYNOPSIS"
10496
 
><A
10497
 
NAME="AEN4587"
10498
 
></A
10499
 
><P
10500
 
></P
10501
 
><CODE
10502
 
CLASS="FUNCDEF"
10503
 
><TT
10504
 
CLASS="FUNCTION"
10505
 
>libgloss_link_flags</TT
10506
 
></CODE
10507
 
>(<TT
10508
 
CLASS="PARAMETER"
10509
 
><I
10510
 
>args</I
10511
 
></TT
10512
 
>);<P
10513
 
></P
10514
 
></DIV
10515
 
><P
10516
 
></P
10517
 
><DIV
10518
 
CLASS="VARIABLELIST"
10519
 
><DL
10520
 
><DT
10521
 
><TT
10522
 
CLASS="PARAMETER"
10523
 
><I
10524
 
>args</I
10525
 
></TT
10526
 
></DT
10527
 
><DD
10528
 
><P
10529
 
></P
10530
 
></DD
10531
 
></DL
10532
 
></DIV
10533
 
></DIV
10534
 
><DIV
10535
 
CLASS="SECT3"
10536
 
><H3
10537
 
CLASS="SECT3"
10538
 
><A
10539
 
NAME="LIBGLOSSINCLUDEFLAGS"
10540
 
></A
10541
 
>Libgloss_include_flags Procedure</H3
10542
 
><P
10543
 
></P
10544
 
><DIV
10545
 
CLASS="FUNCSYNOPSIS"
10546
 
><A
10547
 
NAME="AEN4601"
10548
 
></A
10549
 
><P
10550
 
></P
10551
 
><CODE
10552
 
CLASS="FUNCDEF"
10553
 
><TT
10554
 
CLASS="FUNCTION"
10555
 
>libgloss_include_flags</TT
10556
 
></CODE
10557
 
>(<TT
10558
 
CLASS="PARAMETER"
10559
 
><I
10560
 
>args</I
10561
 
></TT
10562
 
>);<P
10563
 
></P
10564
 
></DIV
10565
 
><P
10566
 
></P
10567
 
><DIV
10568
 
CLASS="VARIABLELIST"
10569
 
><DL
10570
 
><DT
10571
 
><TT
10572
 
CLASS="PARAMETER"
10573
 
><I
10574
 
>args</I
10575
 
></TT
10576
 
></DT
10577
 
><DD
10578
 
><P
10579
 
></P
10580
 
></DD
10581
 
></DL
10582
 
></DIV
10583
 
></DIV
10584
 
><DIV
10585
 
CLASS="SECT3"
10586
 
><H3
10587
 
CLASS="SECT3"
10588
 
><A
10589
 
NAME="NEWLIBLINKFLAGS"
10590
 
></A
10591
 
>Newlib_link_flags Procedure</H3
10592
 
><P
10593
 
></P
10594
 
><DIV
10595
 
CLASS="FUNCSYNOPSIS"
10596
 
><A
10597
 
NAME="AEN4615"
10598
 
></A
10599
 
><P
10600
 
></P
10601
 
><CODE
10602
 
CLASS="FUNCDEF"
10603
 
><TT
10604
 
CLASS="FUNCTION"
10605
 
>newlib_link_flags</TT
10606
 
></CODE
10607
 
>(<TT
10608
 
CLASS="PARAMETER"
10609
 
><I
10610
 
>args</I
10611
 
></TT
10612
 
>);<P
10613
 
></P
10614
 
></DIV
10615
 
><P
10616
 
></P
10617
 
><DIV
10618
 
CLASS="VARIABLELIST"
10619
 
><DL
10620
 
><DT
10621
 
><TT
10622
 
CLASS="PARAMETER"
10623
 
><I
10624
 
>args</I
10625
 
></TT
10626
 
></DT
10627
 
><DD
10628
 
><P
10629
 
></P
10630
 
></DD
10631
 
></DL
10632
 
></DIV
10633
 
></DIV
10634
 
><DIV
10635
 
CLASS="SECT3"
10636
 
><H3
10637
 
CLASS="SECT3"
10638
 
><A
10639
 
NAME="NEWLIBINCLUDEFLAGS"
10640
 
></A
10641
 
>Newlib_include_flags Procedure</H3
10642
 
><P
10643
 
></P
10644
 
><DIV
10645
 
CLASS="FUNCSYNOPSIS"
10646
 
><A
10647
 
NAME="AEN4629"
10648
 
></A
10649
 
><P
10650
 
></P
10651
 
><CODE
10652
 
CLASS="FUNCDEF"
10653
 
><TT
10654
 
CLASS="FUNCTION"
10655
 
>newlib_include_flags</TT
10656
 
></CODE
10657
 
>(<TT
10658
 
CLASS="PARAMETER"
10659
 
><I
10660
 
>args</I
10661
 
></TT
10662
 
>);<P
10663
 
></P
10664
 
></DIV
10665
 
><P
10666
 
></P
10667
 
><DIV
10668
 
CLASS="VARIABLELIST"
10669
 
><DL
10670
 
><DT
10671
 
><TT
10672
 
CLASS="PARAMETER"
10673
 
><I
10674
 
>args</I
10675
 
></TT
10676
 
></DT
10677
 
><DD
10678
 
><P
10679
 
></P
10680
 
></DD
10681
 
></DL
10682
 
></DIV
10683
 
></DIV
10684
 
><DIV
10685
 
CLASS="SECT3"
10686
 
><H3
10687
 
CLASS="SECT3"
10688
 
><A
10689
 
NAME="LIBIOINCLUDEFLAGS"
10690
 
></A
10691
 
>Libio_include_flags Procedure</H3
10692
 
><P
10693
 
></P
10694
 
><DIV
10695
 
CLASS="FUNCSYNOPSIS"
10696
 
><A
10697
 
NAME="AEN4643"
10698
 
></A
10699
 
><P
10700
 
></P
10701
 
><CODE
10702
 
CLASS="FUNCDEF"
10703
 
><TT
10704
 
CLASS="FUNCTION"
10705
 
>libio_include_flags</TT
10706
 
></CODE
10707
 
>(<TT
10708
 
CLASS="PARAMETER"
10709
 
><I
10710
 
>args</I
10711
 
></TT
10712
 
>);<P
10713
 
></P
10714
 
></DIV
10715
 
><P
10716
 
></P
10717
 
><DIV
10718
 
CLASS="VARIABLELIST"
10719
 
><DL
10720
 
><DT
10721
 
><TT
10722
 
CLASS="PARAMETER"
10723
 
><I
10724
 
>args</I
10725
 
></TT
10726
 
></DT
10727
 
><DD
10728
 
><P
10729
 
></P
10730
 
></DD
10731
 
></DL
10732
 
></DIV
10733
 
></DIV
10734
 
><DIV
10735
 
CLASS="SECT3"
10736
 
><H3
10737
 
CLASS="SECT3"
10738
 
><A
10739
 
NAME="LIBIOLINKFLAGS"
10740
 
></A
10741
 
>Libio_link_flags Procedure</H3
10742
 
><P
10743
 
></P
10744
 
><DIV
10745
 
CLASS="FUNCSYNOPSIS"
10746
 
><A
10747
 
NAME="AEN4657"
10748
 
></A
10749
 
><P
10750
 
></P
10751
 
><CODE
10752
 
CLASS="FUNCDEF"
10753
 
><TT
10754
 
CLASS="FUNCTION"
10755
 
>libio_link_flags</TT
10756
 
></CODE
10757
 
>(<TT
10758
 
CLASS="PARAMETER"
10759
 
><I
10760
 
>args</I
10761
 
></TT
10762
 
>);<P
10763
 
></P
10764
 
></DIV
10765
 
><P
10766
 
></P
10767
 
><DIV
10768
 
CLASS="VARIABLELIST"
10769
 
><DL
10770
 
><DT
10771
 
><TT
10772
 
CLASS="PARAMETER"
10773
 
><I
10774
 
>args</I
10775
 
></TT
10776
 
></DT
10777
 
><DD
10778
 
><P
10779
 
></P
10780
 
></DD
10781
 
></DL
10782
 
></DIV
10783
 
></DIV
10784
 
><DIV
10785
 
CLASS="SECT3"
10786
 
><H3
10787
 
CLASS="SECT3"
10788
 
><A
10789
 
NAME="GXXINCLUDEFLAGS"
10790
 
></A
10791
 
>G++_include_flags Procedure</H3
10792
 
><P
10793
 
></P
10794
 
><DIV
10795
 
CLASS="FUNCSYNOPSIS"
10796
 
><A
10797
 
NAME="AEN4671"
10798
 
></A
10799
 
><P
10800
 
></P
10801
 
><CODE
10802
 
CLASS="FUNCDEF"
10803
 
><TT
10804
 
CLASS="FUNCTION"
10805
 
>g++_include_flags</TT
10806
 
></CODE
10807
 
>(<TT
10808
 
CLASS="PARAMETER"
10809
 
><I
10810
 
>args</I
10811
 
></TT
10812
 
>);<P
10813
 
></P
10814
 
></DIV
10815
 
><P
10816
 
></P
10817
 
><DIV
10818
 
CLASS="VARIABLELIST"
10819
 
><DL
10820
 
><DT
10821
 
><TT
10822
 
CLASS="PARAMETER"
10823
 
><I
10824
 
>args</I
10825
 
></TT
10826
 
></DT
10827
 
><DD
10828
 
><P
10829
 
></P
10830
 
></DD
10831
 
></DL
10832
 
></DIV
10833
 
></DIV
10834
 
><DIV
10835
 
CLASS="SECT3"
10836
 
><H3
10837
 
CLASS="SECT3"
10838
 
><A
10839
 
NAME="GXXLINKFLAGS"
10840
 
></A
10841
 
>G++_link_flags Procedure</H3
10842
 
><P
10843
 
></P
10844
 
><DIV
10845
 
CLASS="FUNCSYNOPSIS"
10846
 
><A
10847
 
NAME="AEN4685"
10848
 
></A
10849
 
><P
10850
 
></P
10851
 
><CODE
10852
 
CLASS="FUNCDEF"
10853
 
><TT
10854
 
CLASS="FUNCTION"
10855
 
>g++_link_flags</TT
10856
 
></CODE
10857
 
>(<TT
10858
 
CLASS="PARAMETER"
10859
 
><I
10860
 
>args</I
10861
 
></TT
10862
 
>);<P
10863
 
></P
10864
 
></DIV
10865
 
><P
10866
 
></P
10867
 
><DIV
10868
 
CLASS="VARIABLELIST"
10869
 
><DL
10870
 
><DT
10871
 
><TT
10872
 
CLASS="PARAMETER"
10873
 
><I
10874
 
>args</I
10875
 
></TT
10876
 
></DT
10877
 
><DD
10878
 
><P
10879
 
></P
10880
 
></DD
10881
 
></DL
10882
 
></DIV
10883
 
></DIV
10884
 
><DIV
10885
 
CLASS="SECT3"
10886
 
><H3
10887
 
CLASS="SECT3"
10888
 
><A
10889
 
NAME="LIBSTDCXXINCLUDEFLAGS"
10890
 
></A
10891
 
>Libstdc++_include_flags Procedure</H3
10892
 
><P
10893
 
></P
10894
 
><DIV
10895
 
CLASS="FUNCSYNOPSIS"
10896
 
><A
10897
 
NAME="AEN4699"
10898
 
></A
10899
 
><P
10900
 
></P
10901
 
><CODE
10902
 
CLASS="FUNCDEF"
10903
 
><TT
10904
 
CLASS="FUNCTION"
10905
 
>libstdc++_include_flags</TT
10906
 
></CODE
10907
 
>(<TT
10908
 
CLASS="PARAMETER"
10909
 
><I
10910
 
>args</I
10911
 
></TT
10912
 
>);<P
10913
 
></P
10914
 
></DIV
10915
 
><P
10916
 
></P
10917
 
><DIV
10918
 
CLASS="VARIABLELIST"
10919
 
><DL
10920
 
><DT
10921
 
><TT
10922
 
CLASS="PARAMETER"
10923
 
><I
10924
 
>args</I
10925
 
></TT
10926
 
></DT
10927
 
><DD
10928
 
><P
10929
 
></P
10930
 
></DD
10931
 
></DL
10932
 
></DIV
10933
 
></DIV
10934
 
><DIV
10935
 
CLASS="SECT3"
10936
 
><H3
10937
 
CLASS="SECT3"
10938
 
><A
10939
 
NAME="LIBSTDCXXLINKFLAGS"
10940
 
></A
10941
 
>Libstdc++_link_flags Procedure</H3
10942
 
><P
10943
 
></P
10944
 
><DIV
10945
 
CLASS="FUNCSYNOPSIS"
10946
 
><A
10947
 
NAME="AEN4713"
10948
 
></A
10949
 
><P
10950
 
></P
10951
 
><CODE
10952
 
CLASS="FUNCDEF"
10953
 
><TT
10954
 
CLASS="FUNCTION"
10955
 
>libstdc++_link_flags</TT
10956
 
></CODE
10957
 
>(<TT
10958
 
CLASS="PARAMETER"
10959
 
><I
10960
 
>args</I
10961
 
></TT
10962
 
>);<P
10963
 
></P
10964
 
></DIV
10965
 
><P
10966
 
></P
10967
 
><DIV
10968
 
CLASS="VARIABLELIST"
10969
 
><DL
10970
 
><DT
10971
 
><TT
10972
 
CLASS="PARAMETER"
10973
 
><I
10974
 
>args</I
10975
 
></TT
10976
 
></DT
10977
 
><DD
10978
 
><P
10979
 
></P
10980
 
></DD
10981
 
></DL
10982
 
></DIV
10983
 
></DIV
10984
 
><DIV
10985
 
CLASS="SECT3"
10986
 
><H3
10987
 
CLASS="SECT3"
10988
 
><A
10989
 
NAME="GETMULTILIBS"
10990
 
></A
10991
 
>Get_multilibs Procedure</H3
10992
 
><P
10993
 
></P
10994
 
><DIV
10995
 
CLASS="FUNCSYNOPSIS"
10996
 
><A
10997
 
NAME="AEN4727"
10998
 
></A
10999
 
><P
11000
 
></P
11001
 
><CODE
11002
 
CLASS="FUNCDEF"
11003
 
><TT
11004
 
CLASS="FUNCTION"
11005
 
>get_multilibs</TT
11006
 
></CODE
11007
 
>(<TT
11008
 
CLASS="PARAMETER"
11009
 
><I
11010
 
>args</I
11011
 
></TT
11012
 
>);<P
11013
 
></P
11014
 
></DIV
11015
 
><P
11016
 
></P
11017
 
><DIV
11018
 
CLASS="VARIABLELIST"
11019
 
><DL
11020
 
><DT
11021
 
><TT
11022
 
CLASS="PARAMETER"
11023
 
><I
11024
 
>args</I
11025
 
></TT
11026
 
></DT
11027
 
><DD
11028
 
><P
11029
 
></P
11030
 
></DD
11031
 
></DL
11032
 
></DIV
11033
 
></DIV
11034
 
><DIV
11035
 
CLASS="SECT3"
11036
 
><H3
11037
 
CLASS="SECT3"
11038
 
><A
11039
 
NAME="FINDBINUTILSPROG"
11040
 
></A
11041
 
>Find_binutils_prog Procedure</H3
11042
 
><P
11043
 
></P
11044
 
><DIV
11045
 
CLASS="FUNCSYNOPSIS"
11046
 
><A
11047
 
NAME="AEN4741"
11048
 
></A
11049
 
><P
11050
 
></P
11051
 
><CODE
11052
 
CLASS="FUNCDEF"
11053
 
><TT
11054
 
CLASS="FUNCTION"
11055
 
>find_binutils_prog</TT
11056
 
></CODE
11057
 
>(<TT
11058
 
CLASS="PARAMETER"
11059
 
><I
11060
 
>name</I
11061
 
></TT
11062
 
>);<P
11063
 
></P
11064
 
></DIV
11065
 
><P
11066
 
></P
11067
 
><DIV
11068
 
CLASS="VARIABLELIST"
11069
 
><DL
11070
 
><DT
11071
 
><TT
11072
 
CLASS="PARAMETER"
11073
 
><I
11074
 
>name</I
11075
 
></TT
11076
 
></DT
11077
 
><DD
11078
 
><P
11079
 
></P
11080
 
></DD
11081
 
></DL
11082
 
></DIV
11083
 
></DIV
11084
 
><DIV
11085
 
CLASS="SECT3"
11086
 
><H3
11087
 
CLASS="SECT3"
11088
 
><A
11089
 
NAME="FINDGCC"
11090
 
></A
11091
 
>Find_gcc Procedure</H3
11092
 
><P
11093
 
></P
11094
 
><DIV
11095
 
CLASS="FUNCSYNOPSIS"
11096
 
><A
11097
 
NAME="AEN4755"
11098
 
></A
11099
 
><P
11100
 
></P
11101
 
><CODE
11102
 
CLASS="FUNCDEF"
11103
 
><TT
11104
 
CLASS="FUNCTION"
11105
 
>find_gcc</TT
11106
 
></CODE
11107
 
>(<TT
11108
 
CLASS="PARAMETER"
11109
 
><I
11110
 
></I
11111
 
></TT
11112
 
>);<P
11113
 
></P
11114
 
></DIV
11115
 
></DIV
11116
 
><DIV
11117
 
CLASS="SECT3"
11118
 
><H3
11119
 
CLASS="SECT3"
11120
 
><A
11121
 
NAME="FINDGCJ"
11122
 
></A
11123
 
>Find_gcj Procedure</H3
11124
 
><P
11125
 
></P
11126
 
><DIV
11127
 
CLASS="FUNCSYNOPSIS"
11128
 
><A
11129
 
NAME="AEN4763"
11130
 
></A
11131
 
><P
11132
 
></P
11133
 
><CODE
11134
 
CLASS="FUNCDEF"
11135
 
><TT
11136
 
CLASS="FUNCTION"
11137
 
>find_gcj</TT
11138
 
></CODE
11139
 
>(<TT
11140
 
CLASS="PARAMETER"
11141
 
><I
11142
 
></I
11143
 
></TT
11144
 
>);<P
11145
 
></P
11146
 
></DIV
11147
 
></DIV
11148
 
><DIV
11149
 
CLASS="SECT3"
11150
 
><H3
11151
 
CLASS="SECT3"
11152
 
><A
11153
 
NAME="FINDGXX"
11154
 
></A
11155
 
>Find_g++ Procedure</H3
11156
 
><P
11157
 
></P
11158
 
><DIV
11159
 
CLASS="FUNCSYNOPSIS"
11160
 
><A
11161
 
NAME="AEN4771"
11162
 
></A
11163
 
><P
11164
 
></P
11165
 
><CODE
11166
 
CLASS="FUNCDEF"
11167
 
><TT
11168
 
CLASS="FUNCTION"
11169
 
>find_g++</TT
11170
 
></CODE
11171
 
>(<TT
11172
 
CLASS="PARAMETER"
11173
 
><I
11174
 
></I
11175
 
></TT
11176
 
>);<P
11177
 
></P
11178
 
></DIV
11179
 
></DIV
11180
 
><DIV
11181
 
CLASS="SECT3"
11182
 
><H3
11183
 
CLASS="SECT3"
11184
 
><A
11185
 
NAME="FINDG77"
11186
 
></A
11187
 
>Find_g77 Procedure</H3
11188
 
><P
11189
 
></P
11190
 
><DIV
11191
 
CLASS="FUNCSYNOPSIS"
11192
 
><A
11193
 
NAME="AEN4779"
11194
 
></A
11195
 
><P
11196
 
></P
11197
 
><CODE
11198
 
CLASS="FUNCDEF"
11199
 
><TT
11200
 
CLASS="FUNCTION"
11201
 
>find_g77</TT
11202
 
></CODE
11203
 
>(<TT
11204
 
CLASS="PARAMETER"
11205
 
><I
11206
 
></I
11207
 
></TT
11208
 
>);<P
11209
 
></P
11210
 
></DIV
11211
 
></DIV
11212
 
><DIV
11213
 
CLASS="SECT3"
11214
 
><H3
11215
 
CLASS="SECT3"
11216
 
><A
11217
 
NAME="PROCESSMULTILIBOPTIONS"
11218
 
></A
11219
 
>Process_multilib_options Procedure</H3
11220
 
><P
11221
 
></P
11222
 
><DIV
11223
 
CLASS="FUNCSYNOPSIS"
11224
 
><A
11225
 
NAME="AEN4787"
11226
 
></A
11227
 
><P
11228
 
></P
11229
 
><CODE
11230
 
CLASS="FUNCDEF"
11231
 
><TT
11232
 
CLASS="FUNCTION"
11233
 
>process_multilib_options</TT
11234
 
></CODE
11235
 
>(<TT
11236
 
CLASS="PARAMETER"
11237
 
><I
11238
 
>args</I
11239
 
></TT
11240
 
>);<P
11241
 
></P
11242
 
></DIV
11243
 
><P
11244
 
></P
11245
 
><DIV
11246
 
CLASS="VARIABLELIST"
11247
 
><DL
11248
 
><DT
11249
 
><TT
11250
 
CLASS="PARAMETER"
11251
 
><I
11252
 
>args</I
11253
 
></TT
11254
 
></DT
11255
 
><DD
11256
 
><P
11257
 
></P
11258
 
></DD
11259
 
></DL
11260
 
></DIV
11261
 
></DIV
11262
 
><DIV
11263
 
CLASS="SECT3"
11264
 
><H3
11265
 
CLASS="SECT3"
11266
 
><A
11267
 
NAME="ADDMULTILIBOPTION"
11268
 
></A
11269
 
>Add_multilib_option Procedure</H3
11270
 
><P
11271
 
></P
11272
 
><DIV
11273
 
CLASS="FUNCSYNOPSIS"
11274
 
><A
11275
 
NAME="AEN4801"
11276
 
></A
11277
 
><P
11278
 
></P
11279
 
><CODE
11280
 
CLASS="FUNCDEF"
11281
 
><TT
11282
 
CLASS="FUNCTION"
11283
 
>add_multilib_option</TT
11284
 
></CODE
11285
 
>(<TT
11286
 
CLASS="PARAMETER"
11287
 
><I
11288
 
>args</I
11289
 
></TT
11290
 
>);<P
11291
 
></P
11292
 
></DIV
11293
 
><P
11294
 
></P
11295
 
><DIV
11296
 
CLASS="VARIABLELIST"
11297
 
><DL
11298
 
><DT
11299
 
><TT
11300
 
CLASS="PARAMETER"
11301
 
><I
11302
 
>args</I
11303
 
></TT
11304
 
></DT
11305
 
><DD
11306
 
><P
11307
 
></P
11308
 
></DD
11309
 
></DL
11310
 
></DIV
11311
 
></DIV
11312
 
><DIV
11313
 
CLASS="SECT3"
11314
 
><H3
11315
 
CLASS="SECT3"
11316
 
><A
11317
 
NAME="FINDGAS"
11318
 
></A
11319
 
>Find_gas Procedure</H3
11320
 
><P
11321
 
></P
11322
 
><DIV
11323
 
CLASS="FUNCSYNOPSIS"
11324
 
><A
11325
 
NAME="AEN4815"
11326
 
></A
11327
 
><P
11328
 
></P
11329
 
><CODE
11330
 
CLASS="FUNCDEF"
11331
 
><TT
11332
 
CLASS="FUNCTION"
11333
 
>find_gas</TT
11334
 
></CODE
11335
 
>(<TT
11336
 
CLASS="PARAMETER"
11337
 
><I
11338
 
></I
11339
 
></TT
11340
 
>);<P
11341
 
></P
11342
 
></DIV
11343
 
></DIV
11344
 
><DIV
11345
 
CLASS="SECT3"
11346
 
><H3
11347
 
CLASS="SECT3"
11348
 
><A
11349
 
NAME="FINDLD"
11350
 
></A
11351
 
>Find_ld Procedure</H3
11352
 
><P
11353
 
></P
11354
 
><DIV
11355
 
CLASS="FUNCSYNOPSIS"
11356
 
><A
11357
 
NAME="AEN4823"
11358
 
></A
11359
 
><P
11360
 
></P
11361
 
><CODE
11362
 
CLASS="FUNCDEF"
11363
 
><TT
11364
 
CLASS="FUNCTION"
11365
 
>find_ld</TT
11366
 
></CODE
11367
 
>(<TT
11368
 
CLASS="PARAMETER"
11369
 
><I
11370
 
></I
11371
 
></TT
11372
 
>);<P
11373
 
></P
11374
 
></DIV
11375
 
></DIV
11376
 
><DIV
11377
 
CLASS="SECT3"
11378
 
><H3
11379
 
CLASS="SECT3"
11380
 
><A
11381
 
NAME="BUILDWRAPPER"
11382
 
></A
11383
 
>Build_wrapper Procedure</H3
11384
 
><P
11385
 
></P
11386
 
><DIV
11387
 
CLASS="FUNCSYNOPSIS"
11388
 
><A
11389
 
NAME="AEN4831"
11390
 
></A
11391
 
><P
11392
 
></P
11393
 
><CODE
11394
 
CLASS="FUNCDEF"
11395
 
><TT
11396
 
CLASS="FUNCTION"
11397
 
>build_wrapper</TT
11398
 
></CODE
11399
 
>(<TT
11400
 
CLASS="PARAMETER"
11401
 
><I
11402
 
>gluefile</I
11403
 
></TT
11404
 
>);<P
11405
 
></P
11406
 
></DIV
11407
 
><P
11408
 
></P
11409
 
><DIV
11410
 
CLASS="VARIABLELIST"
11411
 
><DL
11412
 
><DT
11413
 
><TT
11414
 
CLASS="PARAMETER"
11415
 
><I
11416
 
>gluefile</I
11417
 
></TT
11418
 
></DT
11419
 
><DD
11420
 
><P
11421
 
></P
11422
 
></DD
11423
 
></DL
11424
 
></DIV
11425
 
></DIV
11426
 
><DIV
11427
 
CLASS="SECT3"
11428
 
><H3
11429
 
CLASS="SECT3"
11430
 
><A
11431
 
NAME="WINSUPINCLUDEFLAGS"
11432
 
></A
11433
 
>Winsup_include_flags Procedure</H3
11434
 
><P
11435
 
></P
11436
 
><DIV
11437
 
CLASS="FUNCSYNOPSIS"
11438
 
><A
11439
 
NAME="AEN4845"
11440
 
></A
11441
 
><P
11442
 
></P
11443
 
><CODE
11444
 
CLASS="FUNCDEF"
11445
 
><TT
11446
 
CLASS="FUNCTION"
11447
 
>winsup_include_flags</TT
11448
 
></CODE
11449
 
>(<TT
11450
 
CLASS="PARAMETER"
11451
 
><I
11452
 
>args</I
11453
 
></TT
11454
 
>);<P
11455
 
></P
11456
 
></DIV
11457
 
><P
11458
 
></P
11459
 
><DIV
11460
 
CLASS="VARIABLELIST"
11461
 
><DL
11462
 
><DT
11463
 
><TT
11464
 
CLASS="PARAMETER"
11465
 
><I
11466
 
>args</I
11467
 
></TT
11468
 
></DT
11469
 
><DD
11470
 
><P
11471
 
></P
11472
 
></DD
11473
 
></DL
11474
 
></DIV
11475
 
></DIV
11476
 
><DIV
11477
 
CLASS="SECT3"
11478
 
><H3
11479
 
CLASS="SECT3"
11480
 
><A
11481
 
NAME="WINSUPLINKFLAGS"
11482
 
></A
11483
 
>Winsup_link_flags Procedure</H3
11484
 
><P
11485
 
></P
11486
 
><DIV
11487
 
CLASS="FUNCSYNOPSIS"
11488
 
><A
11489
 
NAME="AEN4859"
11490
 
></A
11491
 
><P
11492
 
></P
11493
 
><CODE
11494
 
CLASS="FUNCDEF"
11495
 
><TT
11496
 
CLASS="FUNCTION"
11497
 
>winsup_link_flags</TT
11498
 
></CODE
11499
 
>(<TT
11500
 
CLASS="PARAMETER"
11501
 
><I
11502
 
>args</I
11503
 
></TT
11504
 
>);<P
11505
 
></P
11506
 
></DIV
11507
 
><P
11508
 
></P
11509
 
><DIV
11510
 
CLASS="VARIABLELIST"
11511
 
><DL
11512
 
><DT
11513
 
><TT
11514
 
CLASS="PARAMETER"
11515
 
><I
11516
 
>args</I
11517
 
></TT
11518
 
></DT
11519
 
><DD
11520
 
><P
11521
 
></P
11522
 
></DD
11523
 
></DL
11524
 
></DIV
11525
 
></DIV
11526
 
></DIV
11527
 
><DIV
11528
 
CLASS="SECT2"
11529
 
><H2
11530
 
CLASS="SECT2"
11531
 
><A
11532
 
NAME="DEBUGPROCS"
11533
 
></A
11534
 
>Procedures for debugging your Tcl code.</H2
11535
 
><P
11536
 
><TT
11537
 
CLASS="FILENAME"
11538
 
>lib/debugger.exp</TT
11539
 
>defines these utility
11540
 
      procedures:</P
11541
 
><DIV
11542
 
CLASS="SECT3"
11543
 
><H3
11544
 
CLASS="SECT3"
11545
 
><A
11546
 
NAME="DUMPVARS"
11547
 
></A
11548
 
>Dumpvars Procedure</H3
11549
 
><P
11550
 
>This takes a csh style regular expression (glob rules) and prints
11551
 
        the values of the global variable names that match.  It is abbreviated
11552
 
        as <I
11553
 
CLASS="EMPHASIS"
11554
 
>dv</I
11555
 
>.</P
11556
 
><DIV
11557
 
CLASS="FUNCSYNOPSIS"
11558
 
><A
11559
 
NAME="AEN4878"
11560
 
></A
11561
 
><P
11562
 
></P
11563
 
><CODE
11564
 
CLASS="FUNCDEF"
11565
 
><TT
11566
 
CLASS="FUNCTION"
11567
 
>dumpvars</TT
11568
 
></CODE
11569
 
>(<TT
11570
 
CLASS="PARAMETER"
11571
 
><I
11572
 
>vars</I
11573
 
></TT
11574
 
>);<P
11575
 
></P
11576
 
></DIV
11577
 
><P
11578
 
></P
11579
 
><DIV
11580
 
CLASS="VARIABLELIST"
11581
 
><DL
11582
 
><DT
11583
 
><TT
11584
 
CLASS="PARAMETER"
11585
 
><I
11586
 
>vars</I
11587
 
></TT
11588
 
></DT
11589
 
><DD
11590
 
><P
11591
 
>The variables to dump.</P
11592
 
></DD
11593
 
></DL
11594
 
></DIV
11595
 
></DIV
11596
 
><DIV
11597
 
CLASS="SECT3"
11598
 
><H3
11599
 
CLASS="SECT3"
11600
 
><A
11601
 
NAME="DUMPLOCALS"
11602
 
></A
11603
 
>Dumplocals Procedure</H3
11604
 
><P
11605
 
>This takes a csh style regular expression (glob rules) and
11606
 
          prints the values of the local variable names that match. It is
11607
 
          abbreviated as <I
11608
 
CLASS="EMPHASIS"
11609
 
>dl</I
11610
 
>.</P
11611
 
><DIV
11612
 
CLASS="FUNCSYNOPSIS"
11613
 
><A
11614
 
NAME="AEN4893"
11615
 
></A
11616
 
><P
11617
 
></P
11618
 
><CODE
11619
 
CLASS="FUNCDEF"
11620
 
><TT
11621
 
CLASS="FUNCTION"
11622
 
>dumplocals</TT
11623
 
></CODE
11624
 
>(<TT
11625
 
CLASS="PARAMETER"
11626
 
><I
11627
 
>args</I
11628
 
></TT
11629
 
>);<P
11630
 
></P
11631
 
></DIV
11632
 
><P
11633
 
></P
11634
 
><DIV
11635
 
CLASS="VARIABLELIST"
11636
 
><DL
11637
 
><DT
11638
 
><TT
11639
 
CLASS="PARAMETER"
11640
 
><I
11641
 
>args</I
11642
 
></TT
11643
 
></DT
11644
 
><DD
11645
 
><P
11646
 
></P
11647
 
></DD
11648
 
></DL
11649
 
></DIV
11650
 
></DIV
11651
 
><DIV
11652
 
CLASS="SECT3"
11653
 
><H3
11654
 
CLASS="SECT3"
11655
 
><A
11656
 
NAME="DUMPROCS"
11657
 
></A
11658
 
>Dumprocs Procedure</H3
11659
 
><P
11660
 
>This takes a csh style regular expression (glob rules) and
11661
 
          prints the body of all procs that match. It is abbreviated as
11662
 
          <I
11663
 
CLASS="EMPHASIS"
11664
 
>dp</I
11665
 
>.</P
11666
 
><DIV
11667
 
CLASS="FUNCSYNOPSIS"
11668
 
><A
11669
 
NAME="AEN4908"
11670
 
></A
11671
 
><P
11672
 
></P
11673
 
><CODE
11674
 
CLASS="FUNCDEF"
11675
 
><TT
11676
 
CLASS="FUNCTION"
11677
 
>dumprocs</TT
11678
 
></CODE
11679
 
>(<TT
11680
 
CLASS="PARAMETER"
11681
 
><I
11682
 
>pattern</I
11683
 
></TT
11684
 
>);<P
11685
 
></P
11686
 
></DIV
11687
 
><P
11688
 
></P
11689
 
><DIV
11690
 
CLASS="VARIABLELIST"
11691
 
><DL
11692
 
><DT
11693
 
><TT
11694
 
CLASS="PARAMETER"
11695
 
><I
11696
 
>pattern</I
11697
 
></TT
11698
 
></DT
11699
 
><DD
11700
 
><P
11701
 
>The csh "glob" style pattern to look
11702
 
            for.</P
11703
 
></DD
11704
 
></DL
11705
 
></DIV
11706
 
></DIV
11707
 
><DIV
11708
 
CLASS="SECT3"
11709
 
><H3
11710
 
CLASS="SECT3"
11711
 
><A
11712
 
NAME="DUMPWATCH"
11713
 
></A
11714
 
>Dumpwatch Procedure</H3
11715
 
><P
11716
 
>This takes a csh style regular expression (glob rules) and
11717
 
          prints all the watchpoints. It is abbreviated as
11718
 
          <I
11719
 
CLASS="EMPHASIS"
11720
 
>dw</I
11721
 
>.</P
11722
 
><DIV
11723
 
CLASS="FUNCSYNOPSIS"
11724
 
><A
11725
 
NAME="AEN4923"
11726
 
></A
11727
 
><P
11728
 
></P
11729
 
><CODE
11730
 
CLASS="FUNCDEF"
11731
 
><TT
11732
 
CLASS="FUNCTION"
11733
 
>dumpwatch</TT
11734
 
></CODE
11735
 
>(<TT
11736
 
CLASS="PARAMETER"
11737
 
><I
11738
 
>pattern</I
11739
 
></TT
11740
 
>);<P
11741
 
></P
11742
 
></DIV
11743
 
><P
11744
 
></P
11745
 
><DIV
11746
 
CLASS="VARIABLELIST"
11747
 
><DL
11748
 
><DT
11749
 
><TT
11750
 
CLASS="PARAMETER"
11751
 
><I
11752
 
>pattern</I
11753
 
></TT
11754
 
></DT
11755
 
><DD
11756
 
><P
11757
 
>The csh "glob" style pattern to look
11758
 
            for.</P
11759
 
></DD
11760
 
></DL
11761
 
></DIV
11762
 
></DIV
11763
 
><DIV
11764
 
CLASS="SECT3"
11765
 
><H3
11766
 
CLASS="SECT3"
11767
 
><A
11768
 
NAME="WATCHARRAY"
11769
 
></A
11770
 
>Watcharray Procedure</H3
11771
 
><P
11772
 
></P
11773
 
><DIV
11774
 
CLASS="FUNCSYNOPSIS"
11775
 
><A
11776
 
NAME="AEN4937"
11777
 
></A
11778
 
><P
11779
 
></P
11780
 
><CODE
11781
 
CLASS="FUNCDEF"
11782
 
><TT
11783
 
CLASS="FUNCTION"
11784
 
>watcharray</TT
11785
 
></CODE
11786
 
>(<TT
11787
 
CLASS="PARAMETER"
11788
 
><I
11789
 
>element</I
11790
 
></TT
11791
 
>
11792
 
                <TT
11793
 
CLASS="PARAMETER"
11794
 
><I
11795
 
>type</I
11796
 
></TT
11797
 
>);<P
11798
 
></P
11799
 
></DIV
11800
 
><P
11801
 
></P
11802
 
><DIV
11803
 
CLASS="VARIABLELIST"
11804
 
><DL
11805
 
><DT
11806
 
><TT
11807
 
CLASS="PARAMETER"
11808
 
><I
11809
 
>type</I
11810
 
></TT
11811
 
></DT
11812
 
><DD
11813
 
><P
11814
 
>The csh "glob" style pattern to look
11815
 
            for.</P
11816
 
></DD
11817
 
></DL
11818
 
></DIV
11819
 
></DIV
11820
 
><DIV
11821
 
CLASS="SECT3"
11822
 
><H3
11823
 
CLASS="SECT3"
11824
 
><A
11825
 
NAME="WATCHVAR"
11826
 
></A
11827
 
>Watchvar Procedure</H3
11828
 
><P
11829
 
></P
11830
 
><DIV
11831
 
CLASS="FUNCSYNOPSIS"
11832
 
><A
11833
 
NAME="AEN4952"
11834
 
></A
11835
 
><P
11836
 
></P
11837
 
><CODE
11838
 
CLASS="FUNCDEF"
11839
 
><TT
11840
 
CLASS="FUNCTION"
11841
 
>watchvar</TT
11842
 
></CODE
11843
 
>(<TT
11844
 
CLASS="PARAMETER"
11845
 
><I
11846
 
>var</I
11847
 
></TT
11848
 
>
11849
 
                <TT
11850
 
CLASS="PARAMETER"
11851
 
><I
11852
 
>type</I
11853
 
></TT
11854
 
>);<P
11855
 
></P
11856
 
></DIV
11857
 
><P
11858
 
></P
11859
 
><DIV
11860
 
CLASS="VARIABLELIST"
11861
 
><DL
11862
 
><DT
11863
 
><TT
11864
 
CLASS="PARAMETER"
11865
 
><I
11866
 
></I
11867
 
></TT
11868
 
></DT
11869
 
><DD
11870
 
><P
11871
 
></P
11872
 
></DD
11873
 
></DL
11874
 
></DIV
11875
 
></DIV
11876
 
><DIV
11877
 
CLASS="SECT3"
11878
 
><H3
11879
 
CLASS="SECT3"
11880
 
><A
11881
 
NAME="WATCHUNSET"
11882
 
></A
11883
 
>Watchunset Procedure</H3
11884
 
><P
11885
 
>This breaks program execution when the variable
11886
 
          <SPAN
11887
 
CLASS="SYMBOL"
11888
 
>var</SPAN
11889
 
> is unset. It is abbreviated as
11890
 
          <I
11891
 
CLASS="EMPHASIS"
11892
 
>wu</I
11893
 
>.</P
11894
 
><DIV
11895
 
CLASS="FUNCSYNOPSIS"
11896
 
><A
11897
 
NAME="AEN4969"
11898
 
></A
11899
 
><P
11900
 
></P
11901
 
><CODE
11902
 
CLASS="FUNCDEF"
11903
 
><TT
11904
 
CLASS="FUNCTION"
11905
 
>watchunset</TT
11906
 
></CODE
11907
 
>(<TT
11908
 
CLASS="PARAMETER"
11909
 
><I
11910
 
>arg</I
11911
 
></TT
11912
 
>);<P
11913
 
></P
11914
 
></DIV
11915
 
><P
11916
 
></P
11917
 
><DIV
11918
 
CLASS="VARIABLELIST"
11919
 
><DL
11920
 
><DT
11921
 
><TT
11922
 
CLASS="PARAMETER"
11923
 
><I
11924
 
>args</I
11925
 
></TT
11926
 
></DT
11927
 
><DD
11928
 
><P
11929
 
></P
11930
 
></DD
11931
 
></DL
11932
 
></DIV
11933
 
></DIV
11934
 
><DIV
11935
 
CLASS="SECT3"
11936
 
><H3
11937
 
CLASS="SECT3"
11938
 
><A
11939
 
NAME="WATCHWRITE"
11940
 
></A
11941
 
>Watchwrite Procedure</H3
11942
 
><P
11943
 
>This breaks program execution when the variable
11944
 
          <SPAN
11945
 
CLASS="SYMBOL"
11946
 
>var</SPAN
11947
 
> is written. It is abbreviated as
11948
 
          <I
11949
 
CLASS="EMPHASIS"
11950
 
>ww</I
11951
 
>.</P
11952
 
><DIV
11953
 
CLASS="FUNCSYNOPSIS"
11954
 
><A
11955
 
NAME="AEN4985"
11956
 
></A
11957
 
><P
11958
 
></P
11959
 
><CODE
11960
 
CLASS="FUNCDEF"
11961
 
><TT
11962
 
CLASS="FUNCTION"
11963
 
>watchwrite</TT
11964
 
></CODE
11965
 
>(<TT
11966
 
CLASS="PARAMETER"
11967
 
><I
11968
 
>var</I
11969
 
></TT
11970
 
>);<P
11971
 
></P
11972
 
></DIV
11973
 
><P
11974
 
></P
11975
 
><DIV
11976
 
CLASS="VARIABLELIST"
11977
 
><DL
11978
 
><DT
11979
 
><TT
11980
 
CLASS="PARAMETER"
11981
 
><I
11982
 
>var</I
11983
 
></TT
11984
 
></DT
11985
 
><DD
11986
 
><P
11987
 
>The variable to watch.</P
11988
 
></DD
11989
 
></DL
11990
 
></DIV
11991
 
></DIV
11992
 
><DIV
11993
 
CLASS="SECT3"
11994
 
><H3
11995
 
CLASS="SECT3"
11996
 
><A
11997
 
NAME="WATCHREAD"
11998
 
></A
11999
 
>Watchread Procedure</H3
12000
 
><P
12001
 
>This breaks program execution when the variable
12002
 
          <SPAN
12003
 
CLASS="SYMBOL"
12004
 
>var</SPAN
12005
 
> is read. It is abbreviated as
12006
 
          <I
12007
 
CLASS="EMPHASIS"
12008
 
>wr</I
12009
 
>.</P
12010
 
><DIV
12011
 
CLASS="FUNCSYNOPSIS"
12012
 
><A
12013
 
NAME="AEN5001"
12014
 
></A
12015
 
><P
12016
 
></P
12017
 
><CODE
12018
 
CLASS="FUNCDEF"
12019
 
><TT
12020
 
CLASS="FUNCTION"
12021
 
>watchread</TT
12022
 
></CODE
12023
 
>(<TT
12024
 
CLASS="PARAMETER"
12025
 
><I
12026
 
>var</I
12027
 
></TT
12028
 
>);<P
12029
 
></P
12030
 
></DIV
12031
 
><P
12032
 
></P
12033
 
><DIV
12034
 
CLASS="VARIABLELIST"
12035
 
><DL
12036
 
><DT
12037
 
><TT
12038
 
CLASS="PARAMETER"
12039
 
><I
12040
 
>var</I
12041
 
></TT
12042
 
></DT
12043
 
><DD
12044
 
><P
12045
 
>The variable to watch.</P
12046
 
></DD
12047
 
></DL
12048
 
></DIV
12049
 
></DIV
12050
 
><DIV
12051
 
CLASS="SECT3"
12052
 
><H3
12053
 
CLASS="SECT3"
12054
 
><A
12055
 
NAME="WATCHDEL"
12056
 
></A
12057
 
>Watchdel Procedure</H3
12058
 
><P
12059
 
>This deletes a the watchpoint from the watch list. It is
12060
 
          abbreviated as <I
12061
 
CLASS="EMPHASIS"
12062
 
>wd</I
12063
 
>.</P
12064
 
><DIV
12065
 
CLASS="FUNCSYNOPSIS"
12066
 
><A
12067
 
NAME="AEN5016"
12068
 
></A
12069
 
><P
12070
 
></P
12071
 
><CODE
12072
 
CLASS="FUNCDEF"
12073
 
><TT
12074
 
CLASS="FUNCTION"
12075
 
>watchdel</TT
12076
 
></CODE
12077
 
>(<TT
12078
 
CLASS="PARAMETER"
12079
 
><I
12080
 
>args</I
12081
 
></TT
12082
 
>);<P
12083
 
></P
12084
 
></DIV
12085
 
><P
12086
 
></P
12087
 
><DIV
12088
 
CLASS="VARIABLELIST"
12089
 
><DL
12090
 
><DT
12091
 
><TT
12092
 
CLASS="PARAMETER"
12093
 
><I
12094
 
>args</I
12095
 
></TT
12096
 
></DT
12097
 
><DD
12098
 
><P
12099
 
></P
12100
 
></DD
12101
 
></DL
12102
 
></DIV
12103
 
></DIV
12104
 
><DIV
12105
 
CLASS="SECT3"
12106
 
><H3
12107
 
CLASS="SECT3"
12108
 
><A
12109
 
NAME="PRINT"
12110
 
></A
12111
 
>Print Procedure</H3
12112
 
><P
12113
 
>This prints the value of the variable
12114
 
          <TT
12115
 
CLASS="PARAMETER"
12116
 
><I
12117
 
>var</I
12118
 
></TT
12119
 
>. It is abbreviated as
12120
 
          <I
12121
 
CLASS="EMPHASIS"
12122
 
>p</I
12123
 
>.</P
12124
 
><DIV
12125
 
CLASS="FUNCSYNOPSIS"
12126
 
><A
12127
 
NAME="AEN5032"
12128
 
></A
12129
 
><P
12130
 
></P
12131
 
><CODE
12132
 
CLASS="FUNCDEF"
12133
 
><TT
12134
 
CLASS="FUNCTION"
12135
 
>print</TT
12136
 
></CODE
12137
 
>(<TT
12138
 
CLASS="PARAMETER"
12139
 
><I
12140
 
>var</I
12141
 
></TT
12142
 
>);<P
12143
 
></P
12144
 
></DIV
12145
 
><P
12146
 
></P
12147
 
><DIV
12148
 
CLASS="VARIABLELIST"
12149
 
><DL
12150
 
><DT
12151
 
><TT
12152
 
CLASS="PARAMETER"
12153
 
><I
12154
 
>var</I
12155
 
></TT
12156
 
></DT
12157
 
><DD
12158
 
><P
12159
 
></P
12160
 
></DD
12161
 
></DL
12162
 
></DIV
12163
 
></DIV
12164
 
><DIV
12165
 
CLASS="SECT3"
12166
 
><H3
12167
 
CLASS="SECT3"
12168
 
><A
12169
 
NAME="QUIT"
12170
 
></A
12171
 
>Quit Procedure</H3
12172
 
><P
12173
 
>This makes runtest exit. It is abbreviated as
12174
 
          <I
12175
 
CLASS="EMPHASIS"
12176
 
>q</I
12177
 
>.</P
12178
 
><DIV
12179
 
CLASS="FUNCSYNOPSIS"
12180
 
><A
12181
 
NAME="AEN5047"
12182
 
></A
12183
 
><P
12184
 
></P
12185
 
><CODE
12186
 
CLASS="FUNCDEF"
12187
 
><TT
12188
 
CLASS="FUNCTION"
12189
 
>quit</TT
12190
 
></CODE
12191
 
>(<TT
12192
 
CLASS="PARAMETER"
12193
 
><I
12194
 
></I
12195
 
></TT
12196
 
>);<P
12197
 
></P
12198
 
></DIV
12199
 
><P
12200
 
></P
12201
 
><DIV
12202
 
CLASS="VARIABLELIST"
12203
 
><DL
12204
 
><DT
12205
 
><TT
12206
 
CLASS="PARAMETER"
12207
 
><I
12208
 
></I
12209
 
></TT
12210
 
></DT
12211
 
><DD
12212
 
><P
12213
 
></P
12214
 
></DD
12215
 
></DL
12216
 
></DIV
12217
 
></DIV
12218
 
></DIV
12219
 
></DIV
12220
 
><DIV
12221
 
CLASS="NAVFOOTER"
12222
 
><HR
12223
 
ALIGN="LEFT"
12224
 
WIDTH="100%"><TABLE
12225
 
SUMMARY="Footer navigation table"
12226
 
WIDTH="100%"
12227
 
BORDER="0"
12228
 
CELLPADDING="0"
12229
 
CELLSPACING="0"
12230
 
><TR
12231
 
><TD
12232
 
WIDTH="33%"
12233
 
ALIGN="left"
12234
 
VALIGN="top"
12235
 
><A
12236
 
HREF="x1600.html"
12237
 
ACCESSKEY="P"
12238
 
>&#60;&#60;&#60; Previous</A
12239
 
></TD
12240
 
><TD
12241
 
WIDTH="34%"
12242
 
ALIGN="center"
12243
 
VALIGN="top"
12244
 
><A
12245
 
HREF="book1.html"
12246
 
ACCESSKEY="H"
12247
 
>Home</A
12248
 
></TD
12249
 
><TD
12250
 
WIDTH="33%"
12251
 
ALIGN="right"
12252
 
VALIGN="top"
12253
 
><A
12254
 
HREF="x5058.html"
12255
 
ACCESSKEY="N"
12256
 
>Next &#62;&#62;&#62;</A
12257
 
></TD
12258
 
></TR
12259
 
><TR
12260
 
><TD
12261
 
WIDTH="33%"
12262
 
ALIGN="left"
12263
 
VALIGN="top"
12264
 
>Installation</TD
12265
 
><TD
12266
 
WIDTH="34%"
12267
 
ALIGN="center"
12268
 
VALIGN="top"
12269
 
><A
12270
 
HREF="c1593.html"
12271
 
ACCESSKEY="U"
12272
 
>Up</A
12273
 
></TD
12274
 
><TD
12275
 
WIDTH="33%"
12276
 
ALIGN="right"
12277
 
VALIGN="top"
12278
 
>File Map</TD
12279
 
></TR
12280
 
></TABLE
12281
 
></DIV
12282
 
></BODY
12283
 
></HTML
12284
 
>
 
 
b'\\ No newline at end of file'