htags --version (return code: 0)
htags (GNU GLOBAL) 6.5.7
Copyright (c) 1996-2017 Tama Communications Corporation
License GPLv3+: GNU GPL version 3 or later <http://www.gnu.org/licenses/gpl.html>
This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
htags --help (return code: 0)
Usage: htags [-aDfFghInosTvw][-d dbpath][-m name][-t title][dir]
Options:
-a, --alphabet
Make an alphabetical index suitable for a large project.
--auto-completion[=limit]
Enable auto-completion facility for the input form.
If limit is specified, number of candidates is limited to the value.
Please note this function requires javascript language in your browser.
--caution
Display a caution message on the top page.
--cflow cflowfile
Add a call tree by cflow(1). cflowfile must be posix format.
If you use GNU cflow, invoke the command at the project root
directory with the --format=posix option.
This option is deprecated; please use --call-tree or
--callee-tree instead.
--call-tree callfile
Add a call tree by cflow(1); callfile must be posix format.
If you use GNU cflow, invoke the command at the project root
directory with the --format=posix option.
--callee-tree calleefile
Add a callee tree by cflow(1); calleefile must be posix format.
If you use GNU cflow, invoke the command at the project root
directory with the --format=posix and --reverse options.
--colorize-warned-line
Use color to highlight warned lines.
--cvsweb url
Add a link to cvsweb; url is used as the base of URL.
When directory CVS exists in the root directory of the project,
the content of CVS/Repository is used as the relative path from the base.
--cvsweb-cvsroot cvsroot
Specify cvsroot in cvsweb URL.
-D, --dynamic
Generate a tag list dynamically using CGI program.
Though this option decreases both the size and generation time of
hypertext, you need to start up HTTP server.
-d, --dbpath dbpath
Specify the directory in which GTAGS exists.
The default is the current directory.
--disable-grep
Disable grep in the search form (-f, --form).
--disable-idutils
Disable idutils in the search form (-f, --form).
-F, --frame
Use frames for the top page.
-f, --form
Add a search form using CGI program.
You need to start a HTTP server for it.
--fixed-guide
Put a fixed guide at the bottom of the screen of the browser.
--full-path
Use full path name in the file index.
By default, use just the last component of a path.
-g, --gtags
Execute gtags(1) before starting job.
The -v, -w and dbpath options are
passed to gtags.
--gtagsconf file
Set environment variable GTAGSCONF to file.
--gtagslabel label
Set environment variable GTAGSLABEL to label.
-h, --func-header[=position]
Insert a function header for each function.
By default, htags doesn't generate them.
You can choose the position using position,
which allows one of before, right or after (default).
--html-header file
Insert a header record derived from file
into the HTML header of each file.
-I, --icon
Use icons instead of text for some links.
--insert-footer file
Insert custom footer derived from file before </body> tag.
--insert-header file
Insert custom header derived from file after <body> tag.
--item-order spec
Specify the order of the items in the top page.
The spec is a string consisting of item signs in order.
Each sign means as follows:
c: caution; s: search form;
m: mains; d: definitions; f: files; t: call tree.
The default is csmdf.
-m, --main-func name
Specify startup function name; the default is main.
--map-file
Generate file MAP.
-n, --line-number[=columns]
Print line numbers. By default, don't print line numbers.
The default value of columns is 4.
--no-order-list
Numbers are not given in list form.
-o, --other
Pick up not only source files but also other files for the file index.
-s, --symbol
Make anchors not only for definitions and references
but also other symbols.
--show-position
Print the position string per function definition. The string can be
interpreted by general editors in UNIX. The default is false.
--statistics
Print statistics information.
--suggest
Htags chooses popular options on behalf of beginners.
It is equivalent to
-aghInosTxv --show-position --fixed-guide
now.
--suggest2
Htags chooses popular options on behalf of beginners.
This option enables frame, AJAX and CGI facility in addition
to the facilities by the --suggest option.
It is equivalent to
--suggest -DfF --auto-completion --tree-view=filetree
now.
-T, --table-flist[=rows]
Use <table> tag to display the file index.
You can optionally specify the number of rows; the default is 5.
-t, --title title
Title of the hypertext.
The default is the last component of the path of the current directory.
--tabs cols
Tab stops. The default is 8.
--table-list
Use <table> tag to display the tag list.
--tree-view[=type]
Use treeview for the file index.
Please note this function requires javascript language in your browser.
Possible values of type are as follows: treeview, filetree,
treeview-red, treeview-black, treeview-gray,
treeview-famfamfam. The default is treeview.
-v, --verbose
Verbose mode.
-w, --warning
Print warning messages.
dir
The directory in which the result of this command is stored.
The default is the current directory.
See also:
GNU GLOBAL web site: http://www.gnu.org/software/global/