is a source code tag system that works the same way across diverse environments. It is similar to ctags or etags, but it is independent of any editor.
| htags.ref (global-6.6.4) | : | htags.ref (global-6.6.5) |
|---|
| @c This file is generated automatically by convert.pl from htags/manual.in. | | @c This file is generated automatically by convert.pl from htags/manual.in. |
| @unnumberedsubsec NAME | | @unnumberedsubsec NAME |
| htags - generate a hypertext from a set of source files | | htags - generate a hypertext from a set of source files |
| @unnumberedsubsec SYNOPSIS | | @unnumberedsubsec SYNOPSIS |
| @quotation | | @quotation |
| htags [-aDfFghInosTvw][-d dbpath][-m name][-t title][dir]@* | | htags [-aDfFghInosTvw][-d dbpath][-m name][-t title][dir]@* |
| @end quotation | | @end quotation |
| @unnumberedsubsec DESCRIPTION | | @unnumberedsubsec DESCRIPTION |
| Htags generates a hypertext from a set of source files of | | 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 gtags(1) | | In advance of using this command, you should execute gtags(1) |
| in the root directory of a source project. | | in the root directory of a source project. |
| Then you can execute htags in the same place. | | Then you can execute htags in the same place. |
| Htags makes a directory named @file{HTML}, and puts a hypertext in it. | | 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 htags generates a static hypertext as long as neither @samp{-D} | | Since htags generates a static hypertext as long as neither @samp{-D} |
| nor @samp{-f} option is not specified, you can move it anywhere and browse it | | nor @samp{-f} option is not specified, you can move it anywhere and browse it |
| by any browser without any HTTP server. If you use @samp{-D} or @samp{-f} | | by any browser without any HTTP server. If you use @samp{-D} or @samp{-f} |
| | |
| skipping to change at line 37 | | skipping to change at line 37 |
|---|
| @unnumberedsubsec OPTIONS | | @unnumberedsubsec OPTIONS |
| The following options are available: | | The following options are available: |
| | |
| @table @asis | | @table @asis |
| @item @samp{-a}, @samp{--alphabet} | | @item @samp{-a}, @samp{--alphabet} |
| Make an alphabetical index suitable for a large project. | | Make an alphabetical index suitable for a large project. |
| @item @samp{--auto-completion}[=limit] | | @item @samp{--auto-completion}[=limit] |
| Enable auto-completion facility for the input form. | | Enable auto-completion facility for the input form. |
| If limit is specified, number of candidates is limited to the value. | | If limit is specified, number of candidates is limited to the value. |
| Please note this function requires javascript language in your browser. | | Please note this function requires javascript language in your browser. |
|
| | @item @samp{-C}, @samp{--directory} dir |
| | Change the directory before doing all the work including parameter analysis. |
| @item @samp{--caution} | | @item @samp{--caution} |
| Display a caution message on the top page. | | Display a caution message on the top page. |
| @item @samp{--cflow} cflowfile | | @item @samp{--cflow} cflowfile |
| Add a call tree by cflow(1). cflowfile must be posix format. | | Add a call tree by cflow(1). cflowfile must be posix format. |
| If you use GNU cflow, invoke the command at the project root | | If you use GNU cflow, invoke the command at the project root |
| directory with the @samp{--format=posix} option. | | directory with the @samp{--format=posix} option. |
| This option is deprecated; please use @samp{--call-tree} or | | This option is deprecated; please use @samp{--call-tree} or |
| @samp{--callee-tree} instead. | | @samp{--callee-tree} instead. |
| @item @samp{--call-tree} callfile | | @item @samp{--call-tree} callfile |
| Add a call tree by cflow(1); callfile must be posix format. | | Add a call tree by cflow(1); callfile must be posix format. |
| | |
| skipping to change at line 95 | | skipping to change at line 97 |
|---|
| passed to gtags. | | passed to gtags. |
| @item @samp{--gtagsconf} file | | @item @samp{--gtagsconf} file |
| Set environment variable @var{GTAGSCONF} to file. | | Set environment variable @var{GTAGSCONF} to file. |
| @item @samp{--gtagslabel} label | | @item @samp{--gtagslabel} label |
| Set environment variable @var{GTAGSLABEL} to label. | | Set environment variable @var{GTAGSLABEL} to label. |
| @item @samp{-h}, @samp{--func-header}[=position] | | @item @samp{-h}, @samp{--func-header}[=position] |
| Insert a function header for each function. | | Insert a function header for each function. |
| By default, htags doesn't generate them. | | By default, htags doesn't generate them. |
| You can choose the position using position, | | You can choose the position using position, |
| which allows one of @samp{before}, @samp{right} or @samp{after} (default). | | which allows one of @samp{before}, @samp{right} or @samp{after} (default). |
|
| | @item @samp{--help} |
| | Print a usage message. |
| @item @samp{--html-header} file | | @item @samp{--html-header} file |
| Insert a header record derived from file | | Insert a header record derived from file |
| into the HTML header of each file. | | into the HTML header of each file. |
| @item @samp{-I}, @samp{--icon} | | @item @samp{-I}, @samp{--icon} |
| Use icons instead of text for some links. | | Use icons instead of text for some links. |
| @item @samp{--insert-footer} file | | @item @samp{--insert-footer} file |
| Insert custom footer derived from file before @code{</body>} tag. | | Insert custom footer derived from file before @code{</body>} tag. |
| @item @samp{--insert-header} file | | @item @samp{--insert-header} file |
| Insert custom header derived from file after @code{<body>} tag. | | Insert custom header derived from file after @code{<body>} tag. |
| @item @samp{--item-order} spec | | @item @samp{--item-order} spec |
| | |
| skipping to change at line 160 | | skipping to change at line 164 |
|---|
| @item @samp{--table-list} | | @item @samp{--table-list} |
| Use @code{<table>} tag to display the tag list. | | Use @code{<table>} tag to display the tag list. |
| @item @samp{--tree-view}[=type] | | @item @samp{--tree-view}[=type] |
| Use treeview for the file index. | | Use treeview for the file index. |
| Please note this function requires javascript language in your browser. | | Please note this function requires javascript language in your browser. |
| Possible values of type are as follows: treeview, filetree, | | Possible values of type are as follows: treeview, filetree, |
| treeview-red, treeview-black, treeview-gray, | | treeview-red, treeview-black, treeview-gray, |
| treeview-famfamfam. The default is treeview. | | treeview-famfamfam. The default is treeview. |
| @item @samp{-v}, @samp{--verbose} | | @item @samp{-v}, @samp{--verbose} |
| Verbose mode. | | Verbose mode. |
|
| | @item @samp{--version} |
| | Show version number. |
| @item @samp{-w}, @samp{--warning} | | @item @samp{-w}, @samp{--warning} |
| Print warning messages. | | Print warning messages. |
| @item dir | | @item 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 table | | @end table |
| @unnumberedsubsec EXAMPLES | | @unnumberedsubsec EXAMPLES |
| @example | | @example |
| $ 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 | | 7 lines changed or added |
|---|
"Fossies" - the Fresh Open Source Software Archive 