---

2.3获取帮助的命令¶

本手册的全文可通过命令从Octave提示符处获得doc此外,还可以通过帮助命令本节介绍用于阅读手册的命令以及用户提供的函数和变量的文档字符串。详见函数文件,了解有关如何记录您编写的函数的更多信息。

 

: help name ¶

: help --list ¶

: help . ¶

: help ¶

: help_text = help (…) ¶

显示的帮助文本name.

例如,命令帮助帮助打印一条描述的短信帮助命令

给定单个参数列表,列出Octave当前会话中可用的所有运算符、关键字、内置函数和可加载函数。

给定单个参数.,列出Octave当前会话中可用的所有运算符。

如果在没有任何自变量的情况下调用,帮助显示有关如何从命令行访问帮助的说明。

help命令可以提供有关大多数运算符的信息,但是name必须用单引号或双引号括起来,以防止Octave解释器对执行操作name例如帮助显示有关加法运算符的帮助。

详见: doc, 查找, 哪一个, 信息.

 

: doc function_name ¶

: doc ¶

显示函数的文档函数名称直接从印刷手册的匿名版本,使用GNU信息浏览器。

如果在没有参数的情况下调用,则会从头开始显示手册。

例如,命令doc rand在启动GNU信息浏览器兰特在线版手册中的节点。

GNU信息浏览器运行后,可以使用以下命令获得使用帮助C-h.

详见: 帮助.

 

: lookfor str ¶

: lookfor -all str ¶

: [fcn, help1str] = lookfor (str) ¶

: [fcn, help1str] = lookfor ("-all", str) ¶

搜索字符串str在当前函数搜索路径中所有函数的文档中。

默认情况下,查找查找str仅在找到的每个函数的帮助字符串的第一句中。可以使用搜索每个函数的整个帮助文本全部的参数所有搜索都不区分大小写。

当在没有输出参数的情况下调用时,查找将匹配函数的列表打印到终端。否则,输出参数fcns包含函数名和帮助1str包含每个函数的帮助字符串中的第一句话。

编程注意事项:的能力查找正确识别帮助文本的第一句取决于函数帮助的格式。所有Octave核心函数的格式都是正确的,但不能保证外部包和用户提供的函数也是如此。因此,使用全部的参数对于查找不属于Octave的相关函数可能是必要的。

缓存文档文件大大提高了查找速度。有关更多信息,详见doc_cache_create.

详见: 帮助, doc, 哪一个, 路径, doc_cache_create.

要查看当前版本的Octave中的新增内容,请使用message作用

 

: news ¶

: news package ¶

显示Octave或已安装程序包的当前NEWS文件。

当在没有参数的情况下调用时,显示Octave的NEWS文件。

当给定包名称时软件包,显示该包的当前NEWS文件。

详见: 版本, pkg.

 

: info () ¶

显示GNU Octave社区的联系信息。

 

: warranty () ¶

描述复制和分发Octave的条件。

以下函数可用于更改用于显示文档的程序以及文档的位置。

 

: val = info_file () ¶

: old_val = info_file (new_val) ¶

: old_val = info_file (new_val, "local") ¶

查询或设置指定Octave信息文件名称的内部变量。

默认值为Octave原点/share/info/octave.info,其中Octave原点是Octave安装的根目录。默认值可能会被环境变量覆盖Octave信息文件,或命令行参数--信息文件FNAME.

当从具有的函数内部调用时地方的参数,则该变量会为函数及其调用的任何子程序在本地进行更改。退出函数时将恢复原始变量值。

详见: 信息_图表, doc, 帮助, 制作信息_程序.

 

: val = info_program () ¶

: old_val = info_program (new_val) ¶

: old_val = info_program (new_val, "local") ¶

查询或设置指定要运行的信息程序名称的内部变量。

默认值为信息。默认值可能会被环境变量覆盖Octave信息程序,或命令行参数--信息程序名称.

当从具有的函数内部调用时地方的参数,则该变量会为函数及其调用的任何子程序在本地进行更改。退出函数时将恢复原始变量值。

详见: 信息文件, doc, 帮助, 制作信息_程序.

 

: val = makeinfo_program () ¶

: old_val = makeinfo_program (new_val) ¶

: old_val = makeinfo_program (new_val, "local") ¶

查询或设置内部变量,该变量指定Octave运行的程序的名称,以格式化包含Texinfo符号命令的帮助文本。

默认值为makeinfo.

