namazu-dev(ring)

[Satoru Takabayashi <satoru-t@xxxxxxxxxxxxxxxxxx>]

コマンドラインオプションについて考えてみました。ご意見をくださ
いませ。

namazuコマンド:

変更なし:
|   -n, --max=num           一度に表示する件数
|   -w, --whence=num        表示するリストの先頭番号
|   -s, --short             短いフォーマットで出力
|   -a, --all               検索結果をすべて表示する
|   -c, --count             ヒット数のみを表示する
|   -v, --version           ヴァージョンを表示する
|   -L, --lang=lang         メッセージの言語を設定する ja または en
|   -o, --output=file       指定したファイルに検索結果を出力する
|   -C, --show-config       コンフィギュレーション内容を表示する
|   -f, --config=file       namazu.conf を指定する
|   -q, --quiet             検索結果以外のメッセージを表示しない
|   -R, --no-replace-uri    URI の置き換えを行わない
|   -U, --no-encode-uri     URI encode の復元を行わない
|   -r, --no-references     参考ヒット数を表示しない
|   -H, --page              先の検索結果へのリンクを表示する (ほぼ無意味) 
|   -F, --form              <form> ... </form> の部分を強制的に表示する


|   -S, --very-short        もっと短いフォーマット (リスト表示) で出力

grep の -l オプションと共通にしたい。すると、


|   -l, --late              新しい順にソートする

とかち合うのでので、こちらの -l をあきらめて

    -l, --list              リスト表示で出力
        --late              新しい順にソートする

としたい。-S は下位互換のためにそのまま残しておく。

また、

|   -e, --early             古い順にソートする

も -e を使うのをやめて

        --early             古い順にソートする

としたい。

ソートについては

        --sort=score         スコアでソート [標準]
        --sort=date          日付順でソート
        --sort=field:title   任意のフィールドでソート
        --reverse            ソートを逆順にする [標準は降順]

を追加する予定。


|   -0, --help              help を表示する (この表示)

-0 がヘルプというのはダサイが、-hは

|   -h, --html              HTML で出力する

で使われているので一文字のオプションをあきらめて、

        --help              help を表示する (この表示)

とする。


mknmzコマンド:

|  対象ファイル:
|    -a, --all                すべてのファイルを対象とする
|    -e, --robots-txt         ロボットよけされているファイルを除外する
|    -A, --htaccess           .htaccess で制限されたファイルを除外する
|    -F, --target-list=file   インデックス対象のファイルのリストを読み込む
|    -t, --allow=regex        対象ファイルの正規表現を指定する

         --deny=regex         除外するファイルの正規表現を指定する
         --exclude-dir=regex  除外するディレクトリの正規表現を指定する

を追加。


|  形態素解析:
|    -c, --use-chasen        日本語の単語のわかち書きに ChaSen を用いる
|    -k, --use-kakasi        日本語の単語のわかち書きに KAKASI を用いる
|    -m, --use-chasen-morph  名詞のみを抽出する

そのまま。


|  フィルタ制御:
|    -r, --man          man のファイルを処理する
|    -u, --uuencode     uuencode と BinHex の部分を無視する
|    -h, --rfc822       Mail/News のファイルを処理する
|    -M, --no-mhonarc   MHonArc で作成された HTML の処理を行わない

-u 以外は全部廃止 (File::MMagic の自動判別に任せる)。-h はよ
く使うオプションなのでダミーとして残しておく。


|  文字列処理:
|    -E, --no-edge-symbol  単語の両端の記号は削除する
|    -G, --no-okurigana    送り仮名を削除する
|    -H, --no-hiragana     平仮名のみの単語は登録しない
|    -K, --no-symbol       記号をすべて削除する

この 4つは、そのまま。

|    -L, --no-line-adjust  行頭・行末の調整処理を行わない

これは廃止。


|  要約:
|    -U, --no-encode-uri       URIのencodeを行わない
|    -x, --no-heading-summary  HTML のヘディングによる要約作成を行わない

そのまま。


|  インデックス作成:
|    -P, --no-heading-summary  フレーズ検索用のインデックスを作成しない
|    -R, --no-regex-index      正規表現検索用のインデックスを作成しない
|    -W, --no-date-index       日付によるソート用のインデックス作成しない
|    -X, --no-field-index      フィールド検索用のインデックスを作成しない

この 4つは廃止。インデックスを部分的に作ったり作らなかったり
するのはバグの元なので。


|    -Y, --no-delete           削除された文書の検出を行わない
|    -Z, --no-update           文書の更新/削除を反映しない

この 2つは残す。


|  その他:
|    -s, --checkpoint        チェックポイント機構を作動させる
|    -O, --output-dir=dir    インデックスの出力先を指定する
|    -T, --template-dir=dir  NMZ.{head,foot,body}.* のディレクトリを指定する
|    -v, --version           ヴァージョンを表示する
|    -q, --quiet             インデックス処理の最中にメッセージを表示しない
|    -I, --include=file      カスタマイズ用ファイルを読み込む
|    -V, --verbose           口やかましいモード
|        --debug             デバッグモード
|        --help              このヘルプを表示する

そのまま。


|    -l, --lang=lang         言語を設定する ('en' or 'ja')

これは namazu コマンドと共通にしたいので -L にする。

     -L, --lang=lang         言語を設定する ('en' or 'ja')

  ...

[namazu-dev 261] で mknmz に --config=file オプションをつけ
ることはできないと書きましたが、たぶんなんとかなります。その
うち実装します。

-- Satoru Takabayashi