Previous: Bugs, Up: Preliminaries


1.5 このマニュアルの読み方

このマニュアルにはm4の入力と出力の例がたくさん含まれており、 入力、出力およびm4からのエラーメッセージを区別するための 簡単な表記法が用いられています。 これらの例は通常の文章とは間隔をあけて、 固定幅フォントで次のように表示されます。

     
     This is an example of an example!

入力と出力を区別するため、m4からの出力にはすべて‘’が、 エラーメッセージにはすべて‘error-->’が先頭につきます。 したがって次のようになります。

     Example of input line (入力行の例)
     ⇒Output line from m4 (m4からの出力行の例)
     error-->and an error message (エラーメッセージの例)

m4に最初から定義されているマクロの説明をするときは、 引数に分かりやすい名前をつけたマクロ呼び出しのプロトタイプを示します。 これは次のようになります。

     regexp(string, regexp, opt replacement)

m4ではマクロの引数はすべて文字列ですが、 数字、ファイル名、正規表現としてなど特別な解釈のされかたをするものもあります。

3番目の引数の前にある‘opt’は、この引数が省略可能であることを 表しています。省略したときは、空文字列として解釈されます。 引数リストの最後にある省略記号(‘...’)は、その後にいくつでも引数を 続けてよいことを示してます。