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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
<html lang="en">
<head>
<title>Getting Help - GNU Octave</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Octave">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Getting-Started.html#Getting-Started" title="Getting Started">
<link rel="prev" href="Quitting-Octave.html#Quitting-Octave" title="Quitting Octave">
<link rel="next" href="Command-Line-Editing.html#Command-Line-Editing" title="Command Line Editing">
<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">
<a name="Getting-Help"></a>
<p>
Next: <a rel="next" accesskey="n" href="Command-Line-Editing.html#Command-Line-Editing">Command Line Editing</a>,
Previous: <a rel="previous" accesskey="p" href="Quitting-Octave.html#Quitting-Octave">Quitting Octave</a>,
Up: <a rel="up" accesskey="u" href="Getting-Started.html#Getting-Started">Getting Started</a>
<hr>
</div>
<h3 class="section">2.3 Commands for Getting Help</h3>
<p><a name="index-on_002dline-help-87"></a><a name="index-help_002c-on_002dline-88"></a>
The entire text of this manual is available from the Octave prompt
via the command <kbd>doc</kbd>. In addition, the documentation for
individual user-written functions and variables is also available via
the <kbd>help</kbd> command. This section describes the commands used for
reading the manual and the documentation strings for user-supplied
functions and variables. See <a href="Function-Files.html#Function-Files">Function Files</a>, for more information
about how to document the functions you write.
<!-- help scripts/help/help.m -->
<p><a name="doc_002dhelp"></a>
<div class="defun">
— Command: <b>help</b><var> name<a name="index-help-89"></a></var><br>
— Command: <b>help</b> <code>--list</code><var><a name="index-help-90"></a></var><br>
<blockquote><p>Display the help text for <var>name</var>. For example, the command
<kbd>help help</kbd> prints a short message describing the <code>help</code>
command.
<p>Given the single argument <code>--list</code>, list all operators,
keywords, built-in functions, and loadable functions available
in the current session of Octave.
<p>If invoked without any arguments, <code>help</code> display instructions
on how to access help from the command line.
<p>The help command can give you information about operators, but not the
comma and semicolons that are used as command separators. To get help
for those, you must type <kbd>help comma</kbd> or <kbd>help semicolon</kbd>.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002ddoc.html#doc_002ddoc">doc</a>, <a href="doc_002dlookfor.html#doc_002dlookfor">lookfor</a>, <a href="doc_002dwhich.html#doc_002dwhich">which</a>.
</p></blockquote></div>
<!-- doc scripts/help/doc.m -->
<p><a name="doc_002ddoc"></a>
<div class="defun">
— Command: <b>doc</b><var> function_name<a name="index-doc-91"></a></var><br>
<blockquote><p>Display documentation for the function <var>function_name</var>
directly from an on-line version of
the printed manual, using the GNU Info browser. If invoked without
any arguments, the manual is shown from the beginning.
<p>For example, the command <kbd>doc rand</kbd> starts the GNU Info browser
at the <code>rand</code> node in the on-line version of the manual.
<p>Once the GNU Info browser is running, help for using it is available
using the command <kbd>C-h</kbd>.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dhelp.html#doc_002dhelp">help</a>.
</p></blockquote></div>
<!-- lookfor scripts/help/lookfor.m -->
<p><a name="doc_002dlookfor"></a>
<div class="defun">
— Command: <b>lookfor</b><var> str<a name="index-lookfor-92"></a></var><br>
— Command: <b>lookfor</b><var> -all str<a name="index-lookfor-93"></a></var><br>
— Function File: [<var>func</var>, <var>helpstring</var>] = <b>lookfor</b> (<var>str</var>)<var><a name="index-lookfor-94"></a></var><br>
— Function File: [<var>func</var>, <var>helpstring</var>] = <b>lookfor</b> (<var>'-all', str</var>)<var><a name="index-lookfor-95"></a></var><br>
<blockquote><p>Search for the string <var>str</var> in all functions found in the current
function search path. By default, <code>lookfor</code> searches for <var>str</var>
in the first sentence of the help string of each function found. The entire
help text of each function can be searched if the '-all' argument is
supplied. All searches are case insensitive.
<p>Called with no output arguments, <code>lookfor</code> prints the list of
matching functions to the terminal. Otherwise, the output arguments
<var>func</var> and <var>helpstring</var> define the matching functions and the
first sentence of each of their help strings.
<p>The ability of <code>lookfor</code> to correctly identify the first
sentence of the help text is dependent on the format of the
function's help. All Octave core functions are correctly
formatted, but the same can not be guaranteed for external packages and
user-supplied functions. Therefore, the use of the '-all' argument may
be necessary to find related functions that are not a part of Octave.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dhelp.html#doc_002dhelp">help</a>, <a href="doc_002ddoc.html#doc_002ddoc">doc</a>, <a href="doc_002dwhich.html#doc_002dwhich">which</a>.
</p></blockquote></div>
<p>To see what is new in the current release of Octave, use the <code>news</code>
function.
<!-- news scripts/miscellaneous/news.m -->
<p><a name="doc_002dnews"></a>
<div class="defun">
— Function File: <b>news</b> (<var>package</var>)<var><a name="index-news-96"></a></var><br>
<blockquote><p>Display the current NEWS file for Octave or installed package.
<p>If <var>package</var> is the name of an installed package, display the current
NEWS file for that package.
</p></blockquote></div>
<!-- info scripts/miscellaneous/info.m -->
<p><a name="doc_002dinfo"></a>
<div class="defun">
— Function File: <b>info</b> ()<var><a name="index-info-97"></a></var><br>
<blockquote><p>Display contact information for the GNU Octave community.
</p></blockquote></div>
<!-- warranty src/toplev.cc -->
<p><a name="doc_002dwarranty"></a>
<div class="defun">
— Built-in Function: <b>warranty</b> ()<var><a name="index-warranty-98"></a></var><br>
<blockquote><p>Describe the conditions for copying and distributing Octave.
</p></blockquote></div>
<p>The following functions can be used to change which programs are used
for displaying the documentation, and where the documentation can be
found.
<!-- info_file src/help.cc -->
<p><a name="doc_002dinfo_005ffile"></a>
<div class="defun">
— Built-in Function: <var>val</var> = <b>info_file</b> ()<var><a name="index-info_005ffile-99"></a></var><br>
— Built-in Function: <var>old_val</var> = <b>info_file</b> (<var>new_val</var>)<var><a name="index-info_005ffile-100"></a></var><br>
— Built-in Function: <b>info_file</b> (<var>new_val, "local"</var>)<var><a name="index-info_005ffile-101"></a></var><br>
<blockquote><p>Query or set the internal variable that specifies the name of the
Octave info file. The default value is
<samp><var>octave-home</var><span class="file">/info/octave.info</span></samp>, in
which <var>octave-home</var> is the root directory of the Octave installation.
The default value may be overridden by the environment variable
<samp><span class="env">OCTAVE_INFO_FILE</span></samp><!-- /@w -->, or the command line argument
‘<samp><span class="samp">--info-file NAME</span></samp>’.
<p>When called from inside a function with the "local" option, the variable is
changed locally for the function and any subroutines it calls. The original
variable value is restored when exiting the function.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dinfo_005fprogram.html#doc_002dinfo_005fprogram">info_program</a>, <a href="doc_002ddoc.html#doc_002ddoc">doc</a>, <a href="doc_002dhelp.html#doc_002dhelp">help</a>, <a href="doc_002dmakeinfo_005fprogram.html#doc_002dmakeinfo_005fprogram">makeinfo_program</a>.
</p></blockquote></div>
<!-- info_program src/help.cc -->
<p><a name="doc_002dinfo_005fprogram"></a>
<div class="defun">
— Built-in Function: <var>val</var> = <b>info_program</b> ()<var><a name="index-info_005fprogram-102"></a></var><br>
— Built-in Function: <var>old_val</var> = <b>info_program</b> (<var>new_val</var>)<var><a name="index-info_005fprogram-103"></a></var><br>
— Built-in Function: <b>info_program</b> (<var>new_val, "local"</var>)<var><a name="index-info_005fprogram-104"></a></var><br>
<blockquote><p>Query or set the internal variable that specifies the name of the
info program to run. The default value is
<samp><var>octave-home</var><span class="file">/libexec/octave/</span><var>version</var><span class="file">/exec/</span><var>arch</var><span class="file">/info</span></samp>
in which <var>octave-home</var> is the root directory of the Octave installation,
<var>version</var> is the Octave version number, and <var>arch</var>
is the system type (for example, <code>i686-pc-linux-gnu</code>). The
default value may be overridden by the environment variable
<samp><span class="env">OCTAVE_INFO_PROGRAM</span></samp><!-- /@w -->, or the command line argument
‘<samp><span class="samp">--info-program NAME</span></samp>’.
<p>When called from inside a function with the "local" option, the variable is
changed locally for the function and any subroutines it calls. The original
variable value is restored when exiting the function.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dinfo_005ffile.html#doc_002dinfo_005ffile">info_file</a>, <a href="doc_002ddoc.html#doc_002ddoc">doc</a>, <a href="doc_002dhelp.html#doc_002dhelp">help</a>, <a href="doc_002dmakeinfo_005fprogram.html#doc_002dmakeinfo_005fprogram">makeinfo_program</a>.
</p></blockquote></div>
<!-- makeinfo_program src/help.cc -->
<p><a name="doc_002dmakeinfo_005fprogram"></a>
<div class="defun">
— Built-in Function: <var>val</var> = <b>makeinfo_program</b> ()<var><a name="index-makeinfo_005fprogram-105"></a></var><br>
— Built-in Function: <var>old_val</var> = <b>makeinfo_program</b> (<var>new_val</var>)<var><a name="index-makeinfo_005fprogram-106"></a></var><br>
— Built-in Function: <b>makeinfo_program</b> (<var>new_val, "local"</var>)<var><a name="index-makeinfo_005fprogram-107"></a></var><br>
<blockquote><p>Query or set the internal variable that specifies the name of the
program that Octave runs to format help text containing
Texinfo markup commands. The default value is <code>makeinfo</code>.
<p>When called from inside a function with the "local" option, the variable is
changed locally for the function and any subroutines it calls. The original
variable value is restored when exiting the function.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dinfo_005ffile.html#doc_002dinfo_005ffile">info_file</a>, <a href="doc_002dinfo_005fprogram.html#doc_002dinfo_005fprogram">info_program</a>, <a href="doc_002ddoc.html#doc_002ddoc">doc</a>, <a href="doc_002dhelp.html#doc_002dhelp">help</a>.
</p></blockquote></div>
<!-- doc_cache_file src/help.cc -->
<p><a name="doc_002ddoc_005fcache_005ffile"></a>
<div class="defun">
— Built-in Function: <var>val</var> = <b>doc_cache_file</b> ()<var><a name="index-doc_005fcache_005ffile-108"></a></var><br>
— Built-in Function: <var>old_val</var> = <b>doc_cache_file</b> (<var>new_val</var>)<var><a name="index-doc_005fcache_005ffile-109"></a></var><br>
— Built-in Function: <b>doc_cache_file</b> (<var>new_val, "local"</var>)<var><a name="index-doc_005fcache_005ffile-110"></a></var><br>
<blockquote><p>Query or set the internal variable that specifies the name of the
Octave documentation cache file. A cache file significantly improves
the performance of the <code>lookfor</code> command. The default value is
<samp><var>octave-home</var><span class="file">/share/octave/</span><var>version</var><span class="file">/etc/doc-cache</span></samp>,
in which <var>octave-home</var> is the root directory of the Octave installation,
and <var>version</var> is the Octave version number.
The default value may be overridden by the environment variable
<samp><span class="env">OCTAVE_DOC_CACHE_FILE</span></samp><!-- /@w -->, or the command line argument
‘<samp><span class="samp">--doc-cache-file NAME</span></samp>’.
<p>When called from inside a function with the "local" option, the variable is
changed locally for the function and any subroutines it calls. The original
variable value is restored when exiting the function.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dlookfor.html#doc_002dlookfor">lookfor</a>, <a href="doc_002dinfo_005fprogram.html#doc_002dinfo_005fprogram">info_program</a>, <a href="doc_002ddoc.html#doc_002ddoc">doc</a>, <a href="doc_002dhelp.html#doc_002dhelp">help</a>, <a href="doc_002dmakeinfo_005fprogram.html#doc_002dmakeinfo_005fprogram">makeinfo_program</a>.
</p></blockquote></div>
<!-- suppress_verbose_help_message src/help.cc -->
<p><a name="doc_002dsuppress_005fverbose_005fhelp_005fmessage"></a>
<div class="defun">
— Built-in Function: <var>val</var> = <b>suppress_verbose_help_message</b> ()<var><a name="index-suppress_005fverbose_005fhelp_005fmessage-111"></a></var><br>
— Built-in Function: <var>old_val</var> = <b>suppress_verbose_help_message</b> (<var>new_val</var>)<var><a name="index-suppress_005fverbose_005fhelp_005fmessage-112"></a></var><br>
— Built-in Function: <b>suppress_verbose_help_message</b> (<var>new_val, "local"</var>)<var><a name="index-suppress_005fverbose_005fhelp_005fmessage-113"></a></var><br>
<blockquote><p>Query or set the internal variable that controls whether Octave
will add additional help information to the end of the output from
the <code>help</code> command and usage messages for built-in commands.
<p>When called from inside a function with the "local" option, the variable is
changed locally for the function and any subroutines it calls. The original
variable value is restored when exiting the function.
</p></blockquote></div>
<p>The following functions are principally used internally by Octave for
generating the documentation. They are documented here for completeness
and because they may occasionally be useful for users.
<!-- gen_doc_cache scripts/help/gen_doc_cache.m -->
<p><a name="doc_002dgen_005fdoc_005fcache"></a>
<div class="defun">
— Function File: <b>gen_doc_cache</b> (<var>out_file, directory</var>)<var><a name="index-gen_005fdoc_005fcache-114"></a></var><br>
<blockquote><p>Generate documentation caches for all functions in a given directory.
<p>A documentation cache is generated for all functions in <var>directory</var>.
The
resulting cache is saved in the file <var>out_file</var>.
The cache is used to speed up <code>lookfor</code>.
<p>If no directory is given (or it is the empty matrix), a cache for builtin
operators, etc. is generated.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dlookfor.html#doc_002dlookfor">lookfor</a>, <a href="doc_002dpath.html#doc_002dpath">path</a>.
</p></blockquote></div>
<!-- get_help_text src/help.cc -->
<p><a name="doc_002dget_005fhelp_005ftext"></a>
<div class="defun">
— Loadable Function: [<var>text</var>, <var>format</var>] = <b>get_help_text</b> (<var>name</var>)<var><a name="index-get_005fhelp_005ftext-115"></a></var><br>
<blockquote><p>Return the raw help text of function <var>name</var>.
<p>The raw help text is returned in <var>text</var> and the format in <var>format</var>
The format is a string which is one of <tt>"texinfo"</tt>, <tt>"html"</tt>, or
<tt>"plain text"</tt>.
</p></blockquote></div>
<!-- get_help_text_from_file src/help.cc -->
<p><a name="doc_002dget_005fhelp_005ftext_005ffrom_005ffile"></a>
<div class="defun">
— Loadable Function: [<var>text</var>, <var>format</var>] = <b>get_help_text_from_file</b> (<var>fname</var>)<var><a name="index-get_005fhelp_005ftext_005ffrom_005ffile-116"></a></var><br>
<blockquote><p>Return the raw help text from the file <var>fname</var>.
<p>The raw help text is returned in <var>text</var> and the format in <var>format</var>
The format is a string which is one of <tt>"texinfo"</tt>, <tt>"html"</tt>, or
<tt>"plain text"</tt>.
</p></blockquote></div>
<!-- get_first_help_sentence scripts/help/get_first_help_sentence.m -->
<p><a name="doc_002dget_005ffirst_005fhelp_005fsentence"></a>
<div class="defun">
— Function File: [<var>text</var>, <var>status</var>] = <b>get_first_help_sentence</b> (<var>name</var>)<var><a name="index-get_005ffirst_005fhelp_005fsentence-117"></a></var><br>
— Function File: [<var>text</var>, <var>status</var>] = <b>get_first_help_sentence</b> (<var>name, max_len</var>)<var><a name="index-get_005ffirst_005fhelp_005fsentence-118"></a></var><br>
<blockquote><p>Return the first sentence of a function's help text.
<p>The first sentence is defined as the text after the function
declaration until either the first period (".") or the first appearance of
two consecutive newlines ("\n\n"). The text is truncated to a maximum
length of <var>max_len</var>, which defaults to 80.
<p>The optional output argument <var>status</var> returns the status reported by
<code>makeinfo</code>. If only one output argument is requested, and <var>status</var>
is non-zero, a warning is displayed.
<p>As an example, the first sentence of this help text is
<pre class="example"> get_first_help_sentence ("get_first_help_sentence")
-| ans = Return the first sentence of a function's help text.
</pre>
</blockquote></div>
</body></html>
|
