GNU Global・gtags(HTML表示)

htagsコマンドでソースコードをHTMLにして、ブラウザで見るようにすることができます。 HTML形式はデフォルトではフレーム無しですが、オプションで指定すればフレーム有りや行番号表示などが可能です。

コマンドの実行は、gtagsコマンドを実行したディレクトリで、htagsコマンドを実行します。 すると、HTMLというディレクトリができ、その中のindex.htmlがトップページになります。 CakePHP 2.2.8のソースでgtags、htagsコマンドを実行すると以下のようになります。

$ ls -l
合計 2936
-rw-r--r--  1 mikan pub  229376  5月  1 19:55 2013 GPATH
-rw-r--r--  1 mikan pub 2097152  5月  1 19:55 2013 GRTAGS
-rw-r--r--  1 mikan pub  630784  5月  1 19:55 2013 GTAGS
drwxr-xr-x 11 mikan pub    4096  5月  7 08:46 2013 HTML
-rw-r--r--  1 mikan pub    1665  4月 29 05:29 2013 README.md
drwxr-xr-x 14 mikan pub    4096  4月 29 05:29 2013 app
-rw-r--r--  1 mikan pub     177  4月 29 05:29 2013 build.properties
-rw-r--r--  1 mikan pub    9839  4月 29 05:29 2013 build.xml
-rw-r--r--  1 mikan pub     139  4月 29 05:29 2013 dot.htaccess
-rw-r--r--  1 mikan pub    1405  4月 29 05:29 2013 index.php
drwxr-xr-x  3 mikan pub    4096  4月 29 05:29 2013 lib
drwxr-xr-x  2 mikan pub    4096  4月 29 05:29 2013 plugins
drwxr-xr-x  2 mikan pub    4096  4月 29 05:29 2013 vendors

個人的には以下のようなオプションで使用していて、 フレーム無し、検索有り、アルファベットごとのインデックス作成、ソース以外のインデックス有り、行番号有り、警告表示になります。

$ htags -safnow

上記で作成されたトップ画面

• オプション

指定可能なオプションは以下になります。

-a	アルファベットごとにインデックスを作成
-o	ソース以外のファイルのインデックスも作成
-s	関数以外のシンボルのインデックスを作成
-n	行番号を付ける
-F	フレームを使用する
-f	検索フォームを表示します

その他、詳細表示や警告表示などのオプションもあります。

-w	警告を表示
-v	詳細を表示

上記以外にも、独自のヘッダーやフッターを指定する、"--insert-header"などのオプションもあります。

• オプション無しの場合

オプションを指定しないと以下の画面になります。



• フレームを使用する場合

デフォルトではフレームを使わないようになっています。 フレームを使用する場合は、オプションFを指定します。

$ htags -F

この場合の画面は、以下のようになります。