octave: src/help.cc comparison

comparison src/help.cc @ 5794:1138ced03f14

[project @ 2006-05-08 20:23:04 by jwe]

author	jwe
date	Mon, 08 May 2006 20:23:07 +0000
parents	cbf717bf8150
children	e8be7fe586f9

comparison

equal deleted inserted replaced

-:395382df0d8a
+:1138ced03f14
 // (--info-file file)
 std::string Vinfo_file;
 // Name of the info reader we'd like to use.
 // (--info-program program)
-std::string Vinfo_prog;
+std::string Vinfo_program;
 // Name of the makeinfo program to run.
-static std::string Vmakeinfo_prog = "makeinfo";
+static std::string Vmakeinfo_program = "makeinfo";
 // If TRUE, don't print additional help message in help and usage
 // functions.
-static bool Vsuppress_verbose_help_message;
+static bool Vsuppress_verbose_help_message = false;
 // FIXME -- maybe this should use string instead of char*.
 struct help_list
 {
 void
 additional_help_message (std::ostream& os)
 {
 if (! Vsuppress_verbose_help_message)
 os << "\
-Additional help for built-in functions, operators, and variables\n\
+Additional help for built-in functions and operators is\n\
-is available in the on-line version of the manual.  Use the command\n\
+available in the on-line version of the manual.  Use the command\n\
 `doc <topic>' to search the manual index.\n\
 \n\
 Help and information about Octave is also available on the WWW\n\
 at http://www.octave.org and via the help@octave.org\n\
 mailing list.\n";
 display_names_from_help_list (octave_stdout, keyword_help (),
 				"reserved words");
 // FIXME -- is this distinction needed?
-LIST_SYMBOLS (symbol_record::BUILTIN_VARIABLE, "built-in variables");
 LIST_SYMBOLS (symbol_record::COMMAND, "commands");
 LIST_SYMBOLS (symbol_record::MAPPER_FUNCTION, "mapper functions");
 LIST_SYMBOLS (symbol_record::BUILTIN_FUNCTION, "general functions");
 	cols = 72;
 std::ostringstream buf;
 buf << "sed -e 's/^[#%][#%]* *//' -e 's/^ *@/@/' | "
-	  << "\"" << Vmakeinfo_prog << "\""
+	  << "\"" << Vmakeinfo_program << "\""
 	  << " -D \"VERSION " << OCTAVE_VERSION << "\""
 	  << " -D \"OCTAVEHOME " << OCTAVE_PREFIX << "\""
 	  << " -D \"TARGETHOSTTYPE " << OCTAVE_CANONICAL_HOST_TYPE << "\""
 	  << " --fill-column " << cols
 	  << " --no-warn"
 "-*- texinfo -*-\n\
 @deffn {Command} help\n\
 Octave's @code{help} command can be used to print brief usage-style\n\
 messages, or to display information directly from an on-line version of\n\
 the printed manual, using the GNU Info browser.  If invoked without any\n\
-arguments, @code{help} prints a list of all the available operators,\n\
+arguments, @code{help} prints a list of all the available operators\n\
-functions, and built-in variables.  If the first argument is @code{-i},\n\
+and functions.  If the first argument is @code{-i}, the @code{help}\n\
-the @code{help} command searches the index of the on-line version of\n\
+command searches the index of the on-line version of this manual for\n\
-this manual for the given topics.\n\
+the given topics.\n\
 \n\
 For example, the command @kbd{help help} prints a short message\n\
 describing the @code{help} command, and @kbd{help -i help} starts the\n\
 GNU Info browser at this node in the on-line version of the manual.\n\
 \n\
 }
 return retval;
 }
-static int
+DEFUN (info_file, args, nargout,
-info_file (void)
+"-*- texinfo -*-\n\
-{
+@deftypefn {Built-in Function} {@var{val} =} info_file ()\n\
-int status = 0;
+@deftypefnx {Built-in Function} {@var{old_val} =} info_file (@var{new_val})\n\
+Query or set the internal variable that specifies the name of the\n\
-std::string s = builtin_string_variable ("INFO_FILE");
+Octave info file.  The default value is\n\
+@code{\"@var{octave-home}/info/octave.info\"}, in\n\
-if (s.empty ())
-{
-gripe_invalid_value_specified ("INFO_FILE");
-status = -1;
-}
-else
-Vinfo_file = s;
-return status;
-}
-static int
-info_prog (void)
-{
-int status = 0;
-std::string s = builtin_string_variable ("INFO_PROGRAM");
-if (s.empty ())
-{
-gripe_invalid_value_specified ("INFO_PROGRAM");
-status = -1;
-}
-else
-Vinfo_prog = s;
-return status;
-}
-static int
-makeinfo_prog (void)
-{
-int status = 0;
-std::string s = builtin_string_variable ("MAKEINFO_PROGRAM");
-if (s.empty ())
-{
-gripe_invalid_value_specified ("MAKEINFO_PROGRAM");
-status = -1;
-}
-else
-Vmakeinfo_prog = s;
-return status;
-}
-static int
-suppress_verbose_help_message (void)
-{
-Vsuppress_verbose_help_message
-= check_preference ("suppress_verbose_help_message");
-return 0;
-}
-void
-symbols_of_help (void)
-{
-DEFVAR (INFO_FILE, Vinfo_file, info_file,
-"-*- texinfo -*-\n\
-@defvr {Built-in Variable} INFO_FILE\n\
-The variable @code{INFO_FILE} names the location of the Octave info file.\n\
-The default value is @code{\"@var{octave-home}/info/octave.info\"}, in\n\
 which @var{octave-home} is the directory where all of Octave is installed.\n\
-@end defvr");
+@seealso{info_program, doc, help, makeinfo_program}\n\
+@end deftypefn")
-DEFVAR (INFO_PROGRAM, Vinfo_prog, info_prog,
+{
-"-*- texinfo -*-\n\
+return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_file);
-@defvr {Built-in Variable} INFO_PROGRAM\n\
+}
-The variable @code{INFO_PROGRAM} names the info program to run.  Its\n\
-default initial value is\n\
+DEFUN (info_program, args, nargout,
+"-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {@var{val} =} info_program ()\n\
+@deftypefnx {Built-in Function} {@var{old_val} =} info_program (@var{new_val})\n\
+Query or set the internal variable that specifies the name of the\n\
+info program to run.  The default initial value is\n\
 @code{\"@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info\"}\n\
 in which @var{octave-home} is the directory where all of Octave is\n\
 installed, @var{version} is the Octave version number, and @var{arch}\n\
 is the system type (for example, @code{i686-pc-linux-gnu}).  The\n\
 default initial value may be overridden by the environment variable\n\
 @code{OCTAVE_INFO_PROGRAM}, or the command line argument\n\
-@code{--info-program NAME}, or by setting the value of\n\
+@code{--info-program NAME}.\n\
-@code{INFO_PROGRAM} in a startup script\n\
+@seealso{info_file, doc, help, makeinfo_program}\n\
-@end defvr");
+@end deftypefn")
+{
-DEFVAR (MAKEINFO_PROGRAM, Vmakeinfo_prog, makeinfo_prog,
+return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_program);
-"-*- texinfo -*-\n\
+}
-@defvr {Built-in Variable} MAKEINFO_PROGRAM\n\
-The variable @code{MAKEINFO_PROGRAM} names the makeinfo program that\n\
+DEFUN (makeinfo_program, args, nargout,
-Octave runs to format help text that contains Texinfo markup commands.\n\
+"-*- texinfo -*-\n\
-Its default initial value is @code{\"makeinfo\"}.\n\
+@deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\
-@end defvr");
+@deftypefnx {Built-in Function} {@var{old_val} =} makeinfo_program (@var{new_val})\n\
+Query or set the internal variable that specifies the name of the\n\
-DEFVAR (suppress_verbose_help_message, false, suppress_verbose_help_message,
+makeinfo program that Octave runs to format help text containing\n\
-"-*- texinfo -*-\n\
+Texinfo markup commands.  The default initial value is @code{\"makeinfo\"}.\n\
-@defvr {Built-in Variable} suppress_verbose_help_message\n\
+@seealso{info_file, info_program, doc, help}\n\
-If the value of @code{suppress_verbose_help_message} is nonzero, Octave\n\
+@end deftypefn")
-will not add additional help information to the end of the output from\n\
+{
+return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program);
+}
+DEFUN (suppress_verbose_help_message, args, nargout,
+"-*- texinfo -*-\n\
+@deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\
+@deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\
+Query or set the internal vaiable that controls whether Octave\n\
+will add additional help information to the end of the output from\n\
 the @code{help} command and usage messages for built-in commands.\n\
-@end defvr");
+@end deftypefn")
+{
+return SET_INTERNAL_VARIABLE (suppress_verbose_help_message);
 }
 /*
 ;;; Local Variables: ***
 ;;; mode: C++ ***

Mercurial > octave

comparison src/help.cc @ 5794:1138ced03f14