Typedefs |
typedef std::map< std::string,
std::string > | map_type |
| typedef map_type::value_type | pair_type |
| typedef map_type::const_iterator | map_iter |
Functions |
| template<typename T , std::size_t z> |
| std::size_t | size (T const (&)[z]) |
| string_vector | make_name_list (void) |
| std::string | raw_help (const std::string &nm, bool &symbol_found) |
| | DEFUN (get_help_text, args,,"-*- texinfo -*-\n\
@deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\
Return the help text of a given function.\n\
\n\
This function returns the raw help text @var{text} and an indication of\n\
its format for the function @var{name}. The format indication @var{format}\n\
is a string that can be either @t{\"texinfo\"}, @t{\"html\"}, or\n\
@t{\"plain text\"}.\n\
\n\
To convert the help text to other formats, use the @code{makeinfo} function.\n\
\n\
@seealso{makeinfo}\n\
@end deftypefn") |
| | DEFUN (get_help_text_from_file, args,,"-*- texinfo -*-\n\
@deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname})\n\
Return the help text from the given file.\n\
\n\
This function returns the raw help text @var{text} and an indication of\n\
its format for the function @var{name}. The format indication @var{format}\n\
is a string that can be either @t{\"texinfo\"}, @t{\"html\"}, or\n\
@t{\"plain text\"}.\n\
\n\
To convert the help text to other formats, use the @code{makeinfo} function.\n\
\n\
@seealso{makeinfo}\n\
@end deftypefn") |
| | DEFUN (__operators__,,,"-*- texinfo -*-\n\
@deftypefn {Function File} __operators__ ()\n\
Undocumented internal function.\n\
@end deftypefn") |
| | DEFUN (__keywords__,,,"-*- texinfo -*-\n\
@deftypefn {Function File} __keywords__ ()\n\
Undocumented internal function.\n\
@end deftypefn") |
| | DEFUN (__builtins__,,,"-*- texinfo -*-\n\
@deftypefn {Function File} __builtins__ ()\n\
Undocumented internal function.\n\
@end deftypefn") |
| std::string | do_which (const std::string &name) |
| | DEFUN (__which__, args,,"-*- texinfo -*-\n\
@deftypefn {Built-in Function} {} __which__ (@var{name}, @dots{})\n\
Undocumented internal function.\n\
@end deftypefn") |
| bool | file_is_in_dir (const std::string filename, const std::string dir) |
| | DEFUN (__list_functions__, args,,"-*- texinfo -*-\n\
@deftypefn {Function File} {@var{retval} =} __list_functions__ ()\n\
@deftypefnx {Function File} {@var{retval} =} __list_functions__ (@var{directory})\n\
Undocumented internal function.\n\
@end deftypefn") |
| | DEFUN (doc_cache_file, args, nargout,"-*- texinfo -*-\n\
@deftypefn {Built-in Function} {@var{val} =} doc_cache_file ()\n\
@deftypefnx {Built-in Function} {@var{old_val} =} doc_cache_file (@var{new_val})\n\
Query or set the internal variable that specifies the name of the\n\
Octave documentation cache file. A cache file significantly improves\n\
the performance of the @code{lookfor} command. The default value is \n\
@file{@var{octave-home}/share/octave/@var{version}/etc/doc-cache},\n\
in which @var{octave-home} is the root directory of the Octave installation,\n\
and @var{version} is the Octave version number.\n\
The default value may be overridden by the environment variable\n\
@w{@env{OCTAVE_DOC_CACHE_FILE}}, or the command line argument\n\
@samp{--doc-cache-file NAME}.\n\
@seealso{lookfor, info_program, doc, help, makeinfo_program}\n\
@end deftypefn") |
| | DEFUN (info_file, args, nargout,"-*- texinfo -*-\n\
@deftypefn {Built-in Function} {@var{val} =} info_file ()\n\
@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\
Octave info file. The default value is\n\
@file{@var{octave-home}/info/octave.info}, in\n\
which @var{octave-home} is the root directory of the Octave installation.\n\
The default value may be overridden by the environment variable\n\
@w{@env{OCTAVE_INFO_FILE}}, or the command line argument\n\
@samp{--info-file NAME}.\n\
@seealso{info_program, doc, help, makeinfo_program}\n\
@end deftypefn") |
| | 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 value is\n\
@file{@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info}\n\
in which @var{octave-home} is the root directory of the Octave installation,\n\
@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 value may be overridden by the environment variable\n\
@w{@env{OCTAVE_INFO_PROGRAM}}, or the command line argument\n\
@samp{--info-program NAME}.\n\
@seealso{info_file, doc, help, makeinfo_program}\n\
@end deftypefn") |
| | DEFUN (makeinfo_program, args, nargout,"-*- texinfo -*-\n\
@deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\
@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\
program that Octave runs to format help text containing\n\
Texinfo markup commands. The default value is @code{makeinfo}.\n\
@seealso{info_file, info_program, doc, help}\n\
@end deftypefn") |
| | 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 variable 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 deftypefn") |
Variables |
| std::string | Vdoc_cache_file |
| std::string | Vinfo_file |
| std::string | Vinfo_program |
