Mercurial > hg > octave-nkf
diff doc/interpreter/basics.txi @ 10828:322f43e0e170
Grammarcheck .txi documentation files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Wed, 28 Jul 2010 12:45:04 -0700 |
parents | e103fb2182ce |
children | a4f482e66b65 |
line wrap: on
line diff
--- a/doc/interpreter/basics.txi +++ b/doc/interpreter/basics.txi @@ -80,7 +80,7 @@ @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 -@w{@code{OCTAVE_DOC_CACHE_FILE}} found in the environment, but not any commands +@w{@env{OCTAVE_DOC_CACHE_FILE}} found in the environment, but not any commands in the system or user startup files that use the @code{doc_cache_file} function. @@ -91,16 +91,16 @@ Echo commands as they are executed. @item --eval @var{code} -Evaluate @var{code} and exit when finished unless @code{--persist} is also +Evaluate @var{code} and exit when finished unless @option{--persist} is also specified. @item --exec-path @var{path} @cindex @code{--exec-path @var{path}} Specify the path to search for programs to run. The value of @var{path} specified on the command line will override any value of -@w{@code{OCTAVE_EXEC_PATH}} found in the environment, but not any commands +@w{@env{OCTAVE_EXEC_PATH}} found in the environment, but not any commands in the system or user startup files that set the built-in variable -@w{@code{EXEC_PATH}}. +@w{@env{EXEC_PATH}}. @item --help @itemx -h @@ -114,15 +114,15 @@ @cindex @code{--image-path @var{path}} 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 -@w{@code{OCTAVE_IMAGE_PATH}} found in the environment, but not any commands +@w{@env{OCTAVE_IMAGE_PATH}} found in the environment, but not any commands in the system or user startup files that set the built-in variable -@w{@code{IMAGE_PATH}}. +@w{@env{IMAGE_PATH}}. @item --info-file @var{filename} @cindex @code{--info-file @var{filename}} Specify the name of the info file to use. The value of @var{filename} specified on the command line will override any value of -@w{@code{OCTAVE_INFO_FILE}} found in the environment, but not any commands +@w{@env{OCTAVE_INFO_FILE}} found in the environment, but not any commands in the system or user startup files that use the @code{info_file} function. @@ -130,7 +130,7 @@ @cindex @code{--info-program @var{program}} Specify the name of the info program to use. The value of @var{program} specified on the command line will override any value of -@w{@code{OCTAVE_INFO_PROGRAM}} found in the environment, but not any +@w{@env{OCTAVE_INFO_PROGRAM}} found in the environment, but not any commands in the system or user startup files that use the @code{info_program} function. @@ -174,8 +174,8 @@ @cindex @code{--norc} @cindex @code{-f} Don't read any of the system or user initialization files at startup. -This is equivalent to using both of the options @code{--no-init-file} -and @code{--no-site-file}. +This is equivalent to using both of the options @option{--no-init-file} +and @option{--no-site-file}. @item --path @var{path} @itemx -p @var{path} @@ -183,13 +183,13 @@ @cindex @code{-p @var{path}} 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 @w{@code{OCTAVE_PATH}} found in the environment, but not any commands in the +of @w{@env{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 +Go to interactive mode after @option{--eval} or reading from a file named on the command line. @item --silent @@ -225,6 +225,7 @@ @noindent and disable the following warnings + @example @group Octave:abbreviated-property-match @@ -248,7 +249,7 @@ @item @var{file} Execute commands from @var{file}. Exit when done unless -@code{--persist} is also specified. +@option{--persist} is also specified. @end table Octave also includes several functions which return information @@ -300,7 +301,7 @@ 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}}. +may be overridden by the environment variable @w{@env{OCTAVE_SITE_INITFILE}}. @item @var{octave-home}/share/octave/@var{version}/m/startup/octaverc @cindex version startup file @@ -311,7 +312,7 @@ 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}}. +@w{@env{OCTAVE_VERSION_INITFILE}}. @item ~/.octaverc @cindex personal startup file @@ -333,8 +334,8 @@ @end table A message will be displayed as each of the startup files is read if you -invoke Octave with the @code{--verbose} option but without the -@code{--silent} option. +invoke Octave with the @option{--verbose} option but without the +@option{--silent} option. @node Quitting Octave @section Quitting Octave @@ -993,6 +994,7 @@ end of the line. Any text following the sharp sign or percent symbol is ignored by the Octave interpreter and not executed. The following example shows whole line and partial line comments. + @example @group function countdown @@ -1015,6 +1017,7 @@ Entire blocks of code can be commented by enclosing the code between matching @samp{#@{} and @samp{#@}} or @samp{%@{} and @samp{%@}} markers. For example, + @example @group function quick_countdown @@ -1044,6 +1047,7 @@ string. This means that the same commands used to get help on built-in functions are available for properly formatted user-defined functions. For example, after defining the function @code{f} below, + @example @group function xdot = f (x, t)