1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
3
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
5
<title>GNU Octave: Diary and Echo Commands</title>
7
<meta name="description" content="GNU Octave: Diary and Echo Commands">
8
<meta name="keywords" content="GNU Octave: Diary and Echo Commands">
9
<meta name="resource-type" content="document">
10
<meta name="distribution" content="global">
11
<meta name="Generator" content="makeinfo">
12
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
13
<link href="index.html#Top" rel="start" title="Top">
14
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
15
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
16
<link href="Command-Line-Editing.html#Command-Line-Editing" rel="up" title="Command Line Editing">
17
<link href="Errors.html#Errors" rel="next" title="Errors">
18
<link href="Customizing-the-Prompt.html#Customizing-the-Prompt" rel="prev" title="Customizing the Prompt">
19
<style type="text/css">
21
a.summary-letter {text-decoration: none}
22
blockquote.smallquotation {font-size: smaller}
23
div.display {margin-left: 3.2em}
24
div.example {margin-left: 3.2em}
25
div.indentedblock {margin-left: 3.2em}
26
div.lisp {margin-left: 3.2em}
27
div.smalldisplay {margin-left: 3.2em}
28
div.smallexample {margin-left: 3.2em}
29
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
30
div.smalllisp {margin-left: 3.2em}
31
kbd {font-style:oblique}
32
pre.display {font-family: inherit}
33
pre.format {font-family: inherit}
34
pre.menu-comment {font-family: serif}
35
pre.menu-preformatted {font-family: serif}
36
pre.smalldisplay {font-family: inherit; font-size: smaller}
37
pre.smallexample {font-size: smaller}
38
pre.smallformat {font-family: inherit; font-size: smaller}
39
pre.smalllisp {font-size: smaller}
40
span.nocodebreak {white-space:nowrap}
41
span.nolinebreak {white-space:nowrap}
42
span.roman {font-family:serif; font-weight:normal}
43
span.sansserif {font-family:sans-serif; font-weight:normal}
44
ul.no-bullet {list-style: none}
51
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
52
<a name="Diary-and-Echo-Commands"></a>
55
Previous: <a href="Customizing-the-Prompt.html#Customizing-the-Prompt" accesskey="p" rel="prev">Customizing the Prompt</a>, Up: <a href="Command-Line-Editing.html#Command-Line-Editing" accesskey="u" rel="up">Command Line Editing</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
58
<a name="Diary-and-Echo-Commands-1"></a>
59
<h4 class="subsection">2.4.8 Diary and Echo Commands</h4>
60
<a name="index-diary-of-commands-and-output"></a>
61
<a name="index-command-and-output-logs"></a>
62
<a name="index-logging-commands-and-output"></a>
63
<a name="index-echoing-executing-commands"></a>
64
<a name="index-command-echoing"></a>
66
<p>Octave’s diary feature allows you to keep a log of all or part of an
67
interactive session by recording the input you type and the output that
68
Octave produces in a separate file.
70
<a name="XREFdiary"></a><dl>
71
<dt><a name="index-diary"></a>Command: <em></em> <strong>diary</strong></dt>
72
<dt><a name="index-diary-1"></a>Command: <em></em> <strong>diary</strong> <em>on</em></dt>
73
<dt><a name="index-diary-2"></a>Command: <em></em> <strong>diary</strong> <em>off</em></dt>
74
<dt><a name="index-diary-3"></a>Command: <em></em> <strong>diary</strong> <em><var>filename</var></em></dt>
75
<dd><p>Record a list of all commands <em>and</em> the output they produce, mixed
76
together just as they appear on the terminal.
80
<dl compact="compact">
82
<dd><p>Start recording a session in a file called <samp>diary</samp> in the
83
current working directory.
87
<dd><p>Stop recording the session in the diary file.
90
<dt><var>filename</var></dt>
91
<dd><p>Record the session in the file named <var>filename</var>.
95
<p>With no arguments, <code>diary</code> toggles the current diary state.
97
<p><strong>See also:</strong> <a href="Commands-For-History.html#XREFhistory">history</a>.
101
<p>Sometimes it is useful to see the commands in a function or script as
102
they are being evaluated. This can be especially helpful for debugging
103
some kinds of problems.
105
<a name="XREFecho"></a><dl>
106
<dt><a name="index-echo"></a>Command: <em></em> <strong>echo</strong> <em>options</em></dt>
107
<dd><p>Control whether commands are displayed as they are executed. Valid
110
<dl compact="compact">
111
<dt><code>on</code></dt>
112
<dd><p>Enable echoing of commands as they are executed in script files.
115
<dt><code>off</code></dt>
116
<dd><p>Disable echoing of commands as they are executed in script files.
119
<dt><code>on all</code></dt>
120
<dd><p>Enable echoing of commands as they are executed in script files and
124
<dt><code>off all</code></dt>
125
<dd><p>Disable echoing of commands as they are executed in script files and
130
<p>With no arguments, <code>echo</code> toggles the current echo state.
134
<a name="XREFecho_005fexecuting_005fcommands"></a><dl>
135
<dt><a name="index-echo_005fexecuting_005fcommands"></a>Built-in Function: <em><var>val</var> =</em> <strong>echo_executing_commands</strong> <em>()</em></dt>
136
<dt><a name="index-echo_005fexecuting_005fcommands-1"></a>Built-in Function: <em><var>old_val</var> =</em> <strong>echo_executing_commands</strong> <em>(<var>new_val</var>)</em></dt>
137
<dt><a name="index-echo_005fexecuting_005fcommands-2"></a>Built-in Function: <em></em> <strong>echo_executing_commands</strong> <em>(<var>new_val</var>, "local")</em></dt>
138
<dd><p>Query or set the internal variable that controls the echo state.
139
It may be the sum of the following values:
141
<dl compact="compact">
143
<dd><p>Echo commands read from script files.
147
<dd><p>Echo commands from functions.
151
<dd><p>Echo commands read from command line.
155
<p>More than one state can be active at once. For example, a value of 3 is
156
equivalent to the command <kbd>echo on all</kbd>.
158
<p>The value of <code>echo_executing_commands</code> may be set by the <kbd>echo</kbd>
159
command or the command line option <samp>--echo-commands</samp>.
161
<p>When called from inside a function with the <code>"local"</code> option, the
162
variable is changed locally for the function and any subroutines it calls.
163
The original variable value is restored when exiting the function.
170
Previous: <a href="Customizing-the-Prompt.html#Customizing-the-Prompt" accesskey="p" rel="prev">Customizing the Prompt</a>, Up: <a href="Command-Line-Editing.html#Command-Line-Editing" accesskey="u" rel="up">Command Line Editing</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
added
removed
doc/interpreter/octave.html/Diary-and-Echo-Commands.html
