HTAGS(1)

名称
htags - C や yacc のソースコードからハイパーテキストを生成する

書式
htags [-a] [-f] [-l] [-n] [-v] [-w] [-d tagdir] [-t title] [dir]

解説
htags は GLOBAL のデータベース (GTAGS と GRTAGS) を利用して C や yacc の ソースコードからハイパーテキストを生成します。

このコマンドを使う前には、ソースツリーのルートディレクトリで gtags(1) を実行していなければなりません。 その後、同じディレクトリで htags を使うことができるようになります。 htags は HTML ディレクトリを作成し、そこにハイパーテキストを生成します。

'HTML/index.html' からブラウズを始めることができます。 いったんハイパーテキストが生成されれば、好きな場所に持っていき、 好きなブラウザで見ることが可能です。

-a  アルファベット順の関数一覧を作成します。 大きなプロジェクトには有効でしょう。

-f  CGI プログラムによる入力フォームと動的インデックスをサポートします。 HTTP サーバの設定を行う必要があります。

-l  各行に対し名前のタグ(<A NAME=行番号>)を生成し、他のハイパーテキストから このハイパーテキストの任意の行を指し示すことができるようにします。 デフォルトでは、参照されるオブジェクトがある行にのみタグを生成します。

-n  行番号を表示します。デフォルトでは表示しません。

-v  冗長モード。

-w  警告メッセージを表示します。

-d tagdir
    GTAGS と GRTAGS が存在するディレクトリを指定します。 デフォルトではカレントディレクトリになります。

-t title
    ハイパーテキストのタイトルを指定します。デフォルトでは現在のパスの 最後の構成要素になります。

dir ハイパーテキストが生成されるディレクトリを指定します。 デフォルトではカレントディレクトリになります。

使用例
% cd /usr/src/sys # gtags -se # htags -fnvat 'Welcom to FreeBSD kernel source tour!' % lynx HTML/index.html

関連ファイル
HTML/index.html
    目次ファイル。
GTAGS
    関数定義のタグファイル。
GRTAGS
    関数参照のタグファイル。

環境変数
htags の実行に際しては、以下の環境変数が参照されます。

TMPDIR
    この変数が設定されていると、値が一時ファイルを作成するディレクトリ として用いられます。 デフォルトは /tmp 。

診断
エラーが発生すると htags は非 0 を返し、それ以外では 0 を返して終了します。

関連項目
btreeop(1), global(1), gtags(1).

バグ
生成されるハイパーテキストはとても大きくなります。実行前にディスクの 空き容量をチェックしてください。

作者
Shigio Yamaguchi (shigio@wafu.netgate.net)

歴史
htags コマンドは FreeBSD 2.2.2 で登場しました。