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