changeset 8923:d47290508a55

document --doc-cache-file option
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 11:35:31 -0500
parents 25b85c36208f
children 3c3cbe8f18e0
files doc/ChangeLog doc/interpreter/basics.txi src/ChangeLog src/octave.cc
diffstat 4 files changed, 18 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2009-03-07  John W. Eaton  <jwe@octave.org>
+
+	* interpreter/basics.txi (Command Line Options):
+	Document --doc-cache-file command-line option.
+
 2009-03-06  Jaroslav Hajek  <highegg@gmail.com>
 
 	* interpreter/diagperm.txi: Various improvements.
--- a/doc/interpreter/basics.txi
+++ b/doc/interpreter/basics.txi
@@ -76,6 +76,14 @@
 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}
+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}
+function.
+
 @item --echo-commands
 @itemx -x
 @cindex @code{--echo-commands}
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,7 @@
+2009-03-07  John W. Eaton  <jwe@octave.org>
+
+	* octave.cc (verbose_usage): Include --doc-cache-file in option list.
+
 2009-03-06  Jaroslav Hajek  <highegg@gmail.com>
 
 	* ov.h (octave_value::diag_matrix_value,
--- a/src/octave.cc
+++ b/src/octave.cc
@@ -487,6 +487,7 @@
 Options:\n\
 \n\
   --debug, -d             Enter parser debugging mode.\n\
+  --doc-cache-file FILE   Use doc cache file FILE.\n\
   --echo-commands, -x     Echo commands as they are executed.\n\
   --eval CODE             Evaluate CODE.  Exit when done unless --persist.\n\
   --exec-path PATH        Set path for executing subprograms.\n\