manual.in (global-6.6.4) | : | manual.in (global-6.6.5) | ||
---|---|---|---|---|
skipping to change at line 31 | skipping to change at line 31 | |||
# o command source file (for usage and help). | # o command source file (for usage and help). | |||
# o man format reference manual. | # o man format reference manual. | |||
# o texinfo format reference manual. | # o texinfo format reference manual. | |||
# | # | |||
@HEADER HTAGS,1,June 2013,GNU Project | @HEADER HTAGS,1,June 2013,GNU Project | |||
@NAME htags - generate a hypertext from a set of source files | @NAME htags - generate a hypertext from a set of source files | |||
@SYNOPSIS | @SYNOPSIS | |||
@name{htags} [-aDfFghInosTvw][-d @arg{dbpath}][-m @arg{name}][-t @arg{tit le}][@arg{dir}] | @name{htags} [-aDfFghInosTvw][-d @arg{dbpath}][-m @arg{name}][-t @arg{tit le}][@arg{dir}] | |||
@DESCRIPTION | @DESCRIPTION | |||
@name{Htags} generates a hypertext from a set of source files of | @name{Htags} generates a hypertext from a set of source files of | |||
C, C++, Yacc, Java, PHP and Assembly. | C, Yacc, Java, PHP and assembly. | |||
In advance of using this command, you should execute @xref{gtags,1} | In advance of using this command, you should execute @xref{gtags,1} | |||
in the root directory of a source project. | in the root directory of a source project. | |||
Then you can execute @name{htags} in the same place. | Then you can execute @name{htags} in the same place. | |||
@name{Htags} makes a directory named @file{HTML}, and puts a hypertext in it. | @name{Htags} makes a directory named @file{HTML}, and puts a hypertext in it. | |||
You can start browsing at @file{HTML/index.html}. | You can start browsing at @file{HTML/index.html}. | |||
Since @name{htags} generates a static hypertext as long as neither @optio n{-D} | Since @name{htags} generates a static hypertext as long as neither @optio n{-D} | |||
nor @option{-f} option is not specified, you can move it anywhere and bro wse it | nor @option{-f} option is not specified, you can move it anywhere and bro wse it | |||
by any browser without any HTTP server. If you use @option{-D} or @option {-f} | by any browser without any HTTP server. If you use @option{-D} or @option {-f} | |||
skipping to change at line 58 | skipping to change at line 58 | |||
@OPTIONS | @OPTIONS | |||
The following options are available: | The following options are available: | |||
@begin_itemize | @begin_itemize | |||
@item{@option{-a}, @option{--alphabet}} | @item{@option{-a}, @option{--alphabet}} | |||
Make an alphabetical index suitable for a large project. | Make an alphabetical index suitable for a large project. | |||
@item{@option{--auto-completion}[=@arg{limit}]} | @item{@option{--auto-completion}[=@arg{limit}]} | |||
Enable auto-completion facility for the input form. | Enable auto-completion facility for the input form. | |||
If @arg{limit} is specified, number of candidates is limited to t he value. | If @arg{limit} is specified, number of candidates is limited to t he value. | |||
Please note this function requires javascript language in your br owser. | Please note this function requires javascript language in your br owser. | |||
@item{@option{-C}, @option{--directory} @arg{dir}} | ||||
Change the directory before doing all the work including paramete | ||||
r analysis. | ||||
@item{@option{--caution}} | @item{@option{--caution}} | |||
Display a caution message on the top page. | Display a caution message on the top page. | |||
@item{@option{--cflow} @arg{cflowfile}} | @item{@option{--cflow} @arg{cflowfile}} | |||
Add a call tree by @xref{cflow,1}. @arg{cflowfile} must be posix format. | Add a call tree by @xref{cflow,1}. @arg{cflowfile} must be posix format. | |||
If you use GNU @name{cflow}, invoke the command at the project ro ot | If you use GNU @name{cflow}, invoke the command at the project ro ot | |||
directory with the @option{--format=posix} option. | directory with the @option{--format=posix} option. | |||
This option is deprecated; please use @option{--call-tree} or | This option is deprecated; please use @option{--call-tree} or | |||
@option{--callee-tree} instead. | @option{--callee-tree} instead. | |||
@item{@option{--call-tree} @arg{callfile}} | @item{@option{--call-tree} @arg{callfile}} | |||
Add a call tree by @xref{cflow,1}; @arg{callfile} must be posix f ormat. | Add a call tree by @xref{cflow,1}; @arg{callfile} must be posix f ormat. | |||
skipping to change at line 116 | skipping to change at line 118 | |||
passed to @name{gtags}. | passed to @name{gtags}. | |||
@item{@option{--gtagsconf} @arg{file}} | @item{@option{--gtagsconf} @arg{file}} | |||
Set environment variable @var{GTAGSCONF} to @arg{file}. | Set environment variable @var{GTAGSCONF} to @arg{file}. | |||
@item{@option{--gtagslabel} @arg{label}} | @item{@option{--gtagslabel} @arg{label}} | |||
Set environment variable @var{GTAGSLABEL} to @arg{label}. | Set environment variable @var{GTAGSLABEL} to @arg{label}. | |||
@item{@option{-h}, @option{--func-header}[=@arg{position}]} | @item{@option{-h}, @option{--func-header}[=@arg{position}]} | |||
Insert a function header for each function. | Insert a function header for each function. | |||
By default, @name{htags} doesn't generate them. | By default, @name{htags} doesn't generate them. | |||
You can choose the position using @arg{position}, | You can choose the position using @arg{position}, | |||
which allows one of @val{before}, @val{right} or @val{after} (def ault). | which allows one of @val{before}, @val{right} or @val{after} (def ault). | |||
@item{@option{--help}} | ||||
Print a usage message. | ||||
@item{@option{--html-header} @arg{file}} | @item{@option{--html-header} @arg{file}} | |||
Insert a header record derived from @arg{file} | Insert a header record derived from @arg{file} | |||
into the HTML header of each file. | into the HTML header of each file. | |||
@item{@option{-I}, @option{--icon}} | @item{@option{-I}, @option{--icon}} | |||
Use icons instead of text for some links. | Use icons instead of text for some links. | |||
@item{@option{--insert-footer} @arg{file}} | @item{@option{--insert-footer} @arg{file}} | |||
Insert custom footer derived from @arg{file} before @code{</body> } tag. | Insert custom footer derived from @arg{file} before @code{</body> } tag. | |||
@item{@option{--insert-header} @arg{file}} | @item{@option{--insert-header} @arg{file}} | |||
Insert custom header derived from @arg{file} after @code{<body>} tag. | Insert custom header derived from @arg{file} after @code{<body>} tag. | |||
@item{@option{--item-order} @arg{spec}} | @item{@option{--item-order} @arg{spec}} | |||
skipping to change at line 181 | skipping to change at line 185 | |||
@item{@option{--table-list}} | @item{@option{--table-list}} | |||
Use @code{<table>} tag to display the tag list. | Use @code{<table>} tag to display the tag list. | |||
@item{@option{--tree-view}[=@arg{type}]} | @item{@option{--tree-view}[=@arg{type}]} | |||
Use treeview for the file index. | Use treeview for the file index. | |||
Please note this function requires javascript language in your br owser. | Please note this function requires javascript language in your br owser. | |||
Possible values of @arg{type} are as follows: @arg{treeview}, @ar g{filetree}, | Possible values of @arg{type} are as follows: @arg{treeview}, @ar g{filetree}, | |||
@arg{treeview-red}, @arg{treeview-black}, @arg{treeview-gray}, | @arg{treeview-red}, @arg{treeview-black}, @arg{treeview-gray}, | |||
@arg{treeview-famfamfam}. The default is @arg{treeview}. | @arg{treeview-famfamfam}. The default is @arg{treeview}. | |||
@item{@option{-v}, @option{--verbose}} | @item{@option{-v}, @option{--verbose}} | |||
Verbose mode. | Verbose mode. | |||
@item{@option{--version}} | ||||
Show version number. | ||||
@item{@option{-w}, @option{--warning}} | @item{@option{-w}, @option{--warning}} | |||
Print warning messages. | Print warning messages. | |||
@item{@arg{dir}} | @item{@arg{dir}} | |||
The directory in which the result of this command is stored. | The directory in which the result of this command is stored. | |||
The default is the current directory. | The default is the current directory. | |||
@end_itemize | @end_itemize | |||
@EXAMPLES | @EXAMPLES | |||
@begin_verbatim | @begin_verbatim | |||
$ gtags -v | $ gtags -v | |||
$ htags -sanohITvt 'Welcome to XXX source tour!' | $ htags -sanohITvt 'Welcome to XXX source tour!' | |||
End of changes. 4 change blocks. | ||||
1 lines changed or deleted | 8 lines changed or added |