次: env, 前: verb, 上: Indicating
@var
{metasyntactic-variable}
メタ構文変数を示すため,@var
コマンドを使用してください.メ
タ構文変数(metasyntactic variable)は,テキストの一部と同類のものを意味
するものです.例えば,メタ構文変数を関数に渡される引数を記述するため関数
のドキュメントで使用すべきです.
プログラム言語で,特定の変数の名前に対し@var
を使用しないでくださ
い.これらはプログラムの特別な名前なので,それに対しては@code
が
正しいものです(see code).例えば,Emacs Lisp変数
texinfo-tex-command
はメタ構文変数ではありません.それは,
@code
を使用することで正確に書式化されます.
環境変数に対しても@var
を使用しないでください.それに対しては
@env
が正しいものです(次のセクションを見てください).
Infoでの@var
の効果は,引数の文字を全て大文字に変更します.印刷さ
れたマニュアルとHTML出力では引数は傾いて印刷されます.
例えば,以下のようにします.
To delete file @var{filename}, type @samp{rm @var{filename}}.
以下を生成します.
To delete file filename, type `rm filename'.
(@var
は@code
,@samp
,@file
などの間に現す
ことができることに注意してください.)
メタ構文変数は,スペース以外全て小文字で書き,読みやすくするためハイフン を使用してください.このため,Texinfoマニュアルの初め方を表現するTexinfo ソースは以下のようになります.
\input texinfo @@setfilename @var{info-file-name} @@settitle @var{name-of-manual}
これは以下を生成します.
\input texinfo @setfilename info-file-name @settitle name-of-manual
ドキュメント形式によっては,メタ構文変数は山カッコで表示するものもあり, 以下がその例です.
..., type rm <filename>
しかし,それはTexinfoが使用する形式ではありません.(もちろん,そうしたい
場合,texinfo.texソースを編集して,Info書式化コマンドを
<...>
書式で出力させることもできます.)