Mercurial > octave

diff doc/interpreter/basics.txi @ 31535:4b80982e0af8 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add undocumented functions to Octave manual for 8.1 release. * basics.txi: Add DOCSTRING entry for "cmdline_options". Correct missing word in description of "--built-in-docstrings-file" commmand line option. Wrap some lines to 80 characters. * mk_undocumented_list: Add exceptions to undocumented list for ytickangle, ztickangle. * octave.cc (Fcmdline_options): Improve documentation string. Add BIST tests. * octave.cc (Fprogram_invocation_name, Fprogram_name): Improve documentation string. Check for pattern "Invalid call" in BIST error tests for input validation.
author Rik <rik@octave.org>
date Thu, 24 Nov 2022 06:30:04 -0800
parents 796f54d4ddbf
children 597f3ee61a48
line wrap: on
line diff
--- a/doc/interpreter/basics.txi	Thu Nov 24 06:12:23 2022 -0800
+++ b/doc/interpreter/basics.txi	Thu Nov 24 06:30:04 2022 -0800
@@ -65,14 +65,13 @@
 Here is a complete list of the command line options that Octave
 accepts.
 
-
 @table @code
 
 @item --built-in-docstrings-file @var{filename}
 @cindex @sortas{options, Octave command --built-in-docstrings-file} @ @ @code{--built-in-docstrings-file @var{filename}}
 Specify the name of the file containing documentation strings for the
 built-in functions of Octave.  This value is normally correct and should
-only need to specified in extraordinary situations.
+only need to be specified in extraordinary situations.
 
 @item  --debug
 @itemx -d
@@ -84,8 +83,8 @@
 
 @item --doc-cache-file @var{filename}
 @cindex @sortas{options, Octave command --doc-cache-file} @ @ @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
+Specify the name of the documentation cache file to use.  The value of
+@var{filename} specified on the command line will override any value of
 @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.
@@ -287,16 +286,17 @@
 Print the program version number and exit.
 
 @item @var{file}
-Execute commands from @var{file}.  Exit when done unless
-@option{--persist} is also specified.
+Execute commands from @var{file}.  Exit when done unless @option{--persist} is
+also specified.
 @end table
 
-Octave also includes several functions which return information
-about the command line, including the number of arguments and all of the
-options.
+Octave also includes several functions which return information about the
+command line, including the number of arguments and all of the options.
 
 @DOCSTRING(argv)
 
+@DOCSTRING(cmdline_options)
+
 @DOCSTRING(program_name)
 
 @DOCSTRING(program_invocation_name)