.\" You may copy, distribute and modify under the terms of the LDP General
.\" Public License as specified in the LICENSE file that comes with the
.\" gnumaniak distribution
.\"
.\" The author kindly requests that no comments regarding the "better"
.\" suitability or up-to-date notices of any info documentation alternative
.\" is added without contacting him first.
.\"
.\" (C) 2002 Ragnar Hojland Espinosa <ragnar@ragnar-hojland.com>
.\"
.\"	GNU ptx man page
.\"	man pages are NOT obsolete!
.\"	<ragnar@ragnar-hojland.com>
.\"
.\" Japanese Version Copyright (c) 2000 NAKANO Takeo all rights reserved.
.\" Translated Sun 12 Mar 2000 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\"
.\"WORD:	permuted index		整列済み索引
.\"WORD:	reference		参照
.\"
.TH PTX 1 "7 October 2002" "GNU textutils 2.1"
.SH 名前
ptx \- 整列済み索引を作成する
.SH 書式
.B ptx
.RI [ OPTION... "] [" FILE... ]

.B ptx
.RB [ \-G ]
.RB [ \-\-traditional ]
.RI [ OPTION... "] [" IN\-FILE " [" OUT\-FILE ]]
.SS Options:
.RB [ \-frAORT ]
.RB [ "\-b \fIFILE" ]
.RB [ "\-g \fINUMBER" ]
.RB [ "\-i \fIFILE" ]
.RB [ "\-o \fIFILE" ]
.RB [ "\-w \fINUMBER" ]
.RB [ "\-F \fISTRING" ]
.RB [ "\-M \fISTRING" ]
.RB [ "\-S \fIREGEXP" ]
.RB [ "\-W \fIREGEXP" ]
.RB [ \-\-auto\-reference ]
.RB [ \-\-break\-file=\fIFILE ]
.RB [ \-\-flac\-truncation=\fISTRING ]
.RB [ \-\-format=\fR{\fBnroff,tex }]
.RB [ \-\-gap\-size=\fINUMBER ]
.RB [ \-\-ignore\-case ]
.RB [ \-\-ignore\-file=\fIFILE ]
.RB [ \-\-macro\-name=\fISTRING ]
.RB [ \-\-only\-file=\fIFILE ]
.RB [ \-\-references ]
.RB [ \-\-right\-side\-refs ]
.RB [ \-\-sentence\-regexp=\fIREGEXP ]
.RB [ \-\-word\-regexp=\fIREGEXP ]
.RI [ FILE... ]
 
