File: Diary-and-Echo-Commands.html

package info (click to toggle)
octave 6.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 124,192 kB
  • sloc: cpp: 322,665; ansic: 68,088; fortran: 20,980; objc: 8,121; sh: 7,719; yacc: 4,266; lex: 4,123; perl: 1,530; java: 1,366; awk: 1,257; makefile: 424; xml: 147
file content (157 lines) | stat: -rw-r--r-- 6,366 bytes parent folder | download
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Diary and Echo Commands (GNU Octave (version 6.2.0))</title>

<meta name="description" content="Diary and Echo Commands (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Diary and Echo Commands (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Command-Line-Editing.html" rel="up" title="Command Line Editing">
<link href="Errors.html" rel="next" title="Errors">
<link href="Customizing-the-Prompt.html" rel="prev" title="Customizing the Prompt">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<span id="Diary-and-Echo-Commands"></span><div class="header">
<p>
Previous: <a href="Customizing-the-Prompt.html" accesskey="p" rel="prev">Customizing the Prompt</a>, Up: <a href="Command-Line-Editing.html" accesskey="u" rel="up">Command Line Editing</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Diary-and-Echo-Commands-1"></span><h4 class="subsection">2.4.8 Diary and Echo Commands</h4>
<span id="index-diary-of-commands-and-output"></span>
<span id="index-command-and-output-logs"></span>
<span id="index-logging-commands-and-output"></span>
<span id="index-echoing-executing-commands"></span>
<span id="index-command-echoing"></span>

<p>Octave&rsquo;s diary feature allows you to keep a log of all or part of an
interactive session by recording the input you type and the output that
Octave produces in a separate file.
</p>
<span id="XREFdiary"></span><dl>
<dt id="index-diary-5">: <em></em> <strong>diary</strong></dt>
<dt id="index-diary-6">: <em></em> <strong>diary</strong> <em>on</em></dt>
<dt id="index-diary-7">: <em></em> <strong>diary</strong> <em>off</em></dt>
<dt id="index-diary-8">: <em></em> <strong>diary</strong> <em><var>filename</var></em></dt>
<dt id="index-diary-9">: <em>[<var>status</var>, <var>diaryfile</var>] =</em> <strong>diary</strong></dt>
<dd><p>Record a list of all commands <em>and</em> the output they produce, mixed
together just as they appear on the terminal.
</p>
<p>Valid options are:
</p>
<dl compact="compact">
<dt>on</dt>
<dd><p>Start recording a session in a file called <samp>diary</samp> in the current working
directory.
</p>
</dd>
<dt>off</dt>
<dd><p>Stop recording the session in the diary file.
</p>
</dd>
<dt><var>filename</var></dt>
<dd><p>Record the session in the file named <var>filename</var>.
</p></dd>
</dl>

<p>With no input or output arguments, <code>diary</code> toggles the current diary
state.
</p>
<p>If output arguments are requested, <code>diary</code> ignores inputs and returns
the current status.  The boolean <var>status</var> indicates whether recording is on
or off, and <var>diaryfile</var> is the name of the file where the session is
stored.
</p>
<p><strong>See also:</strong> <a href="Commands-for-History.html#XREFhistory">history</a>, <a href="Evaluation.html#XREFevalc">evalc</a>.
</p></dd></dl>


<p>Sometimes it is useful to see the commands in a function or script as
they are being evaluated.  This can be especially helpful for debugging
some kinds of problems.
</p>
<span id="XREFecho"></span><dl>
<dt id="index-echo">: <em></em> <strong>echo</strong></dt>
<dt id="index-echo-1">: <em></em> <strong>echo</strong> <em>on</em></dt>
<dt id="index-echo-2">: <em></em> <strong>echo</strong> <em>off</em></dt>
<dt id="index-echo-3">: <em></em> <strong>echo</strong> <em>on all</em></dt>
<dt id="index-echo-4">: <em></em> <strong>echo</strong> <em>off all</em></dt>
<dt id="index-echo-5">: <em></em> <strong>echo</strong> <em><var>function</var> on</em></dt>
<dt id="index-echo-6">: <em></em> <strong>echo</strong> <em><var>function</var> off</em></dt>
<dd><p>Control whether commands are displayed as they are executed.
</p>
<p>Valid options are:
</p>
<dl compact="compact">
<dt><code>on</code></dt>
<dd><p>Enable echoing of commands as they are executed in script files.
</p>
</dd>
<dt><code>off</code></dt>
<dd><p>Disable echoing of commands as they are executed in script files.
</p>
</dd>
<dt><code>on all</code></dt>
<dd><p>Enable echoing of commands as they are executed in script files and
functions.
</p>
</dd>
<dt><code>off all</code></dt>
<dd><p>Disable echoing of commands as they are executed in script files and
functions.
</p>
</dd>
<dt><code><var>function</var> on</code></dt>
<dd><p>Enable echoing of commands as they are executed in the named function.
</p>
</dd>
<dt><code><var>function</var> off</code></dt>
<dd><p>Disable echoing of commands as they are executed in the named function.
</p></dd>
</dl>

<p>With no arguments, <code>echo</code> toggles the current echo state.
</p>

<p><strong>See also:</strong> <a href="Customizing-the-Prompt.html#XREFPS4">PS4</a>.
</p></dd></dl>


<hr>
<div class="header">
<p>
Previous: <a href="Customizing-the-Prompt.html" accesskey="p" rel="prev">Customizing the Prompt</a>, Up: <a href="Command-Line-Editing.html" accesskey="u" rel="up">Command Line Editing</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>