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
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Executable Octave Programs (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Executable Octave Programs (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Executable Octave Programs (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<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="Getting-Started.html" rel="up" title="Getting Started">
<link href="Comments.html" rel="next" title="Comments">
<link href="Errors.html" rel="prev" title="Errors">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="section-level-extent" id="Executable-Octave-Programs">
<div class="nav-panel">
<p>
Next: <a href="Comments.html" accesskey="n" rel="next">Comments in Octave Programs</a>, Previous: <a href="Errors.html" accesskey="p" rel="prev">How Octave Reports Errors</a>, Up: <a href="Getting-Started.html" accesskey="u" rel="up">Getting Started</a> [<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>
<h3 class="section" id="Executable-Octave-Programs-1"><span>2.6 Executable Octave Programs<a class="copiable-link" href="#Executable-Octave-Programs-1"> ¶</a></span></h3>
<a class="index-entry-id" id="index-executable-scripts"></a>
<a class="index-entry-id" id="index-scripts"></a>
<a class="index-entry-id" id="index-batch-processing"></a>
<a class="index-entry-id" id="index-self-contained-programs"></a>
<a class="index-entry-id" id="index-program_002c-self-contained"></a>
<a class="index-entry-id" id="index-_0023_0021-self_002dcontained-script"></a>
<p>Once you have learned Octave, you may want to write self-contained
Octave scripts, using the ‘<samp class="samp">#!</samp>’ script mechanism. You can do this
on GNU systems and on many Unix systems <a class="footnote" id="DOCF1" href="#FOOT1"><sup>1</sup></a>.
</p>
<p>Self-contained Octave scripts are useful when you want to write a
program which users can invoke without knowing that the program is
written in the Octave language. Octave scripts are also used for batch
processing of data files. Once an algorithm has been developed and tested
in the interactive portion of Octave, it can be committed to an executable
script and used again and again on new data files.
</p>
<p>As a trivial example of an executable Octave script, you might create a
text file named <samp class="file">hello</samp>, containing the following lines:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">#! <var class="var">octave-interpreter-name</var> -qf
# a sample Octave program
printf ("Hello, world!\n");
</pre></div></div>
<p>(where <var class="var">octave-interpreter-name</var> should be replaced with the full
path and name of your Octave binary). Note that this will only work if
‘<samp class="samp">#!</samp>’ appears at the very beginning of the file. After making the
file executable (with the <code class="code">chmod</code> command on Unix systems), you can
simply type:
</p>
<div class="example">
<pre class="example-preformatted">hello
</pre></div>
<p>at the shell, and the system will arrange to run Octave as if you had
typed:
</p>
<div class="example">
<pre class="example-preformatted">octave hello
</pre></div>
<p>The line beginning with ‘<samp class="samp">#!</samp>’ lists the full path and filename of an
interpreter to be run, and an optional initial command line argument to
pass to that interpreter. The operating system then runs the
interpreter with the given argument and the full argument list of the
executed program. The first argument in the list is the full filename
of the Octave executable. The rest of the argument list will either be
options to Octave, or data files, or both. The ‘<samp class="samp">-qf</samp>’ options are
usually specified in stand-alone Octave programs to prevent them from
printing the normal startup message, and to keep them from behaving
differently depending on the contents of a particular user’s
<samp class="file">~/.octaverc</samp> file. See <a class="xref" href="Invoking-Octave-from-the-Command-Line.html">Invoking Octave from the Command Line</a>.
</p>
<p>Note that some operating systems may place a limit on the number of
characters that are recognized after ‘<samp class="samp">#!</samp>’. Also, the arguments
appearing in a ‘<samp class="samp">#!</samp>’ line are parsed differently by various
shells/systems. The majority of them group all the arguments together in one
string and pass it to the interpreter as a single argument. In this case, the
following script:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">#! <var class="var">octave-interpreter-name</var> -q -f # comment
</pre></div></div>
<p>is equivalent to typing at the command line:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">octave "-q -f # comment"
</pre></div></div>
<p>which will produce an error message. Unfortunately, it is
not possible for Octave to determine whether it has been called from the
command line or from a ‘<samp class="samp">#!</samp>’ script, so some care is needed when using the
‘<samp class="samp">#!</samp>’ mechanism.
</p>
<ul class="mini-toc">
<li><a href="Passing-Arguments-to-Executable-Scripts.html" accesskey="1">Passing Arguments to Executable Scripts</a></li>
<li><a href="Dual_002dPurpose-Executable-Scripts-and-Octave-Functions.html" accesskey="2">Dual-Purpose Executable Scripts and Octave Functions</a></li>
</ul>
</div>
<div class="footnotes-segment">
<hr>
<h4 class="footnotes-heading">Footnotes</h4>
<h5 class="footnote-body-heading"><a id="FOOT1" href="#DOCF1">(1)</a></h5>
<p>The ‘<samp class="samp">#!</samp>’
mechanism works on Unix systems derived from Berkeley Unix, System V
Release 4, and some System V Release 3 systems.</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Comments.html">Comments in Octave Programs</a>, Previous: <a href="Errors.html">How Octave Reports Errors</a>, Up: <a href="Getting-Started.html">Getting Started</a> [<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>
|
