.\" This file is generated automatically by convert.pl from htags/manual.in. .TH HTAGS 1 "June 2013" "GNU Project" .SH NAME htags \- generate a hypertext from a set of source files .SH SYNOPSIS \fBhtags\fP [-aDfFghInosTvw][-d \fIdbpath\fP][-m \fIname\fP][-t \fItitle\fP][\fIdir\fP] .br .SH DESCRIPTION \fBHtags\fP generates a hypertext from a set of source files of C, C++, Yacc, Java, PHP and Assembly. .PP In advance of using this command, you should execute \fBgtags\fP(1) in the root directory of a source project. Then you can execute \fBhtags\fP in the same place. \fBHtags\fP makes a directory named \'HTML\', and puts a hypertext in it. You can start browsing at \'HTML/index.html\'. .PP Since \fBhtags\fP generates a static hypertext as long as neither \fB-D\fP nor \fB-f\fP option is not specified, you can move it anywhere and browse it by any browser without any HTTP server. If you use \fB-D\fP or \fB-f\fP option, you need to use HTTP server. Though any HTTP server is available, \fBhtags-server\fP(1) is recommended. .PP This command has so many options. If you are new to \fBhtags\fP, it is recommended to use \fB--suggest\fP option. With that option, \fBhtags\fP chooses popular options on your behalf. .SH OPTIONS The following options are available: .PP .TP \fB-a\fP, \fB--alphabet\fP Make an alphabetical index suitable for a large project. .TP \fB--auto-completion\fP[=\fIlimit\fP] Enable auto-completion facility for the input form. If \fIlimit\fP is specified, number of candidates is limited to the value. Please note this function requires javascript language in your browser. .TP \fB--caution\fP Display a caution message on the top page. .TP \fB--cflow\fP \fIcflowfile\fP Add a call tree by \fBcflow\fP(1). \fIcflowfile\fP must be posix format. If you use GNU \fBcflow\fP, invoke the command at the project root directory with the \fB--format=posix\fP option. This option is deprecated; please use \fB--call-tree\fP or \fB--callee-tree\fP instead. .TP \fB--call-tree\fP \fIcallfile\fP Add a call tree by \fBcflow\fP(1); \fIcallfile\fP must be posix format. If you use GNU \fBcflow\fP, invoke the command at the project root directory with the \fB--format=posix\fP option. .TP \fB--callee-tree\fP \fIcalleefile\fP Add a callee tree by \fBcflow\fP(1); \fIcalleefile\fP must be posix format. If you use GNU \fBcflow\fP, invoke the command at the project root directory with the \fB--format=posix\fP and \fB--reverse\fP options. .TP \fB--colorize-warned-line\fP Use color to highlight warned lines. .TP \fB--cvsweb\fP \fIurl\fP Add a link to cvsweb; \fIurl\fP 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. .TP \fB--cvsweb-cvsroot\fP \fIcvsroot\fP Specify cvsroot in cvsweb URL. .TP \fB-D\fP, \fB--dynamic\fP 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. .TP \fB-d\fP, \fB--dbpath\fP \fIdbpath\fP Specify the directory in which \'GTAGS\' exists. The default is the current directory. .TP \fB--disable-grep\fP Disable \fBgrep\fP in the search form (\fB-f\fP, \fB--form\fP). .TP \fB--disable-idutils\fP Disable \fBidutils\fP in the search form (\fB-f\fP, \fB--form\fP). .TP \fB-F\fP, \fB--frame\fP Use frames for the top page. .TP \fB-f\fP, \fB--form\fP Add a search form using CGI program. You need to start a HTTP server for it. .TP \fB--fixed-guide\fP Put a fixed guide at the bottom of the screen of the browser. .TP \fB--full-path\fP Use full path name in the file index. By default, use just the last component of a path. .TP \fB-g\fP, \fB--gtags\fP Execute \fBgtags\fP(1) before starting job. The \fB-v\fP, \fB-w\fP and \fIdbpath\fP options are passed to \fBgtags\fP. .TP \fB--gtagsconf\fP \fIfile\fP Set environment variable \fBGTAGSCONF\fP to \fIfile\fP. .TP \fB--gtagslabel\fP \fIlabel\fP Set environment variable \fBGTAGSLABEL\fP to \fIlabel\fP. .TP \fB-h\fP, \fB--func-header\fP[=\fIposition\fP] Insert a function header for each function. By default, \fBhtags\fP doesn't generate them. You can choose the position using \fIposition\fP, which allows one of \'before\', \'right\' or \'after\' (default). .TP \fB--html-header\fP \fIfile\fP Insert a header record derived from \fIfile\fP into the HTML header of each file. .TP \fB-I\fP, \fB--icon\fP Use icons instead of text for some links. .TP \fB--insert-footer\fP \fIfile\fP Insert custom footer derived from \fIfile\fP before
tag. .TP \fB--item-order\fP \fIspec\fP Specify the order of the items in the top page. The \fIspec\fP 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\'. .TP \fB-m\fP, \fB--main-func\fP \fIname\fP Specify startup function name; the default is \'main\'. .TP \fB--map-file\fP Generate file \'MAP\'. .TP \fB-n\fP, \fB--line-number\fP[=\fIcolumns\fP] Print line numbers. By default, don't print line numbers. The default value of \fIcolumns\fP is 4. .TP \fB--no-order-list\fP Numbers are not given in list form. .TP \fB-o\fP, \fB--other\fP Pick up not only source files but also other files for the file index. .TP \fB-s\fP, \fB--symbol\fP Make anchors not only for definitions and references but also other symbols. .TP \fB--show-position\fP Print the position string per function definition. The string can be interpreted by general editors in UNIX. The default is false. .TP \fB--statistics\fP Print statistics information. .TP \fB--suggest\fP \fBHtags\fP chooses popular options on behalf of beginners. It is equivalent to \fB-aghInosTxv --show-position --fixed-guide\fP now. .TP \fB--suggest2\fP \fBHtags\fP chooses popular options on behalf of beginners. This option enables frame, AJAX and CGI facility in addition to the facilities by the \fB--suggest\fP option. It is equivalent to \fB--suggest -DfF --auto-completion --tree-view=filetree\fP now. .TP \fB-T\fP, \fB--table-flist\fP[=\fIrows\fP] Use