refer コマンド

目的

文書内で参考資料を見つけ、その資料を文書に挿入します。

構文

refer [ -b ] [ -e ] [ -P ] [ -S ] [ -a [ Number ] ] [ -B Label.Macro ] [ -c Keys ] [ -f Number | -k Label | -l Letter, Digit ] [ -n ] [ -p Reference ] [ -s Keys ] [ File ... ]

説明

refer コマンドは、nroff または troff コマンドのプリプロセッサーです。refer コマンドは、脚注または巻末の注に関する参照を検索してフォーマットします。また、このコマンドは、適切な書式で入力されたスタンドアロン参考文献一覧などのデータに索引を付け、検索し、ソートして出力するように設計された一連のプログラムの基礎となります。

引用が不完全であってもキーワードが十分に正確であれば、refer コマンドは、参考文献データベースを検索し、タイトル、著者、定期刊行物などのどこかにこれらのキーワードを持つ参照がないか調べます。 入力ファイル (そうでなければ標準入力) は、.[ (ピリオド、左大括弧) と .] (ピリオド、右大括弧) 区切り文字で囲まれた行を除き、標準出力にコピーされます。区切り文字で囲まれた行は、キーワードを含むものと見なされ、参考文献データベースからの情報で置換されます。ユーザーは、別のデータベースを検索したり、特定のフィールドを上書きしたり、新規フィールドを追加することもできます。ソースがどこであれ、参照データは、troff コマンド・ストリングのセットに割り当てられます。ms マクロ・パッケージなどのマクロ・パッケージは、これらの文字列から生成された完全な参照テキストを印刷します。デフォルトでは、参照には脚注番号のフラグが付きます。

独自の参照を使用する場合は、それらを例のセクションで説明するフォーマットにします。これらの参照にアクセスするには、-p フラグを使用するか、REFER 環境変数をそれらの参照ファイルに設定します。refer コマンドを使用する前に、参照に対して indxbib コマンドを実行すると、参照の検索速度を増すことができます。索引を付けなければ、線型検索が実行されます。refer コマンドをプリプロセッサー・コマンド (eqn、neqn、または tbl コマンド) のいずれかと一緒に使用する場合は、パイプ接続を介して渡されるデータ量を最小に抑えるために、最初に refer コマンドを発行しなければなりません。

注: 参照ファイルを編集する場合、そのファイルに対して indxbib コマンドを再発行しなければなりません。indxbib コマンドを使用しない場合は、 その参照ファイルに関連する .ia、.ib、.ic、および .ig ファイルをすべて除去してください。これらのファイルを除去しないと、 refer コマンドから「too many hits」というエラー・メッセージが表示されます。

refer コマンドおよびそれに関連するプログラムは、ブランク行で区切られたレコードからなる参照ファイルから入力されることを予期します。レコードとは、それぞれに 1 種類の情報が入っているフィールド (行) の集合体です。フィールドは、先頭の % (パーセント記号) の後にキー文字、スペース文字、およびフィールドの内容が続く行で始まり、最後にフィールドの内容を持つ行で開始し、% (パーセント記号) で始まる次の行まで継続します。フィールドの出力順序とフォーマットは、nroff および troff コマンド用に指定されたマクロ (脚注および巻末の注用)、または roffbib コマンド用に指定されたマクロ (スタンドアロン参考文献一覧用) で制御されます。最も一般的なキー文字およびそれらに対応するフィールドのリストについては、addbib コマンドのセクションを参照してください。

フラグ

.[
$LIST$
.]

例

以下は、refer コマンドのエントリー例です。

ファイル