23 |
# o man format reference manual. |
# o man format reference manual. |
24 |
# o texinfo format reference manual. |
# o texinfo format reference manual. |
25 |
# |
# |
26 |
@HEADER HTAGS,1,March 2005,GNU Project |
@HEADER HTAGS,1,April 2005,GNU Project |
27 |
@NAME htags - generate hypertext from source code. |
@NAME htags - generate hypertext from source code. |
28 |
@SYNOPSIS |
@SYNOPSIS |
29 |
@name{htags} [-a][-c][-D][-f][-F][-g][-n][-o][-s][-v][-w][-x][-d @arg{dbpath}][-m @arg{name}][-S @arg{cgidir}][-t @arg{title}][@arg{htmldir}] |
@name{htags} [-a][-c][-D][-f][-F][-g][-n][-o][-s][-v][-w][-x][-d @arg{dbpath}][-m @arg{name}][-S @arg{cgidir}][-t @arg{title}][@arg{htmldir}] |
30 |
@DESCRIPTION |
@DESCRIPTION |
31 |
@name{Htags} makes hypertext from C, C++, Yacc, Java, PHP and Assembly source code. |
@name{Htags} makes hypertext of C, C++, Yacc, Java, PHP and Assembly source code. |
32 |
|
|
33 |
In advance of using this command, you must execute |
In advance of using this command, you must execute |
34 |
@xref{gtags,1} from the root directory of the source tree. |
@xref{gtags,1} from the root directory of the source tree. |
35 |
Then you can execute @name{htags} from the same place. |
Then you can execute @name{htags} from the same place. |
36 |
@name{Htags} makes an @file{HTML} directory and generates hypertext in it. |
@name{Htags} makes an @file{HTML} directory and generates hypertext in it. |
37 |
|
|
|
You must use the same parser for both @xref{gtags,1} and @name{htags}. |
|
|
If you use the default parser, it is not necessary to consider for it. |
|
|
|
|
38 |
You can start browsing from @file{HTML/index.html}. |
You can start browsing from @file{HTML/index.html}. |
39 |
Once the hypertext is generated, you can move it anywhere and browse it |
Once the hypertext is generated, you can move it anywhere and browse it |
40 |
with any browser. |
with any browser. |
41 |
|
|
42 |
|
You must use the same parser for both @xref{gtags,1} and @name{htags}. |
43 |
|
If you use the default parser, it is not necessary to consider for it. |
44 |
|
|
45 |
@OPTIONS |
@OPTIONS |
46 |
The following options are available: |
The following options are available: |
47 |
@begin_itemize |
@begin_itemize |
48 |
@item{@option{-a}, @option{--alphabet}} |
@item{@option{-a}, @option{--alphabet}} |
49 |
Make an alphabetical function index, suitable for a large project. |
Make an alphabetical function index which is suitable |
50 |
|
for a large project. |
51 |
@item{@option{--caution}} |
@item{@option{--caution}} |
52 |
Include caution message to prohibit downloading. |
Include caution message to prohibit downloading. |
53 |
@item{@option{-c}, @option{--compact}} |
@item{@option{-c}, @option{--compact}} |
54 |
Compress html files by @xref{gzip,1}. |
Compress html files by @xref{gzip,1}. |
55 |
You need to set up a HTTP server so that @xref{gzip,1} |
You need to set up a web server so that @xref{gzip,1} |
56 |
is invoked for each compressed file. |
is invoked for each compressed file. |
57 |
See @file{HTML/.htaccess} that is generated by htags. |
See @file{HTML/.htaccess} that is generated by htags. |
58 |
@item{@option{--cvsweb} @arg{url}} |
@item{@option{--cvsweb} @arg{url}} |
60 |
@item{@option{--cvsweb-cvsroot} @arg{cvsroot}} |
@item{@option{--cvsweb-cvsroot} @arg{cvsroot}} |
61 |
Specifies cvsroot in cvsweb URL. |
Specifies cvsroot in cvsweb URL. |
62 |
@item{@option{-D}, @option{--dynamic}} |
@item{@option{-D}, @option{--dynamic}} |
63 |
Generate object list dynamically using CGI program. |
Generate object lists dynamically using CGI program. |
64 |
By default, object list is generated statically. |
By default, object lists are generated statically. |
65 |
If hypertext is moved from source directory, line image will be |
Though this option decrease both the size and the generation |
66 |
omitted from the list of other symbols. |
time of the hypertext, you need to set up a web server, and |
67 |
If -c option of @xref{gtags,1} is used and hypertext is moved from source directory, |
you cannot move the hypertext from the source directroy. |
|
line image will be omitted from the list of definitions and references. |
|
68 |
@item{@option{-d}, @option{--dbpath} @arg{dbpath}} |
@item{@option{-d}, @option{--dbpath} @arg{dbpath}} |
69 |
Specifies the directory in which @file{GTAGS} and @file{GRTAGS} |
Specifies the directory in which @file{GTAGS} and @file{GRTAGS} |
70 |
exist. The default is the current directory. |
exist. The default is the current directory. |
71 |
@item{@option{-f}, @option{--form}} |
@item{@option{-f}, @option{--form}} |
72 |
Support search form using CGI program. |
Support search form using CGI program. |
73 |
You need to set up a HTTP server for this. |
You need to set up a web server, and you cannot move |
74 |
If hypertext is moved from source directory, line image will be |
the hypertext from the source directroy. |
|
omitted from the list of other symbols. |
|
|
If -c option of @xref{gtags,1} is used and hypertext is moved from source directory, |
|
|
line image will be omitted from the list of definitions and references. |
|
75 |
@item{@option{-F}, @option{--frame}} |
@item{@option{-F}, @option{--frame}} |
76 |
Use frame for each part of the contents. |
Use frame for each part of the contents. |
77 |
@item{@option{-g}, @option{--gtags}} |
@item{@option{-g}, @option{--gtags}} |
80 |
@item{@option{--gtagsconf} @arg{file}} |
@item{@option{--gtagsconf} @arg{file}} |
81 |
Load user's configuration from @arg{file}. |
Load user's configuration from @arg{file}. |
82 |
@item{@option{--gtagslabel} @arg{label}} |
@item{@option{--gtagslabel} @arg{label}} |
83 |
@arg{label} is used as the label of configuration file. |
@arg{label} is used for the label of configuration file. |
84 |
The default is @code{default}. |
The default is @code{default}. |
85 |
@item{@option{-m}, @option{--main-func} @arg{name}} |
@item{@option{-m}, @option{--main-func} @arg{name}} |
86 |
Specify the main function name. The default is @code{main}. |
Specify the main function name. The default is @code{main}. |
87 |
@item{@option{-n}, @option{--line-number}} |
@item{@option{-n}, @option{--line-number}} |
88 |
Print the line numbers. By default, doesn't print it. |
Print line numbers. By default, doesn't print them. |
89 |
@item{@option{--no-map-file}} |
@item{@option{--no-map-file}} |
90 |
Doesn't generate @file{MAP} and @file{MAPFILE} file. |
Doesn't generate @file{MAP} and @file{MAPFILE} file. |
91 |
By default, @name{htags} generates them. |
By default, @name{htags} generates them. |
96 |
Print statistics information. |
Print statistics information. |
97 |
@item{@option{--style-sheet} @arg{file}} |
@item{@option{--style-sheet} @arg{file}} |
98 |
Load style sheet file and insert it into <head> tag. |
Load style sheet file and insert it into <head> tag. |
99 |
|
If you use the @option{--xhtml} option, you should use |
100 |
|
@file{style.css} instead. |
101 |
@item{@option{-s}, @option{--symbol}} |
@item{@option{-s}, @option{--symbol}} |
102 |
Make anchors not only for functions but also other symbols. |
Make anchors not only for functions but also other symbols. |
103 |
@file{GSYMS} tag file needed. |
@file{GSYMS} tag file needed. |
104 |
@item{@option{-S}, @option{--secure-cgi} @arg{cgidir}} |
@item{@option{-S}, @option{--secure-cgi} @arg{cgidir}} |
105 |
write cgi script into @arg{cgidir} to realize a centralised |
Write CGI programs into the @arg{cgidir} to realize |
106 |
cgi script. Script alias is @file{/cgi-bin} by default. |
a centralised CGI program. |
107 |
You can overwrite this value with config variable |
Script alias is @file{/cgi-bin} by default. |
108 |
|
You can overwrite this value using config variable |
109 |
@code{script_alias} in @file{gtags.conf}. |
@code{script_alias} in @file{gtags.conf}. |
110 |
@item{@option{-t}, @option{--title} @arg{title}} |
@item{@option{-t}, @option{--title} @arg{title}} |
111 |
The @arg{title} of this hypertext. The default is the last |
The @arg{title} of this hypertext. The default is the last |
180 |
The following configuration variables affect the execution of @name{htags}: |
The following configuration variables affect the execution of @name{htags}: |
181 |
If the @option{--xhtml} option is specified then all definitions of |
If the @option{--xhtml} option is specified then all definitions of |
182 |
HTML tag are ignored. |
HTML tag are ignored. |
183 |
|
Instead, you can customize the appearance using style sheet file |
184 |
|
(@file{style.css}). |
185 |
@begin_itemize |
@begin_itemize |
186 |
@item{@code{datadir}(string)} |
@item{@code{datadir}(string)} |
187 |
Shared data directory. The default is '/usr/local/share' but |
Shared data directory. The default is '/usr/local/share' but |