2016-08-12 119 views
1

我在Windows 10上运行Window的Octave端口。Octave Forge软件包

我已经安装了3个软件包;控制,信号和通信。

我想知道是否有程序运行来更新磁盘上的帮助?

或者我应该只使用在线帮助在Octave Forge online documentation

T.I.A.

+1

如果你的意思是,例如'help medfilt1',那么你首先需要'pkg加载信号',否则当功能不可访问时帮助不可用。如果您的意思是“文档”,如控制台和编辑器选项卡旁边的文档选项卡中,那么不是,我不认为软件包会安装任何文档,所以是的,请在线查看。 然而,直接进入函数引用的包页面可能更容易,而不是一般索引,例如, http://octave.sourceforge.net/signal/index.html –

+0

@TasosPapastylianou啊,是的。我在想'help'而不是'doc'。 – beaker

+0

谢谢塔索斯,是的,我的意思是'文件'。 –

回答

2

只是为了给未来的读者一个更全面的答案。

核心倍频文档有两种形式:

  • 手动,这是PDF和HTML形式此处可用的:http://www.octave.org/doc
    这是显示在八度GUI时相同的文档你点击“文档”选项卡。

  • 帮助标头。这些是在每个功能内部定义的,可以通过help <functionname>命令召唤。

对于没有不同的HTML和 “帮助标题” 版本。只有帮助标题。但是,这些帮助标题也可以在octave forge网站以稍好看的html格式在线阅读,并在其功能参考下列出。如果你的软件包安装是最新的,那么这两者应该是相同的。

通过输入pkg describe -verbose <packagename>,您可以在终端上获得有关套件本身的一些信息(例如简短描述和它提供的功能列表),您可以通过news <packagename>查看更改日志。再次,这是相同的信息,可以找到八度锻造,只是格式化更好的HTML。

+0

相对缺乏良好的深度文档似乎是八度中正在发生的疼痛点之一,讨论。理论上质量好的文档贡献是受欢迎的,但我同意“帮助标题”并不总是最适合文档的格式。也许值得在线提供“正确”的文档并将其重定向到解释器的文档中...... –

+0

你眼中缺少什么?每个函数都使用texinfo进行记录。这用于可以用'help'显示的函数文档,用于生成html页面。有些软件包还有一个“软件包文档”,请参阅http://octave.sourceforge.net/interval/package_doc/index.html还有一些wiki页面可以由用户编辑。一些例子:http://wiki.octave.org/IO_package http://wiki.octave.org/Image_acquisition_package http://wiki.octave.org/Instrument_control_package – Andy

+0

对不起,我并不是想听起来像我抱怨(或更糟的是,“拖钓”)。我只知道文档的质量已经在过去讨论过;例如我记得在IRC的一次聊天中,缺乏适当的文档是去年octconf中一个相当主要的主题(尽管我认为这更多的是针对代码文档)。总的来说,这个wiki有点难以捉摸,它并没有被提升为主要资源(我认为它不应该是)。间隔包是一个值得注意的例外,即使它的文档不在八度音阶客户端中。 (续) –