refer(1) FreeBSD 一般コマンドマニュアル

refer

前のページ 上に戻る 次のページ

refer



書式

       refer [ -benvCPRS ] [ -an ] [ -cfields ] [ -fn ]
             [ -ifields ] [ -kfield ] [ -lm,n ] [ -pfilename ]
             [ -sfields ] [ -tn ] [ -Bfield.macro ] [ file-
             name... ]

       コマンドラインオプションとパラメータの間に、空白を置くこと
       が可能です。


解説

       本 ファイルでは groff ドキュメントフォーマッティングシステ
       ムの一部である GNU バージョンの refer について記述します。
       refer.[.]  で囲まれた引用として解釈される行と、
       .R1.R2 で囲まれた引用の処理方法を記述したコマンドと し
       て解釈される行を除き、 filename...  の内容を標準出力にコピ
       ーします。

       各々の引用では参考文献を指定します。引用では、ある参考文献
       にのみ含まれるキーワードの集合を与えることによって、その参
       考文献を図書目録データベースから指定できます。また、引用の
       中でデータベースレコードを指定することによっても参考文献を
       指定できます。これらの方法を組み合わせることも可能です。

       各々の引用において refer はテキストの中にマークを作成で き
       ます。このマークは色々な方法でテキストや他のラベルから区別
       されるいくつかのラベルから構成されます。各引用における参考
       文献をマクロパッケージを使ってフォーマットして出力するため
       の groff コマンドを出力することもできます。そのた め に は
       refer の出力は適切なマクロパッケージを使って処理されなけれ
       ばなりません。 -ms-me はいずれも適切なマクロです。引用
       の参考文献をフォーマットするコマンドを引用の直後に出力する
       ことも、参考文献を蓄積して後でコマンドを出力することもでき
       ます。参考文献を蓄積した時、同じ参考文献が複数から引用され
       ている場合には、参考文献は 1 つにまとめてフォーマットさ れ
       ます。

       GNU refer の新しい機能として .R1.R2 の間の行はコマンド
       として解釈されます。この機能を使用して作成されたドキュメン
       トは、ドキュメントの先頭に

              .de R1
              .ig R2
              ..
       の行を追加することにより UNIX refer でも処理できます。この
       指定によって troff.R1.R2 の間をすべて無視しま す。
       このオプションによっていくつかのコマンドと同等の効果を得る
       ことができます。これらのオプションは主に Unix refer との互
       換 性 のためにサポートされているものです。通常はコマンドを
       使った方が便利です。

       referrefer の出力を読むコマンドによって生成される メッ
       セ ージの中のファイル名と行番号が正しくなるように .lf 行を
       -n     no-default-database

       -C     compatible

       -P     move-punctuation

       -S     label  "(A.n|Q) ', ' (D.y|D)"; bracket-label " (" )
              "; "

       -an    reverse An

       -cfields
              capitalize fields

       -fn    label %n

       -ifields
              search-ignore fields

       -k     label L~%a

       -kfield
              label field~%a

       -l     label A.nD.y%a

       -lm    label A.n+mD.y%a

       -l,n   label A.nD.y-n%a

       -lm,n  label A.n+mD.y-n%a

       -pfilename
              database filename

       -sspec sort spec

       -tn    search-truncate n

       これらのオプションは以下のコマンドと同等です。ただし、通常
       の 方法のかわりにコマンド行で指定されるファイル名が bibli-
       ography コマンドへの引数であるように処理されます。

       -B     annotate X AP; no-label-in-reference

       -Bfield.macro
              annotate field macro; no-label-in-reference

       以下のオプションには同等なコマンドはありません。

       -v     バージョン番号を表示します。

              なりません。 A フィールドは複数回現れても構い ま せ
              ん。出現する順番は意味を持ちます。 A フィールドか Q
              フィールドは常に指定するのが良いでしょう。

       B      ある本の一部である記事において、その本のタイトル で
              す。

       C      出版社の所在地 (都市) です。

       D       出版された日付です。出版年に略称を使用してはいけま
              せん。もし出版月を指定する場合は数字による月では な
              く、月名を使わなければなりませんが、最初の 3 文字を
              指定すれば十分です。 D フィールドは常に指定するのが
              良いでしょう。ただし、出版の日付が分からなければ in
              pressunknown のような値を使うこともできます。

       E      ある本の一部である記事において、その本の編集者の 名
              前 です。出版作業が著者のない編集だけのものであった
              場合、編集者の名前を A フィールドで指定し、  , (ed)
              または , (eds) を最後の著者の後に指定しなければなり
              ません。

       G      米国政府注文番号です。

       I      出版者 (発行人) です。

       J      定期刊行物の記事における、その刊行物の名称です。

       K      検索に使われるキーワードです。

       L      ラベルです。

       N      定期刊行物の発行番号です。

       O      その他の情報です。これは通常参考文献の末尾に印刷 さ
              れます。

       P      ページ番号です。ページ番号の範囲は m - n で指定でき
              ます。

       Q      著者が個人でない場合の著者の名称です。これは A フィ
              ールドがない場合にのみ使用されます。 Q フィールドは
              1 つのみ使うことができます。

       R      技術報告書番号です。

       S      シリーズの名称です。

       T      タイトルです。本や定期刊行物中の記事ではこれは記 事
              のタイトルとなります。

       V      定期刊行物もしくは本のボリューム番号です。
       引用のフォーマットは
              .[opening-text
              flags keywords
              fields
              .]closing-text
       となります。

       opening-textclosing-textflags のコンポーネントは省
       略可能です。 keywordsfields のいずれか 1 つのコンポ ー
       ネントを指定する必要があります。

       keywords  コンポーネントは keywords に含まれる全ての単語を
       含む参考文献を文献データベースから検索するために指定 し ま
       す。もし複数の参考文献が見つかった場合はエラーとなります。

       fields コンポーネントは参考文献の中で指定されるものを置 き
       換えるか付け加えるための追加フィールドを指定します。参考文
       献が蓄積される設定で、 keywords コンポーネントが空でなけれ
       ば、追加フィールドはある特定の参考文献が引用されている最初
       の部分においてのみ指定されなければならず、その参考文献を引
       用している全ての部分に適用されます。

       opening-textclosing-text  コンポーネントは bracket-
       label コマンドにおいて指定される文字列の代わりにラベルを囲
       むために使われる文字列を指定します。これらのいずれもが空で
       なければ、 bracket-label コマンドで指定されている文字列 は
       使われません。この処理は [] フラグを使って置き換えるこ
       とができます。これらのコンポーネントの前と後につくスペース
       は意味を持つことに注意して下さい。

       flags コンポーネントはここでの引用の扱いを変更するためのア
       ルファベット以外の文字のリストです。 Unix refer はこれらの
       フ ラ グをキーワードの一部として処理しますが、それらはアル
       ファベットでないため無視します。以下のフラグが現在認識され
       るものです。

       #      これは short-label コマンドによって指定されるラベル
              を label コマンドで指定されるものの代わりに使用する
              こ とを指示します。もしショートラベルが指定されなけ
              れば、通常のラベルが使用されます。普通はショート ラ
              ベルは auther-date ラベルに使用され、日付とおそらく
              は曖昧さが取り除かれた文字から構成されま す。 こ こ
              で、 # はラベルの数字によるタイプを示唆するものと考
              えられます。

       [      bracket-label コマンドの中で指定される最初の文字 列
              が opening-text の前に置かれます。

       ]      bracket-label コマンドの中で指定される 2 番目の文字
              列が closing-text の後に置かれます。

       opening-textclosing-text の中に括弧を含めるの で は な
       ト し たり、マージしたりすることもできます。ラベルの表記法
       <> とコマンド sort-adjacent-labelsabbreviate-label-
       ranges   の 説 明 を参照して下さい。ラベルは引用に空でない
       opening-textclosing-text がある時にはマージさ れ ま せ
       ん。 しかし、 opening-text が伴わず [ フラグを使った引用が
       その直後に続く、 closing-text を伴わない ] フラグを使っ た
       引用のラベルは最初の引用の opening-text か次の引用の clos-
       ing-text が空でない場合においても、ソートとマージを行な う
       ことができます。 (もしこれを行ないたくない場合は、最初の引
       用で closing-text\& としてください。)

   B>コB>マB>ンB>ド
       コマンドは .R1 で始まる行と .R2 の間に指定されます。これら
       の行は -R オプションを使うことによって認識されないようにで
       きます。 .R1 行が認識された時、すべての蓄積されている参 考
       文献は消去されます。 .R1 行と .R2 行およびこれらの間に指定
       されたものはすべて出力されません。

       コマンドは改行か ; によって区切られます。 # からその行の最
       後まではコメントとなります (しかし、改行自身は改行としてあ
       つかわれます)。各コマンドはワードに分割されます。ワードは
       ス ペースかタブによって区切られます。 " で始まるワードは次
       の " (ただしもう 1 つの " が直後にないもの) までがワードと
       し て扱われます。もし、次の " がない場合にはその行の最後ま
       でがワードとなります。 " で始まるワード中の " のペアはひと
       つの " として扱われます。 " の中では #; は認識されませ
       ん。行は末尾に \ をつけることによって継続できます。ただ し
       # の後の場合は継続されません。

       * でマークされた各コマンド name には name の効果を打ち消す
       否定コマンド no-name があります。例えば、 no-sort コマンド
       は参考文献をソートしないことを指定します。否定コマンドは引
       数を取りません。

       以下の説明で各引数はひとつのワードとなります。  field   は
       フィ ー ル ドの名前となる 1 文字の小文字または大文字です。
       fields はそのような文字のシーケンスです。 mn は非負 の
       数字です。 string は任意の文字列です。 filename はファイル
       名です。

       abbreviate* fields string1 string2 string3 string4
                                fields のファーストネームを短縮形
                                にします。頭文字ともう 1 つの頭文
                                字の間には string1 が挿入さ れ ま
                                す。 ラ ス ト ネ ー ム との間には
                                string2 が挿入され、その他のも の
                                (  vonde のようなもの) との間
                                には string3 が挿入されます。これ
                                ら のストリングのデフォルトはピリ
                                オドにスペースが続いたものとな り
                                ま す。ハイフンで区切られたファー
                                ストネームの中で、名前の最初の 部
                                す。 string が省略された場合の デ
                                フォルトは - です。

       accumulate*               各参考文献を出現するたびに書き出
                                すのではなく、参考文献を蓄積し て
                                い きます。蓄積された参考文献はす
                                べての入力ファイルが処理され  .R1
                                行が認識された後に、

                                       .[
                                       $LIST$
                                       .]

                                の 形式の参照が指定された時に書き
                                出されます。

       annotate* field string   field は注釈です。注釈は参考文 献
                                の最後に

                                       .string

                                の 行の後にパラグラフとして印刷さ
                                れます。 macro が省略される と デ
                                フォ ルトの AP となります。もし、
                                field も省略されるとデフォルト の
                                X  となります。注釈になれるフィー
                                ルドは 1 つのみです。

       articles string...       string...  は定冠詞もしくは不定冠
                                詞 であり、ソートされる時にはフィ
                                ールド T の最初では無視されなけれ
                                ばなりません。初期状態では theaan が冠詞として認識 さ れ ま
                                す。

       bibliography filename...  図書目録データベース filename...
                                に含まれる全ての参考文献を書き 出
                                します。

       bracket-label string1 string2 string3
                                テ キスト中で、各ラベルを string1string2 で囲みま す。  string2
                                の 直 後に string1 が現れた場合は
                                string3 に置き換えられ ま す。 デ
                                フォルトでは

                                       bracket-label  \*([. \*(.]
                                       ", "

                                となります。

       capitalize fields        fields を大文字とそれに続く小文字
       date-as-label* string    string はラベルを構成した後にフィ
                                ールド D を置き換える文字列を指定
                                す るラベル式です。ラベル式の説明
                                については B>ラB>ベB>ルB>式の項を参照して
                                下 さい。このコマンドは参考文献リ
                                ストの中で明示的なラベルは使い た
                                く ないが、何らかの方法で日付を修
                                飾することによって曖昧さを取り 除
                                き たい場合に便利です。通常、テキ
                                スト中で使用されているラベルは 作
                                者 と日付の組み合わせになります。
                                ほとんどの場合、 no-label-in-ref-
                                erence コマンドも使う必要がありま
                                す。例えば、

                                       date-as-label
                                       D.+yD.y%a*D.-y

                                は参考文献中のフィールド D の年の
                                部分に曖昧さを取り除く文字を追 加
                                します。

       default-database*         デフォルトのデータベースを検索し
                                ます。これはデフォルトの動作で あ
                                り、 このコマンドの否定バージョン
                                が有用です。 refer は検索を行なう
                                必 要が最初に出てきた場合、デフォ
                                ルトのデータベースを検索するべ き
                                か ど う かを決定します。そのため
                                no-default-database コマンドを 有
                                効 とするためには、それ以前に指定
                                しておく必要があります。

       discard* fields          参考文献が読み込まれた時、 fields
                                を 無効とします。 fields の文字列
                                の定義は出力されません。初期状 態
                                で は  fieldsXYZ となっていま
                                す。

       et-al* string m n        ラベル式における式 @ の評価 で の
                                et  al の使い方を制御します。著者
                                のシーケンスを明確にするために 必
                                要な著者の数を u 、著者の合計が t
                                とすると、最後の t-u  の 著 者 が
                                string  によって置換され、 t-um より小さくなく、 tn より 小
                                さ くないようになります。デフォル
                                トでは

                                       et-al " et al" 2 3

                                となります。
                                string2 も省略されると、デフォ ル
                                トは string1 となります。例えば、

                                       join-authors " and " ",  "
                                       ", and "

                                は 作者の連結をデフォルトの方法に
                                戻します。

       label-in-reference*      参考文献を出力する時に、文字列 [F
                                を 参考文献のラベルに定義します。
                                これはデフォルトの動作です。こ の
                                コ マンドの否定バージョンが有用で
                                す。

       label-in-text*           各参考文献においてテキスト中の ラ
                                ベ ル を 出 力 し ま す。ラベルは
                                bracket-label コマンドに記述さ れ
                                て いるようにそれを囲むテキストと
                                分離されます。これはデフォルト の
                                動 作です。このコマンドの否定バー
                                ジョンが有用です。

       label string             string はどのように各参考文献にラ
                                ベ ルをつけるかを記述するラベル式
                                となります。

       separate-label-second-parts string
                                2つの部分からなるラベルをマージす
                                る時、2 番目のラベルの 2 番目の部
                                分を string で最初のラベルと分 離
                                し ます。ラベル式については <> の
                                ラベル式の説明を参照して下さい。

       move-punctuation*        テキストにおいてラベルの後の行 末
                                の 句読点を移動します。ラベルに肩
                                文字の数字を使っていなければ、 こ
                                のコマンドを使うといいでしょう。

       reverse* string           名前が string 中にあるフィールド
                                を逆にします。各フィールド名の 後
                                に はいくつのフィールドが逆にされ
                                るかを示す数が指定されます。 フィ
                                ー ル ド にこの数が指定されなけれ
                                ば、そのフィールドは全て逆にな り
                                ます。

       search-ignore* fields     インデックスが存在しないデータベ
                                ースでキーを検索してい る 際 に、
                                fields の内容を無視します。初期状
                                態ではフィールド XYZ が無視されま
                                す。
                                識別できることがあり、ラベルで は
                                作 者を省略したいことがあります。
                                通常、 short-label コマンドは日付
                                と  (多分) 明確な文字のみを含むラ
                                ベルを指定するために使用 さ れ ま
                                す。

       sort* string             string に従って参考文献をソートし
                                ます。参考文献は自動的に累積さ れ
                                ま す。 string はフィールド名のリ
                                ストであり、各フィールド名には ソ
                                ー トに使われる名前にいくつのフィ
                                ールドがあるかを示す数字が続き ま
                                す。 + を名前のついた全てのフィー
                                ルドを使うことを示すために使う こ
                                と ができます。また、 .  を参考文
                                献が (一時的な) ラベルを使って ソ
                                ー トされることを示すために使うこ
                                ともできます。 ( B>ラB>ベB>ルB>式の セ ク
                                ショ ンで一時的なラベルの概念につ
                                いて説明しています。)

       sort-adjacent-labels*    参考文献リスト中での位 置 に 従っ
                                て、 テキスト中の隣接しているラベ
                                ルをソートします。このコマンド は
                                通常は abbreviate-label-ranges コ
                                マンドが与えられている時か、ラ ベ
                                ル 式に <> 式が含まれている時に使
                                用するべきです。これは参考文献 が
                                累 積されていないと影響がありませ
                                ん。

   B>ラB>ベB>ルB>式
       ラベル式は通常もしくは一時的に評価できます。通常評価の結果
       は 出 力に使われます。一時的評価の結果は一時的ラベルと呼ば
       れ、通常評価でラベルを明確にする必要がある情報を集めるため
       に使われます。 date-as-labelshort-label コマンドで指定
       されるラベル式は一時的には評価されません。通常評価と一時的
       評 価 は  @*% の式を除いた全てのタイプの式で同じで
       す。以下の説明は特に指定された場合を除き通常評価に適用され
       ます。

       field
       field n
              fieldn 番めの部分です。 n が省略された場合はデ
              フォルトは 1 となります。

       'string'
              string 中の文字は文字通り解釈されます。

       @      全ての作者を join-authors コマンドで指定された通 り
              に 連結します。各々の作者名の全体が使用されます。し
              われる場合、残りの作者は et-al コマンドで指定された
              文 字列で置き換えられます。このコマンドは頭文字のシ
              ーケンスを使うことができる以前に満たされる追加の 要
              求も指定できます。 @ は一時的に作者の正式の表現に評
              価され、ソートのために同等かどうかを比較する作者 は
              同じ表現となります。

       %n
       %a
       %A
       %i
       %I     参考文献のシリアル番号は % が続く文字に従ってフォー
              マットされます。参考文献のシリアル番号はこの参考 文
              献 として同じ一時的ラベルをもつ先に現れた参考文献の
              番号に 1 を加えたものとなります。これらの式は一時的
              に空の文字列に評価されます。

       expr*  この参考文献としての同じ一時的ラベルを持つもう 1 つ
              の参考文献がある場合、空の文字列でなければ expr  と
              な ります。これは一時的に評価され、空の文字列になり
              ます。

       expr+n
       expr-n expr の最初 (+) または末尾 (-) の n 文字の大文字 か
              小文字か数字です。 troff の ( \('a のような) 特別文
              字は 1 文字としてカウントされます。アクセント文字列
              は保持されますが、合計にはカウントされません。

       expr.l expr を小文字に変換したものです。

       expr.u expr を大文字に変換したものです。

       expr.c expr を大文字とそれに続く小文字に変換したものです。

       expr.r expr をラストネームが最初に来るように逆にしたもので
              す。

       expr.a ファーストネームが略称になった expr です。 abbrevi-
              ate コマンドによって指定されたフィールドはラベル が
              評 価される前に略称にされます。このため、 .a は参考
              文献の中ではなくラベルの中でのみフィールドを略称 に
              したい時のみ有用です。

       expr.y expr の年の部分です。

       expr.+y
              expr の年の前の部分、もしくはそれが年を含んでいなけ
              れば expr の全体となります。

       expr.-y
              expr の年の後の部分、もしくは expr が年を含んでいな
              ければ空の文字列となります。

       expr1&expr2
              expr1 が空でなければ expr2 となり、それ以外では空の
              文字列となります。

       expr1?expr2:expr3
              expr1 が空でなければ expr2 となりそれ以外では expr3
              となります。

       <expr> このラベルには 2 つの部分があり、 expr によって分離
              されています。 2 つの部分からなり、最初の部分が同じ
              である 2 つの連続したラベルは最初のラベルに次のラベ
              ルの 2 番目の部分を追加し、  separate-label-second-
              parts  コマンド (初期値ではスペースが続くコンマ) に
              よって指定された文字列によって分離することによっ て
              マージされます。その結果のラベルもまた 2 つの部分か
              らなるラベルとなり、最初の部分がマージ前の最初の 部
              分 となります。さらに追加されるラベルはこれにマージ
              されます。最初の部分が空であっても差し支えありま せ
              ん。これは short-label コマンドで使う式で使うことが
              できます。

       (expr) expr と同様です。グルーピングを行なうために使われま
              す。

       上 述 の式は順位 (高いものが最初) の順にリストされます。 &| は同じ優先順位となります。

   B>マB>クB>ロB>イB>ンB>タB>フB>ェB>ーB>ス
       各参考文献はマクロ ]- の呼び出しで始まります。文字列 [Fno-label-in-reference コマンドが与えられていないと、この参
       考文献のラベルになるように定義されます。その後一連の文字列
       の 定義が続きます。定義は各フィールドに 1 つずつで、文字列
       [X はフィールド X に対応します。数値レジスタ [P はフィール
       ド  P がページの範囲を含んでいれば 1 にセットされます。 [T[A[O の数値レジスタは、 .?!  の文字のいずれかで終る
       フィールド TAO に対応して 1 にセットされます。数値
       レジスタ [E は文字列 [E が複数の名前を含んでいれば  1   に
       セットされます。参考文献にはマクロ ][ への呼び出しが続きま
       す。このマクロの最初の引数には参考文献のタイプを表す数を与
       え ます。もし参考文献がフィールド J を含んでいると、タイプ
       1 として分類されます。またフィールド B を含んでいるとタ イ
       プ 3、フィールド GR を含んでいるとタイプ 4、フィールド
       I を含んでいるとタイプ 2となり、これら以外ではタイプ 0  と
       な り ま す。 2 番目の引数はタイプ other, journal-article,
       book, article-in-book もしくは tech-report のシンボル名 で
       す。 bibliography コマンドによって累積もしくは生成される参
       考文献のグループは ]< マクロの呼び出しに先行し、 ]> マクロ
       の呼び出しが続きます。


関連ファイル

       /usr/share/dict/papers/Ind  デフォルトのデータベースです。


ABELNET VPSサービス