2.3 ヘルプを得るためのコマンド
このマニュアルの全文は，Octaveプロンプトからコマンドdocで入手できます。さらに，ユーザが記述した個々の関数や変数のドキュメンテーションも， helpコマンドによって入手することができます。このセクションでは，マニュアルを読むために使用するコマンドと，ユーザが 提供した関数や変数のドキュメント文字列について説明します。自分が書いた関数のドキュメントの書き方については、関数ファイルを参照してください。
: help name
: help --list
: help .
: help
: help_text = help (…)
name のヘルプ・テキストを表示します。
例えば，help helpコマンドは，helpコマンドを説明する短いメッセージを表示する。
単一の引数-listを指定すると，Octaveの現在のセッションで利用可能な すべての演算子，キーワード，組込み関数，ロード可能な関数をリストします。
単一の引数 . を指定すると，Octaveの現在のセッションで利用可能なすべての 演算子をリストします。
引数なしで呼び出された場合，helpはコマンドラインからヘルプにアクセス する方法を表示する。
helpコマンドは，ほとんどの演算子に関する情報を提供することができ るが，Octaveインタプリタがnameに作用しないようにするために，nameを一重 引用符または二重引用符で囲む必要がある。例えば，help 「+」は加算演算子に関するヘルプを表示する。
参照：doc，lookfor，which，info。
: doc function_name
: doc
関数function_nameのドキュメントを，GNU Infoブラウザを使って，印刷されたマニュアルのオンライン版から直接表示します。
引数なしで実行された場合、マニュアルは最初から表示される。
例えば、コマンド doc rand は、オンライン版マニュアルの rand ノードから GNU Info ブラウザを起動します。
GNU情報ブラウザが起動したら、C-hコマンドを使ってヘルプを見ることができます。
helpも参照してください。
: lookfor str
: lookfor -all str
: [fcn, help1str] = lookfor (str)
: [fcn, help1str] = lookfor ("-all", str)
現在の関数検索パスにあるすべての関数のドキュメントから文字列 str を検索します。
デフォルトでは、検索された各関数のヘルプ文字列の最初の一文だけを検索します。引数「-all」を使用することで、各関数のヘルプテキスト全体を検索することができます。すべての検索は、大文字と小文字を区別しない。
出力引数なしで呼ばれた場合、lookforはマッチした関数のリストを端末に出力する。そうでない場合は、出力引数fcnsに関数名が、help1strに各関数のヘルプ文字列の最初の文が含まれる。
プログラミング上の注意：lookforがヘルプテキストの最初の文を正しく識別できるかど うかは，関数のヘルプの書式に依存します。Octaveのコア関数はすべて正しくフォーマットされていますが，外部パッ ケージやユーザが提供する関数については保証できません。したがって，「-all 」引数の使用は，Octaveの一部ではない関連関数を検索するために必要かもしれません。
検索速度は，キャッシュされたドキュメント・ファイルによって大幅に向上します。詳細については，doc_cache_createを参照。
See also: help, doc, which, path, doc_cache_create.
Octaveの現在のリリースの新機能を見るには，ニュース機能を使用してください。
: news
: news package
Octaveまたはインストールされたパッケージの現在のNEWSファイルを 表示する。
引数なしで呼ばれた場合，OctaveのNEWSファイルを表示する。
パッケージ名 packageが与えられた場合，そのパッケージの現在のNEWSファ イルを表示する。
See also: ver, pkg.
:info ()
GNU Octaveコミュニティの連絡先情報を表示する。
: warranty ()
Octaveのコピーと配布に関する条件を記述する。
以下の関数を使用して，ドキュメントの表示に使用するプログラムと，ドキュメ ンテーションの場所を変更することができる。
: val = info_file ()
: old_val = info_file (new_val)
old_val = info_file (new_val, "local")
Octave情報ファイルの名前を指定する内部変数をクエリまたはセットする。
デフォルト値は，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である。デフォルト値は、環境変数OCTAVE_INFO_PROGRAMまたはコマンドライン引数--info-program NAMEによって上書きされる。
関数内部から 「local 」オプションで呼び出されると、その関数と呼び出されたサブルーチンの変数がローカルに変更される。関数を終了すると元の変数値に戻る。
info_file, doc, help, makeinfo_program も参照のこと。
:: val = info_program ()
: old_val = info_program (new_val)
: old_val = info_program (new_val, "local")
OctaveがTexinfoマークアップコマンドを含むヘルプテキストをフォーマットする ために実行するプログラムの名前を指定する内部変数をクエリまたはセットする。
デフォルト値はmakeinfoである。
関数内部から 「local 」オプションで呼び出された場合，その関数と呼び出されたサブルーチンの変数がローカルに変更される。関数を終了すると元の変数値に戻ります。
参照: texi_macros_file、info_file、info_program、doc、help。
: 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/バージョン/etc/doc-cacheここで、octave-homeはOctaveインストールのルートディレクトリ、versionはOctaveのバージョン番号です。デフォルト値は環境変数 OCTAVE_DOC_CACHE_FILEまたはコマンドライン引数 によって上書きされる場合があります。--doc-cache-file FNAME。
オプションを使用して関数内から呼び出されると"local"、関数とそれが呼び出すサブルーチンに対して変数がローカルに変更されます。関数を終了すると、元の変数値が復元されます。
See also: doc_cache_create, lookfor, info_program, doc, help, makeinfo_program.
See also: 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またはコマンドライン引数 によって上書きされる場合があります。FNAME--組み込みドキュメント文字列ファイル 。
Note: This variable is only used when Octave is initializing itself. Modifying it during a running session of Octave will have no effect.
: 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 がドキュメントを生成するために内部的に使用します。これらは完全性のため、また場合によってはユーザーにとって役立つ可能性があるため、ここでドキュメント化されています。
: doc_cache_create (out_file, directory)
: doc_cache_create (out_file)
: doc_cache_create ()
ディレクトリ内のすべての関数のドキュメント キャッシュを生成します。
ディレクトリ内のすべての関数に対してドキュメント キャッシュが生成されます。 これは単一の文字列または文字列のセル配列になります。キャッシュは関数を高速化するために使用されますlookfor。
キャッシュはファイルout_fileに保存され、デフォルトでは次の値になります。 ドキュメントキャッシュ与えられていない場合。
ディレクトリが指定されていない場合（または空のマトリックスの場合）、組み込み関数、演算子、およびキーワードのキャッシュが生成されます。
See also: doc_cache_file, lookfor, path.
: [text, format] = get_help_text (name)
関数名の生のヘルプ テキストを返します。
生のヘルプ テキストはtextで返され、形式はformatで返されます。形式は"texinfo"makeinfo"html"または"plain text"のいずれかの文字列です
See also: get_help_text_from_file.
: [text, format] = get_help_text_from_file (fname)
ファイルfnameから生のヘルプ テキストを返します。
生のヘルプ テキストはtextで返され、形式はformatで返されます。形式は"texinfo""...""html"または"plain text"のいずれかの文字列です。
See also: get_help_text.
: text = get_first_help_sentence (name)
: text = get_first_help_sentence (name, max_len)
: [text, status] = get_first_help_sentence (…)
関数のヘルプ テキストの最初の文を返します。
最初の文は、関数宣言の後の最初のピリオド (「.」) または 2 つの連続する改行 (「\n\n」) の最初の出現までのテキストとして定義されます。テキストは、最大長 max_len (デフォルトは 80) に切り捨てられます。テキストを切り捨てる必要がある場合は、テキストの最後の 3 文字が に置き換えられ、"..."さらにテキストが使用可能であることを示します。
オプションの出力引数status は、makeinfoによって報告されたステータスを返します 。出力引数が 1つだけ要求され、status が 0 以外の場合、警告が表示されます。
例えば、このヘルプテキストの最初の文は
例えば、このヘルプテキストの最初の文は
get_first_help_sentence ("get_first_help_sentence")
-| ans = Return the first sentence of a function's help text.