File: Diary-and-Echo-Commands.html

package info (click to toggle)
octave3.2 3.2.4-8
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 62,936 kB
  • ctags: 37,353
  • sloc: cpp: 219,497; fortran: 116,336; ansic: 10,264; sh: 5,508; makefile: 4,245; lex: 3,573; yacc: 3,062; objc: 2,042; lisp: 1,692; awk: 860; perl: 844
file content (112 lines) | stat: -rw-r--r-- 4,791 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
<html lang="en">
<head>
<title>Diary and Echo Commands - Untitled</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Untitled">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Command-Line-Editing.html#Command-Line-Editing" title="Command Line Editing">
<link rel="prev" href="Customizing-the-Prompt.html#Customizing-the-Prompt" title="Customizing the Prompt">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Diary-and-Echo-Commands"></a>
Previous:&nbsp;<a rel="previous" accesskey="p" href="Customizing-the-Prompt.html#Customizing-the-Prompt">Customizing the Prompt</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Command-Line-Editing.html#Command-Line-Editing">Command Line Editing</a>
<hr>
</div>

<h4 class="subsection">2.4.8 Diary and Echo Commands</h4>

<p><a name="index-diary-of-commands-and-output-142"></a><a name="index-command-and-output-logs-143"></a><a name="index-logging-commands-and-output-144"></a><a name="index-echoing-executing-commands-145"></a><a name="index-command-echoing-146"></a>
Octave'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.

<!-- pager.cc -->
   <p><a name="doc_002ddiary"></a>

<div class="defun">
&mdash; Command: <b>diary</b><var> options<a name="index-diary-147"></a></var><br>
<blockquote><p>Record a list of all commands <em>and</em> the output they produce, mixed
together just as you see them on your terminal.  Valid options are:

          <dl>
<dt><code>on</code><dd>Start recording your session in a file called <samp><span class="file">diary</span></samp> in your
current working directory.

          <br><dt><code>off</code><dd>Stop recording your session in the diary file.

          <br><dt><var>file</var><dd>Record your session in the file named <var>file</var>. 
</dl>

        <p>With no arguments, <code>diary</code> toggles the current diary state. 
</p></blockquote></div>

   <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.

<!-- input.cc -->
   <p><a name="doc_002decho"></a>

<div class="defun">
&mdash; Command: <b>echo</b><var> options<a name="index-echo-148"></a></var><br>
<blockquote><p>Control whether commands are displayed as they are executed.  Valid
options are:

          <dl>
<dt><code>on</code><dd>Enable echoing of commands as they are executed in script files.

          <br><dt><code>off</code><dd>Disable echoing of commands as they are executed in script files.

          <br><dt><code>on all</code><dd>Enable echoing of commands as they are executed in script files and
functions.

          <br><dt><code>off all</code><dd>Disable echoing of commands as they are executed in script files and
functions. 
</dl>

     <p class="noindent">With no arguments, <code>echo</code> toggles the current echo state. 
</p></blockquote></div>

<!-- input.cc -->
   <p><a name="doc_002decho_005fexecuting_005fcommands"></a>

<div class="defun">
&mdash; Built-in Function: <var>val</var> = <b>echo_executing_commands</b> ()<var><a name="index-echo_005fexecuting_005fcommands-149"></a></var><br>
&mdash; Built-in Function: <var>old_val</var> = <b>echo_executing_commands</b> (<var>new_val</var>)<var><a name="index-echo_005fexecuting_005fcommands-150"></a></var><br>
<blockquote><p>Query or set the internal variable that controls the echo state. 
It may be the sum of the following values:

          <dl>
<dt>1<dd>Echo commands read from script files.

          <br><dt>2<dd>Echo commands from functions.

          <br><dt>4<dd>Echo commands read from command line. 
</dl>

        <p>More than one state can be active at once.  For example, a value of 3 is
equivalent to the command <kbd>echo on all</kbd>.

        <p>The value of <code>echo_executing_commands</code> may be set by the <kbd>echo</kbd>
command or the command line option <code>--echo-commands</code>. 
</p></blockquote></div>

   </body></html>