| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
このマニュアルの完全な文章は,Octaveプロンプトからhelp -iというコマ ンドを入力することにより入手できます。さらに,個々のユーザ作成関数および 変数についてのドキュメントも,helpコマンドを通して得ることができま す。この節ではマニュアル,およびユーザ提供関数や変数に対するドキュメント を読むために使用されるコマンドについて述べています。あなたの書いた関数に 対して,どのように文書化すべきかについてのさらなる情報は, 関数ファイルを参照してください。
Octaveのhelpコマンドは,GNU Infoブラウザを用いて,簡略な使用法を
述べたメッセージを表示する,あるいは印刷マニュアルのオンライン版から直接
情報を表示するために使用される。このコマンドを引数なしで呼び出すならば,
全ての利用可能な演算子,関数および組み込み変数のリストを出力する。もし
1番目の引数が-iであれば,与えられたトピックに対して,このマニュ
アルのオンライン版の索引を表示する。
たとえば,help helpは,helpコマンドを説明する短いメッセー
ジを表示し,help -i helpはマニュアルのオンライン版のこのノードに
おいて,GNU Infoブラウザを起動する。
いちどGNU Infoブラウザを実行すると,キー入力C-hを使用することによ り,その使用法についてのヘルプを得ることができる。
helpコマンドは,演算子についての情報を提供します。しかし,コマンド
の区切りとして使用されるカンマやセミコロンについては,そうはいきません。そ
れらに関するヘルプを得るには,help commaあるいはhelp semicolon
と打ち込まなければなりません。
変数INFO_FILEは,Octaveのinfoファイルの位置を表す。初期状態では,
"octave-home/info/octave.info"である。ここで
octave-homeは,Octaveがインストールされたディレクトリである。
変数INFO_PROGRAMは,実行すべきinfoプログラムを表す。初期状態では,
"octave-home/libexec/octave/version/exec/arch/info"
である。ここでoctave-homeはOctaveがインストールされたディレクトリ,
versionはOctaveのバージョン番号,およびarchはシステムのタイプ
(たとえばi686-pc-linux-gnu)である。初期値は,環境変数
OCTAVE_INFO_PROGRAM,あるいはコマンドライン引数
--info-program NAME,さらにはスタートアップファイルにおいて
INFO_PROGRAM変数に値をセットすることで上書きされる。
変数MAKEINFO_PROGRAMは,OctaveがTexinfoマークアップコマンドを含む
ヘルプ文章を書式化するために起動するmakeinfoプログラムを表す。その初期値
は"makeinfo"である。
もしsuppress_verbose_help_messageの値がゼロでないならば,Octaveは
helpコマンドからの出力あるいは組み込みコマンドの使用法メッセージの
末端に,追加のヘルプ情報を追加することになる。
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] |
This document was generated on July, 20 2006 using texi2html 1.76.