namazu-dev(ring)
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: generate man pages
Abe Ryuji <raeva@xxxxxxxxxxxx> wrote:
>> * マニュアルを整備 (大変だ)
>
>man pagesに関しては、最近GNU softwareの仲間入りをしたhelp2man
>というのが使えると思います。コマンドが--helpオプションをサポート
>していれば、
>$ LANG=C help2man <executable>
>のようにすれば、roffのソースを出力します。
さっそく試しました。メイル末尾に整形後のテキストを添付してお
きます。こりゃ使える。:-)
# SEE ALSO は「HTML版のマニュアルを見よ」に書き換えよう :)
man ディレクトリを作ってそこに namazu.1, mknmz.1 を放り込ん
でおけばいいかな?
日本語の man はどうしよう。インストール先を決めるのが大変な
んですよね。(環境変数 LANG なりから推測できる?)
# なくてもいい、といえばいいのですが (man はおまけなので)
-- Satoru Takabayashi
NAMAZU(1) FSF NAMAZU(1)
NAME
namazu - manual page for namazu v1.9.8
SYNOPSIS
namazu [options] <query> [index ...]
DESCRIPTION
Search Program of Namazu v1.9.8 Copyright (C) 1997-1999
Satoru Takabayashi All rights reserved.
-n, --max=num
set number of documents shown at once.
-w, --whence=num
set first number of documents shown in results.
-l, --list
print results by listing format.
-s, --short
print results by short format.
--results=ext
set NMZ.result.ext for printing results.
--late sort documents in late order.
--early
sort documents in early order.
--sort=method
set a sort method (score, date, field:name)
--ascending
sort in ascending order (default: descending)
-a, --all
print all results.
-c, --count
print only number of hits.
-h, --html
print in HTML format.
-r, --no-references
do not display reference hit counts.
-H, --page
print further result links. (nearly meaningless)
-F, --form
force to print <form> ... </form> region.
namazu v1.9.8 November 1999 1
NAMAZU(1) FSF NAMAZU(1)
-R, --no-replace
do not replace URI string.
-U, --no-encode-uri
do not decode URI when printing in a plain format.
-o, --output=file
set output file name.
-f, --config=file
set a pathname of a config file.
-C, --show-config
print current configuration.
-q, --quiet
do not display extra messages except search
results.
-L, --lang=lang
set language (ja or en)
-v, --version
show the version of namazu and exit.
--help show this help and exit
SEE ALSO
The full documentation for namazu is maintained as a Tex-
info manual. If the info and namazu programs are properly
installed at your site, the command
info namazu
should give you access to the complete manual.
namazu v1.9.8 November 1999 2