.BR ptx " [" \-C "] [" \-\-copyright "]  [" \-\-help "] [" \-\-version ]
.SH 説明
GNU 拡張された
.B ptx
(デフォルト) は、与えられた
.I FILE
それぞれの整列済み索引 (permutated index)
を標準出力に書く。
.I FILE
が一つも与えられないと標準入力から読み込む。また
.I FILE
が
.RB ` \- '
だった場合には、そのファイルには標準入力が用いられる。
結果は結合されるが、各
.I FILE
はそれぞれ独自のコンテクストを持ち、
自動参照を使うときには別々に参照される。

[訳注: 参照 (reference) とは、キーワードの現れるファイル名と行数の表示。]

.B \-\-traditional
モードを使うと、
.B ptx
は入力を
.I IN\-FILE
から読み、
.I OUT\-FILE
に書く。後者が省略されると標準出力に書く。

デフォルトの出力フォーマットは、
キーワードをセンターに、そしてコンテクストがあれば左または右に書く。
.B \-\-traditional
モードでは
.B \-\-format\-nroff
が用いられる。
.SH オプション
.TP 
.B \-b \fIFILE\fB, \-\-break\-file=\fIFILE
単語に含むことのできない文字を
.I FILE
から取得する (このファイルは
.B break file
と呼ばれる)。
デフォルトのモードでは、
.I FILE
にある全ての文字が (改行文字も含めて) 考慮される。
過去互換モードでは、空白・タブ・改行の各文字は、常に
.I FILE
からは捨てられる。
.TP
.B \-f, \-\-ignore\-case
文字列をソートするとき英大文字小文字を無視する。
.TP
.B \-g \fINUMBER\fB, \-\-gap\-size=\fINUMBER
フィールド間の空白の最低数を
.I NUMBER
に設定する (デフォルトは 3)。
.TP
.B \-i \fIFILE\fB, \-\-ignore\-file=\fIFILE
無視するキーワードのリストを
.I FILE
から取得する (このファイルは
.B ignore file
と呼ばれる。デフォルトは /usr/local/lib/eign)。
各行には単語を一つだけ指定する。
.B ignore file
にある単語は
.B only file
にある単語を上書きする。
.TP
.B \-o \fIFILE\fB, \-\-only\-file=\fIFILE
キーワードのリストを
.I FILE
から取得する (このファイルは
.B only file
と呼ばれる)。インデックスを生成するとき、
このリストにない単語は無視する。各行には単語を一つだけ指定する。
.TP
.B \-r, \-\-references
各行の前にコンテクストを指示する文字列 (行頭の単語) を付ける。
.B ptx
は参照をコンテクストから削除しようとし、
コンテクストが改行で終わる場合にはこれは常に成功する。
このオプションを
.B \-S
と共に用いたり (これはデフォルト)、
.B \-\-traditional
モードを用いると、参照は常にコンテクストから削除される。
.TP
.B \-w \fINUMBER\fB, \-\-width=\fINUMBER
出力行を
.I NUMBER
桁を越えないように切り捨てる。
.B \-\-right\-side\-refs
の分は含まれないので注意。これを用いた場合は指定桁を越えることがある。
.TP
.B \-A, \-\-auto\-reference
各行の前にファイル名 (標準入力から読み込んだ場合は空文字列)、
行番号、コロンを出力する。
.B \-\-references
より優先する。
.TP
.B \-F \fISTRING\fB, \-\-flac\-truncation=\fISTRING
.B \-\-width
によって行を切り捨てるときや、コンテクストが行区切りを越えて続く場合に
.I STRING
(デフォルトは `\fB\e\fR') を出力する。