当从具有的函数内部调用时地方的参数,则该变量会为函数及其调用的任何子程序在本地进行更改。退出函数时将恢复原始变量值。

详见: tex_macros_file, 信息文件, 信息_图表, doc, 帮助.

 

: val = texi_macros_file () ¶

: old_val = texi_macros_file (new_val) ¶

: old_val = texi_macros_file (new_val, "local") ¶

查询或设置内部变量,该变量指定包含Texinfo宏的文件的名称,这些宏在传递给makeinfo之前已准备好文档字符串。

默认值为Octave原点/份额/Octave/版本/etc/macross.tesi,其中Octave原点是Octave安装的根目录,并且版本是Octave版本号。默认值可能会被环境变量覆盖OCTAVE_TEXI_MACROS_FILE,或命令行参数--texi宏文件FNAME.

当从具有的函数内部调用时地方的参数,则该变量会为函数及其调用的任何子程序在本地进行更改。退出函数时将恢复原始变量值。

详见: 制作信息_程序.

 

: val = doc_cache_file () ¶

: old_val = doc_cache_file (new_val) ¶

: old_val = doc_cache_file (new_val, "local") ¶

查询或设置指定Octave文档缓存文件名称的内部变量。

缓存文件显著提高了的性能查找命令默认值为Octave原点/份额/Octave/版本/etc/doc缓存,其中Octave原点是Octave安装的根目录,并且版本是Octave版本号。默认值可能会被环境变量覆盖OCTAVE_DOC_CACHE_FILE,或命令行参数--文档缓存文件FNAME.

当从具有的函数内部调用时地方的参数,则该变量会为函数及其调用的任何子程序在本地进行更改。退出函数时将恢复原始变量值。

详见: doc_cache_create, 查找, 信息_图表, doc, 帮助, 制作信息_程序.

详见: 查找.

 

: val = built_in_docstrings_file () ¶

: old_val = built_in_docstrings_file (new_val) ¶

: old_val = built_in_docstrings_file (new_val, "local") ¶

查询或设置内部变量,该变量指定包含内置Octave函数的文档字符串的文件的名称。

默认值为Octave原点/份额/Octave/版本/etc/内置文档字符串,其中Octave原点是Octave安装的根目录,并且版本是Octave版本号。默认值可能会被环境变量覆盖Octaveuilt_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是否将其他帮助信息添加到的输出末尾帮助内置命令的命令和使用消息。

当从具有的函数内部调用时地方的参数,则该变量会为函数及其调用的任何子程序在本地进行更改。退出函数时将恢复原始变量值。

Octave伪造文档主要在内部使用以下函数。它们在这里被记录为完整的,因为它们有时可能对用户有用。

 

: doc_cache_create (out_file, directory) ¶

: doc_cache_create (out_file) ¶

: doc_cache_create () ¶

为中的所有函数生成文档缓存目录.

为中的所有函数生成文档缓存目录其可以是单个串或串的元胞数组。缓存用于加速函数查找.

缓存保存在文件中输出文件默认值文档缓存如果没有给出。

如果没有给定目录(或者是空矩阵),则会生成用于生成的函数、运算符和关键字的缓存。

详见: doc_cache_file, 查找, 路径.

 

: [text, format] = get_help_text (name) ¶

返回函数的原始帮助文本name.

原始帮助文本返回于文本以及中的格式format。格式是一个字符串,它是texinfo, </html>或纯文本.

详见: 获取帮助_文本_文件.

 

: [text, format] = get_help_text_from_file (fname) ¶

返回文件中的原始帮助文本filename.

原始帮助文本返回于文本以及中的格式format。格式是一个字符串,它是texinfo, </html>或纯文本.

详见: 获取帮助文本.

 

: text = get_first_help_sentence (name) ¶

: text = get_first_help_sentence (name, max_len) ¶

: [text, status] = get_first_help_sentence (…) ¶

返回函数帮助文本的第一句话。

第一句定义为函数语句之后的文本,直到第一个句点(“.”)或两个连续换行符(“\n\n”)首次出现为止。文本被截断为最大长度最大长度(_len),默认为80。如果必须截断文本,则文本的最后三个字符将替换为...以指示还有更多文本可用。

可选输出参数status返回返回的状态makeinfo。如果只指定一个输出参数,并且status为非零,则显示警告。

例如,此帮助文本的第一句是

get_first_help_sentence(“get_first_help_sentent”)-|ans=返回函数帮助文本的第一句话。