Mercurial > octave-nkf
diff doc/interpreter/basics.txi @ 9132:eb1747dbd360
Update help strings for command line options
Add documentation for --no-init-path option
Add documentation for environment variables OCTAVE_SITE_INITFILE, OCTAVE_VERSION_INITFILE
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 17 Apr 2009 14:53:17 -0700 |
parents | 1bf0ce0930be |
children | c0cef1436788 |
line wrap: on
line diff
--- a/doc/interpreter/basics.txi Fri Apr 17 14:53:05 2009 -0700 +++ b/doc/interpreter/basics.txi Fri Apr 17 14:53:17 2009 -0700 @@ -63,12 +63,12 @@ @cindex command options @cindex options, Octave command -Here is a complete list of all the command line options that Octave +Here is a complete list of the command line options that Octave accepts. @table @code -@item --debug +@item --debug @itemx -d @cindex @code{--debug} @cindex @code{-d} @@ -76,22 +76,22 @@ parser to print a lot of information about the commands it reads, and is probably only useful if you are actually trying to debug the parser. -@item --doc-cache-file -@cindex @code{--doc-cache-file} @var{filename} +@item --doc-cache-file @var{filename} +@cindex @code{--doc-cache-file @var{filename}} Specify the name of the doc cache file to use. The value of @var{filename} specified on the command line will override any value of @code{OCTAVE_DOC_CACHE_FILE} found in the environment, but not any commands -in the system or user startup files that use the @code{doc_file_cache} +in the system or user startup files that use the @code{doc_cache_file} function. -@item --echo-commands +@item --echo-commands @itemx -x @cindex @code{--echo-commands} @cindex @code{-x} Echo commands as they are executed. @item --eval @var{code} -Evaluate @var{code} and exit when done unless @code{--persist} is also +Evaluate @var{code} and exit when finished unless @code{--persist} is also specified. @item --exec-path @var{path} @@ -102,7 +102,7 @@ in the system or user startup files that set the built-in variable @code{EXEC_PATH}. -@item --help +@item --help @itemx -h @itemx -? @cindex @code{--help} @@ -112,9 +112,11 @@ @item --image-path @var{path} @cindex @code{--image-path @var{path}} -Specify the path to search for images. The value of @var{path} -specified on the command line will set the value of -@code{IMAGE_PATH} found in the environment. +Add path to the head of the search path for images. The value of +@var{path} specified on the command line will override any value of +@code{OCTAVE_IMAGE_PATH} found in the environment, but not any commands +in the system or user startup files that set the built-in variable +@code{IMAGE_PATH}. @item --info-file @var{filename} @cindex @code{--info-file @var{filename}} @@ -132,7 +134,7 @@ commands in the system or user startup files that use the @code{info_program} function. -@item --interactive +@item --interactive @itemx -i @cindex @code{--interactive} @cindex @code{-i} @@ -140,13 +142,24 @@ remote shell command or inside an Emacs shell buffer. For another way to run Octave within Emacs, see @ref{Emacs Octave Support}. -@item --no-history +@item --line-editing +@cindex @code{--line-editing} +Force readline use for command-line editing. + +@item --no-history @itemx -H -Disable command-line history. +@cindex @code{--no-history} +@cindex @code{-H} +Disable recording of command-line history. @item --no-init-file @cindex @code{--no-init-file} -Don't read the @file{~/.octaverc} or @file{.octaverc} files. +Don't read the initialization files @file{~/.octaverc} and @file{.octaverc}. + +@item --no-init-path +@cindex @code{--no-init-path} +Don't initialize the search path for function files to include default +locations. @item --no-line-editing @cindex @code{--no-line-editing} @@ -154,9 +167,9 @@ @item --no-site-file @cindex @code{--no-site-file} -Don't read the site-wide @file{octaverc} file. +Don't read the site-wide @file{octaverc} initialization files. -@item --norc +@item --norc @itemx -f @cindex @code{--norc} @cindex @code{-f} @@ -164,21 +177,22 @@ This is equivalent to using both of the options @code{--no-init-file} and @code{--no-site-file}. -@item --path @var{path} +@item --path @var{path} @itemx -p @var{path} @cindex @code{--path @var{path}} @cindex @code{-p @var{path}} -Specify the path to search for function files. The value of @var{path} -specified on the command line will override any value of -@code{OCTAVE_PATH} found in the environment, but not any commands in the +Add path to the head of the search path for function files. The +value of @var{path} specified on the command line will override any value +of @code{OCTAVE_PATH} found in the environment, but not any commands in the system or user startup files that set the internal load path through one of the path functions. @item --persist +@cindex @code{--persist} Go to interactive mode after @code{--eval} or reading from a file named on the command line. -@item --silent +@item --silent @itemx --quiet @itemx -q @cindex @code{--silent} @@ -186,7 +200,7 @@ @cindex @code{-q} Don't print the usual greeting and version message at startup. -@item --traditional +@item --traditional @itemx --braindead @cindex @code{--traditional} @cindex @code{--braindead} @@ -198,6 +212,7 @@ PS1 = ">> " PS2 = "" beep_on_error = true +confirm_recursive_rmdir = false crash_dumps_octave_core = false default_save_options = "-mat-binary" fixed_point_format = true @@ -218,13 +233,13 @@ @end group @end example -@item --verbose +@item --verbose @itemx -V @cindex @code{--verbose} @cindex @code{-V} Turn on verbose output. -@item --version +@item --version @itemx -v @cindex @code{--version} @cindex @code{-v} @@ -235,7 +250,7 @@ @code{--persist} is also specified. @end table -Octave also includes several built-in variables that contain information +Octave also includes several functions which return information about the command line, including the number of arguments and all of the options. @@ -245,22 +260,24 @@ @DOCSTRING(program_invocation_name) -Here is an example of using these functions to reproduce Octave's -command line. +Here is an example of using these functions to reproduce the command +line which invoked Octave. @example +@group printf ("%s", program_name ()); arg_list = argv (); for i = 1:nargin printf (" %s", arg_list@{i@}); endfor printf ("\n"); +@end group @end example @noindent -@xref{Index Expressions}, for an explanation of how to properly index -arrays of strings and substrings in Octave, and @xref{Defining Functions}, -for information about the variable @code{nargin}. +@xref{Indexing Cell Arrays}, for an explanation of how to retrieve objects +from cell arrays, and @ref{Defining Functions}, for information about the +variable @code{nargin}. @node Startup Files @subsection Startup Files @@ -275,28 +292,34 @@ @table @code @item @var{octave-home}/share/octave/site/m/startup/octaverc -Where @var{octave-home} is the directory in which all of Octave is -installed (the default is @file{@value{OCTAVEHOME}}). This file is -provided so that changes to the default Octave environment can be made -globally for all users at your site for all versions of Octave you have -installed. Some care should be taken when making changes to this file, -since all users of Octave at your site will be affected. +@cindex site startup file +where @var{octave-home} is the directory in which Octave is installed +(the default is @file{@value{OCTAVEHOME}}). +This file is provided so that changes to the default Octave environment +can be made globally for all users at your site for all versions of Octave +you have installed. Care should be taken when making changes to this file +since all users of Octave at your site will be affected. The default file +may be overridden by the environment variable @w{@code{OCTAVE_SITE_INITFILE}}. @item @var{octave-home}/share/octave/@var{version}/m/startup/octaverc -Where @var{octave-home} is the directory in which all of Octave is +@cindex version startup file +where @var{octave-home} is the directory in which Octave is installed (the default is @file{@value{OCTAVEHOME}}), and @var{version} is the version number of Octave. This file is provided so that changes -to the default Octave environment can be made globally for all users for -a particular version of Octave. Some care should be taken when making -changes to this file, since all users of Octave at your site will be -affected. +to the default Octave environment can be made globally for all users of +a particular version of Octave. Care should be taken when making +changes to this file since all users of Octave at your site will be +affected. The default file may be overridden by the environment variable +@w{@code{OCTAVE_VERSION_INITFILE}}. @item ~/.octaverc +@cindex personal startup file @cindex @code{~/.octaverc} This file is used to make personal changes to the default Octave environment. @item .octaverc +@cindex project startup file @cindex @code{.octaverc} This file can be used to make changes to the default Octave environment for a particular project. Octave searches for this file in the current @@ -754,12 +777,14 @@ Octave will respond immediately with a message like this: @example +@group parse error: syntax error >>> functon y = f (x) y = x^2; endfunction ^ +@end group @end example @noindent