Mercurial > octave-nkf
annotate doc/interpreter/basics.txi @ 19425:385499581a5e
allow disabling of permutation and diagonal matrices
* ov.cc (Vdisable_diagonal_matrix, Vdisable_permutation_matrix):
New static variables. Use them in octave_value constructors to
determine whether to create diagonal and permutation matrices.
(Fdisable_diagonal_matrix, Fdisable_permutation_matrix):
New functions.
* octave.cc (maximum_braindamage): Disable permutation and diagonal
matrices for --traditional option.
* CMatrix.cc, CMatrix.h, dMatrix.cc, dMatrix.h, fCMatrix.cc,
fCMatrix.h, fMatrix.cc, fMatrix.h: New conversion constructors.
* basics.txi, diagperm.txi: Update docs for change.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 08 Dec 2014 10:14:00 -0500 |
| parents | 66ca15a97988 |
| children | b39cbe9f3bb0 |
| rev | line source |
|---|---|
|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
17281
diff
changeset
|
1 @c Copyright (C) 1996-2013 John W. Eaton |
| 7018 | 2 @c |
| 3 @c This file is part of Octave. | |
| 4 @c | |
| 5 @c Octave is free software; you can redistribute it and/or modify it | |
| 6 @c under the terms of the GNU General Public License as published by the | |
| 7 @c Free Software Foundation; either version 3 of the License, or (at | |
| 8 @c your option) any later version. | |
| 9 @c | |
| 10 @c Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 13 @c for more details. | |
| 14 @c | |
| 15 @c You should have received a copy of the GNU General Public License | |
| 16 @c along with Octave; see the file COPYING. If not, see | |
| 17 @c <http://www.gnu.org/licenses/>. | |
| 3294 | 18 |
| 4167 | 19 @node Getting Started |
| 3294 | 20 @chapter Getting Started |
| 21 | |
| 22 This chapter explains some of Octave's basic features, including how to | |
| 23 start an Octave session, get help at the command prompt, edit the | |
| 24 command line, and write Octave programs that can be executed as commands | |
| 25 from your shell. | |
| 26 | |
| 27 @menu | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
28 * Invoking Octave from the Command Line:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
29 * Quitting Octave:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
30 * Getting Help:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
31 * Command Line Editing:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
32 * Errors:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
33 * Executable Octave Programs:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
34 * Comments:: |
| 3294 | 35 @end menu |
| 36 | |
| 6620 | 37 @node Invoking Octave from the Command Line |
| 38 @section Invoking Octave from the Command Line | |
| 3294 | 39 |
| 40 Normally, Octave is used interactively by running the program | |
| 41 @samp{octave} without any arguments. Once started, Octave reads | |
| 42 commands from the terminal until you tell it to exit. | |
| 43 | |
| 44 You can also specify the name of a file on the command line, and Octave | |
| 45 will read and execute the commands from the named file and then exit | |
| 46 when it is finished. | |
| 47 | |
| 48 You can further control how Octave starts by using the command-line | |
| 49 options described in the next section, and Octave itself can remind you | |
| 50 of the options available. Type @samp{octave --help} to display all | |
| 51 available options and briefly describe their use (@samp{octave -h} is a | |
| 52 shorter equivalent). | |
| 53 | |
| 54 @menu | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
55 * Command Line Options:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
56 * Startup Files:: |
| 3294 | 57 @end menu |
| 58 | |
| 4167 | 59 @node Command Line Options |
| 3294 | 60 @subsection Command Line Options |
| 61 @cindex Octave command options | |
| 62 @cindex command options | |
| 63 @cindex options, Octave command | |
| 64 | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
65 Here is a complete list of the command line options that Octave |
| 3294 | 66 accepts. |
| 67 | |
| 6620 | 68 |
| 3294 | 69 @table @code |
|
16807
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
70 |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
71 @item --built-in-docstrings-file @var{filename} |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
72 @cindex @code{--built-in-docstrings-file @var{filename}} |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
73 Specify the name of the file containing documentation strings for the |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
74 built-in functions of Octave. This value is normally correct and should |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
75 only need to specified in extraordinary situations. |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
76 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
77 @item --debug |
| 3294 | 78 @itemx -d |
| 79 @cindex @code{--debug} | |
| 80 @cindex @code{-d} | |
| 81 Enter parser debugging mode. Using this option will cause Octave's | |
| 82 parser to print a lot of information about the commands it reads, and is | |
| 83 probably only useful if you are actually trying to debug the parser. | |
| 84 | |
|
16877
5482cd26311a
Rename enable_jit_compiler to jit_enable, enable_jit_debugging to debug_jit.
Rik <rik@octave.org>
parents:
16876
diff
changeset
|
85 @item --debug-jit |
|
5482cd26311a
Rename enable_jit_compiler to jit_enable, enable_jit_debugging to debug_jit.
Rik <rik@octave.org>
parents:
16876
diff
changeset
|
86 @cindex @code{--debug-jit} |
|
5482cd26311a
Rename enable_jit_compiler to jit_enable, enable_jit_debugging to debug_jit.
Rik <rik@octave.org>
parents:
16876
diff
changeset
|
87 Enable JIT compiler debugging and tracing. |
|
5482cd26311a
Rename enable_jit_compiler to jit_enable, enable_jit_debugging to debug_jit.
Rik <rik@octave.org>
parents:
16876
diff
changeset
|
88 |
|
16807
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
89 @item --doc-cache-file @var{filename} |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
90 @cindex @code{--doc-cache-file @var{filename}} |
|
8923
d47290508a55
document --doc-cache-file option
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
91 Specify the name of the doc cache file to use. The value of @var{filename} |
|
d47290508a55
document --doc-cache-file option
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
92 specified on the command line will override any value of |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
93 @w{@env{OCTAVE_DOC_CACHE_FILE}} found in the environment, but not any commands |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
94 in the system or user startup files that use the @code{doc_cache_file} |
|
8923
d47290508a55
document --doc-cache-file option
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
95 function. |
|
d47290508a55
document --doc-cache-file option
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
96 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
97 @item --echo-commands |
| 3294 | 98 @itemx -x |
| 99 @cindex @code{--echo-commands} | |
| 100 @cindex @code{-x} | |
| 101 Echo commands as they are executed. | |
| 102 | |
| 5190 | 103 @item --eval @var{code} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
104 Evaluate @var{code} and exit when finished unless @option{--persist} is also |
| 5190 | 105 specified. |
| 106 | |
| 3294 | 107 @item --exec-path @var{path} |
| 108 @cindex @code{--exec-path @var{path}} | |
| 109 Specify the path to search for programs to run. The value of @var{path} | |
| 110 specified on the command line will override any value of | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
111 @w{@env{OCTAVE_EXEC_PATH}} found in the environment, but not any commands |
| 3294 | 112 in the system or user startup files that set the built-in variable |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
113 @w{@env{EXEC_PATH}}. |
| 3294 | 114 |
|
15540
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
115 @item --force-gui |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
116 @cindex @code{--force-gui} |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
117 Force the graphical user interface (GUI) to start. |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
118 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
119 @item --help |
| 3294 | 120 @itemx -h |
| 121 @itemx -? | |
| 122 @cindex @code{--help} | |
| 123 @cindex @code{-h} | |
| 124 @cindex @code{-?} | |
| 125 Print short help message and exit. | |
| 126 | |
| 6620 | 127 @item --image-path @var{path} |
| 128 @cindex @code{--image-path @var{path}} | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
129 Add path to the head of the search path for images. The value of |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
130 @var{path} specified on the command line will override any value of |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
131 @w{@env{OCTAVE_IMAGE_PATH}} found in the environment, but not any commands |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
132 in the system or user startup files that set the built-in variable |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
133 @w{@env{IMAGE_PATH}}. |
| 6620 | 134 |
| 3294 | 135 @item --info-file @var{filename} |
| 136 @cindex @code{--info-file @var{filename}} | |
| 137 Specify the name of the info file to use. The value of @var{filename} | |
| 138 specified on the command line will override any value of | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
139 @w{@env{OCTAVE_INFO_FILE}} found in the environment, but not any commands |
| 6653 | 140 in the system or user startup files that use the @code{info_file} |
| 6477 | 141 function. |
| 3294 | 142 |
| 143 @item --info-program @var{program} | |
| 144 @cindex @code{--info-program @var{program}} | |
| 145 Specify the name of the info program to use. The value of @var{program} | |
| 146 specified on the command line will override any value of | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
147 @w{@env{OCTAVE_INFO_PROGRAM}} found in the environment, but not any |
| 6477 | 148 commands in the system or user startup files that use the |
| 149 @code{info_program} function. | |
| 3294 | 150 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
151 @item --interactive |
| 3294 | 152 @itemx -i |
| 153 @cindex @code{--interactive} | |
| 154 @cindex @code{-i} | |
| 155 Force interactive behavior. This can be useful for running Octave via a | |
| 156 remote shell command or inside an Emacs shell buffer. For another way | |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16880
diff
changeset
|
157 to run Octave within Emacs, @pxref{Emacs Octave Support}. |
| 3294 | 158 |
|
17793
344f15ecfbb6
doc: Document --jit-compiler option in manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
159 @item --jit-compiler |
|
344f15ecfbb6
doc: Document --jit-compiler option in manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
160 @cindex @code{--jit-compiler} |
|
344f15ecfbb6
doc: Document --jit-compiler option in manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
161 Enable the JIT compiler used for accelerating loops. |
|
344f15ecfbb6
doc: Document --jit-compiler option in manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
162 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
163 @item --line-editing |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
164 @cindex @code{--line-editing} |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
165 Force readline use for command-line editing. |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
166 |
|
15540
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
167 @item --no-gui |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
168 @cindex @code{--no-gui} |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
169 Disable the graphical user interface (GUI) and use the command line |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
170 interface (CLI) instead. |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
171 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
172 @item --no-history |
| 3428 | 173 @itemx -H |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
174 @cindex @code{--no-history} |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
175 @cindex @code{-H} |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
176 Disable recording of command-line history. |
| 3428 | 177 |
| 3294 | 178 @item --no-init-file |
| 179 @cindex @code{--no-init-file} | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
180 Don't read the initialization files @file{~/.octaverc} and @file{.octaverc}. |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
181 |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
182 @item --no-init-path |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
183 @cindex @code{--no-init-path} |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
184 Don't initialize the search path for function files to include default |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
185 locations. |
| 3294 | 186 |
| 187 @item --no-line-editing | |
| 188 @cindex @code{--no-line-editing} | |
| 189 Disable command-line editing. | |
| 190 | |
| 191 @item --no-site-file | |
| 192 @cindex @code{--no-site-file} | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
193 Don't read the site-wide @file{octaverc} initialization files. |
| 3294 | 194 |
|
16774
8d188159ce5f
Add -W command line option to disable window system (bug #38937)
Rik <rik@octave.org>
parents:
16772
diff
changeset
|
195 @item --no-window-system |
|
8d188159ce5f
Add -W command line option to disable window system (bug #38937)
Rik <rik@octave.org>
parents:
16772
diff
changeset
|
196 @itemx -W |
|
15540
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
197 @cindex @code{--no-window-system} |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
198 Disable use of a windowing system including graphics. This forces a |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
199 strictly terminal-only environment. |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
200 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
201 @item --norc |
| 3294 | 202 @itemx -f |
| 203 @cindex @code{--norc} | |
| 204 @cindex @code{-f} | |
| 205 Don't read any of the system or user initialization files at startup. | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
206 This is equivalent to using both of the options @option{--no-init-file} |
|
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
207 and @option{--no-site-file}. |
| 3294 | 208 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
209 @item --path @var{path} |
| 3294 | 210 @itemx -p @var{path} |
| 211 @cindex @code{--path @var{path}} | |
| 212 @cindex @code{-p @var{path}} | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
213 Add path to the head of the search path for function files. The |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
214 value of @var{path} specified on the command line will override any value |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
215 of @w{@env{OCTAVE_PATH}} found in the environment, but not any commands in the |
| 6643 | 216 system or user startup files that set the internal load path through one |
| 217 of the path functions. | |
| 3294 | 218 |
| 5190 | 219 @item --persist |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
220 @cindex @code{--persist} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
221 Go to interactive mode after @option{--eval} or reading from a file |
| 5190 | 222 named on the command line. |
| 223 | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
224 @item --silent |
| 3294 | 225 @itemx --quiet |
| 226 @itemx -q | |
| 227 @cindex @code{--silent} | |
| 228 @cindex @code{--quiet} | |
| 229 @cindex @code{-q} | |
| 230 Don't print the usual greeting and version message at startup. | |
| 231 | |
|
15540
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
232 @item --texi-macros-file @var{filename} |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
233 @cindex @code{--texi-macros-file @var{filename}} |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
234 Specify the name of the file containing Texinfo macros for use by makeinfo. |
|
d8e3111b1890
doc: Add documentation about new command-line options available.
Rik <rik@octave.org>
parents:
14856
diff
changeset
|
235 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
236 @item --traditional |
| 3294 | 237 @itemx --braindead |
| 238 @cindex @code{--traditional} | |
| 239 @cindex @code{--braindead} | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9035
diff
changeset
|
240 For compatibility with @sc{matlab}, set initial values for |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
241 user preferences to the following values |
| 3294 | 242 |
| 243 @example | |
| 4455 | 244 @group |
|
10613
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
245 PS1 = ">> " |
|
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
246 PS2 = "" |
|
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
247 beep_on_error = true |
|
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
248 confirm_recursive_rmdir = false |
|
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
249 crash_dumps_octave_core = false |
|
19425
385499581a5e
allow disabling of permutation and diagonal matrices
John W. Eaton <jwe@octave.org>
parents:
19308
diff
changeset
|
250 disable_diagonal_matrix = true |
|
385499581a5e
allow disabling of permutation and diagonal matrices
John W. Eaton <jwe@octave.org>
parents:
19308
diff
changeset
|
251 disable_permutation_matrix = true |
|
10613
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
252 fixed_point_format = true |
|
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
253 history_timestamp_format_string = "%%-- %D %I:%M %p --%%" |
|
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
254 page_screen_output = false |
|
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
255 print_empty_dimensions = false |
|
19425
385499581a5e
allow disabling of permutation and diagonal matrices
John W. Eaton <jwe@octave.org>
parents:
19308
diff
changeset
|
256 save_default_options = "-mat-binary" |
|
18153
5971c8f515a7
doc: Document options set when using --traditional.
Rik <rik@octave.org>
parents:
17793
diff
changeset
|
257 struct_levels_to_print = 0 |
| 6556 | 258 @end group |
| 259 @end example | |
| 260 | |
| 261 @noindent | |
| 262 and disable the following warnings | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
263 |
| 6556 | 264 @example |
| 265 @group | |
|
10613
e103fb2182ce
use internal variable instead of warning state to control whether to allow non-integer ranges as indices
John W. Eaton <jwe@octave.org>
parents:
9906
diff
changeset
|
266 Octave:abbreviated-property-match |
| 7031 | 267 Octave:fopen-file-in-path |
| 268 Octave:function-name-clash | |
| 269 Octave:load-file-in-path | |
|
18153
5971c8f515a7
doc: Document options set when using --traditional.
Rik <rik@octave.org>
parents:
17793
diff
changeset
|
270 Octave:possible-matlab-short-circuit-operator |
| 4455 | 271 @end group |
| 3294 | 272 @end example |
| 273 | |
|
15618
9aa8dcf1e93d
doc: cross-reference Octave:matlab-incompatible to --braindead and --traditional
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
15545
diff
changeset
|
274 @noindent |
|
9aa8dcf1e93d
doc: cross-reference Octave:matlab-incompatible to --braindead and --traditional
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
15545
diff
changeset
|
275 Note that this does not enable the @code{Octave:matlab-incompatible} |
|
9aa8dcf1e93d
doc: cross-reference Octave:matlab-incompatible to --braindead and --traditional
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
15545
diff
changeset
|
276 warning, which you might want if you want to be told about writing code |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16880
diff
changeset
|
277 that works in Octave but not @sc{matlab} (@pxref{XREFwarning,,warning}, |
|
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16880
diff
changeset
|
278 @ref{XREFwarning_ids,,warning_ids}). |
|
15618
9aa8dcf1e93d
doc: cross-reference Octave:matlab-incompatible to --braindead and --traditional
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
15545
diff
changeset
|
279 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
280 @item --verbose |
| 3294 | 281 @itemx -V |
| 282 @cindex @code{--verbose} | |
| 283 @cindex @code{-V} | |
| 284 Turn on verbose output. | |
| 285 | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
286 @item --version |
| 3294 | 287 @itemx -v |
| 288 @cindex @code{--version} | |
| 289 @cindex @code{-v} | |
| 290 Print the program version number and exit. | |
| 291 | |
| 292 @item @var{file} | |
| 5190 | 293 Execute commands from @var{file}. Exit when done unless |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
294 @option{--persist} is also specified. |
| 3294 | 295 @end table |
| 296 | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
297 Octave also includes several functions which return information |
| 3294 | 298 about the command line, including the number of arguments and all of the |
| 299 options. | |
| 300 | |
| 3332 | 301 @DOCSTRING(argv) |
| 3294 | 302 |
| 6550 | 303 @DOCSTRING(program_name) |
| 304 | |
| 3332 | 305 @DOCSTRING(program_invocation_name) |
| 3294 | 306 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
307 Here is an example of using these functions to reproduce the command |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
308 line which invoked Octave. |
| 3294 | 309 |
| 310 @example | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
311 @group |
| 6479 | 312 printf ("%s", program_name ()); |
| 6620 | 313 arg_list = argv (); |
| 3294 | 314 for i = 1:nargin |
| 6479 | 315 printf (" %s", arg_list@{i@}); |
| 3294 | 316 endfor |
| 317 printf ("\n"); | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
318 @end group |
| 3294 | 319 @end example |
| 320 | |
| 321 @noindent | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
322 @xref{Indexing Cell Arrays}, for an explanation of how to retrieve objects |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
323 from cell arrays, and @ref{Defining Functions}, for information about the |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
324 variable @code{nargin}. |
| 3294 | 325 |
| 4167 | 326 @node Startup Files |
| 3294 | 327 @subsection Startup Files |
| 328 @cindex initialization | |
| 329 @cindex startup | |
| 330 | |
| 6620 | 331 When Octave starts, it looks for commands to execute from the files in |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
332 the following list. These files may contain any valid Octave commands, |
| 6620 | 333 including function definitions. |
| 3294 | 334 |
| 335 @cindex startup files | |
| 336 | |
| 337 @table @code | |
| 338 @item @var{octave-home}/share/octave/site/m/startup/octaverc | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
339 @cindex site startup file |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
340 where @var{octave-home} is the directory in which Octave is installed |
| 9906 | 341 (the default is @file{/usr/local}). |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
342 This file is provided so that changes to the default Octave environment |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
343 can be made globally for all users at your site for all versions of Octave |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
344 you have installed. Care should be taken when making changes to this file |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
345 since all users of Octave at your site will be affected. The default file |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
346 may be overridden by the environment variable @w{@env{OCTAVE_SITE_INITFILE}}. |
| 3294 | 347 |
| 348 @item @var{octave-home}/share/octave/@var{version}/m/startup/octaverc | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
349 @cindex version startup file |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
350 where @var{octave-home} is the directory in which Octave is |
| 9906 | 351 installed (the default is @file{/usr/local}), and @var{version} |
| 3294 | 352 is the version number of Octave. This file is provided so that changes |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
353 to the default Octave environment can be made globally for all users of |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
354 a particular version of Octave. Care should be taken when making |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
355 changes to this file since all users of Octave at your site will be |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
356 affected. The default file may be overridden by the environment variable |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
357 @w{@env{OCTAVE_VERSION_INITFILE}}. |
| 3294 | 358 |
| 359 @item ~/.octaverc | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
360 @cindex personal startup file |
| 3294 | 361 @cindex @code{~/.octaverc} |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
362 This file is used to make personal changes to the default |
| 3294 | 363 Octave environment. |
| 364 | |
| 365 @item .octaverc | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
366 @cindex project startup file |
| 3294 | 367 @cindex @code{.octaverc} |
| 368 This file can be used to make changes to the default Octave environment | |
| 369 for a particular project. Octave searches for this file in the current | |
| 370 directory after it reads @file{~/.octaverc}. Any use of the @code{cd} | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
371 command in the @file{~/.octaverc} file will affect the directory where |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
372 Octave searches for @file{.octaverc}. |
| 3294 | 373 |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
8015
diff
changeset
|
374 If you start Octave in your home directory, commands from the file |
| 3294 | 375 @file{~/.octaverc} will only be executed once. |
| 376 @end table | |
| 377 | |
| 378 A message will be displayed as each of the startup files is read if you | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
379 invoke Octave with the @option{--verbose} option but without the |
|
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
380 @option{--silent} option. |
| 3294 | 381 |
| 4167 | 382 @node Quitting Octave |
| 3294 | 383 @section Quitting Octave |
| 384 @cindex exiting octave | |
| 385 @cindex quitting octave | |
|
19307
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
386 @cindex finish.m |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
387 @cindex site exiting file |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
388 |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
389 Shutdown is initiated with the @code{exit} or @code{quit} commands (they are |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
390 equivalent). Similar to startup, Octave has a shutdown process that can be |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
391 customized by user script files. During shutdown Octave will search for the |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
392 script file @file{finish.m} in the function load path. Commands to save all |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
393 workspace variables or cleanup temporary files may be placed there. Additional |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
394 functions to execute on shutdown may be registered with @code{atexit}. |
| 3294 | 395 |
| 3332 | 396 @DOCSTRING(quit) |
| 3294 | 397 |
| 3332 | 398 @DOCSTRING(atexit) |
| 3294 | 399 |
| 4167 | 400 @node Getting Help |
| 3294 | 401 @section Commands for Getting Help |
|
15544
6a4e79110857
doc: Replace 'on-line' with modern 'online' in documentation and messages.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
402 @cindex online help |
|
6a4e79110857
doc: Replace 'on-line' with modern 'online' in documentation and messages.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
403 @cindex help, online |
| 3294 | 404 |
| 405 The entire text of this manual is available from the Octave prompt | |
| 6620 | 406 via the command @kbd{doc}. In addition, the documentation for |
| 3294 | 407 individual user-written functions and variables is also available via |
| 408 the @kbd{help} command. This section describes the commands used for | |
| 409 reading the manual and the documentation strings for user-supplied | |
| 410 functions and variables. @xref{Function Files}, for more information | |
| 411 about how to document the functions you write. | |
| 412 | |
| 3332 | 413 @DOCSTRING(help) |
| 3294 | 414 |
| 6549 | 415 @DOCSTRING(doc) |
| 416 | |
| 417 @DOCSTRING(lookfor) | |
| 418 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
419 To see what is new in the current release of Octave, use the @code{news} |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
420 function. |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
421 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
422 @DOCSTRING(news) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
423 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
424 @DOCSTRING(info) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
425 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
426 @DOCSTRING(warranty) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
427 |
|
9133
c0cef1436788
Update help text for sections 2.2 and 2.3 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9132
diff
changeset
|
428 The following functions can be used to change which programs are used |
| 6620 | 429 for displaying the documentation, and where the documentation can be |
| 430 found. | |
| 3294 | 431 |
| 6477 | 432 @DOCSTRING(info_file) |
| 3294 | 433 |
| 6477 | 434 @DOCSTRING(info_program) |
| 3294 | 435 |
| 6477 | 436 @DOCSTRING(makeinfo_program) |
| 3686 | 437 |
|
14618
36f451642f79
doc: Add texi_macros_file to manual.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
438 @DOCSTRING(texi_macros_file) |
|
36f451642f79
doc: Add texi_macros_file to manual.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
439 |
|
9133
c0cef1436788
Update help text for sections 2.2 and 2.3 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9132
diff
changeset
|
440 @DOCSTRING(doc_cache_file) |
|
c0cef1436788
Update help text for sections 2.2 and 2.3 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9132
diff
changeset
|
441 |
|
16807
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
442 @DOCSTRING(built_in_docstrings_file) |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
443 |
| 3332 | 444 @DOCSTRING(suppress_verbose_help_message) |
| 3294 | 445 |
|
12519
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
446 The following functions are principally used internally by Octave for |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
447 generating the documentation. They are documented here for completeness |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
448 and because they may occasionally be useful for users. |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
449 |
|
16872
5372068bb148
Rename gen_doc_cache() to doc_cache_create().
Rik <rik@octave.org>
parents:
16816
diff
changeset
|
450 @DOCSTRING(doc_cache_create) |
|
12519
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
451 |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
452 @DOCSTRING(get_help_text) |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
453 |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
454 @DOCSTRING(get_help_text_from_file) |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
455 |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
456 @DOCSTRING(get_first_help_sentence) |
|
91ccd08fe80c
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12175
diff
changeset
|
457 |
| 4167 | 458 @node Command Line Editing |
| 3294 | 459 @section Command Line Editing |
| 460 @cindex command-line editing | |
| 461 @cindex editing the command line | |
| 462 | |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
463 Octave uses the GNU Readline library to provide an extensive set of |
| 3294 | 464 command-line editing and history features. Only the most common |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
465 features are described in this manual. In addition, all of the editing |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
466 functions can be bound to different key strokes at the user's discretion. |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
467 This manual assumes no changes from the default Emacs bindings. See the GNU |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
468 Readline Library manual for more information on customizing Readline and |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
469 for a complete feature list. |
| 3294 | 470 |
| 471 To insert printing characters (letters, digits, symbols, etc.), simply | |
| 472 type the character. Octave will insert the character at the cursor and | |
| 473 advance the cursor forward. | |
| 474 | |
| 475 Many of the command-line editing functions operate using control | |
| 476 characters. For example, the character @kbd{Control-a} moves the cursor | |
| 477 to the beginning of the line. To type @kbd{C-a}, hold down @key{CTRL} | |
| 478 and then press @key{a}. In the following sections, control characters | |
| 479 such as @kbd{Control-a} are written as @kbd{C-a}. | |
| 480 | |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
481 Another set of command-line editing functions use Meta characters. To |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
482 type @kbd{M-u}, hold down the @key{META} key and press @key{u}. Depending |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
483 on the keyboard, the @key{META} key may be labeled @key{ALT} or |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
484 even @key{WINDOWS}. If your terminal does not have a @key{META} key, you |
| 7001 | 485 can still type Meta characters using two-character sequences starting |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
486 with @kbd{ESC}. Thus, to enter @kbd{M-u}, you would type |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
487 @key{ESC} @key{u}. The @kbd{ESC} character sequences are also allowed on |
| 3294 | 488 terminals with real Meta keys. In the following sections, Meta |
| 489 characters such as @kbd{Meta-u} are written as @kbd{M-u}. | |
| 490 | |
| 3428 | 491 |
| 3294 | 492 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
493 * Cursor Motion:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
494 * Killing and Yanking:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
495 * Commands For Text:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
496 * Commands For Completion:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
497 * Commands For History:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
498 * Customizing readline:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
499 * Customizing the Prompt:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
500 * Diary and Echo Commands:: |
| 3294 | 501 @end menu |
| 502 | |
| 4167 | 503 @node Cursor Motion |
| 3294 | 504 @subsection Cursor Motion |
| 505 | |
| 506 The following commands allow you to position the cursor. | |
| 507 | |
| 508 @table @kbd | |
| 509 @item C-b | |
| 510 Move back one character. | |
| 511 | |
| 512 @item C-f | |
| 513 Move forward one character. | |
| 514 | |
|
11487
0f14c093476e
Add <BACKSPACE> documentation to cursor movement section.
Rik <octave@nomad.inbox5.com>
parents:
11486
diff
changeset
|
515 @item @key{BACKSPACE} |
|
0f14c093476e
Add <BACKSPACE> documentation to cursor movement section.
Rik <octave@nomad.inbox5.com>
parents:
11486
diff
changeset
|
516 Delete the character to the left of the cursor. |
|
0f14c093476e
Add <BACKSPACE> documentation to cursor movement section.
Rik <octave@nomad.inbox5.com>
parents:
11486
diff
changeset
|
517 |
| 3294 | 518 @item @key{DEL} |
|
11487
0f14c093476e
Add <BACKSPACE> documentation to cursor movement section.
Rik <octave@nomad.inbox5.com>
parents:
11486
diff
changeset
|
519 Delete the character underneath the cursor. |
| 3294 | 520 |
| 521 @item C-d | |
| 522 Delete the character underneath the cursor. | |
| 523 | |
| 524 @item M-f | |
| 525 Move forward a word. | |
| 526 | |
| 527 @item M-b | |
| 528 Move backward a word. | |
| 529 | |
| 530 @item C-a | |
| 531 Move to the start of the line. | |
| 532 | |
| 533 @item C-e | |
| 534 Move to the end of the line. | |
| 535 | |
| 536 @item C-l | |
| 537 Clear the screen, reprinting the current line at the top. | |
| 538 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
539 @item C-_ |
| 3294 | 540 @itemx C-/ |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
541 Undo the last action. You can undo all the way back to an empty line. |
| 3294 | 542 |
| 543 @item M-r | |
| 544 Undo all changes made to this line. This is like typing the `undo' | |
| 545 command enough times to get back to the beginning. | |
| 546 @end table | |
| 547 | |
| 548 The above table describes the most basic possible keystrokes that you need | |
| 549 in order to do editing of the input line. On most terminals, you can | |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
550 also use the left and right arrow keys in place of @kbd{C-f} and @kbd{C-b} |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
551 to move forward and backward. |
| 3294 | 552 |
| 553 Notice how @kbd{C-f} moves forward a character, while @kbd{M-f} moves | |
| 554 forward a word. It is a loose convention that control keystrokes | |
| 555 operate on characters while meta keystrokes operate on words. | |
| 556 | |
| 557 @cindex clearing the screen | |
| 558 | |
| 6620 | 559 The function @code{clc} will allow you to clear the screen from within |
| 560 Octave programs. | |
| 561 | |
| 3332 | 562 @DOCSTRING(clc) |
| 3294 | 563 |
| 4167 | 564 @node Killing and Yanking |
| 3294 | 565 @subsection Killing and Yanking |
| 566 | |
| 567 @dfn{Killing} text means to delete the text from the line, but to save | |
| 568 it away for later use, usually by @dfn{yanking} it back into the line. | |
| 569 If the description for a command says that it `kills' text, then you can | |
| 570 be sure that you can get the text back in a different (or the same) | |
| 571 place later. | |
| 572 | |
| 573 Here is the list of commands for killing text. | |
| 574 | |
| 575 @table @kbd | |
| 576 @item C-k | |
| 577 Kill the text from the current cursor position to the end of the line. | |
| 578 | |
| 579 @item M-d | |
| 580 Kill from the cursor to the end of the current word, or if between | |
| 581 words, to the end of the next word. | |
| 582 | |
| 583 @item M-@key{DEL} | |
| 584 Kill from the cursor to the start of the previous word, or if between | |
| 585 words, to the start of the previous word. | |
| 586 | |
| 587 @item C-w | |
| 588 Kill from the cursor to the previous whitespace. This is different than | |
| 589 @kbd{M-@key{DEL}} because the word boundaries differ. | |
| 590 @end table | |
| 591 | |
| 592 And, here is how to @dfn{yank} the text back into the line. Yanking | |
| 593 means to copy the most-recently-killed text from the kill buffer. | |
| 594 | |
| 595 @table @kbd | |
| 596 @item C-y | |
| 597 Yank the most recently killed text back into the buffer at the cursor. | |
| 598 | |
| 599 @item M-y | |
| 600 Rotate the kill-ring, and yank the new top. You can only do this if | |
| 601 the prior command is @kbd{C-y} or @kbd{M-y}. | |
| 602 @end table | |
| 603 | |
| 604 When you use a kill command, the text is saved in a @dfn{kill-ring}. | |
| 605 Any number of consecutive kills save all of the killed text together, so | |
| 606 that when you yank it back, you get it in one clean sweep. The kill | |
| 607 ring is not line specific; the text that you killed on a previously | |
| 608 typed line is available to be yanked back later, when you are typing | |
| 609 another line. | |
| 610 | |
| 4167 | 611 @node Commands For Text |
| 3294 | 612 @subsection Commands For Changing Text |
| 613 | |
| 614 The following commands can be used for entering characters that would | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
615 otherwise have a special meaning (e.g., @key{TAB}, @kbd{C-q}, etc.), or |
| 3294 | 616 for quickly correcting typing mistakes. |
| 617 | |
| 618 @table @kbd | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
619 @item C-q |
| 3294 | 620 @itemx C-v |
| 621 Add the next character that you type to the line verbatim. This is | |
| 622 how to insert things like @kbd{C-q} for example. | |
| 623 | |
| 624 @item M-@key{TAB} | |
| 625 Insert a tab character. | |
| 626 | |
| 627 @item C-t | |
| 628 Drag the character before the cursor forward over the character at the | |
| 629 cursor, also moving the cursor forward. If the cursor is at the end of | |
| 630 the line, then transpose the two characters before it. | |
| 631 | |
| 632 @item M-t | |
| 633 Drag the word behind the cursor past the word in front of the cursor | |
| 634 moving the cursor over that word as well. | |
| 635 | |
| 636 @item M-u | |
| 637 Uppercase the characters following the cursor to the end of the current | |
| 638 (or following) word, moving the cursor to the end of the word. | |
| 639 | |
| 640 @item M-l | |
| 6620 | 641 Lowercase the characters following the cursor to the end of the current |
| 3294 | 642 (or following) word, moving the cursor to the end of the word. |
| 643 | |
| 644 @item M-c | |
| 645 Uppercase the character following the cursor (or the beginning of the | |
| 646 next word if the cursor is between words), moving the cursor to the end | |
| 647 of the word. | |
| 648 @end table | |
| 649 | |
| 4167 | 650 @node Commands For Completion |
| 3294 | 651 @subsection Letting Readline Type For You |
| 652 @cindex command completion | |
| 653 | |
| 654 The following commands allow Octave to complete command and variable | |
| 655 names for you. | |
| 656 | |
| 657 @table @kbd | |
| 658 @item @key{TAB} | |
| 659 Attempt to do completion on the text before the cursor. Octave can | |
| 660 complete the names of commands and variables. | |
| 661 | |
| 662 @item M-? | |
| 663 List the possible completions of the text before the cursor. | |
| 664 @end table | |
| 665 | |
| 3332 | 666 @DOCSTRING(completion_append_char) |
| 3294 | 667 |
| 3332 | 668 @DOCSTRING(completion_matches) |
| 3294 | 669 |
| 4167 | 670 @node Commands For History |
| 3294 | 671 @subsection Commands For Manipulating The History |
| 672 @cindex command history | |
| 673 @cindex input history | |
| 674 @cindex history of commands | |
| 675 | |
| 676 Octave normally keeps track of the commands you type so that you can | |
| 677 recall previous commands to edit or execute them again. When you exit | |
| 678 Octave, the most recent commands you have typed, up to the number | |
| 679 specified by the variable @code{history_size}, are saved in a file. | |
| 680 When Octave starts, it loads an initial list of commands from the file | |
| 681 named by the variable @code{history_file}. | |
| 682 | |
| 683 Here are the commands for simple browsing and searching the history | |
| 684 list. | |
| 685 | |
| 686 @table @kbd | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
687 @item @key{LFD} |
| 3294 | 688 @itemx @key{RET} |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
689 Accept the current line regardless of where the cursor is. If the line is |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
690 non-empty, add it to the history list. If the line was a history |
| 3294 | 691 line, then restore the history line to its original state. |
| 692 | |
| 693 @item C-p | |
| 694 Move `up' through the history list. | |
| 695 | |
| 696 @item C-n | |
| 697 Move `down' through the history list. | |
| 698 | |
| 699 @item M-< | |
| 700 Move to the first line in the history. | |
| 701 | |
| 702 @item M-> | |
| 703 Move to the end of the input history, i.e., the line you are entering! | |
| 704 | |
| 705 @item C-r | |
| 706 Search backward starting at the current line and moving `up' through | |
| 707 the history as necessary. This is an incremental search. | |
| 708 | |
| 709 @item C-s | |
| 710 Search forward starting at the current line and moving `down' through | |
| 711 the history as necessary. | |
| 712 @end table | |
| 713 | |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
714 On most terminals, you can also use the up and down arrow keys in place |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
715 of @kbd{C-p} and @kbd{C-n} to move through the history list. |
| 3294 | 716 |
| 717 In addition to the keyboard commands for moving through the history | |
| 718 list, Octave provides three functions for viewing, editing, and | |
| 719 re-running chunks of commands from the history list. | |
| 720 | |
| 3332 | 721 @DOCSTRING(history) |
| 3294 | 722 |
| 3332 | 723 @DOCSTRING(edit_history) |
| 3294 | 724 |
| 3332 | 725 @DOCSTRING(run_history) |
| 3294 | 726 |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
727 @noindent |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
728 Octave also allows you customize the details of when, where, and how history |
| 6620 | 729 is saved. |
| 3294 | 730 |
|
16876
9e0618443c2b
Rename saving_history() to history_save().
Rik <rik@octave.org>
parents:
16875
diff
changeset
|
731 @DOCSTRING(history_save) |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
732 |
|
11486
a1deab9a6e71
bash-like history control
Pascal Dupuis <Pascal.Dupuis@worldonline.be> and John W. Eaton <jwe@octave.org>
parents:
10846
diff
changeset
|
733 @DOCSTRING(history_control) |
|
a1deab9a6e71
bash-like history control
Pascal Dupuis <Pascal.Dupuis@worldonline.be> and John W. Eaton <jwe@octave.org>
parents:
10846
diff
changeset
|
734 |
| 3332 | 735 @DOCSTRING(history_file) |
| 3294 | 736 |
| 3332 | 737 @DOCSTRING(history_size) |
| 3294 | 738 |
| 6550 | 739 @DOCSTRING(history_timestamp_format_string) |
| 740 | |
| 6620 | 741 @DOCSTRING(EDITOR) |
| 742 | |
| 4167 | 743 @node Customizing readline |
| 3428 | 744 @subsection Customizing @code{readline} |
|
12175
2090995ca588
Correct en-dash,em-dash instances in docstrings.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
745 @cindex @code{~/.inputrc} |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
746 @cindex customizing @code{readline} |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
747 @cindex @code{readline} customization |
| 3428 | 748 |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
749 Octave uses the GNU Readline library for command-line editing and |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
750 history features. Readline is very flexible and can be modified through |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
751 a configuration file of commands (See the GNU Readline library for the |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
752 exact command syntax). The default configuration file is normally |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
753 @file{~/.inputrc}. |
| 6620 | 754 |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
755 Octave provides two commands for initializing Readline and thereby changing |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
756 the command line behavior. |
| 3428 | 757 |
|
16879
cc3743a91652
Rename read_readline_init_file to readline_read_init_file.
Rik <rik@octave.org>
parents:
16877
diff
changeset
|
758 @DOCSTRING(readline_read_init_file) |
| 3428 | 759 |
|
16880
1aebb613a5ac
Rename re_read_readline_init_file to readline_re_read_init_file.
Rik <rik@octave.org>
parents:
16879
diff
changeset
|
760 @DOCSTRING(readline_re_read_init_file) |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
761 |
| 4167 | 762 @node Customizing the Prompt |
| 3294 | 763 @subsection Customizing the Prompt |
| 764 @cindex prompt customization | |
| 765 @cindex customizing the prompt | |
| 766 | |
| 767 The following variables are available for customizing the appearance of | |
| 768 the command-line prompts. Octave allows the prompt to be customized by | |
| 769 inserting a number of backslash-escaped special characters that are | |
| 770 decoded as follows: | |
| 771 | |
| 772 @table @samp | |
| 773 @item \t | |
| 774 The time. | |
| 775 | |
| 776 @item \d | |
| 777 The date. | |
| 778 | |
| 779 @item \n | |
| 780 Begins a new line by printing the equivalent of a carriage return | |
| 781 followed by a line feed. | |
| 782 | |
| 783 @item \s | |
| 784 The name of the program (usually just @samp{octave}). | |
| 785 | |
| 786 @item \w | |
| 787 The current working directory. | |
| 788 | |
| 789 @item \W | |
| 790 The basename of the current working directory. | |
| 791 | |
| 792 @item \u | |
| 793 The username of the current user. | |
| 794 | |
| 795 @item \h | |
| 796 The hostname, up to the first `.'. | |
| 797 | |
| 798 @item \H | |
| 799 The hostname. | |
| 800 | |
| 801 @item \# | |
| 802 The command number of this command, counting from when Octave starts. | |
| 803 | |
| 804 @item \! | |
| 805 The history number of this command. This differs from @samp{\#} by the | |
| 806 number of commands in the history list when Octave starts. | |
| 807 | |
| 808 @item \$ | |
| 809 If the effective UID is 0, a @samp{#}, otherwise a @samp{$}. | |
| 810 | |
| 811 @item \nnn | |
| 812 The character whose character code in octal is @var{nnn}. | |
| 813 | |
| 814 @item \\ | |
| 815 A backslash. | |
| 816 @end table | |
| 817 | |
| 3332 | 818 @DOCSTRING(PS1) |
| 3294 | 819 |
| 3332 | 820 @DOCSTRING(PS2) |
| 3294 | 821 |
| 3332 | 822 @DOCSTRING(PS4) |
| 3294 | 823 |
| 4167 | 824 @node Diary and Echo Commands |
| 3294 | 825 @subsection Diary and Echo Commands |
| 826 @cindex diary of commands and output | |
| 6939 | 827 @cindex command and output logs |
| 3294 | 828 @cindex logging commands and output |
| 829 @cindex echoing executing commands | |
| 830 @cindex command echoing | |
| 831 | |
| 832 Octave's diary feature allows you to keep a log of all or part of an | |
| 833 interactive session by recording the input you type and the output that | |
| 834 Octave produces in a separate file. | |
| 835 | |
| 3332 | 836 @DOCSTRING(diary) |
| 3294 | 837 |
| 838 Sometimes it is useful to see the commands in a function or script as | |
| 839 they are being evaluated. This can be especially helpful for debugging | |
| 840 some kinds of problems. | |
| 841 | |
| 3332 | 842 @DOCSTRING(echo) |
| 3294 | 843 |
| 3332 | 844 @DOCSTRING(echo_executing_commands) |
| 3294 | 845 |
| 4167 | 846 @node Errors |
| 3294 | 847 @section How Octave Reports Errors |
| 848 @cindex error messages | |
| 849 @cindex messages, error | |
| 850 | |
| 851 Octave reports two kinds of errors for invalid programs. | |
| 852 | |
| 853 A @dfn{parse error} occurs if Octave cannot understand something you | |
| 854 have typed. For example, if you misspell a keyword, | |
| 855 | |
| 856 @example | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
857 octave:13> function y = f (x) y = x***2; endfunction |
| 3294 | 858 @end example |
| 859 | |
| 860 @noindent | |
| 861 Octave will respond immediately with a message like this: | |
| 862 | |
| 863 @example | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
864 @group |
| 3294 | 865 parse error: |
| 866 | |
|
8015
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
867 syntax error |
|
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
868 |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
869 >>> function y = f (x) y = x***2; endfunction |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
870 ^ |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
871 @end group |
| 3294 | 872 @end example |
| 873 | |
| 874 @noindent | |
| 875 For most parse errors, Octave uses a caret (@samp{^}) to mark the point | |
| 876 on the line where it was unable to make sense of your input. In this | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
877 case, Octave generated an error message because the keyword for |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
878 exponentiation (@code{**}) was misspelled. It marked the error at the |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
879 third @samp{*} because the code leading up to this was correct but the final |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
880 @samp{*} was not understood. |
| 3294 | 881 |
| 882 Another class of error message occurs at evaluation time. These | |
| 883 errors are called @dfn{run-time errors}, or sometimes | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
884 @dfn{evaluation errors}, because they occur when your program is being |
| 3294 | 885 @dfn{run}, or @dfn{evaluated}. For example, if after correcting the |
| 886 mistake in the previous function definition, you type | |
| 887 | |
| 888 @example | |
| 889 octave:13> f () | |
| 890 @end example | |
| 891 | |
| 892 @noindent | |
| 893 Octave will respond with | |
| 894 | |
|
9153
5247e89688e1
Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents:
9135
diff
changeset
|
895 @example |
| 3294 | 896 @group |
| 897 error: `x' undefined near line 1 column 24 | |
|
8015
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
898 error: called from: |
|
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
899 error: f at line 1, column 22 |
| 3294 | 900 @end group |
|
9153
5247e89688e1
Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents:
9135
diff
changeset
|
901 @end example |
| 3294 | 902 |
| 6620 | 903 @noindent |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
904 This error message has several parts, and gives quite a bit of |
| 3294 | 905 information to help you locate the source of the error. The messages |
| 906 are generated from the point of the innermost error, and provide a | |
| 907 traceback of enclosing expressions and function calls. | |
| 908 | |
| 909 In the example above, the first line indicates that a variable named | |
| 910 @samp{x} was found to be undefined near line 1 and column 24 of some | |
| 911 function or expression. For errors occurring within functions, lines | |
| 912 are counted from the beginning of the file containing the function | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
913 definition. For errors occurring outside of an enclosing function, |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
914 the line number indicates the input line number, which is usually displayed |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
915 in the primary prompt string. |
| 3294 | 916 |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
917 The second and third lines of the error message indicate that the error |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
918 occurred within the function @code{f}. If the function @code{f} had been |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
919 called from within another function, for example, @code{g}, the list of |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
920 errors would have ended with one more line: |
| 3294 | 921 |
| 922 @example | |
|
8015
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
923 error: g at line 1, column 17 |
| 3294 | 924 @end example |
| 925 | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
926 These lists of function calls make it fairly easy to trace the |
| 3294 | 927 path your program took before the error occurred, and to correct the |
| 928 error before trying again. | |
| 929 | |
| 4167 | 930 @node Executable Octave Programs |
| 3294 | 931 @section Executable Octave Programs |
| 932 @cindex executable scripts | |
| 933 @cindex scripts | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
934 @cindex batch processing |
| 3294 | 935 @cindex self contained programs |
| 936 @cindex program, self contained | |
| 937 @cindex @samp{#!} | |
| 938 | |
| 939 Once you have learned Octave, you may want to write self-contained | |
| 940 Octave scripts, using the @samp{#!} script mechanism. You can do this | |
| 941 on GNU systems and on many Unix systems @footnote{The @samp{#!} | |
| 942 mechanism works on Unix systems derived from Berkeley Unix, System V | |
| 6481 | 943 Release 4, and some System V Release 3 systems.}. |
| 944 | |
| 945 Self-contained Octave scripts are useful when you want to write a | |
| 946 program which users can invoke without knowing that the program is | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
947 written in the Octave language. Octave scripts are also used for batch |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
948 processing of data files. Once an algorithm has been developed and tested |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
949 in the interactive portion of Octave, it can be committed to an executable |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
950 script and used again and again on new data files. |
| 3294 | 951 |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
952 As a trivial example of an executable Octave script, you might create a |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
953 text file named @file{hello}, containing the following lines: |
| 3294 | 954 |
| 955 @example | |
| 956 @group | |
| 957 #! @var{octave-interpreter-name} -qf | |
| 958 # a sample Octave program | |
| 959 printf ("Hello, world!\n"); | |
| 960 @end group | |
| 961 @end example | |
| 962 | |
| 963 @noindent | |
| 964 (where @var{octave-interpreter-name} should be replaced with the full | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
965 path and name of your Octave binary). Note that this will only work if |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
966 @samp{#!} appears at the very beginning of the file. After making the |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
967 file executable (with the @code{chmod} command on Unix systems), you can |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
968 simply type: |
| 3294 | 969 |
| 970 @example | |
| 971 hello | |
| 972 @end example | |
| 973 | |
| 974 @noindent | |
| 975 at the shell, and the system will arrange to run Octave as if you had | |
| 976 typed: | |
| 977 | |
| 978 @example | |
| 979 octave hello | |
| 980 @end example | |
| 981 | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
982 The line beginning with @samp{#!} lists the full path and filename of an |
| 3294 | 983 interpreter to be run, and an optional initial command line argument to |
| 984 pass to that interpreter. The operating system then runs the | |
| 985 interpreter with the given argument and the full argument list of the | |
| 986 executed program. The first argument in the list is the full file name | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
987 of the Octave executable. The rest of the argument list will either be |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
988 options to Octave, or data files, or both. The @samp{-qf} options are |
| 3294 | 989 usually specified in stand-alone Octave programs to prevent them from |
| 990 printing the normal startup message, and to keep them from behaving | |
| 991 differently depending on the contents of a particular user's | |
| 6620 | 992 @file{~/.octaverc} file. @xref{Invoking Octave from the Command Line}. |
| 6481 | 993 |
| 994 Note that some operating systems may place a limit on the number of | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
995 characters that are recognized after @samp{#!}. Also, the arguments |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
996 appearing in a @samp{#!} line are parsed differently by various |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
997 shells/systems. The majority of them group all the arguments together in one |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
998 string and pass it to the interpreter as a single argument. In this case, the |
| 6481 | 999 following script: |
| 1000 | |
| 1001 @example | |
| 1002 @group | |
| 1003 #! @var{octave-interpreter-name} -q -f # comment | |
| 1004 @end group | |
| 1005 @end example | |
| 1006 | |
| 1007 @noindent | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1008 is equivalent to typing at the command line: |
| 3294 | 1009 |
| 6481 | 1010 @example |
| 1011 @group | |
| 1012 octave "-q -f # comment" | |
| 1013 @end group | |
| 1014 @end example | |
| 3294 | 1015 |
| 6481 | 1016 @noindent |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1017 which will produce an error message. Unfortunately, it is |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1018 not possible for Octave to determine whether it has been called from the |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1019 command line or from a @samp{#!} script, so some care is needed when using the |
| 6481 | 1020 @samp{#!} mechanism. |
| 1021 | |
| 1022 Note that when Octave is started from an executable script, the built-in | |
| 1023 function @code{argv} returns a cell array containing the command line | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1024 arguments passed to the executable Octave script, not the arguments |
| 6481 | 1025 passed to the Octave interpreter on the @samp{#!} line of the script. |
| 1026 For example, the following program will reproduce the command line that | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1027 was used to execute the script, not @samp{-qf}. |
| 3294 | 1028 |
| 1029 @example | |
| 1030 @group | |
| 1031 #! /bin/octave -qf | |
| 6479 | 1032 printf ("%s", program_name ()); |
| 6620 | 1033 arg_list = argv (); |
| 3294 | 1034 for i = 1:nargin |
| 6479 | 1035 printf (" %s", arg_list@{i@}); |
| 3294 | 1036 endfor |
| 1037 printf ("\n"); | |
| 1038 @end group | |
| 1039 @end example | |
| 1040 | |
| 4167 | 1041 @node Comments |
| 3294 | 1042 @section Comments in Octave Programs |
| 1043 @cindex comments | |
| 1044 @cindex use of comments | |
| 1045 @cindex documenting Octave programs | |
| 1046 | |
| 1047 A @dfn{comment} is some text that is included in a program for the sake | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1048 of human readers, and which is NOT an executable part of the program. |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1049 Comments can explain what the program does, and how it works. Nearly all |
| 3294 | 1050 programming languages have provisions for comments, because programs are |
| 1051 typically hard to understand without them. | |
| 1052 | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1053 @menu |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1054 * Single Line Comments:: |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1055 * Block Comments:: |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
1056 * Comments and the Help System:: |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1057 @end menu |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1058 |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1059 @node Single Line Comments |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1060 @subsection Single Line Comments |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1061 @cindex @samp{#} |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1062 @cindex @samp{%} |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1063 |
| 3294 | 1064 In the Octave language, a comment starts with either the sharp sign |
| 1065 character, @samp{#}, or the percent symbol @samp{%} and continues to the | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1066 end of the line. Any text following the sharp sign or percent symbol is |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1067 ignored by the Octave interpreter and not executed. The following example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1068 shows whole line and partial line comments. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
1069 |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1070 @example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1071 @group |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1072 function countdown |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1073 # Count down for main rocket engines |
|
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1074 disp (3); |
|
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1075 disp (2); |
|
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1076 disp (1); |
|
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1077 disp ("Blast Off!"); # Rocket leaves pad |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1078 endfunction |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1079 @end group |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1080 @end example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1081 |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1082 @node Block Comments |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1083 @subsection Block Comments |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1084 @cindex block comments |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1085 @cindex multi-line comments |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1086 @cindex @samp{#@{} |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1087 @cindex @samp{%@{} |
| 3294 | 1088 |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1089 Entire blocks of code can be commented by enclosing the code between |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1090 matching @samp{#@{} and @samp{#@}} or @samp{%@{} and @samp{%@}} markers. |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1091 For example, |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
1092 |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1093 @example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1094 @group |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1095 function quick_countdown |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1096 # Count down for main rocket engines |
|
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1097 disp (3); |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1098 #@{ |
|
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1099 disp (2); |
|
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1100 disp (1); |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1101 #@} |
|
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1102 disp ("Blast Off!"); # Rocket leaves pad |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1103 endfunction |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1104 @end group |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1105 @end example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1106 |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1107 @noindent |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1108 will produce a very quick countdown from @qcode{'3'} to @qcode{"Blast Off"} as |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1109 the lines "@code{disp (2);}" and "@code{disp (1);}" won't be executed. |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1110 |
|
12680
1acead61c527
doc: Document that block comment markers must appear alone on a line (bug #33297)
Rik <octave@nomad.inbox5.com>
parents:
12545
diff
changeset
|
1111 The block comment markers must appear alone as the only characters on a line |
|
14038
b0cdd60db5e5
doc: Grammarcheck documentation ahead of 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents:
12691
diff
changeset
|
1112 (excepting whitespace) in order to be parsed correctly. |
|
12680
1acead61c527
doc: Document that block comment markers must appear alone on a line (bug #33297)
Rik <octave@nomad.inbox5.com>
parents:
12545
diff
changeset
|
1113 |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1114 @node Comments and the Help System |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1115 @subsection Comments and the Help System |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1116 @cindex documenting functions |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1117 @cindex documenting user scripts |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1118 @cindex help, user-defined functions |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1119 |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1120 The @code{help} command (@pxref{Getting Help}) is able to find the first |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1121 block of comments in a function and return those as a documentation |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1122 string. This means that the same commands used to get help |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1123 on built-in functions are available for properly formatted user-defined |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1124 functions. For example, after defining the function @code{f} below, |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
1125 |
| 3294 | 1126 @example |
| 1127 @group | |
| 1128 function xdot = f (x, t) | |
| 1129 | |
| 1130 # usage: f (x, t) | |
| 1131 # | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1132 # This function defines the right-hand |
| 3294 | 1133 # side functions for a set of nonlinear |
| 1134 # differential equations. | |
| 1135 | |
| 1136 r = 0.25; | |
| 1137 @dots{} | |
| 1138 endfunction | |
| 1139 @end group | |
| 1140 @end example | |
| 1141 | |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1142 @noindent |
| 3294 | 1143 the command @kbd{help f} produces the output |
| 1144 | |
| 1145 @example | |
| 1146 @group | |
| 1147 usage: f (x, t) | |
| 1148 | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1149 This function defines the right-hand |
| 3294 | 1150 side functions for a set of nonlinear |
| 1151 differential equations. | |
| 1152 @end group | |
| 1153 @end example | |
| 1154 | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1155 Although it is possible to put comment lines into keyboard-composed, |
|
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1156 throw-away Octave programs, it usually isn't very useful because the |
| 3294 | 1157 purpose of a comment is to help you or another person understand the |
| 1158 program at a later time. | |
| 1159 | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1160 The @code{help} parser currently only recognizes single line comments |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1161 (@pxref{Single Line Comments}) and not block comments for the initial |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1162 help text. |