2016-08-12 120 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有點難以捉摸,它並沒有被提升爲主要資源(我認爲它不應該是)。間隔包是一個值得注意的例外,即使它的文檔不在八度音階客戶端中。 (續) –