octave: doc/interpreter/basics.txi annotate

annotate doc/interpreter/basics.txi @ 31191:bb9d776eafac stable

Fix wrong color in PDF printout of some latex strings (bug #62884) * octave-svgconvert (draw): For "rect" elements only set brush color if necessary and eventually restore to previous color.

author	Pantxo Diribarne <pantxo.diribarne@gmail.com>
date	Sun, 14 Aug 2022 18:24:07 +0200
parents	796f54d4ddbf
children	4b80982e0af8

rev	line source
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 30321 diff changeset	1 @c Copyright (C) 1996-2022 The Octave Project Developers
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	4 @c
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24507 diff changeset	5 @c Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22475 diff changeset	6 @c under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24507 diff changeset	7 @c the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22475 diff changeset	8 @c (at your option) any later version.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	9 @c
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22475 diff changeset	10 @c Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22475 diff changeset	11 @c WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22475 diff changeset	12 @c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22475 diff changeset	13 @c GNU General Public License for more details.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	14 @c
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	16 @c along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24507 diff changeset	17 @c <https://www.gnu.org/licenses/>.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	18
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	19 @node Getting Started
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	20 @chapter Getting Started
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	21
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	22 This chapter explains some of Octave's basic features, including how to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	23 start an Octave session, get help at the command prompt, edit the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	24 command line, and write Octave programs that can be executed as commands
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	25 from your shell.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	26
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	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 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	35 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	36
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	37 @node Invoking Octave from the Command Line
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	38 @section Invoking Octave from the Command Line
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	39
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	40 Normally, Octave is used interactively by running the program
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	41 @samp{octave} without any arguments. Once started, Octave reads
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	42 commands from the terminal until you tell it to exit.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	43
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	44 You can also specify the name of a file on the command line, and Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	45 will read and execute the commands from the named file and then exit
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	46 when it is finished.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	47
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	48 You can further control how Octave starts by using the command-line
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	49 options described in the next section, and Octave itself can remind you
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	50 of the options available. Type @samp{octave --help} to display all
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	51 available options and briefly describe their use (@samp{octave -h} is a
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	52 shorter equivalent).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	53
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	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 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	57 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	58
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	59 @node Command Line Options
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	60 @subsection Command Line Options
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	61 @cindex Octave command options
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	62 @cindex command options
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	63 @cindex options, Octave command
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	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 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	66 accepts.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	67
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	68
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	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}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	72 @cindex @sortas{options, Octave command --built-in-docstrings-file} @ @ @code{--built-in-docstrings-file @var{filename}}
16807 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 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	78 @itemx -d
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	79 @cindex @sortas{options, Octave command --debug} @ @ @code{--debug}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	80 @cindex @sortas{options, Octave command -d} @ @ @code{-d}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	81 Enter parser debugging mode. Using this option will cause Octave's
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	82 parser to print a lot of information about the commands it reads, and is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	83 probably only useful if you are actually trying to debug the parser.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	84
16807 2fd22fbaffa3 doc: Add built_in_docstrings_file() to documentation. Rik <rik@octave.org> parents: 16774 diff changeset	85 @item --doc-cache-file @var{filename}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	86 @cindex @sortas{options, Octave command --doc-cache-file} @ @ @code{--doc-cache-file @var{filename}}
8923 d47290508a55 document --doc-cache-file option John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	87 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	88 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	89 @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	90 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	91 function.
d47290508a55 document --doc-cache-file option John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	92
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	93 @item --echo-commands
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	94 @itemx -x
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	95 @cindex @sortas{options, Octave command --echo-commands} @ @ @code{--echo-commands}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	96 @cindex @sortas{options, Octave command -x} @ @ @code{-x}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	97 Echo commands as they are executed.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	98
5190 2021bbfff5fd [project @ 2005-03-04 02:51:33 by jwe] jwe parents: 4476 diff changeset	99 @item --eval @var{code}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	100 @cindex @sortas{options, Octave command --eval} @ @ @code{--eval @var{code}}
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10613 diff changeset	101 Evaluate @var{code} and exit when finished unless @option{--persist} is also
5190 2021bbfff5fd [project @ 2005-03-04 02:51:33 by jwe] jwe parents: 4476 diff changeset	102 specified.
2021bbfff5fd [project @ 2005-03-04 02:51:33 by jwe] jwe parents: 4476 diff changeset	103
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	104 @item --exec-path @var{path}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	105 @cindex @sortas{options, Octave command --exec-path} @ @ @code{--exec-path @var{path}}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	106 Specify the path to search for programs to run. The value of @var{path}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	107 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	108 @w{@env{OCTAVE_EXEC_PATH}} found in the environment, but not any commands
28652 bb0ca2753bc2 update docs for built-in variables (bug #58988) John W. Eaton <jwe@octave.org> parents: 28506 diff changeset	109 in the system or user startup files that call the
bb0ca2753bc2 update docs for built-in variables (bug #58988) John W. Eaton <jwe@octave.org> parents: 28506 diff changeset	110 @w{@env{EXEC_PATH}} function.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	111
25188 bd0631439f8c doc: document the --gui command-line options, update description of --no-gui Mike Miller <mtmiller@octave.org> parents: 25184 diff changeset	112 @item --gui
bd0631439f8c doc: document the --gui command-line options, update description of --no-gui Mike Miller <mtmiller@octave.org> parents: 25184 diff changeset	113 @cindex @sortas{options, Octave command --gui} @ @ @code{--gui}
bd0631439f8c doc: document the --gui command-line options, update description of --no-gui Mike Miller <mtmiller@octave.org> parents: 25184 diff changeset	114 Start the graphical user interface (GUI).
15540 d8e3111b1890 doc: Add documentation about new command-line options available. Rik <rik@octave.org> parents: 14856 diff changeset	115
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	116 @item --help
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	117 @itemx -h
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	118 @cindex @sortas{options, Octave command --help} @ @ @code{--help}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	119 @cindex @sortas{options, Octave command -h} @ @ @code{-h}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	120 Print short help message and exit.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	121
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	122 @item --image-path @var{path}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	123 @cindex @sortas{options, Octave command --image-path} @ @ @code{--image-path @var{path}}
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	124 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	125 @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	126 @w{@env{OCTAVE_IMAGE_PATH}} found in the environment, but not any commands
28652 bb0ca2753bc2 update docs for built-in variables (bug #58988) John W. Eaton <jwe@octave.org> parents: 28506 diff changeset	127 in the system or user startup files that call the @w{@env{IMAGE_PATH}}
bb0ca2753bc2 update docs for built-in variables (bug #58988) John W. Eaton <jwe@octave.org> parents: 28506 diff changeset	128 function.
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	129
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	130 @item --info-file @var{filename}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	131 @cindex @sortas{options, Octave command --info-file} @ @ @code{--info-file @var{filename}}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	132 Specify the name of the info file to use. The value of @var{filename}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	133 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	134 @w{@env{OCTAVE_INFO_FILE}} found in the environment, but not any commands
6653 673686daec87 [project @ 2007-05-22 15:36:09 by jwe] jwe parents: 6643 diff changeset	135 in the system or user startup files that use the @code{info_file}
6477 a441d6681364 [project @ 2007-03-29 13:44:44 by jwe] jwe parents: 5775 diff changeset	136 function.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	137
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	138 @item --info-program @var{program}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	139 @cindex @sortas{options, Octave command --info-program} @ @ @code{--info-program @var{program}}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	140 Specify the name of the info program to use. The value of @var{program}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	141 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	142 @w{@env{OCTAVE_INFO_PROGRAM}} found in the environment, but not any
6477 a441d6681364 [project @ 2007-03-29 13:44:44 by jwe] jwe parents: 5775 diff changeset	143 commands in the system or user startup files that use the
a441d6681364 [project @ 2007-03-29 13:44:44 by jwe] jwe parents: 5775 diff changeset	144 @code{info_program} function.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	145
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	146 @item --interactive
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	147 @itemx -i
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	148 @cindex @sortas{options, Octave command --interactive} @ @ @code{--interactive}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	149 @cindex @sortas{options, Octave command -i} @ @ @code{-i}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	150 Force interactive behavior. This can be useful for running Octave via a
22475 e511f86fb230 doc: Remove Emacs chapter from manual. Rik <rik@octave.org> parents: 22342 diff changeset	151 remote shell command or inside an Emacs shell buffer.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	152
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	153 @item --line-editing
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	154 @cindex @sortas{options, Octave command --line-editing} @ @ @code{--line-editing}
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	155 Force readline use for command-line editing.
eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	156
15540 d8e3111b1890 doc: Add documentation about new command-line options available. Rik <rik@octave.org> parents: 14856 diff changeset	157 @item --no-gui
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	158 @cindex @sortas{options, Octave command --no-gui} @ @ @code{--no-gui}
15540 d8e3111b1890 doc: Add documentation about new command-line options available. Rik <rik@octave.org> parents: 14856 diff changeset	159 Disable the graphical user interface (GUI) and use the command line
25188 bd0631439f8c doc: document the --gui command-line options, update description of --no-gui Mike Miller <mtmiller@octave.org> parents: 25184 diff changeset	160 interface (CLI) instead. This is the default behavior, but this option
bd0631439f8c doc: document the --gui command-line options, update description of --no-gui Mike Miller <mtmiller@octave.org> parents: 25184 diff changeset	161 may be useful to override a previous @option{--gui}.
15540 d8e3111b1890 doc: Add documentation about new command-line options available. Rik <rik@octave.org> parents: 14856 diff changeset	162
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	163 @item --no-history
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3402 diff changeset	164 @itemx -H
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	165 @cindex @sortas{options, Octave command --no-history} @ @ @code{--no-history}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	166 @cindex @sortas{options, Octave command -H} @ @ @code{-H}
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	167 Disable recording of command-line history.
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3402 diff changeset	168
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	169 @item --no-init-file
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	170 @cindex @sortas{options, Octave command --no-init-file} @ @ @code{--no-init-file}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	171 @cindex @sortas{octaverc ~/.octaverc} @code{~/.octaverc}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	172 @cindex @sortas{octaverc .octaverc} @code{.octaverc}
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	173 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	174
eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	175 @item --no-init-path
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	176 @cindex @sortas{options, Octave command --no-init-path} @ @ @code{--no-init-path}
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	177 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	178 locations.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	179
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	180 @item --no-line-editing
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	181 @cindex @sortas{options, Octave command --no-line-editing} @ @ @code{--no-line-editing}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	182 Disable command-line editing.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	183
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	184 @item --no-site-file
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	185 @cindex @sortas{options, Octave command --no-site-file} @ @ @code{--no-site-file}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	186 @cindex site startup file
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	187 Don't read the site-wide @file{octaverc} initialization files.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	188
16774 8d188159ce5f Add -W command line option to disable window system (bug #38937) Rik <rik@octave.org> parents: 16772 diff changeset	189 @item --no-window-system
8d188159ce5f Add -W command line option to disable window system (bug #38937) Rik <rik@octave.org> parents: 16772 diff changeset	190 @itemx -W
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	191 @cindex @sortas{options, Octave command --no-window-system} @ @ @code{--no-window-system}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	192 @cindex @sortas{options, Octave command -W} @ @ @code{-W}
15540 d8e3111b1890 doc: Add documentation about new command-line options available. Rik <rik@octave.org> parents: 14856 diff changeset	193 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	194 strictly terminal-only environment.
d8e3111b1890 doc: Add documentation about new command-line options available. Rik <rik@octave.org> parents: 14856 diff changeset	195
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	196 @item --norc
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	197 @itemx -f
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	198 @cindex @sortas{options, Octave command --norc} @ @ @code{--norc}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	199 @cindex @sortas{options, Octave command -f} @ @ @code{-f}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	200 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	201 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	202 and @option{--no-site-file}.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	203
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	204 @item --path @var{path}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	205 @itemx -p @var{path}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	206 @cindex @sortas{options, Octave command --path} @ @ @code{--path @var{path}}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	207 @cindex @sortas{options, Octave command -p} @ @ @code{-p @var{path}}
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	208 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	209 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	210 of @w{@env{OCTAVE_PATH}} found in the environment, but not any commands in the
6643 6a7fc4105bcc [project @ 2007-05-21 20:37:43 by jwe] jwe parents: 6623 diff changeset	211 system or user startup files that set the internal load path through one
6a7fc4105bcc [project @ 2007-05-21 20:37:43 by jwe] jwe parents: 6623 diff changeset	212 of the path functions.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	213
5190 2021bbfff5fd [project @ 2005-03-04 02:51:33 by jwe] jwe parents: 4476 diff changeset	214 @item --persist
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	215 @cindex @sortas{options, Octave command --persist} @ @ @code{--persist}
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10613 diff changeset	216 Go to interactive mode after @option{--eval} or reading from a file
5190 2021bbfff5fd [project @ 2005-03-04 02:51:33 by jwe] jwe parents: 4476 diff changeset	217 named on the command line.
2021bbfff5fd [project @ 2005-03-04 02:51:33 by jwe] jwe parents: 4476 diff changeset	218
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	219 @item --silent
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	220 @itemx --quiet
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	221 @itemx -q
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	222 @cindex @sortas{options, Octave command --silent} @ @ @code{--silent}
25003 2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24534 diff changeset	223 @cindex @sortas{options, Octave command --quiet} @ @ @code{--quiet}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	224 @cindex @sortas{options, Octave command -q} @ @ @code{-q}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	225 Don't print the usual greeting and version message at startup.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	226
15540 d8e3111b1890 doc: Add documentation about new command-line options available. Rik <rik@octave.org> parents: 14856 diff changeset	227 @item --texi-macros-file @var{filename}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	228 @cindex @sortas{options, Octave command --texi-macros-file} @ @ @code{--texi-macros-file @var{filename}}
15540 d8e3111b1890 doc: Add documentation about new command-line options available. Rik <rik@octave.org> parents: 14856 diff changeset	229 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	230
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	231 @item --traditional
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	232 @itemx --braindead
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	233 @cindex @sortas{options, Octave command --traditional} @ @ @code{--traditional}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	234 @cindex @sortas{options, Octave command --braindead} @ @ @code{--braindead}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9035 diff changeset	235 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	236 user preferences to the following values
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	237
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	238 @example
4455 abbf63293766 [project @ 2003-07-11 01:01:16 by jwe] jwe parents: 4452 diff changeset	239 @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	240 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	241 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	242 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	243 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	244 crash_dumps_octave_core = false
29982 605275522c37 Deprecate disable_range, disable_diagonal_matrix, disable_permutation_matrix. Rik <rik@octave.org> parents: 29949 diff changeset	245 optimize_diagonal_matrix = false
605275522c37 Deprecate disable_range, disable_diagonal_matrix, disable_permutation_matrix. Rik <rik@octave.org> parents: 29949 diff changeset	246 optimize_permutation_matrix = false
605275522c37 Deprecate disable_range, disable_diagonal_matrix, disable_permutation_matrix. Rik <rik@octave.org> parents: 29949 diff changeset	247 optimize_range = false
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	248 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	249 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	250 print_empty_dimensions = false
29932 b39203a44db2 Call print_struct_array_contents(1) when '--traditional' option used. Rik <rik@octave.org> parents: 29668 diff changeset	251 print_struct_array_contents = true
19391 385499581a5e allow disabling of permutation and diagonal matrices John W. Eaton <jwe@octave.org> parents: 19274 diff changeset	252 save_default_options = "-mat-binary"
18154 5971c8f515a7 doc: Document options set when using --traditional. Rik <rik@octave.org> parents: 17793 diff changeset	253 struct_levels_to_print = 0
6556 8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6551 diff changeset	254 @end group
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6551 diff changeset	255 @end example
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6551 diff changeset	256
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6551 diff changeset	257 @noindent
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6551 diff changeset	258 and disable the following warnings
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10613 diff changeset	259
6556 8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6551 diff changeset	260 @example
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6551 diff changeset	261 @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	262 Octave:abbreviated-property-match
27517 85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 26376 diff changeset	263 Octave:colon-nonscalar-argument
25179 3ae57b161ab4 doc: Document warning ID Octave:data-file-in-path (bug #53588) Rik <rik@octave.org> parents: 25054 diff changeset	264 Octave:data-file-in-path
29932 b39203a44db2 Call print_struct_array_contents(1) when '--traditional' option used. Rik <rik@octave.org> parents: 29668 diff changeset	265 Octave:empty-index
7031 120f3135952f [project @ 2007-10-15 15:30:03 by jwe] jwe parents: 7018 diff changeset	266 Octave:function-name-clash
18154 5971c8f515a7 doc: Document options set when using --traditional. Rik <rik@octave.org> parents: 17793 diff changeset	267 Octave:possible-matlab-short-circuit-operator
4455 abbf63293766 [project @ 2003-07-11 01:01:16 by jwe] jwe parents: 4452 diff changeset	268 @end group
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	269 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	270
15618 9aa8dcf1e93d doc: cross-reference Octave:matlab-incompatible to --braindead and --traditional Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 15545 diff changeset	271 @noindent
19852 e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'. Carnë Draug <carandraug@octave.org> parents: 19697 diff changeset	272 Note that this does not enable the @code{Octave:language-extension}
15618 9aa8dcf1e93d doc: cross-reference Octave:matlab-incompatible to --braindead and --traditional Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 15545 diff changeset	273 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	274 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	275 @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	276
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	277 @item --verbose
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	278 @itemx -V
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	279 @cindex @sortas{options, Octave command --verbose} @ @ @code{--verbose}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	280 @cindex @sortas{options, Octave command -V} @ @ @code{-V}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	281 Turn on verbose output.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	282
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	283 @item --version
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	284 @itemx -v
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	285 @cindex @sortas{options, Octave command --version} @ @ @code{--version}
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	286 @cindex @sortas{options, Octave command -v} @ @ @code{-v}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	287 Print the program version number and exit.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	288
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	289 @item @var{file}
5190 2021bbfff5fd [project @ 2005-03-04 02:51:33 by jwe] jwe parents: 4476 diff changeset	290 Execute commands from @var{file}. Exit when done unless
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10613 diff changeset	291 @option{--persist} is also specified.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	292 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	293
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	294 Octave also includes several functions which return information
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	295 about the command line, including the number of arguments and all of the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	296 options.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	297
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	298 @DOCSTRING(argv)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	299
6550 1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	300 @DOCSTRING(program_name)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	301
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	302 @DOCSTRING(program_invocation_name)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	303
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	304 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	305 line which invoked Octave.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	306
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	307 @example
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	308 @group
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	309 printf ("%s", program_name ());
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	310 arg_list = argv ();
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	311 for i = 1:nargin
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	312 printf (" %s", arg_list@{i@});
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	313 endfor
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	314 printf ("\n");
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	315 @end group
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	316 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	317
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	318 @noindent
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	319 @xref{Indexing Cell Arrays}, for an explanation of how to retrieve objects
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	320 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	321 variable @code{nargin}.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	322
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	323 @node Startup Files
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	324 @subsection Startup Files
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	325 @cindex initialization
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	326 @cindex startup
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	327
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	328 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	329 the following list. These files may contain any valid Octave commands,
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	330 including function definitions.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	331
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	332 @cindex startup files
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	333
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	334 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	335 @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	336 @cindex site startup file
27832 8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	337 where @code{@var{octave-home}} is the directory in which Octave is installed
9906 8d20fb66a0dc more automake fixes John W. Eaton <jwe@octave.org> parents: 9153 diff changeset	338 (the default is @file{/usr/local}).
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	339 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	340 can be made globally for all users at your site for all versions of Octave
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	341 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	342 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	343 may be overridden by the environment variable @w{@env{OCTAVE_SITE_INITFILE}}.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	344
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	345 @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	346 @cindex version startup file
27832 8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	347 where @code{@var{octave-home}} is the directory in which Octave is installed
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	348 (the default is @file{/usr/local}), and @code{@var{version}} is the version
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	349 number of Octave. This file is provided so that changes to the default
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	350 Octave environment can be made globally for all users of a particular version
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	351 of Octave. Care should be taken when making changes to this file since all
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	352 users of Octave at your site will be affected. The default file may be
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	353 overridden by the environment variable @w{@env{OCTAVE_VERSION_INITFILE}}.
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	354
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	355 @item @var{config-dir}/octave/octaverc
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	356 @cindex personal startup file
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	357 where @code{@var{config-dir}} is the platform-dependent location for user
27931 0fa21907e54c doc: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 27838 diff changeset	358 local configuration files (e.g., @w{@env{$XDG_CONFIG_HOME}} on many Unix-like
27838 659acfaaf0c9 Use APPDATA for startup file location on Windows (bug #40444). Markus Mützel <markus.muetzel@gmx.de> parents: 27832 diff changeset	359 operating systems or @w{@env{%APPDATA%}} on Windows).
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	360
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	361 @item ~/.octaverc
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	362 @cindex personal startup file
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	363 @cindex @sortas{octaverc ~/.octaverc} @code{~/.octaverc}
27832 8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	364 This file is used to make personal changes to the default Octave environment.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	365
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	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
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	368 @cindex @sortas{octaverc .octaverc} @code{.octaverc}
27832 8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	369 This file can be used to make changes to the default Octave environment for a
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	370 particular project. Octave searches for this file in the current directory
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	371 after it reads @file{~/.octaverc}. Any use of the @code{cd} command in the
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	372 @file{~/.octaverc} file will affect the directory where Octave searches for
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	373 @file{.octaverc}.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	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 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	376 @file{~/.octaverc} will only be executed once.
21350 ea31a050bdd8 Execute commands in startup.m at start for compatibility with Matlab. Rik <rik@octave.org> parents: 20713 diff changeset	377
ea31a050bdd8 Execute commands in startup.m at start for compatibility with Matlab. Rik <rik@octave.org> parents: 20713 diff changeset	378 @item startup.m
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	379 @cindex @code{startup.m}
27832 8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	380 This file is used to make personal changes to the default Octave environment.
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	381 It is executed for @sc{matlab} compatibility, but @file{~/.octaverc} is the
8fd7d1d2a4ca Read startup files from XDG_CONFIG_HOME or LOCALAPPDATA (bug #36477). Mike Miller <mtmiller@octave.org> parents: 27517 diff changeset	382 preferred location for configuration changes.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	383 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	384
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	385 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	386 invoke Octave with the @option{--verbose} option but without the
322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10613 diff changeset	387 @option{--silent} option.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	388
28713 28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 28652 diff changeset	389 The startup files are always processed in the system's locale charset
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 28652 diff changeset	390 (independent of the m-file encoding that is set, for example, in the GUI
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 28652 diff changeset	391 properties). In other words, the system's locale charset is in effect until a
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 28652 diff changeset	392 user manually sets the m-file encoding (e.g., in one of the startup files) and
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 28652 diff changeset	393 triggers re-parsing of any relevant m-files. Octave can be forced to use a
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 28652 diff changeset	394 new encoding with the undocumented function @code{__mfile_encoding__}:
28506 6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	395
6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	396 @example
6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	397 @group
6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	398 __mfile_encoding__ ("utf-8"); # set new encoding
6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	399 clear ("functions"); # re-parse all .m files in the new encoding
6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	400 @end group
6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	401 @end example
6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	402
28713 28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 28652 diff changeset	403 This changes the encoding that is used to interpret all subsequently run
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 28652 diff changeset	404 startup and m-files (not including the currently executing file).
28506 6bd9d77c7105 Document that startup files are interpreted in the locale charset (bug #57235). Markus Mützel <markus.muetzel@gmx.de> parents: 27931 diff changeset	405
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	406 @node Quitting Octave
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	407 @section Quitting Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	408 @cindex exiting octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	409 @cindex quitting octave
19273 dc64f1c4a33e doc: Add documentation about finish.m and shutdown procedure to manual. Rik <rik@octave.org> parents: 18154 diff changeset	410 @cindex finish.m
dc64f1c4a33e doc: Add documentation about finish.m and shutdown procedure to manual. Rik <rik@octave.org> parents: 18154 diff changeset	411 @cindex site exiting file
dc64f1c4a33e doc: Add documentation about finish.m and shutdown procedure to manual. Rik <rik@octave.org> parents: 18154 diff changeset	412
dc64f1c4a33e doc: Add documentation about finish.m and shutdown procedure to manual. Rik <rik@octave.org> parents: 18154 diff changeset	413 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: 18154 diff changeset	414 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: 18154 diff changeset	415 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: 18154 diff changeset	416 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: 18154 diff changeset	417 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: 18154 diff changeset	418 functions to execute on shutdown may be registered with @code{atexit}.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	419
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	420 @DOCSTRING(quit)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	421
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	422 @DOCSTRING(atexit)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	423
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	424 @node Getting Help
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	425 @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	426 @cindex online help
6a4e79110857 doc: Replace 'on-line' with modern 'online' in documentation and messages. Rik <rik@octave.org> parents: 14138 diff changeset	427 @cindex help, online
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	428
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	429 The entire text of this manual is available from the Octave prompt
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	430 via the command @kbd{doc}. In addition, the documentation for
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	431 individual user-written functions and variables is also available via
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	432 the @kbd{help} command. This section describes the commands used for
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	433 reading the manual and the documentation strings for user-supplied
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	434 functions and variables. @xref{Function Files}, for more information
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	435 about how to document the functions you write.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	436
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	437 @DOCSTRING(help)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	438
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6501 diff changeset	439 @DOCSTRING(doc)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6501 diff changeset	440
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6501 diff changeset	441 @DOCSTRING(lookfor)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6501 diff changeset	442
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	443 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	444 function.
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	445
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	446 @DOCSTRING(news)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	447
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	448 @DOCSTRING(info)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	449
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	450 @DOCSTRING(warranty)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	451
9133 c0cef1436788 Update help text for sections 2.2 and 2.3 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9132 diff changeset	452 The following functions can be used to change which programs are used
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	453 for displaying the documentation, and where the documentation can be
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	454 found.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	455
6477 a441d6681364 [project @ 2007-03-29 13:44:44 by jwe] jwe parents: 5775 diff changeset	456 @DOCSTRING(info_file)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	457
6477 a441d6681364 [project @ 2007-03-29 13:44:44 by jwe] jwe parents: 5775 diff changeset	458 @DOCSTRING(info_program)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	459
6477 a441d6681364 [project @ 2007-03-29 13:44:44 by jwe] jwe parents: 5775 diff changeset	460 @DOCSTRING(makeinfo_program)
3686 9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3439 diff changeset	461
14618 36f451642f79 doc: Add texi_macros_file to manual. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	462 @DOCSTRING(texi_macros_file)
36f451642f79 doc: Add texi_macros_file to manual. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	463
9133 c0cef1436788 Update help text for sections 2.2 and 2.3 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9132 diff changeset	464 @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	465
16807 2fd22fbaffa3 doc: Add built_in_docstrings_file() to documentation. Rik <rik@octave.org> parents: 16774 diff changeset	466 @DOCSTRING(built_in_docstrings_file)
2fd22fbaffa3 doc: Add built_in_docstrings_file() to documentation. Rik <rik@octave.org> parents: 16774 diff changeset	467
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	468 @DOCSTRING(suppress_verbose_help_message)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	469
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	470 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	471 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	472 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	473
16872 5372068bb148 Rename gen_doc_cache() to doc_cache_create(). Rik <rik@octave.org> parents: 16816 diff changeset	474 @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	475
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	476 @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	477
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	478 @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	479
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	480 @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	481
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	482 @node Command Line Editing
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	483 @section Command Line Editing
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	484 @cindex command-line editing
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	485 @cindex editing the command line
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	486
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	487 Octave uses the GNU Readline library to provide an extensive set of
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	488 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	489 features are described in this manual. In addition, all of the editing
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	490 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	491 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	492 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	493 for a complete feature list.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	494
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	495 To insert printing characters (letters, digits, symbols, etc.), simply
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	496 type the character. Octave will insert the character at the cursor and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	497 advance the cursor forward.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	498
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	499 Many of the command-line editing functions operate using control
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	500 characters. For example, the character @kbd{Control-a} moves the cursor
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	501 to the beginning of the line. To type @kbd{C-a}, hold down @key{CTRL}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	502 and then press @key{a}. In the following sections, control characters
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	503 such as @kbd{Control-a} are written as @kbd{C-a}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	504
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	505 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	506 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	507 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	508 even @key{WINDOWS}. If your terminal does not have a @key{META} key, you
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6939 diff changeset	509 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	510 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	511 @key{ESC} @key{u}. The @kbd{ESC} character sequences are also allowed on
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	512 terminals with real Meta keys. In the following sections, Meta
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	513 characters such as @kbd{Meta-u} are written as @kbd{M-u}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	514
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3402 diff changeset	515
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	516 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	517 * Cursor Motion::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	518 * Killing and Yanking::
22342 609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	519 * Commands for Text::
609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	520 * Commands for Completion::
609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	521 * Commands for History::
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	522 * Customizing readline::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	523 * Customizing the Prompt::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	524 * Diary and Echo Commands::
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	525 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	526
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	527 @node Cursor Motion
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	528 @subsection Cursor Motion
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	529
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	530 The following commands allow you to position the cursor.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	531
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	532 @table @kbd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	533 @item C-b
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	534 Move back one character.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	535
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	536 @item C-f
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	537 Move forward one character.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	538
11487 0f14c093476e Add <BACKSPACE> documentation to cursor movement section. Rik <octave@nomad.inbox5.com> parents: 11486 diff changeset	539 @item @key{BACKSPACE}
0f14c093476e Add <BACKSPACE> documentation to cursor movement section. Rik <octave@nomad.inbox5.com> parents: 11486 diff changeset	540 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	541
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	542 @item @key{DEL}
11487 0f14c093476e Add <BACKSPACE> documentation to cursor movement section. Rik <octave@nomad.inbox5.com> parents: 11486 diff changeset	543 Delete the character underneath the cursor.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	544
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	545 @item C-d
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	546 Delete the character underneath the cursor.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	547
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	548 @item M-f
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	549 Move forward a word.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	550
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	551 @item M-b
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	552 Move backward a word.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	553
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	554 @item C-a
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	555 Move to the start of the line.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	556
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	557 @item C-e
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	558 Move to the end of the line.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	559
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	560 @item C-l
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	561 Clear the screen, reprinting the current line at the top.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	562
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	563 @item C-_
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	564 @itemx C-/
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	565 Undo the last action. You can undo all the way back to an empty line.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	566
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	567 @item M-r
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	568 Undo all changes made to this line. This is like typing the `undo'
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	569 command enough times to get back to the beginning.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	570 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	571
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	572 The above table describes the most basic possible keystrokes that you need
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	573 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	574 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	575 to move forward and backward.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	576
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	577 Notice how @kbd{C-f} moves forward a character, while @kbd{M-f} moves
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	578 forward a word. It is a loose convention that control keystrokes
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	579 operate on characters while meta keystrokes operate on words.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	580
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	581 @cindex clearing the screen
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	582
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	583 The function @code{clc} will allow you to clear the screen from within
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	584 Octave programs.
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	585
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	586 @DOCSTRING(clc)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	587
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	588 @node Killing and Yanking
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	589 @subsection Killing and Yanking
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	590
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	591 @dfn{Killing} text means to delete the text from the line, but to save
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	592 it away for later use, usually by @dfn{yanking} it back into the line.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	593 If the description for a command says that it `kills' text, then you can
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	594 be sure that you can get the text back in a different (or the same)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	595 place later.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	596
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	597 Here is the list of commands for killing text.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	598
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	599 @table @kbd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	600 @item C-k
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	601 Kill the text from the current cursor position to the end of the line.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	602
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	603 @item M-d
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	604 Kill from the cursor to the end of the current word, or if between
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	605 words, to the end of the next word.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	606
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	607 @item M-@key{DEL}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	608 Kill from the cursor to the start of the previous word, or if between
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	609 words, to the start of the previous word.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	610
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	611 @item C-w
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	612 Kill from the cursor to the previous whitespace. This is different than
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	613 @kbd{M-@key{DEL}} because the word boundaries differ.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	614 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	615
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	616 And, here is how to @dfn{yank} the text back into the line. Yanking
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	617 means to copy the most-recently-killed text from the kill buffer.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	618
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	619 @table @kbd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	620 @item C-y
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	621 Yank the most recently killed text back into the buffer at the cursor.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	622
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	623 @item M-y
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	624 Rotate the kill-ring, and yank the new top. You can only do this if
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	625 the prior command is @kbd{C-y} or @kbd{M-y}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	626 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	627
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	628 When you use a kill command, the text is saved in a @dfn{kill-ring}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	629 Any number of consecutive kills save all of the killed text together, so
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	630 that when you yank it back, you get it in one clean sweep. The kill
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	631 ring is not line specific; the text that you killed on a previously
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	632 typed line is available to be yanked back later, when you are typing
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	633 another line.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	634
22342 609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	635 @node Commands for Text
609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	636 @subsection Commands for Changing Text
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	637
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	638 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	639 otherwise have a special meaning (e.g., @key{TAB}, @kbd{C-q}, etc.), or
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	640 for quickly correcting typing mistakes.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	641
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	642 @table @kbd
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	643 @item C-q
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	644 @itemx C-v
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	645 Add the next character that you type to the line verbatim. This is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	646 how to insert things like @kbd{C-q} for example.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	647
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	648 @item M-@key{TAB}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	649 Insert a tab character.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	650
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	651 @item C-t
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	652 Drag the character before the cursor forward over the character at the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	653 cursor, also moving the cursor forward. If the cursor is at the end of
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	654 the line, then transpose the two characters before it.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	655
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	656 @item M-t
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	657 Drag the word behind the cursor past the word in front of the cursor
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	658 moving the cursor over that word as well.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	659
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	660 @item M-u
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	661 Uppercase the characters following the cursor to the end of the current
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	662 (or following) word, moving the cursor to the end of the word.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	663
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	664 @item M-l
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	665 Lowercase the characters following the cursor to the end of the current
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	666 (or following) word, moving the cursor to the end of the word.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	667
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	668 @item M-c
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	669 Uppercase the character following the cursor (or the beginning of the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	670 next word if the cursor is between words), moving the cursor to the end
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	671 of the word.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	672 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	673
22342 609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	674 @node Commands for Completion
609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	675 @subsection Letting Readline Type for You
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	676 @cindex command completion
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	677
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	678 The following commands allow Octave to complete command and variable
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	679 names for you.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	680
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	681 @table @kbd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	682 @item @key{TAB}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	683 Attempt to do completion on the text before the cursor. Octave can
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	684 complete the names of commands and variables.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	685
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	686 @item M-?
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	687 List the possible completions of the text before the cursor.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	688 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	689
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	690 @DOCSTRING(completion_append_char)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	691
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	692 @DOCSTRING(completion_matches)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	693
22342 609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	694 @node Commands for History
609403f90bb7 doc: Update Copyright and release date for manual. Rik <rik@octave.org> parents: 22323 diff changeset	695 @subsection Commands for Manipulating the History
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	696 @cindex command history
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	697 @cindex input history
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	698 @cindex history of commands
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	699
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	700 Octave normally keeps track of the commands you type so that you can
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	701 recall previous commands to edit or execute them again. When you exit
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	702 Octave, the most recent commands you have typed, up to the number
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	703 specified by the variable @code{history_size}, are saved in a file.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	704 When Octave starts, it loads an initial list of commands from the file
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	705 named by the variable @code{history_file}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	706
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	707 Here are the commands for simple browsing and searching the history
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	708 list.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	709
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	710 @table @kbd
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	711 @item @key{LFD}
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	712 @itemx @key{RET}
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	713 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	714 non-empty, add it to the history list. If the line was a history
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	715 line, then restore the history line to its original state.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	716
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	717 @item C-p
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	718 Move `up' through the history list.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	719
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	720 @item C-n
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	721 Move `down' through the history list.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	722
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	723 @item M-<
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	724 Move to the first line in the history.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	725
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	726 @item M->
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	727 Move to the end of the input history, i.e., the line you are entering!
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	728
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	729 @item C-r
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	730 Search backward starting at the current line and moving `up' through
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	731 the history as necessary. This is an incremental search.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	732
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	733 @item C-s
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	734 Search forward starting at the current line and moving `down' through
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	735 the history as necessary.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	736 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	737
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	738 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	739 of @kbd{C-p} and @kbd{C-n} to move through the history list.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	740
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	741 In addition to the keyboard commands for moving through the history
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	742 list, Octave provides three functions for viewing, editing, and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	743 re-running chunks of commands from the history list.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	744
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	745 @DOCSTRING(history)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	746
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	747 @DOCSTRING(edit_history)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	748
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	749 @DOCSTRING(run_history)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	750
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	751 @noindent
a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	752 Octave also allows you customize the details of when, where, and how history
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	753 is saved.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	754
16876 9e0618443c2b Rename saving_history() to history_save(). Rik <rik@octave.org> parents: 16875 diff changeset	755 @DOCSTRING(history_save)
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	756
11486 a1deab9a6e71 bash-like history control Pascal Dupuis <Pascal.Dupuis@worldonline.be> and John W. Eaton <jwe@octave.org> parents: 10846 diff changeset	757 @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	758
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	759 @DOCSTRING(history_file)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	760
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	761 @DOCSTRING(history_size)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	762
6550 1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	763 @DOCSTRING(history_timestamp_format_string)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	764
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	765 @DOCSTRING(EDITOR)
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	766
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	767 @node Customizing readline
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3402 diff changeset	768 @subsection Customizing @code{readline}
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	769 @cindex @sortas{inputrc ~/.inputrc} @code{~/.inputrc}
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	770 @cindex customizing @code{readline}
a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	771 @cindex @code{readline} customization
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3402 diff changeset	772
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	773 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	774 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	775 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	776 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	777 @file{~/.inputrc}.
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	778
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9133 diff changeset	779 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	780 the command line behavior.
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3402 diff changeset	781
16879 cc3743a91652 Rename read_readline_init_file to readline_read_init_file. Rik <rik@octave.org> parents: 16877 diff changeset	782 @DOCSTRING(readline_read_init_file)
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3402 diff changeset	783
16880 1aebb613a5ac Rename re_read_readline_init_file to readline_re_read_init_file. Rik <rik@octave.org> parents: 16879 diff changeset	784 @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	785
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	786 @node Customizing the Prompt
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	787 @subsection Customizing the Prompt
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	788 @cindex prompt customization
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	789 @cindex customizing the prompt
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	790
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	791 The following variables are available for customizing the appearance of
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	792 the command-line prompts. Octave allows the prompt to be customized by
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	793 inserting a number of backslash-escaped special characters that are
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	794 decoded as follows:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	795
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	796 @table @samp
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	797 @item \t
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	798 The time.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	799
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	800 @item \d
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	801 The date.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	802
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	803 @item \n
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	804 Begins a new line by printing the equivalent of a carriage return
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	805 followed by a line feed.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	806
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	807 @item \s
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	808 The name of the program (usually just @samp{octave}).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	809
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	810 @item \w
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	811 The current working directory.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	812
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	813 @item \W
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	814 The basename of the current working directory.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	815
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	816 @item \u
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	817 The username of the current user.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	818
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	819 @item \h
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	820 The hostname, up to the first `.'.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	821
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	822 @item \H
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	823 The hostname.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	824
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	825 @item \#
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	826 The command number of this command, counting from when Octave starts.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	827
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	828 @item \!
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	829 The history number of this command. This differs from @samp{\#} by the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	830 number of commands in the history list when Octave starts.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	831
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	832 @item \$
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	833 If the effective UID is 0, a @samp{#}, otherwise a @samp{$}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	834
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	835 @item \nnn
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	836 The character whose character code in octal is @var{nnn}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	837
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	838 @item \\
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	839 A backslash.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	840 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	841
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	842 @DOCSTRING(PS1)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	843
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	844 @DOCSTRING(PS2)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	845
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	846 @DOCSTRING(PS4)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	847
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	848 @node Diary and Echo Commands
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	849 @subsection Diary and Echo Commands
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	850 @cindex diary of commands and output
6939 46d1ad37d943 [project @ 2007-10-01 16:12:20 by jwe] jwe parents: 6778 diff changeset	851 @cindex command and output logs
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	852 @cindex logging commands and output
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	853 @cindex echoing executing commands
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	854 @cindex command echoing
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	855
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	856 Octave's diary feature allows you to keep a log of all or part of an
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	857 interactive session by recording the input you type and the output that
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	858 Octave produces in a separate file.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	859
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	860 @DOCSTRING(diary)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	861
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	862 Sometimes it is useful to see the commands in a function or script as
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	863 they are being evaluated. This can be especially helpful for debugging
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	864 some kinds of problems.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	865
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	866 @DOCSTRING(echo)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	867
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	868 @node Errors
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	869 @section How Octave Reports Errors
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	870 @cindex error messages
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	871 @cindex messages, error
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	872
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	873 Octave reports two kinds of errors for invalid programs.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	874
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	875 A @dfn{parse error} occurs if Octave cannot understand something you
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	876 have typed. For example, if you misspell a keyword,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	877
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	878 @example
30321 2ba4758654ca deprecate and . operators (bug #60882) John W. Eaton <jwe@octave.org> parents: 29982 diff changeset	879 octave:13> function z = f (x, y) z = x \|\|\| 2; endfunction
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	880 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	881
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	882 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	883 Octave will respond immediately with a message like this:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	884
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	885 @example
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	886 @group
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	887 parse error:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	888
8015 30629059b72d Update the manual to reflect the changes in error output sh@sh-laptop parents: 7031 diff changeset	889 syntax error
30629059b72d Update the manual to reflect the changes in error output sh@sh-laptop parents: 7031 diff changeset	890
30321 2ba4758654ca deprecate and . operators (bug #60882) John W. Eaton <jwe@octave.org> parents: 29982 diff changeset	891 >>> function z = f (x, y) z = x \|\|\| y; endfunction
2ba4758654ca deprecate and . operators (bug #60882) John W. Eaton <jwe@octave.org> parents: 29982 diff changeset	892 ^
9132 eb1747dbd360 Update help strings for command line options Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	893 @end group
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	894 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	895
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	896 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	897 For most parse errors, Octave uses a caret (@samp{^}) to mark the point
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	898 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	899 case, Octave generated an error message because the keyword for
30321 2ba4758654ca deprecate and . operators (bug #60882) John W. Eaton <jwe@octave.org> parents: 29982 diff changeset	900 the logical or operator (@code{\|\|}) was misspelled. It marked the error
2ba4758654ca deprecate and . operators (bug #60882) John W. Eaton <jwe@octave.org> parents: 29982 diff changeset	901 at the third @samp{\|} because the code leading up to this was correct
2ba4758654ca deprecate and . operators (bug #60882) John W. Eaton <jwe@octave.org> parents: 29982 diff changeset	902 but the final @samp{\|} was not understood.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	903
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	904 Another class of error message occurs at evaluation time. These
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	905 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	906 @dfn{evaluation errors}, because they occur when your program is being
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	907 @dfn{run}, or @dfn{evaluated}. For example, if after correcting the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	908 mistake in the previous function definition, you type
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	909
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	910 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	911 octave:13> f ()
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	912 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	913
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	914 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	915 Octave will respond with
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	916
9153 5247e89688e1 Eliminate most overfull errors when running texi2pdf for generating pdf documentation Rik <rdrider0-list@yahoo.com> parents: 9135 diff changeset	917 @example
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	918 @group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	919 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	920 error: called from:
30629059b72d Update the manual to reflect the changes in error output sh@sh-laptop parents: 7031 diff changeset	921 error: f at line 1, column 22
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	922 @end group
9153 5247e89688e1 Eliminate most overfull errors when running texi2pdf for generating pdf documentation Rik <rdrider0-list@yahoo.com> parents: 9135 diff changeset	923 @end example
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	924
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	925 @noindent
9135 b04f95fabbf9 Update sections 2.5, 2.6, 2.7 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9134 diff changeset	926 This error message has several parts, and gives quite a bit of
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	927 information to help you locate the source of the error. The messages
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	928 are generated from the point of the innermost error, and provide a
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	929 traceback of enclosing expressions and function calls.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	930
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	931 In the example above, the first line indicates that a variable named
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	932 @samp{x} was found to be undefined near line 1 and column 24 of some
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	933 function or expression. For errors occurring within functions, lines
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	934 are counted from the beginning of the file containing the function
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	935 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	936 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	937 in the primary prompt string.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	938
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	939 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	940 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	941 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	942 errors would have ended with one more line:
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	943
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	944 @example
8015 30629059b72d Update the manual to reflect the changes in error output sh@sh-laptop parents: 7031 diff changeset	945 error: g at line 1, column 17
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	946 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	947
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	948 These lists of function calls make it fairly easy to trace the
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	949 path your program took before the error occurred, and to correct the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	950 error before trying again.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	951
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	952 @node Executable Octave Programs
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	953 @section Executable Octave Programs
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	954 @cindex executable scripts
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	955 @cindex scripts
9135 b04f95fabbf9 Update sections 2.5, 2.6, 2.7 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9134 diff changeset	956 @cindex batch processing
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	957 @cindex self contained programs
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	958 @cindex program, self contained
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	959
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	960 @opindex @code{#!} self-contained script
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	961 Once you have learned Octave, you may want to write self-contained
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	962 Octave scripts, using the @samp{#!} script mechanism. You can do this
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	963 on GNU systems and on many Unix systems @footnote{The @samp{#!}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	964 mechanism works on Unix systems derived from Berkeley Unix, System V
6481 89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	965 Release 4, and some System V Release 3 systems.}.
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	966
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	967 Self-contained Octave scripts are useful when you want to write a
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	968 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	969 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	970 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	971 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	972 script and used again and again on new data files.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	973
9135 b04f95fabbf9 Update sections 2.5, 2.6, 2.7 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9134 diff changeset	974 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	975 text file named @file{hello}, containing the following lines:
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	976
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	977 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	978 @group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	979 #! @var{octave-interpreter-name} -qf
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	980 # a sample Octave program
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	981 printf ("Hello, world!\n");
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	982 @end group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	983 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	984
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	985 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	986 (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	987 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	988 @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	989 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	990 simply type:
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	991
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	992 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	993 hello
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	994 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	995
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	996 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	997 at the shell, and the system will arrange to run Octave as if you had
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	998 typed:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	999
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1000 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1001 octave hello
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1002 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1003
9135 b04f95fabbf9 Update sections 2.5, 2.6, 2.7 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9134 diff changeset	1004 The line beginning with @samp{#!} lists the full path and filename of an
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1005 interpreter to be run, and an optional initial command line argument to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1006 pass to that interpreter. The operating system then runs the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1007 interpreter with the given argument and the full argument list of the
20713 2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base. Rik <rik@octave.org> parents: 19852 diff changeset	1008 executed program. The first argument in the list is the full filename
9135 b04f95fabbf9 Update sections 2.5, 2.6, 2.7 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9134 diff changeset	1009 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	1010 options to Octave, or data files, or both. The @samp{-qf} options are
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1011 usually specified in stand-alone Octave programs to prevent them from
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1012 printing the normal startup message, and to keep them from behaving
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1013 differently depending on the contents of a particular user's
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	1014 @file{~/.octaverc} file. @xref{Invoking Octave from the Command Line}.
6481 89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1015
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1016 Note that some operating systems may place a limit on the number of
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	1017 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	1018 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	1019 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	1020 string and pass it to the interpreter as a single argument. In this case, the
6481 89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1021 following script:
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1022
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1023 @example
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1024 @group
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1025 #! @var{octave-interpreter-name} -q -f # comment
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1026 @end group
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1027 @end example
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1028
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1029 @noindent
9135 b04f95fabbf9 Update sections 2.5, 2.6, 2.7 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9134 diff changeset	1030 is equivalent to typing at the command line:
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1031
6481 89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1032 @example
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1033 @group
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1034 octave "-q -f # comment"
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1035 @end group
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1036 @end example
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1037
6481 89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1038 @noindent
9135 b04f95fabbf9 Update sections 2.5, 2.6, 2.7 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9134 diff changeset	1039 which will produce an error message. Unfortunately, it is
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	1040 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	1041 command line or from a @samp{#!} script, so some care is needed when using the
6481 89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1042 @samp{#!} mechanism.
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1043
29508 7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1044 @menu
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1045 * Passing Arguments to Executable Scripts::
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1046 * Dual-Purpose Executable Scripts and Octave Functions::
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1047 @end menu
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1048
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1049 @node Passing Arguments to Executable Scripts
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1050 @subsection Passing Arguments to Executable Scripts
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1051
6481 89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1052 Note that when Octave is started from an executable script, the built-in
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1053 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	1054 arguments passed to the executable Octave script, not the arguments
6481 89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1055 passed to the Octave interpreter on the @samp{#!} line of the script.
89ed13fec6fe [project @ 2007-04-03 19:39:11 by jwe] jwe parents: 6479 diff changeset	1056 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	1057 was used to execute the script, not @samp{-qf}.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1058
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1059 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1060 @group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1061 #! /bin/octave -qf
6479 2ee8293554a3 [project @ 2007-04-03 15:30:58 by jwe] jwe parents: 6477 diff changeset	1062 printf ("%s", program_name ());
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 6556 diff changeset	1063 arg_list = argv ();
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1064 for i = 1:nargin
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	1065 printf (" %s", arg_list@{i@});
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1066 endfor
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1067 printf ("\n");
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1068 @end group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1069 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1070
29508 7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1071 @node Dual-Purpose Executable Scripts and Octave Functions
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1072 @subsection Dual-Purpose Executable Scripts and Octave Functions
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1073
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1074 To write m-files that can act as executable programs when called from the shell
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1075 or as normal functions when called from within Octave, use default input
29668 f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release. Rik <rik@octave.org> parents: 29508 diff changeset	1076 arguments initialized with the @code{argv} function.
29508 7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1077
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1078 If a function is called from the shell Octave will not pass any input
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1079 parameters to the function and therefore the default argument is used. But
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1080 when a function is called from the interpreter any arguments @emph{are} passed
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1081 to the function and these override the default.
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1082
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1083 Additionally, the file must end with the extension @file{.m} so that the
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1084 interpreter will recognize it as an Octave function. Finally, the output from
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1085 @code{argv} is a cell array of strings. It may be necessary to convert this
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1086 to a numeric value with @code{str2double} or @code{str2num} before processing.
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1087
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1088 As a complete example, consider the following code located in the file
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1089 @file{mysin.m}.
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1090
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1091 @example
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1092 @group
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1093 #! /bin/octave -qf
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1094 function retval = mysin (x = str2double (argv()@{end@}))
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1095 retval = sin (x)
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1096 endfunction
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1097 @end group
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1098 @end example
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1099
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1100 This can be called from the shell with
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1101
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1102 @example
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1103 mysin.m 1.5
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1104 @end example
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1105
29668 f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release. Rik <rik@octave.org> parents: 29508 diff changeset	1106 @noindent
29508 7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1107 or from Octave with
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1108
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1109 @example
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1110 mysin (1.5)
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1111 @end example
7e987b69ebde doc: Explain how to write dual-purpose executable scripts and Octave functions (bug #60291). Rik <rik@octave.org> parents: 28713 diff changeset	1112
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3974 diff changeset	1113 @node Comments
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1114 @section Comments in Octave Programs
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1115 @cindex comments
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1116 @cindex use of comments
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1117 @cindex documenting Octave programs
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1118
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1119 A @dfn{comment} is some text that is included in a program for the sake
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	1120 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	1121 Comments can explain what the program does, and how it works. Nearly all
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1122 programming languages have provisions for comments, because programs are
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1123 typically hard to understand without them.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1124
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1125 @menu
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1126 * Single Line Comments::
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1127 * Block Comments::
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	1128 * Comments and the Help System::
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1129 @end menu
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1130
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1131 @node Single Line Comments
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1132 @subsection Single Line Comments
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1133
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	1134 @opindex @code{#} comment marker
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	1135 @opindex @code{%} comment marker
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1136 In the Octave language, a comment starts with either the sharp sign
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1137 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	1138 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	1139 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	1140 shows whole line and partial line comments.
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10613 diff changeset	1141
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1142 @example
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1143 @group
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1144 function countdown
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	1145 # 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	1146 disp (3);
c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14618 diff changeset	1147 disp (2);
c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14618 diff changeset	1148 disp (1);
c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14618 diff changeset	1149 disp ("Blast Off!"); # Rocket leaves pad
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1150 endfunction
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1151 @end group
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1152 @end example
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1153
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1154 @node Block Comments
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1155 @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	1156 @cindex block comments
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1157 @cindex multi-line comments
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1158
24507 dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	1159 @opindex @code{#@{} block comment marker
dc25a0dc7800 Correct a host of small formatting issues with Texinfo manual (bug #52774) Daniel J Sebald <daniel.sebald@ieee.org> parents: 23723 diff changeset	1160 @opindex @code{%@{} block comment marker
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	1161 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	1162 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	1163 For example,
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10613 diff changeset	1164
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1165 @example
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1166 @group
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1167 function quick_countdown
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	1168 # 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	1169 disp (3);
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1170 #@{
14856 c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14618 diff changeset	1171 disp (2);
c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14618 diff changeset	1172 disp (1);
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1173 #@}
14856 c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14618 diff changeset	1174 disp ("Blast Off!"); # Rocket leaves pad
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1175 endfunction
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1176 @end group
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1177 @end example
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1178
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1179 @noindent
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1180 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	1181 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	1182
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	1183 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	1184 (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	1185
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1186 @node Comments and the Help System
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1187 @subsection Comments and the Help System
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1188 @cindex documenting functions
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1189 @cindex documenting user scripts
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1190 @cindex help, user-defined functions
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1191
57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1192 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	1193 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	1194 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	1195 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	1196 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	1197
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1198 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1199 @group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1200 function xdot = f (x, t)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1201
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1202 # usage: f (x, t)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1203 #
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1204 # This function defines the right-hand
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1205 # side functions for a set of nonlinear
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1206 # differential equations.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1207
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1208 r = 0.25;
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1209 @dots{}
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1210 endfunction
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1211 @end group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1212 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1213
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	1214 @noindent
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1215 the command @kbd{help f} produces the output
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1216
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1217 @example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1218 @group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1219 usage: f (x, t)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1220
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1221 This function defines the right-hand
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1222 side functions for a set of nonlinear
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1223 differential equations.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1224 @end group
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1225 @end example
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1226
9135 b04f95fabbf9 Update sections 2.5, 2.6, 2.7 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9134 diff changeset	1227 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	1228 throw-away Octave programs, it usually isn't very useful because the
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1229 purpose of a comment is to help you or another person understand the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1230 program at a later time.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	1231
9035 57649dcecb55 Documentation cleanup of basics.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1232 The @code{help} parser currently only recognizes single line comments
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17793 diff changeset	1233 (@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	1234 help text.

Mercurial > octave

annotate doc/interpreter/basics.txi @ 31191:bb9d776eafac stable