本手册的全文可以通过 Octave 提示符下的 doc 命令获取。此外，用户编写的函数和变量的文档也可以通过 help 命令获取。本节介绍用于阅读手册以及用户提供的函数和变量的文档字符串的命令。请参阅 函数文件，了解更多关于如何为您编写的函数编写文档的信息。
name ¶--list ¶. ¶help_text = help (…) ¶显示 name 的帮助文本。
例如，命令 help help 会打印一段描述 help 命令的简短消息。
如果给定单个参数 --list，则列出当前 Octave 会话中所有可用的运算符、关键字、内置函数和可加载函数。
如果给定单个参数 .，则列出当前 Octave 会话中所有可用的运算符。
如果在没有任何参数的情况下调用，help 会显示如何从命令行访问帮助的说明。
help 命令可以提供有关大多数运算符的信息，但 name 必须用单引号或双引号括起来，以防止 Octave 解释器对 name 执行操作。例如，help "+" 显示加法运算符的帮助信息。
function_name ¶使用 GNU Info 浏览器，直接从印刷手册的在线版本显示函数 function_name 的文档。
如果在没有参数的情况下调用，则从头开始显示手册。
例如，命令 doc rand 会在 GNU Info 浏览器中定位到在线手册中的 rand 节点。
一旦 GNU Info 浏览器运行起来，可以使用命令 C-h 获取使用帮助。
另请参阅： help。
str ¶-all str ¶[fcn, help1str] = lookfor (str) ¶[fcn, help1str] = lookfor ("-all", str) ¶在当前函数搜索路径的所有函数的文档中搜索字符串 str。
默认情况下，lookfor 仅在找到的每个函数的帮助字符串的第一句中搜索 str。可以使用 "-all" 参数搜索每个函数的整个帮助文本。所有搜索都不区分大小写。
当在没有输出参数的情况下调用时，lookfor 会将匹配函数的列表打印到终端。否则，输出参数 fcns 包含函数名，help1str 包含每个函数的帮助字符串的第一句话。
编程注意事项：lookfor 正确识别帮助文本第一句的能力取决于函数帮助的格式。所有 Octave 核心函数的格式都是正确的，但不能保证外部包和用户提供的函数也是如此。因此，使用 "-all" 参数可能是查找不属于 Octave 的相关函数的必要手段。
缓存文档文件可以大大提高查找速度。有关更多信息，请参阅 doc_cache_create。
另请参阅： help、doc、which、path、doc_cache_create。
要查看当前 Octave 版本的新增内容，请使用 news 函数。
package ¶显示 Octave 或已安装包的当前 NEWS 文件。
当在没有参数的情况下调用时，显示 Octave 的 NEWS 文件。
当给定包名称 package 时，显示该包的当前 NEWS 文件。
() ¶显示 GNU Octave 社区的联系信息。
() ¶描述复制和分发 Octave 的条件。
以下函数可用于更改用于显示文档的程序以及文档的查找位置。
val = info_file () ¶old_val = info_file (new_val) ¶old_val = info_file (new_val, "local") ¶查询或设置指定 Octave info 文件名的内部变量。
默认值为 octave-home/share/info/octave.info，其中 octave-home 是 Octave 安装的根目录。默认值可以通过环境变量 OCTAVE_INFO_FILE 或命令行参数 --info-file FNAME 覆盖。
当在函数内部使用 "local" 选项调用时，该变量会在该函数及其调用的任何子例程中本地更改。退出函数时恢复原始变量值。
另请参阅： info_program、doc、help、makeinfo_program。
val = info_program () ¶old_val = info_program (new_val) ¶old_val = info_program (new_val, "local") ¶查询或设置指定要运行的 info 程序名称的内部变量。
默认值为 info。默认值可以通过环境变量 OCTAVE_INFO_PROGRAM 或命令行参数 --info-program NAME 覆盖。
当在函数内部使用 "local" 选项调用时，该变量会在该函数及其调用的任何子例程中本地更改。退出函数时恢复原始变量值。
另请参阅： info_file、doc、help、makeinfo_program。
val = makeinfo_program () ¶old_val = makeinfo_program (new_val) ¶old_val = makeinfo_program (new_val, "local") ¶查询或设置指定 Octave 用于格式化包含 Texinfo 标记命令的帮助文本的程序名称的内部变量。
默认值为 makeinfo。
当在函数内部使用 "local" 选项调用时，该变量会在该函数及其调用的任何子例程中本地更改。退出函数时恢复原始变量值。
另请参阅： texi_macros_file、info_file、info_program、doc、help。
val = texi_macros_file () ¶old_val = texi_macros_file (new_val) ¶old_val = texi_macros_file (new_val, "local") ¶查询或设置指定包含 Texinfo 宏的文件名的内部变量，这些宏会在传递给 makeinfo 之前附加到文档字符串前面。
默认值为 octave-home/share/octave/version/etc/macros.texi，其中 octave-home 是 Octave 安装的根目录，version 是 Octave 版本号。默认值可以通过环境变量 OCTAVE_TEXI_MACROS_FILE 或命令行参数 --texi-macros-file FNAME 覆盖。
当在函数内部使用 "local" 选项调用时，该变量会在该函数及其调用的任何子例程中本地更改。退出函数时恢复原始变量值。
另请参阅： makeinfo_program。
val = doc_cache_file () ¶old_val = doc_cache_file (new_val) ¶old_val = doc_cache_file (new_val, "local") ¶查询或设置指定 Octave 文档缓存文件名的内部变量。
缓存文件显著提高了 lookfor 命令的性能。默认值为 octave-home/share/octave/version/etc/doc-cache，其中 octave-home 是 Octave 安装的根目录，version 是 Octave 版本号。默认值可以通过环境变量 OCTAVE_DOC_CACHE_FILE 或命令行参数 --doc-cache-file FNAME 覆盖。
当在函数内部使用 "local" 选项调用时，该变量会在该函数及其调用的任何子例程中本地更改。退出函数时恢复原始变量值。
另请参阅： doc_cache_create、lookfor、info_program、doc、help、makeinfo_program。
另请参阅： lookfor。
val = built_in_docstrings_file () ¶old_val = built_in_docstrings_file (new_val) ¶old_val = built_in_docstrings_file (new_val, "local") ¶查询或设置指定包含 Octave 内置函数文档字符串的文件名的内部变量。
默认值为 octave-home/share/octave/version/etc/built-in-docstrings，其中 octave-home 是 Octave 安装的根目录，version 是 Octave 版本号。默认值可以通过环境变量 OCTAVE_BUILT_IN_DOCSTRINGS_FILE 或命令行参数 --built-in-docstrings-file FNAME 覆盖。
注意：此变量仅在 Octave 初始化自身时使用。在 Octave 运行会话期间修改它不会产生任何效果。
val = suppress_verbose_help_message () ¶old_val = suppress_verbose_help_message (new_val) ¶old_val = suppress_verbose_help_message (new_val, "local") ¶查询或设置控制 Octave 是否在 help 命令的输出和内置命令的使用消息末尾添加额外帮助信息的内部变量。
当在函数内部使用 "local" 选项调用时，该变量会在该函数及其调用的任何子例程中本地更改。退出函数时恢复原始变量值。
以下函数主要用于 Octave 内部生成文档。此处列出它们是为了完整起见，并且因为它们偶尔可能对用户有用。
(out_file, directory) ¶(out_file) ¶() ¶为 directory 中的所有函数生成文档缓存。
为 directory 中的所有函数生成文档缓存，directory 可以是单个字符串或字符串的元胞数组。该缓存用于加速 lookfor 函数。
缓存保存在文件 out_file 中，如果未给出，则默认为 doc-cache。
如果没有给定目录（或者为空矩阵），则会生成内置函数、运算符和关键字的缓存。
另请参阅： doc_cache_file、lookfor、path。
[text, format] = get_help_text (name) ¶返回函数 name 的原始帮助文本。
原始帮助文本在 text 中返回，格式在 format 中返回。格式是一个字符串，可以是 "texinfo"、"html" 或 "plain text"。
另请参阅： get_help_text_from_file。
[text, format] = get_help_text_from_file (fname) ¶从文件 fname 中返回原始帮助文本。
原始帮助文本在 text 中返回，格式在 format 中返回。格式是一个字符串，可以是 "texinfo"、"html" 或 "plain text"。
另请参阅： get_help_text。
text = get_first_help_sentence (name) ¶text = get_first_help_sentence (name, max_len) ¶[text, status] = get_first_help_sentence (…) ¶返回函数帮助文本的第一句话。
第一句话定义为函数声明之后的文本，直到第一个句点（"."）或第一次出现两个连续换行符（"\n\n"）为止。文本被截断为最大长度 max_len，默认为 80。如果必须截断文本，则文本的最后三个字符将替换为 "..."，以表示还有更多文本可用。
可选的输出参数 status 返回 makeinfo 报告的状态。如果只请求一个输出参数，并且 status 为非零，则会显示警告。
例如，此帮助文本的第一句话是
get_first_help_sentence ("get_first_help_sentence")
-| ans = Return the first sentence of a function's help text.
