# HG changeset patch
# User Rik <octave@nomad.inbox5.com>
# Date 1300563189 25200
# Node ID 30ee8f0cc7c2e1e08eb41f1e73b45aa179c0b624
# Parent  f8ea3eabcb85fc015c56ea52c43217465cf723b9
Add dump_prefs to documentation.

diff -r f8ea3eabcb85 -r 30ee8f0cc7c2 doc/ChangeLog
--- a/doc/ChangeLog	Sat Mar 19 12:12:57 2011 -0700
+++ b/doc/ChangeLog	Sat Mar 19 12:33:09 2011 -0700
@@ -1,3 +1,7 @@
+2010-03-19  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/basics.txi: Add dump_prefs to documentation.
+
 2010-03-19  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/octave.texi, interpreter/plot.txi: Add daspect, pbaspect
diff -r f8ea3eabcb85 -r 30ee8f0cc7c2 doc/interpreter/basics.txi
--- a/doc/interpreter/basics.txi	Sat Mar 19 12:12:57 2011 -0700
+++ b/doc/interpreter/basics.txi	Sat Mar 19 12:33:09 2011 -0700
@@ -336,6 +336,11 @@
 invoke Octave with the @option{--verbose} option but without the
 @option{--silent} option.
 
+The @code{dump_prefs} function is useful for determining what customizations
+to Octave are possible and which are in effect.
+
+@DOCSTRING(dump_prefs)
+
 @node Quitting Octave
 @section Quitting Octave
 @cindex exiting octave
diff -r f8ea3eabcb85 -r 30ee8f0cc7c2 scripts/ChangeLog
--- a/scripts/ChangeLog	Sat Mar 19 12:12:57 2011 -0700
+++ b/scripts/ChangeLog	Sat Mar 19 12:33:09 2011 -0700
@@ -1,3 +1,7 @@
+2010-03-19  Rik  <octave@nomad.inbox5.com>
+
+	* miscellaneous/dump_prefs.m: Improve docstring.
+
 2010-03-19  Rik  <octave@nomad.inbox5.com>
 
 	* plot/daspect.m, plot/pbaspect.m: Use newline between @deftypefnx
diff -r f8ea3eabcb85 -r 30ee8f0cc7c2 scripts/miscellaneous/dump_prefs.m
--- a/scripts/miscellaneous/dump_prefs.m	Sat Mar 19 12:12:57 2011 -0700
+++ b/scripts/miscellaneous/dump_prefs.m	Sat Mar 19 12:33:09 2011 -0700
@@ -17,10 +17,11 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} dump_prefs (@var{file})
-## Have Octave dump all the current user preference variables to
-## @var{file} in a format that can be parsed by Octave later.  If
-## @var{file} is omitted, the listing is printed to stdout.
+## @deftypefn {Function File} {} dump_prefs ()
+## @deftypefn {Function File} {} dump_prefs (@var{fid})
+## Dump all of the current user preference variables in a format that can be
+## parsed by Octave later.  @var{fid} is a file descriptor as returned by
+## @code{fopen}.  If @var{file} is omitted, the listing is printed to stdout.
 ## @end deftypefn
 
 ## Author: jwe