Mercurial > octave-nkf

diff doc/interpreter/basics.txi @ 16807:2fd22fbaffa3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add built_in_docstrings_file() to documentation. * doc/interpreter/basics.txi: Add built_in_docstrings_file() to manual. * libinterp/interpfcn/help.cc(built_in_docstrings_file): Update docstring to mention environment variable and command line overrides.
author Rik <rik@octave.org>
date Sat, 22 Jun 2013 10:58:16 -0700
parents 8d188159ce5f
children 12005245b645
line wrap: on
line diff
--- a/doc/interpreter/basics.txi	Sat Jun 22 10:28:21 2013 -0700
+++ b/doc/interpreter/basics.txi	Sat Jun 22 10:58:16 2013 -0700
@@ -67,6 +67,13 @@
 
 
 @table @code
+
+@item --built-in-docstrings-file @var{filename}
+@cindex @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.
+
 @item  --debug
 @itemx -d
 @cindex @code{--debug}
@@ -75,8 +82,8 @@
 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 --docXcache-file @var{filename}
-@cindex @code{--docXcache-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
 @w{@env{OCTAVE_DOC_CACHE_FILE}} found in the environment, but not any commands
@@ -426,6 +433,8 @@
 
 @DOCSTRING(doc_cache_file)
 
+@DOCSTRING(built_in_docstrings_file)
+
 @DOCSTRING(suppress_verbose_help_message)
 
 The following functions are principally used internally by Octave for