.I STRING
中では、(C プログラムで使うような)
バックスラッシュを用いたエスケープシーケンスの多くも認識され、
適切な文字に変換される。
.\":nakano この辺原文がよれている...
.TP
.B \-M \fISTRING\fB, \-\-macro\-name=\fISTRING
nroff や TeX 形式で出力するときに、
.I STRING
をマクロ名に使う (デフォルトは
.RB ` .xx ')。
.TP
.B \-O, \-\-format=nroff
出力を nroff 形式にする。
印字できない文字はスペースに置換され、クォート文字は二重にして
正しく処理できるようにする。各行のフォーマットは以下の通り:
.sp
.nf
 .xx "TAIL" "BEFORE" "KEYWORD_AND_AFTER" "HEAD" "REF"
.fi
.TP
.B \-R, \-\-right\-side\-refs
.B \-\-references
と似ているが、参照を右に出力する。
.TP
.B \-S \fIREGEXP\fB, \-\-sentence\-regexp=\fIREGEXP
.I REGEXP
を行末または文末の評価に用いる。
GNU モードで
.B \-\-references
オプションが指定されていない場合のデフォルトは以下:
.sp
.RS
.RS
.nf
[.?!][]\e"')}]*\e\e($\e\e|\et\e\e|  \e\e)[ \et\en]*	 
.fi
.RE
.sp
.B \-\-traditional
モードや、 GNU モードで
.B \-\-references
オプションが指定されている場合のデフォルトは以下:
.sp
.RS
.nf
\en
.fi
.RE
.sp
.B \-F
と同様、バックスラッシュを用いたシーケンスも認識・変換される。
.RE
.TP
.B \-T, \-\-format=tex
出力を TeX 形式にする。
印字できない文字はスペースに置換し、
いくつかの特殊文字 (`$', `%', `&', `#', `_' など)
をバックスラッシュでプロテクトする。
バックスラッシュは `\ebackslash{}' に、
アクセント記号は `^\e{ }' に、
チルダは `~\e{ }' に置換し、
その他の音韻記号も可能な限り最も適切な TeX シーケンスに変換する。
各行のフォーマットは以下の通り:
.sp
.RS
.RS
.nf
\exx {TAIL}{BEFORE}{KEYWORD}{AFTER}{HEAD}{REF}
.fi
.RE
.RE
.TP
.B \-W \fIREGEXP\fB, \-\-word\-regexp=\fIREGEXP
.I REGEXP
にマッチする単語をキーワードにする。
.B \-\-break\-file
に指定されている単語も出力する。 GNU モードでのデフォルトは:
.sp
.RS
.RS
.nf
.B \ew+
.fi
.RE
.sp
.B \-\-traditional
モードでのデフォルトは
.sp
.nf
.RS
.B [^ \et\en]+
.fi
.RE
.sp
.I REGEXP
が空の場合はデフォルトを用いる。
.B \-F
と同じく、バックスラッシュを用いたシーケンスも認識・変換される。
.RE
.TP
.B "\-C, \-\-copyright"
標準出力に短い copyright メッセージを出力して正常終了する。
.TP
.B "\-\-help"
標準出力に使用方法のメッセージを出力して正常終了する。
.TP
.B "\-\-version"
標準出力にバージョン情報を出力して正常終了する。
.SH 例
分量が多くなるので、完全な例はここには示していない。
.SS プレインテキスト

.B ptx
の著者である Francois Pinard は、私の出したメールを
.B ptx
に通し、以下の返事を送ってくれた
(*** は man ページに収めるために手で行った切り捨てを示す)。
.sp
.nf
>>    /I've had a look at the source,   and I still   ***
>>    /or what is a permutated index,   and what it   ***

> ptx merely produces a sorted list of the vocabulary you
> used, with some context for each, so I can study your
> writing style, for example.  Whenever you use the word 
> "and", it is preceded by a comma :-). 

[ptx は君の使ったボキャブラリをソートしてリストを作り、
 前後のコンテクストと共に示してくれるんだ。これを見ると、
 例えば君の書き方のクセがわかるわけさ。君が "and" って
 いう単語を使う前には必ずコンマを入れる、とかね :-)]
.fi
.SS bang パス
news へのポストや email メッセージに対して grep を行い、
bang パスを取得してみよう。例えば:
.sp
.RS
.nf
lightside~% grep posts "^Path: " |cut -b 7- > paths.txt
.fi
.RE
.sp
すると paths.txt の内容は以下のようになるだろう。
.sp
.RS
.nf
lightside!host2!host3!host4!host5!news
lightside!host2!host3!host4!host6!news
lightside!host7!host8!host9|host10|host4|host5!news
lightside!host4!host5!news
lightside!host11!news
.fi
.RE
.sp
これに正規表現を正しくエスケープして
.B ptx
を用いてみよう。
.sp
.RS
.nf
lightside~% ptx \-\-sentence\-regexp="\en" \e
                \-\-word\-regexp="[^\e!]+."
.fi
.RE
.sp
するとポストの経路の解析に適した出力が生成されるだろう。
行数が、ここに示した 5 行よりもずっと多くなると、とても便利になるだろう。
.SH 移植性
.B \-\-traditional
を指定すると、
System V の
.B ptx
と互換になる。 GNU
.B ptx
は行幅をよりうまく使えるのだが、この点も
System V の出力に時々現れる異常をまねしようと試みる。
.\"nakano: ここわかんない(^^;
.B \-\-traditioanl
モードとの他の相違点は以下の通り:
.RS
.sp
\fB\(bu\fR\ \fB説明\fR にあるように、引数の取り方が変わる。
.sp
\fB\(bu\fR\ 指定できるオプションが
.BR \-b ", " \-f ", " \-g ", " \-i ", " \-o ", "\-r ", " \-t ", " \-w
だけになる。
.sp
\fB\(bu\fR\ デフォルトの出力形式が
.B \-\-format=nroff
になる。
.sp
\fB\(bu\fR\ \fB\-\-width\fR で行切り捨てを行うとき、参照の幅を考慮しなくなる。
.sp
\fB\(bu\fR\ 8 ビット文字とチルダ (`\fB~\fR') をはねる。
いくつかの制御文字もはねる。
.sp
\fB\(bu\fR\ 入力行の 200 文字以降を黙って切り捨てる。
.sp
\fB\(bu\fR\ \fBignore file\fP と \fBonly file\fP の両方を同時に指定できない。
.sp
\fB\(bu\fR\ \fBオプション\fPに記述したように、
いくつかのオプションのデフォルトが変わる。
.RE
.SH 注意
プログラムのバグについては bug-textutils@gnu.org に報告してください。
.br
man ページは Ragnar Hojland Espinosa <ragnar@ragnar-hojland.com> が作成しました。