Mercurial > octave-nkf
annotate doc/interpreter/basics.txi @ 19630:0e1f5a750d00
maint: Periodic merge of gui-release to default.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 20 Jan 2015 10:24:46 -0500 |
| parents | b39cbe9f3bb0 fe689210525c |
| children | 4197fc428c7d |
| 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. | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
9 @c |
| 7018 | 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. | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
14 @c |
| 7018 | 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}} | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
129 Add path to the head of the search path for images. The value of |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
130 @var{path} specified on the command line will override any value of |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
131 @w{@env{OCTAVE_IMAGE_PATH}} found in the environment, but not any commands |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
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} |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
184 Don't initialize the search path for function files to include default |
|
9132
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}} | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
213 Add path to the head of the search path for function files. The |
|
9132
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 |
|
19428
b39cbe9f3bb0
allow ranges to be disabled
John W. Eaton <jwe@octave.org>
parents:
19425
diff
changeset
|
252 disable_range = 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
|
253 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
|
254 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
|
255 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
|
256 print_empty_dimensions = false |
|
19425
385499581a5e
allow disabling of permutation and diagonal matrices
John W. Eaton <jwe@octave.org>
parents:
19308
diff
changeset
|
257 save_default_options = "-mat-binary" |
|
18153
5971c8f515a7
doc: Document options set when using --traditional.
Rik <rik@octave.org>
parents:
17793
diff
changeset
|
258 struct_levels_to_print = 0 |
| 6556 | 259 @end group |
| 260 @end example | |
| 261 | |
| 262 @noindent | |
| 263 and disable the following warnings | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
264 |
| 6556 | 265 @example |
| 266 @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
|
267 Octave:abbreviated-property-match |
| 7031 | 268 Octave:fopen-file-in-path |
| 269 Octave:function-name-clash | |
| 270 Octave:load-file-in-path | |
|
18153
5971c8f515a7
doc: Document options set when using --traditional.
Rik <rik@octave.org>
parents:
17793
diff
changeset
|
271 Octave:possible-matlab-short-circuit-operator |
| 4455 | 272 @end group |
| 3294 | 273 @end example |
| 274 | |
|
15618
9aa8dcf1e93d
doc: cross-reference Octave:matlab-incompatible to --braindead and --traditional
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
15545
diff
changeset
|
275 @noindent |
|
9aa8dcf1e93d
doc: cross-reference Octave:matlab-incompatible to --braindead and --traditional
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
15545
diff
changeset
|
276 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
|
277 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
|
278 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
|
279 @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
|
280 |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
281 @item --verbose |
| 3294 | 282 @itemx -V |
| 283 @cindex @code{--verbose} | |
| 284 @cindex @code{-V} | |
| 285 Turn on verbose output. | |
| 286 | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
287 @item --version |
| 3294 | 288 @itemx -v |
| 289 @cindex @code{--version} | |
| 290 @cindex @code{-v} | |
| 291 Print the program version number and exit. | |
| 292 | |
| 293 @item @var{file} | |
| 5190 | 294 Execute commands from @var{file}. Exit when done unless |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
295 @option{--persist} is also specified. |
| 3294 | 296 @end table |
| 297 | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
298 Octave also includes several functions which return information |
| 3294 | 299 about the command line, including the number of arguments and all of the |
| 300 options. | |
| 301 | |
| 3332 | 302 @DOCSTRING(argv) |
| 3294 | 303 |
| 6550 | 304 @DOCSTRING(program_name) |
| 305 | |
| 3332 | 306 @DOCSTRING(program_invocation_name) |
| 3294 | 307 |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
308 Here is an example of using these functions to reproduce the command |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
309 line which invoked Octave. |
| 3294 | 310 |
| 311 @example | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
312 @group |
| 6479 | 313 printf ("%s", program_name ()); |
| 6620 | 314 arg_list = argv (); |
| 3294 | 315 for i = 1:nargin |
| 6479 | 316 printf (" %s", arg_list@{i@}); |
| 3294 | 317 endfor |
| 318 printf ("\n"); | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
319 @end group |
| 3294 | 320 @end example |
| 321 | |
| 322 @noindent | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
323 @xref{Indexing Cell Arrays}, for an explanation of how to retrieve objects |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
324 from cell arrays, and @ref{Defining Functions}, for information about the |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
325 variable @code{nargin}. |
| 3294 | 326 |
| 4167 | 327 @node Startup Files |
| 3294 | 328 @subsection Startup Files |
| 329 @cindex initialization | |
| 330 @cindex startup | |
| 331 | |
| 6620 | 332 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
|
333 the following list. These files may contain any valid Octave commands, |
| 6620 | 334 including function definitions. |
| 3294 | 335 |
| 336 @cindex startup files | |
| 337 | |
| 338 @table @code | |
| 339 @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
|
340 @cindex site startup file |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
341 where @var{octave-home} is the directory in which Octave is installed |
| 9906 | 342 (the default is @file{/usr/local}). |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
343 This file is provided so that changes to the default Octave environment |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
344 can be made globally for all users at your site for all versions of Octave |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
345 you have installed. Care should be taken when making changes to this file |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
346 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
|
347 may be overridden by the environment variable @w{@env{OCTAVE_SITE_INITFILE}}. |
| 3294 | 348 |
| 349 @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
|
350 @cindex version startup file |
|
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
351 where @var{octave-home} is the directory in which Octave is |
| 9906 | 352 installed (the default is @file{/usr/local}), and @var{version} |
| 3294 | 353 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
|
354 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
|
355 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
|
356 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
|
357 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
|
358 @w{@env{OCTAVE_VERSION_INITFILE}}. |
| 3294 | 359 |
| 360 @item ~/.octaverc | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
361 @cindex personal startup file |
| 3294 | 362 @cindex @code{~/.octaverc} |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
363 This file is used to make personal changes to the default |
| 3294 | 364 Octave environment. |
| 365 | |
| 366 @item .octaverc | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
367 @cindex project startup file |
| 3294 | 368 @cindex @code{.octaverc} |
| 369 This file can be used to make changes to the default Octave environment | |
| 370 for a particular project. Octave searches for this file in the current | |
| 371 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
|
372 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
|
373 Octave searches for @file{.octaverc}. |
| 3294 | 374 |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
8015
diff
changeset
|
375 If you start Octave in your home directory, commands from the file |
| 3294 | 376 @file{~/.octaverc} will only be executed once. |
| 377 @end table | |
| 378 | |
| 379 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
|
380 invoke Octave with the @option{--verbose} option but without the |
|
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
381 @option{--silent} option. |
| 3294 | 382 |
| 4167 | 383 @node Quitting Octave |
| 3294 | 384 @section Quitting Octave |
| 385 @cindex exiting octave | |
| 386 @cindex quitting octave | |
|
19307
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
387 @cindex finish.m |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
388 @cindex site exiting file |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
389 |
|
dc64f1c4a33e
doc: Add documentation about finish.m and shutdown procedure to manual.
Rik <rik@octave.org>
parents:
18153
diff
changeset
|
390 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
|
391 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
|
392 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
|
393 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
|
394 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
|
395 functions to execute on shutdown may be registered with @code{atexit}. |
| 3294 | 396 |
| 3332 | 397 @DOCSTRING(quit) |
| 3294 | 398 |
| 3332 | 399 @DOCSTRING(atexit) |
| 3294 | 400 |
| 4167 | 401 @node Getting Help |
| 3294 | 402 @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
|
403 @cindex online help |
|
6a4e79110857
doc: Replace 'on-line' with modern 'online' in documentation and messages.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
404 @cindex help, online |
| 3294 | 405 |
| 406 The entire text of this manual is available from the Octave prompt | |
| 6620 | 407 via the command @kbd{doc}. In addition, the documentation for |
| 3294 | 408 individual user-written functions and variables is also available via |
| 409 the @kbd{help} command. This section describes the commands used for | |
| 410 reading the manual and the documentation strings for user-supplied | |
| 411 functions and variables. @xref{Function Files}, for more information | |
| 412 about how to document the functions you write. | |
| 413 | |
| 3332 | 414 @DOCSTRING(help) |
| 3294 | 415 |
| 6549 | 416 @DOCSTRING(doc) |
| 417 | |
| 418 @DOCSTRING(lookfor) | |
| 419 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
420 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
|
421 function. |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
422 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
423 @DOCSTRING(news) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
424 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
425 @DOCSTRING(info) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
426 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
427 @DOCSTRING(warranty) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
428 |
|
9133
c0cef1436788
Update help text for sections 2.2 and 2.3 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9132
diff
changeset
|
429 The following functions can be used to change which programs are used |
| 6620 | 430 for displaying the documentation, and where the documentation can be |
| 431 found. | |
| 3294 | 432 |
| 6477 | 433 @DOCSTRING(info_file) |
| 3294 | 434 |
| 6477 | 435 @DOCSTRING(info_program) |
| 3294 | 436 |
| 6477 | 437 @DOCSTRING(makeinfo_program) |
| 3686 | 438 |
|
14618
36f451642f79
doc: Add texi_macros_file to manual.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
439 @DOCSTRING(texi_macros_file) |
|
36f451642f79
doc: Add texi_macros_file to manual.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
440 |
|
9133
c0cef1436788
Update help text for sections 2.2 and 2.3 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9132
diff
changeset
|
441 @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
|
442 |
|
16807
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
443 @DOCSTRING(built_in_docstrings_file) |
|
2fd22fbaffa3
doc: Add built_in_docstrings_file() to documentation.
Rik <rik@octave.org>
parents:
16774
diff
changeset
|
444 |
| 3332 | 445 @DOCSTRING(suppress_verbose_help_message) |
| 3294 | 446 |
|
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
|
447 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
|
448 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
|
449 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
|
450 |
|
16872
5372068bb148
Rename gen_doc_cache() to doc_cache_create().
Rik <rik@octave.org>
parents:
16816
diff
changeset
|
451 @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
|
452 |
|
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 @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
|
454 |
|
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 @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
|
456 |
|
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 @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
|
458 |
| 4167 | 459 @node Command Line Editing |
| 3294 | 460 @section Command Line Editing |
| 461 @cindex command-line editing | |
| 462 @cindex editing the command line | |
| 463 | |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
464 Octave uses the GNU Readline library to provide an extensive set of |
| 3294 | 465 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
|
466 features are described in this manual. In addition, all of the editing |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
467 functions can be bound to different key strokes at the user's discretion. |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
468 This manual assumes no changes from the default Emacs bindings. See the GNU |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
469 Readline Library manual for more information on customizing Readline and |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
470 for a complete feature list. |
| 3294 | 471 |
| 472 To insert printing characters (letters, digits, symbols, etc.), simply | |
| 473 type the character. Octave will insert the character at the cursor and | |
| 474 advance the cursor forward. | |
| 475 | |
| 476 Many of the command-line editing functions operate using control | |
| 477 characters. For example, the character @kbd{Control-a} moves the cursor | |
| 478 to the beginning of the line. To type @kbd{C-a}, hold down @key{CTRL} | |
| 479 and then press @key{a}. In the following sections, control characters | |
| 480 such as @kbd{Control-a} are written as @kbd{C-a}. | |
| 481 | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
482 Another set of command-line editing functions use Meta characters. To |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
483 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
|
484 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
|
485 even @key{WINDOWS}. If your terminal does not have a @key{META} key, you |
| 7001 | 486 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
|
487 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
|
488 @key{ESC} @key{u}. The @kbd{ESC} character sequences are also allowed on |
| 3294 | 489 terminals with real Meta keys. In the following sections, Meta |
| 490 characters such as @kbd{Meta-u} are written as @kbd{M-u}. | |
| 491 | |
| 3428 | 492 |
| 3294 | 493 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
494 * Cursor Motion:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
495 * Killing and Yanking:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
496 * Commands For Text:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
497 * Commands For Completion:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
498 * Commands For History:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
499 * Customizing readline:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
500 * Customizing the Prompt:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
501 * Diary and Echo Commands:: |
| 3294 | 502 @end menu |
| 503 | |
| 4167 | 504 @node Cursor Motion |
| 3294 | 505 @subsection Cursor Motion |
| 506 | |
| 507 The following commands allow you to position the cursor. | |
| 508 | |
| 509 @table @kbd | |
| 510 @item C-b | |
| 511 Move back one character. | |
| 512 | |
| 513 @item C-f | |
| 514 Move forward one character. | |
| 515 | |
|
11487
0f14c093476e
Add <BACKSPACE> documentation to cursor movement section.
Rik <octave@nomad.inbox5.com>
parents:
11486
diff
changeset
|
516 @item @key{BACKSPACE} |
|
0f14c093476e
Add <BACKSPACE> documentation to cursor movement section.
Rik <octave@nomad.inbox5.com>
parents:
11486
diff
changeset
|
517 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
|
518 |
| 3294 | 519 @item @key{DEL} |
|
11487
0f14c093476e
Add <BACKSPACE> documentation to cursor movement section.
Rik <octave@nomad.inbox5.com>
parents:
11486
diff
changeset
|
520 Delete the character underneath the cursor. |
| 3294 | 521 |
| 522 @item C-d | |
| 523 Delete the character underneath the cursor. | |
| 524 | |
| 525 @item M-f | |
| 526 Move forward a word. | |
| 527 | |
| 528 @item M-b | |
| 529 Move backward a word. | |
| 530 | |
| 531 @item C-a | |
| 532 Move to the start of the line. | |
| 533 | |
| 534 @item C-e | |
| 535 Move to the end of the line. | |
| 536 | |
| 537 @item C-l | |
| 538 Clear the screen, reprinting the current line at the top. | |
| 539 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
540 @item C-_ |
| 3294 | 541 @itemx C-/ |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
542 Undo the last action. You can undo all the way back to an empty line. |
| 3294 | 543 |
| 544 @item M-r | |
| 545 Undo all changes made to this line. This is like typing the `undo' | |
| 546 command enough times to get back to the beginning. | |
| 547 @end table | |
| 548 | |
| 549 The above table describes the most basic possible keystrokes that you need | |
| 550 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
|
551 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
|
552 to move forward and backward. |
| 3294 | 553 |
| 554 Notice how @kbd{C-f} moves forward a character, while @kbd{M-f} moves | |
| 555 forward a word. It is a loose convention that control keystrokes | |
| 556 operate on characters while meta keystrokes operate on words. | |
| 557 | |
| 558 @cindex clearing the screen | |
| 559 | |
| 6620 | 560 The function @code{clc} will allow you to clear the screen from within |
| 561 Octave programs. | |
| 562 | |
| 3332 | 563 @DOCSTRING(clc) |
| 3294 | 564 |
| 4167 | 565 @node Killing and Yanking |
| 3294 | 566 @subsection Killing and Yanking |
| 567 | |
| 568 @dfn{Killing} text means to delete the text from the line, but to save | |
| 569 it away for later use, usually by @dfn{yanking} it back into the line. | |
| 570 If the description for a command says that it `kills' text, then you can | |
| 571 be sure that you can get the text back in a different (or the same) | |
| 572 place later. | |
| 573 | |
| 574 Here is the list of commands for killing text. | |
| 575 | |
| 576 @table @kbd | |
| 577 @item C-k | |
| 578 Kill the text from the current cursor position to the end of the line. | |
| 579 | |
| 580 @item M-d | |
| 581 Kill from the cursor to the end of the current word, or if between | |
| 582 words, to the end of the next word. | |
| 583 | |
| 584 @item M-@key{DEL} | |
| 585 Kill from the cursor to the start of the previous word, or if between | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
586 words, to the start of the previous word. |
| 3294 | 587 |
| 588 @item C-w | |
| 589 Kill from the cursor to the previous whitespace. This is different than | |
| 590 @kbd{M-@key{DEL}} because the word boundaries differ. | |
| 591 @end table | |
| 592 | |
| 593 And, here is how to @dfn{yank} the text back into the line. Yanking | |
| 594 means to copy the most-recently-killed text from the kill buffer. | |
| 595 | |
| 596 @table @kbd | |
| 597 @item C-y | |
| 598 Yank the most recently killed text back into the buffer at the cursor. | |
| 599 | |
| 600 @item M-y | |
| 601 Rotate the kill-ring, and yank the new top. You can only do this if | |
| 602 the prior command is @kbd{C-y} or @kbd{M-y}. | |
| 603 @end table | |
| 604 | |
| 605 When you use a kill command, the text is saved in a @dfn{kill-ring}. | |
| 606 Any number of consecutive kills save all of the killed text together, so | |
| 607 that when you yank it back, you get it in one clean sweep. The kill | |
| 608 ring is not line specific; the text that you killed on a previously | |
| 609 typed line is available to be yanked back later, when you are typing | |
| 610 another line. | |
| 611 | |
| 4167 | 612 @node Commands For Text |
| 3294 | 613 @subsection Commands For Changing Text |
| 614 | |
| 615 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
|
616 otherwise have a special meaning (e.g., @key{TAB}, @kbd{C-q}, etc.), or |
| 3294 | 617 for quickly correcting typing mistakes. |
| 618 | |
| 619 @table @kbd | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
620 @item C-q |
| 3294 | 621 @itemx C-v |
| 622 Add the next character that you type to the line verbatim. This is | |
| 623 how to insert things like @kbd{C-q} for example. | |
| 624 | |
| 625 @item M-@key{TAB} | |
| 626 Insert a tab character. | |
| 627 | |
| 628 @item C-t | |
| 629 Drag the character before the cursor forward over the character at the | |
| 630 cursor, also moving the cursor forward. If the cursor is at the end of | |
| 631 the line, then transpose the two characters before it. | |
| 632 | |
| 633 @item M-t | |
| 634 Drag the word behind the cursor past the word in front of the cursor | |
| 635 moving the cursor over that word as well. | |
| 636 | |
| 637 @item M-u | |
| 638 Uppercase the characters following the cursor to the end of the current | |
| 639 (or following) word, moving the cursor to the end of the word. | |
| 640 | |
| 641 @item M-l | |
| 6620 | 642 Lowercase the characters following the cursor to the end of the current |
| 3294 | 643 (or following) word, moving the cursor to the end of the word. |
| 644 | |
| 645 @item M-c | |
| 646 Uppercase the character following the cursor (or the beginning of the | |
| 647 next word if the cursor is between words), moving the cursor to the end | |
| 648 of the word. | |
| 649 @end table | |
| 650 | |
| 4167 | 651 @node Commands For Completion |
| 3294 | 652 @subsection Letting Readline Type For You |
| 653 @cindex command completion | |
| 654 | |
| 655 The following commands allow Octave to complete command and variable | |
| 656 names for you. | |
| 657 | |
| 658 @table @kbd | |
| 659 @item @key{TAB} | |
| 660 Attempt to do completion on the text before the cursor. Octave can | |
| 661 complete the names of commands and variables. | |
| 662 | |
| 663 @item M-? | |
| 664 List the possible completions of the text before the cursor. | |
| 665 @end table | |
| 666 | |
| 3332 | 667 @DOCSTRING(completion_append_char) |
| 3294 | 668 |
| 3332 | 669 @DOCSTRING(completion_matches) |
| 3294 | 670 |
| 4167 | 671 @node Commands For History |
| 3294 | 672 @subsection Commands For Manipulating The History |
| 673 @cindex command history | |
| 674 @cindex input history | |
| 675 @cindex history of commands | |
| 676 | |
| 677 Octave normally keeps track of the commands you type so that you can | |
| 678 recall previous commands to edit or execute them again. When you exit | |
| 679 Octave, the most recent commands you have typed, up to the number | |
| 680 specified by the variable @code{history_size}, are saved in a file. | |
| 681 When Octave starts, it loads an initial list of commands from the file | |
| 682 named by the variable @code{history_file}. | |
| 683 | |
| 684 Here are the commands for simple browsing and searching the history | |
| 685 list. | |
| 686 | |
| 687 @table @kbd | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
688 @item @key{LFD} |
| 3294 | 689 @itemx @key{RET} |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
690 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
|
691 non-empty, add it to the history list. If the line was a history |
| 3294 | 692 line, then restore the history line to its original state. |
| 693 | |
| 694 @item C-p | |
| 695 Move `up' through the history list. | |
| 696 | |
| 697 @item C-n | |
| 698 Move `down' through the history list. | |
| 699 | |
| 700 @item M-< | |
| 701 Move to the first line in the history. | |
| 702 | |
| 703 @item M-> | |
| 704 Move to the end of the input history, i.e., the line you are entering! | |
| 705 | |
| 706 @item C-r | |
| 707 Search backward starting at the current line and moving `up' through | |
| 708 the history as necessary. This is an incremental search. | |
| 709 | |
| 710 @item C-s | |
| 711 Search forward starting at the current line and moving `down' through | |
| 712 the history as necessary. | |
| 713 @end table | |
| 714 | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
715 On most terminals, you can also use the up and down arrow keys in place |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
716 of @kbd{C-p} and @kbd{C-n} to move through the history list. |
| 3294 | 717 |
| 718 In addition to the keyboard commands for moving through the history | |
| 719 list, Octave provides three functions for viewing, editing, and | |
| 720 re-running chunks of commands from the history list. | |
| 721 | |
| 3332 | 722 @DOCSTRING(history) |
| 3294 | 723 |
| 3332 | 724 @DOCSTRING(edit_history) |
| 3294 | 725 |
| 3332 | 726 @DOCSTRING(run_history) |
| 3294 | 727 |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
728 @noindent |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
729 Octave also allows you customize the details of when, where, and how history |
| 6620 | 730 is saved. |
| 3294 | 731 |
|
16876
9e0618443c2b
Rename saving_history() to history_save().
Rik <rik@octave.org>
parents:
16875
diff
changeset
|
732 @DOCSTRING(history_save) |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
733 |
|
11486
a1deab9a6e71
bash-like history control
Pascal Dupuis <Pascal.Dupuis@worldonline.be> and John W. Eaton <jwe@octave.org>
parents:
10846
diff
changeset
|
734 @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
|
735 |
| 3332 | 736 @DOCSTRING(history_file) |
| 3294 | 737 |
| 3332 | 738 @DOCSTRING(history_size) |
| 3294 | 739 |
| 6550 | 740 @DOCSTRING(history_timestamp_format_string) |
| 741 | |
| 6620 | 742 @DOCSTRING(EDITOR) |
| 743 | |
| 4167 | 744 @node Customizing readline |
| 3428 | 745 @subsection Customizing @code{readline} |
|
12175
2090995ca588
Correct en-dash,em-dash instances in docstrings.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
746 @cindex @code{~/.inputrc} |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
747 @cindex customizing @code{readline} |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
748 @cindex @code{readline} customization |
| 3428 | 749 |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
750 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
|
751 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
|
752 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
|
753 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
|
754 @file{~/.inputrc}. |
| 6620 | 755 |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9133
diff
changeset
|
756 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
|
757 the command line behavior. |
| 3428 | 758 |
|
16879
cc3743a91652
Rename read_readline_init_file to readline_read_init_file.
Rik <rik@octave.org>
parents:
16877
diff
changeset
|
759 @DOCSTRING(readline_read_init_file) |
| 3428 | 760 |
|
16880
1aebb613a5ac
Rename re_read_readline_init_file to readline_re_read_init_file.
Rik <rik@octave.org>
parents:
16879
diff
changeset
|
761 @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
|
762 |
| 4167 | 763 @node Customizing the Prompt |
| 3294 | 764 @subsection Customizing the Prompt |
| 765 @cindex prompt customization | |
| 766 @cindex customizing the prompt | |
| 767 | |
| 768 The following variables are available for customizing the appearance of | |
| 769 the command-line prompts. Octave allows the prompt to be customized by | |
| 770 inserting a number of backslash-escaped special characters that are | |
| 771 decoded as follows: | |
| 772 | |
| 773 @table @samp | |
| 774 @item \t | |
| 775 The time. | |
| 776 | |
| 777 @item \d | |
| 778 The date. | |
| 779 | |
| 780 @item \n | |
| 781 Begins a new line by printing the equivalent of a carriage return | |
| 782 followed by a line feed. | |
| 783 | |
| 784 @item \s | |
| 785 The name of the program (usually just @samp{octave}). | |
| 786 | |
| 787 @item \w | |
| 788 The current working directory. | |
| 789 | |
| 790 @item \W | |
| 791 The basename of the current working directory. | |
| 792 | |
| 793 @item \u | |
| 794 The username of the current user. | |
| 795 | |
| 796 @item \h | |
| 797 The hostname, up to the first `.'. | |
| 798 | |
| 799 @item \H | |
| 800 The hostname. | |
| 801 | |
| 802 @item \# | |
| 803 The command number of this command, counting from when Octave starts. | |
| 804 | |
| 805 @item \! | |
| 806 The history number of this command. This differs from @samp{\#} by the | |
| 807 number of commands in the history list when Octave starts. | |
| 808 | |
| 809 @item \$ | |
| 810 If the effective UID is 0, a @samp{#}, otherwise a @samp{$}. | |
| 811 | |
| 812 @item \nnn | |
| 813 The character whose character code in octal is @var{nnn}. | |
| 814 | |
| 815 @item \\ | |
| 816 A backslash. | |
| 817 @end table | |
| 818 | |
| 3332 | 819 @DOCSTRING(PS1) |
| 3294 | 820 |
| 3332 | 821 @DOCSTRING(PS2) |
| 3294 | 822 |
| 3332 | 823 @DOCSTRING(PS4) |
| 3294 | 824 |
| 4167 | 825 @node Diary and Echo Commands |
| 3294 | 826 @subsection Diary and Echo Commands |
| 827 @cindex diary of commands and output | |
| 6939 | 828 @cindex command and output logs |
| 3294 | 829 @cindex logging commands and output |
| 830 @cindex echoing executing commands | |
| 831 @cindex command echoing | |
| 832 | |
| 833 Octave's diary feature allows you to keep a log of all or part of an | |
| 834 interactive session by recording the input you type and the output that | |
| 835 Octave produces in a separate file. | |
| 836 | |
| 3332 | 837 @DOCSTRING(diary) |
| 3294 | 838 |
| 839 Sometimes it is useful to see the commands in a function or script as | |
| 840 they are being evaluated. This can be especially helpful for debugging | |
| 841 some kinds of problems. | |
| 842 | |
| 3332 | 843 @DOCSTRING(echo) |
| 3294 | 844 |
| 3332 | 845 @DOCSTRING(echo_executing_commands) |
| 3294 | 846 |
| 4167 | 847 @node Errors |
| 3294 | 848 @section How Octave Reports Errors |
| 849 @cindex error messages | |
| 850 @cindex messages, error | |
| 851 | |
| 852 Octave reports two kinds of errors for invalid programs. | |
| 853 | |
| 854 A @dfn{parse error} occurs if Octave cannot understand something you | |
| 855 have typed. For example, if you misspell a keyword, | |
| 856 | |
| 857 @example | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
858 octave:13> function y = f (x) y = x***2; endfunction |
| 3294 | 859 @end example |
| 860 | |
| 861 @noindent | |
| 862 Octave will respond immediately with a message like this: | |
| 863 | |
| 864 @example | |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
865 @group |
| 3294 | 866 parse error: |
| 867 | |
|
8015
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
868 syntax error |
|
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
869 |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
870 >>> 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
|
871 ^ |
|
9132
eb1747dbd360
Update help strings for command line options
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
872 @end group |
| 3294 | 873 @end example |
| 874 | |
| 875 @noindent | |
| 876 For most parse errors, Octave uses a caret (@samp{^}) to mark the point | |
| 877 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
|
878 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
|
879 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
|
880 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
|
881 @samp{*} was not understood. |
| 3294 | 882 |
| 883 Another class of error message occurs at evaluation time. These | |
| 884 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
|
885 @dfn{evaluation errors}, because they occur when your program is being |
| 3294 | 886 @dfn{run}, or @dfn{evaluated}. For example, if after correcting the |
| 887 mistake in the previous function definition, you type | |
| 888 | |
| 889 @example | |
| 890 octave:13> f () | |
| 891 @end example | |
| 892 | |
| 893 @noindent | |
| 894 Octave will respond with | |
| 895 | |
|
9153
5247e89688e1
Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents:
9135
diff
changeset
|
896 @example |
| 3294 | 897 @group |
| 898 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
|
899 error: called from: |
|
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
900 error: f at line 1, column 22 |
| 3294 | 901 @end group |
|
9153
5247e89688e1
Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents:
9135
diff
changeset
|
902 @end example |
| 3294 | 903 |
| 6620 | 904 @noindent |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
905 This error message has several parts, and gives quite a bit of |
| 3294 | 906 information to help you locate the source of the error. The messages |
| 907 are generated from the point of the innermost error, and provide a | |
| 908 traceback of enclosing expressions and function calls. | |
| 909 | |
| 910 In the example above, the first line indicates that a variable named | |
| 911 @samp{x} was found to be undefined near line 1 and column 24 of some | |
| 912 function or expression. For errors occurring within functions, lines | |
| 913 are counted from the beginning of the file containing the function | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
914 definition. For errors occurring outside of an enclosing function, |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
915 the line number indicates the input line number, which is usually displayed |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
916 in the primary prompt string. |
| 3294 | 917 |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
918 The second and third lines of the error message indicate that the error |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
919 occurred within the function @code{f}. If the function @code{f} had been |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
920 called from within another function, for example, @code{g}, the list of |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
921 errors would have ended with one more line: |
| 3294 | 922 |
| 923 @example | |
|
8015
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7031
diff
changeset
|
924 error: g at line 1, column 17 |
| 3294 | 925 @end example |
| 926 | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
927 These lists of function calls make it fairly easy to trace the |
| 3294 | 928 path your program took before the error occurred, and to correct the |
| 929 error before trying again. | |
| 930 | |
| 4167 | 931 @node Executable Octave Programs |
| 3294 | 932 @section Executable Octave Programs |
| 933 @cindex executable scripts | |
| 934 @cindex scripts | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
935 @cindex batch processing |
| 3294 | 936 @cindex self contained programs |
| 937 @cindex program, self contained | |
| 938 @cindex @samp{#!} | |
| 939 | |
| 940 Once you have learned Octave, you may want to write self-contained | |
| 941 Octave scripts, using the @samp{#!} script mechanism. You can do this | |
| 942 on GNU systems and on many Unix systems @footnote{The @samp{#!} | |
| 943 mechanism works on Unix systems derived from Berkeley Unix, System V | |
| 6481 | 944 Release 4, and some System V Release 3 systems.}. |
| 945 | |
| 946 Self-contained Octave scripts are useful when you want to write a | |
| 947 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
|
948 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
|
949 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
|
950 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
|
951 script and used again and again on new data files. |
| 3294 | 952 |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
953 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
|
954 text file named @file{hello}, containing the following lines: |
| 3294 | 955 |
| 956 @example | |
| 957 @group | |
| 958 #! @var{octave-interpreter-name} -qf | |
| 959 # a sample Octave program | |
| 960 printf ("Hello, world!\n"); | |
| 961 @end group | |
| 962 @end example | |
| 963 | |
| 964 @noindent | |
| 965 (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
|
966 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
|
967 @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
|
968 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
|
969 simply type: |
| 3294 | 970 |
| 971 @example | |
| 972 hello | |
| 973 @end example | |
| 974 | |
| 975 @noindent | |
| 976 at the shell, and the system will arrange to run Octave as if you had | |
| 977 typed: | |
| 978 | |
| 979 @example | |
| 980 octave hello | |
| 981 @end example | |
| 982 | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
983 The line beginning with @samp{#!} lists the full path and filename of an |
| 3294 | 984 interpreter to be run, and an optional initial command line argument to |
| 985 pass to that interpreter. The operating system then runs the | |
| 986 interpreter with the given argument and the full argument list of the | |
| 987 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
|
988 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
|
989 options to Octave, or data files, or both. The @samp{-qf} options are |
| 3294 | 990 usually specified in stand-alone Octave programs to prevent them from |
| 991 printing the normal startup message, and to keep them from behaving | |
| 992 differently depending on the contents of a particular user's | |
| 6620 | 993 @file{~/.octaverc} file. @xref{Invoking Octave from the Command Line}. |
| 6481 | 994 |
| 995 Note that some operating systems may place a limit on the number of | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
996 characters that are recognized after @samp{#!}. Also, the arguments |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
997 appearing in a @samp{#!} line are parsed differently by various |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
998 shells/systems. The majority of them group all the arguments together in one |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
999 string and pass it to the interpreter as a single argument. In this case, the |
| 6481 | 1000 following script: |
| 1001 | |
| 1002 @example | |
| 1003 @group | |
| 1004 #! @var{octave-interpreter-name} -q -f # comment | |
| 1005 @end group | |
| 1006 @end example | |
| 1007 | |
| 1008 @noindent | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1009 is equivalent to typing at the command line: |
| 3294 | 1010 |
| 6481 | 1011 @example |
| 1012 @group | |
| 1013 octave "-q -f # comment" | |
| 1014 @end group | |
| 1015 @end example | |
| 3294 | 1016 |
| 6481 | 1017 @noindent |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1018 which will produce an error message. Unfortunately, it is |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
1019 not possible for Octave to determine whether it has been called from the |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1020 command line or from a @samp{#!} script, so some care is needed when using the |
| 6481 | 1021 @samp{#!} mechanism. |
| 1022 | |
| 1023 Note that when Octave is started from an executable script, the built-in | |
| 1024 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
|
1025 arguments passed to the executable Octave script, not the arguments |
| 6481 | 1026 passed to the Octave interpreter on the @samp{#!} line of the script. |
| 1027 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
|
1028 was used to execute the script, not @samp{-qf}. |
| 3294 | 1029 |
| 1030 @example | |
| 1031 @group | |
| 1032 #! /bin/octave -qf | |
| 6479 | 1033 printf ("%s", program_name ()); |
| 6620 | 1034 arg_list = argv (); |
| 3294 | 1035 for i = 1:nargin |
| 6479 | 1036 printf (" %s", arg_list@{i@}); |
| 3294 | 1037 endfor |
| 1038 printf ("\n"); | |
| 1039 @end group | |
| 1040 @end example | |
| 1041 | |
| 4167 | 1042 @node Comments |
| 3294 | 1043 @section Comments in Octave Programs |
| 1044 @cindex comments | |
| 1045 @cindex use of comments | |
| 1046 @cindex documenting Octave programs | |
| 1047 | |
| 1048 A @dfn{comment} is some text that is included in a program for the sake | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
1049 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
|
1050 Comments can explain what the program does, and how it works. Nearly all |
| 3294 | 1051 programming languages have provisions for comments, because programs are |
| 1052 typically hard to understand without them. | |
| 1053 | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1054 @menu |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1055 * Single Line Comments:: |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1056 * Block Comments:: |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
1057 * Comments and the Help System:: |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1058 @end menu |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1059 |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1060 @node Single Line Comments |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1061 @subsection Single Line Comments |
|
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 @cindex @samp{%} |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1064 |
| 3294 | 1065 In the Octave language, a comment starts with either the sharp sign |
| 1066 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
|
1067 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
|
1068 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
|
1069 shows whole line and partial line comments. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
1070 |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1071 @example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1072 @group |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1073 function countdown |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
1074 # 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
|
1075 disp (3); |
|
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1076 disp (2); |
|
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1077 disp (1); |
|
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1078 disp ("Blast Off!"); # Rocket leaves pad |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1079 endfunction |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1080 @end group |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1081 @end example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1082 |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1083 @node Block Comments |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1084 @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
|
1085 @cindex block comments |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1086 @cindex multi-line comments |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1087 @cindex @samp{#@{} |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1088 @cindex @samp{%@{} |
| 3294 | 1089 |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
1090 Entire blocks of code can be commented by enclosing the code between |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
1091 matching @samp{#@{} and @samp{#@}} or @samp{%@{} and @samp{%@}} markers. |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1092 For example, |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10613
diff
changeset
|
1093 |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1094 @example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1095 @group |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1096 function quick_countdown |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
1097 # 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
|
1098 disp (3); |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1099 #@{ |
|
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1100 disp (2); |
|
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1101 disp (1); |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1102 #@} |
|
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14618
diff
changeset
|
1103 disp ("Blast Off!"); # Rocket leaves pad |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1104 endfunction |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1105 @end group |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1106 @end example |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1107 |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1108 @noindent |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1109 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
|
1110 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
|
1111 |
|
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
|
1112 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
|
1113 (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
|
1114 |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1115 @node Comments and the Help System |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1116 @subsection Comments and the Help System |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1117 @cindex documenting functions |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1118 @cindex documenting user scripts |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1119 @cindex help, user-defined functions |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1120 |
|
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1121 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
|
1122 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
|
1123 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
|
1124 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
|
1125 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
|
1126 |
| 3294 | 1127 @example |
| 1128 @group | |
| 1129 function xdot = f (x, t) | |
| 1130 | |
| 1131 # usage: f (x, t) | |
| 1132 # | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1133 # This function defines the right-hand |
| 3294 | 1134 # side functions for a set of nonlinear |
| 1135 # differential equations. | |
| 1136 | |
| 1137 r = 0.25; | |
| 1138 @dots{} | |
| 1139 endfunction | |
| 1140 @end group | |
| 1141 @end example | |
| 1142 | |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1143 @noindent |
| 3294 | 1144 the command @kbd{help f} produces the output |
| 1145 | |
| 1146 @example | |
| 1147 @group | |
| 1148 usage: f (x, t) | |
| 1149 | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1150 This function defines the right-hand |
| 3294 | 1151 side functions for a set of nonlinear |
| 1152 differential equations. | |
| 1153 @end group | |
| 1154 @end example | |
| 1155 | |
|
9135
b04f95fabbf9
Update sections 2.5, 2.6, 2.7 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9134
diff
changeset
|
1156 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
|
1157 throw-away Octave programs, it usually isn't very useful because the |
| 3294 | 1158 purpose of a comment is to help you or another person understand the |
| 1159 program at a later time. | |
| 1160 | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1161 The @code{help} parser currently only recognizes single line comments |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
1162 (@pxref{Single Line Comments}) and not block comments for the initial |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17793
diff
changeset
|
1163 help text. |