Mercurial > octave

comparison 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
comparison
equal deleted inserted replaced
31533:c154cc05cd1f 31535:4b80982e0af8
63 @cindex options, Octave command 63 @cindex options, Octave command
64 64
65 Here is a complete list of the command line options that Octave 65 Here is a complete list of the command line options that Octave
66 accepts. 66 accepts.
67 67
68
69 @table @code 68 @table @code
70 69
71 @item --built-in-docstrings-file @var{filename} 70 @item --built-in-docstrings-file @var{filename}
72 @cindex @sortas{options, Octave command --built-in-docstrings-file} @ @ @code{--built-in-docstrings-file @var{filename}} 71 @cindex @sortas{options, Octave command --built-in-docstrings-file} @ @ @code{--built-in-docstrings-file @var{filename}}
73 Specify the name of the file containing documentation strings for the 72 Specify the name of the file containing documentation strings for the
74 built-in functions of Octave. This value is normally correct and should 73 built-in functions of Octave. This value is normally correct and should
75 only need to specified in extraordinary situations. 74 only need to be specified in extraordinary situations.
76 75
77 @item --debug 76 @item --debug
78 @itemx -d 77 @itemx -d
79 @cindex @sortas{options, Octave command --debug} @ @ @code{--debug} 78 @cindex @sortas{options, Octave command --debug} @ @ @code{--debug}
80 @cindex @sortas{options, Octave command -d} @ @ @code{-d} 79 @cindex @sortas{options, Octave command -d} @ @ @code{-d}
82 parser to print a lot of information about the commands it reads, and is 81 parser to print a lot of information about the commands it reads, and is
83 probably only useful if you are actually trying to debug the parser. 82 probably only useful if you are actually trying to debug the parser.
84 83
85 @item --doc-cache-file @var{filename} 84 @item --doc-cache-file @var{filename}
86 @cindex @sortas{options, Octave command --doc-cache-file} @ @ @code{--doc-cache-file @var{filename}} 85 @cindex @sortas{options, Octave command --doc-cache-file} @ @ @code{--doc-cache-file @var{filename}}
87 Specify the name of the doc cache file to use. The value of @var{filename} 86 Specify the name of the documentation cache file to use. The value of
88 specified on the command line will override any value of 87 @var{filename} specified on the command line will override any value of
89 @w{@env{OCTAVE_DOC_CACHE_FILE}} found in the environment, but not any commands 88 @w{@env{OCTAVE_DOC_CACHE_FILE}} found in the environment, but not any commands
90 in the system or user startup files that use the @code{doc_cache_file} 89 in the system or user startup files that use the @code{doc_cache_file}
91 function. 90 function.
92 91
93 @item --echo-commands 92 @item --echo-commands
285 @cindex @sortas{options, Octave command --version} @ @ @code{--version} 284 @cindex @sortas{options, Octave command --version} @ @ @code{--version}
286 @cindex @sortas{options, Octave command -v} @ @ @code{-v} 285 @cindex @sortas{options, Octave command -v} @ @ @code{-v}
287 Print the program version number and exit. 286 Print the program version number and exit.
288 287
289 @item @var{file} 288 @item @var{file}
290 Execute commands from @var{file}. Exit when done unless 289 Execute commands from @var{file}. Exit when done unless @option{--persist} is
291 @option{--persist} is also specified. 290 also specified.
292 @end table 291 @end table
293 292
294 Octave also includes several functions which return information 293 Octave also includes several functions which return information about the
295 about the command line, including the number of arguments and all of the 294 command line, including the number of arguments and all of the options.
296 options.
297 295
298 @DOCSTRING(argv) 296 @DOCSTRING(argv)
297
298 @DOCSTRING(cmdline_options)
299 299
300 @DOCSTRING(program_name) 300 @DOCSTRING(program_name)
301 301
302 @DOCSTRING(program_invocation_name) 302 @DOCSTRING(program_invocation_name)
303 303