1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
.\"
.\" Copyright (c) 1996, 1997 Shigio Yamaguchi. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Shigio Yamaguchi.
.\" 4. Neither the name of the author nor the names of any co-contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\" jpman %Id: htags.1,v 1.3 1997/07/27 12:58:52 horikawa Stab %
.\"
.Dd June 28, 1997
.Dt HTAGS 1
.Os BSD 4
.Sh 名称
.Nm htags
.Nd C や yacc のソースコードからハイパーテキストを生成する
.Sh 書式
.Nm htags
.Op Fl a
.Op Fl f
.Op Fl l
.Op Fl n
.Op Fl v
.Op Fl w
.Op Fl d Ar tagdir
.Op Fl t Ar title
.Op Ar dir
.Sh 解説
.Nm
は GLOBAL のデータベース (GTAGS と GRTAGS) を利用して C や yacc の
ソースコードからハイパーテキストを生成します。
.Pp
このコマンドを使う前には、ソースツリーのルートディレクトリで
.Xr gtags 1
を実行していなければなりません。
その後、同じディレクトリで
.Nm
を使うことができるようになります。
.Nm
は HTML ディレクトリを作成し、そこにハイパーテキストを生成します。
.Pp
\&'HTML/index.html' からブラウズを始めることができます。
いったんハイパーテキストが生成されれば、好きな場所に持っていき、
好きなブラウザで見ることが可能です。
.Pp
.br
.Bl -tag -width Ds
.It Fl a
アルファベット順の関数一覧を作成します。
大きなプロジェクトには有効でしょう。
.It Fl f
CGI プログラムによる入力フォームと動的インデックスをサポートします。
HTTP サーバの設定を行う必要があります。
.It Fl l
各行に対し名前のタグ(<A NAME=行番号>)を生成し、他のハイパーテキストから
このハイパーテキストの任意の行を指し示すことができるようにします。
デフォルトでは、参照されるオブジェクトがある行にのみタグを生成します。
.It Fl n
行番号を表示します。デフォルトでは表示しません。
.It Fl v
冗長モード。
.It Fl w
警告メッセージを表示します。
.It Fl d Ar tagdir
GTAGS と GRTAGS が存在するディレクトリを指定します。
デフォルトではカレントディレクトリになります。
.It Fl t Ar title
ハイパーテキストのタイトルを指定します。デフォルトでは現在のパスの
最後の構成要素になります。
.It Ar dir
ハイパーテキストが生成されるディレクトリを指定します。
デフォルトではカレントディレクトリになります。
.Sh 使用例
% cd /usr/src/sys
# gtags -se
# htags -fnvat 'Welcom to FreeBSD kernel source tour!'
% lynx HTML/index.html
.Sh 関連ファイル
.Bl -tag -width tags -compact
.It Pa HTML/index.html
目次ファイル。
.It Pa GTAGS
関数定義のタグファイル。
.It Pa GRTAGS
関数参照のタグファイル。
.El
.Sh 環境変数
htags の実行に際しては、以下の環境変数が参照されます。
.Pp
.Bl -tag -width indent
.It Ev TMPDIR
この変数が設定されていると、値が一時ファイルを作成するディレクトリ
として用いられます。
デフォルトは /tmp 。
.Sh 診断
エラーが発生すると
.Nm
は非 0 を返し、それ以外では 0 を返して終了します。
.Sh 関連項目
.Xr btreeop 1 ,
.Xr global 1 ,
.Xr gtags 1 .
.Sh バグ
生成されるハイパーテキストはとても大きくなります。実行前にディスクの
空き容量をチェックしてください。
.Sh 作者
Shigio Yamaguchi (shigio@wafu.netgate.net)
.Sh 歴史
.Nm
コマンドは FreeBSD 2.2.2 で登場しました。
|
