docsrc/xlisp/xlisp-doc/reference/dribble.htm


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

<html><head><title>XLISP dribble</title>

<link rel="stylesheet" type="text/css" href="reference.css">

</head>

<body>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

<hr>

<h1>dribble</h1>

<hr>

<p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
<tr valign="top">
  <td><nobr>Type:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>function (subr)</nobr></td>
</tr>
<tr valign="top">
  <td><nobr>Source:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>xlisp.c, xlsys.c, msstuff.c</nobr></td>
</tr>
</tbody></table></p>

<h2>Syntax</h2>

<dl>
<dt>(dribble [<i>file-str</i>])</dt>
<dd><i>file-str</i> - a string expression for a file name<br>
returns - <a href="t.htm">&nbsp;T&nbsp;</a> if the transcript
is opened, <a href="nil.htm">NIL</a> if it is closed</dd>
</dl>

<h2>Description</h2>

<p>The 'dribble' function, when called with a 'file-str' argument, opens the
specified file and records a transcript of the XLISP session. When 'dribble'
is called with no 'file-str' argument, it closes the current transcript file
[if any]. 'dribble' will return
<a href="t.htm">&nbsp;T&nbsp;</a> if the specified 'file-str'
was successfully opened. It will return a
<a href="nil.htm">NIL</a> if the 'file-str' was not opened
successfully or if 'dribble' was evaluated to close a transcript.</p>

<h2>Examples</h2>

<pre class="example">
(dribble "my-trans-file")  <font color="#008844">; open file "my-trans-file"</font>
                           <font color="#008844">;   for a session transcript</font>
(+ 2 2)                                 
(dribble)                  <font color="#008844">; close the transcript</font>
</pre>

<p><b>Note:</b> It is also possible to start a transcript when invoking
XLISP. To start XLISP with a transcript file of 'myfile' type in
<nobr>'xlisp -tmyfile'.</nobr> <nobr>[I haven't</nobr> tested this with
Nyquist.]</p>

<p>See the
<a href="../manual/xlisp-man-031.htm#dribble">dribble</a>
function in the <nobr>XLISP 2.0</nobr> manual.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</nobr></a></p>

<hr>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

</body></html>