📄 htags.ref
字号:
@c This file is generated automatically by convert.pl from htags/manual.in.@unnumberedsubsec NAMEhtags - generate hypertext from source code.@unnumberedsubsec SYNOPSIS@noindent@quotationhtags [-acDfFgnosvwx][-d dbpath][-m name][-S cgidir][-t title][htmldir]@*@end quotation@unnumberedsubsec DESCRIPTIONHtags makes hypertext of C, C++, Yacc, Java, PHP and Assembly source code.In advance of using this command, you must executegtags(1) from the root directory of the source tree.Then you can execute htags from the same place.Htags makes an directory named @file{HTML} and generateshypertext in it.You can start browsing from @file{HTML/index.html}.Since htags generates static hypertext as long asthe @samp{-D} or @samp{-f} option is not specified,you can move it anywhere and browse it with any browser withoutweb server.You must use same parser for both gtags(1) and htags.If you use the default parser, it is not necessary to consider for it.@unnumberedsubsec OPTIONSThe following options are available:@table @asis@item @samp{-a}, @samp{--alphabet}Make an alphabetical function index which is suitablefor a large project.@item @samp{--caution}Include caution message to prohibit downloading.@item @samp{-c}, @samp{--compact}Compress html files by gzip(1).You need to set up a web server so that gzip(1)is invoked for each compressed file.See @file{HTML/.htaccess} that is generated by htags.@item @samp{--cvsweb} urlInclude cvsweb URL. url is used as base of URL.@item @samp{--cvsweb-cvsroot} cvsrootSpecifies cvsroot in cvsweb URL.@item @samp{-D}, @samp{--dynamic}Generate object lists dynamically using CGI program.By default, object lists are generated statically.Though this option decrease both the size and the generationtime of the hypertext, you need to set up a web server, and you cannot move the hypertext from the source directroy.@item @samp{-d}, @samp{--dbpath} dbpathSpecifies the directory in which @file{GTAGS} and @file{GRTAGS}exist. The default is the current directory.@item @samp{-f}, @samp{--form}Support search form using CGI program.You need to set up a web server, and you cannot movethe hypertext from the source directroy.@item @samp{-F}, @samp{--frame}Use frame for each part of the contents.@item @samp{-g}, @samp{--gtags}Execute gtags(1) before creating hypertext.The @samp{-v}, @samp{-w} and dbpath are passed to gtags.@item @samp{--gtagsconf} fileLoad user's configuration from file.@item @samp{--gtagslabel} labellabel is used for the label of configuration file.The default is @code{default}.@item @samp{--insert-header} fileInsert custom header derived from file after <body> tag.@item @samp{--insert-footer} fileInsert custom footer derived from file before </body> tag.@item @samp{-m}, @samp{--main-func} nameSpecify the main function name. The default is @code{main}.@item @samp{-n}, @samp{--line-number}Print line numbers. By default, doesn't print them.@item @samp{--no-map-file}Doesn't generate @file{MAP} and @file{FILEMAP} file.By default, htags generates them.@item @samp{-o}, @samp{--other}Pick up not only source files but also other files except forbinary files.@item @samp{--statistics}Print statistics information.@item @samp{--style-sheet} fileLoad style sheet file and insert it into <head> tag.If you use the @samp{--xhtml} option, you should use@file{style.css} instead.@item @samp{-s}, @samp{--symbol}Make anchors not only for functions but also other symbols.@file{GSYMS} tag file needed.@item @samp{-S}, @samp{--secure-cgi} cgidirWrite CGI programs into the cgidir to realizea centralised CGI program.Script alias is @file{/cgi-bin} by default.You can overwrite this value using config variable@code{script_alias} in @file{gtags.conf}.@item @samp{-t}, @samp{--title} titleThe title of this hypertext. The default is the lastcomponent of the current directory.@item @samp{-v}, @samp{--verbose}Verbose mode.@item @samp{-w}, @samp{--warning}Print warning messages.@item @samp{-x}, @samp{--xhtml}Generate XHTML hypertext instead of HTML.If the @samp{--frame} option is specified thengenerate XHTML-1.0 Frameset for index.htmland generate XHTML-1.0 Transitional for other files,else if config variable@code{xhtml_version} is set to @code{1.1} then generateXHTML-1.1 else XHTML 1.0 Transitional.@item htmldirThe directory in which hypertext is generated.The default is the current directory.@end table@unnumberedsubsec EXAMPLES@example $ cd /usr/src/sys # gtags -v # htags -fFnvat 'Welcom to FreeBSD kernel source tour!' $ lynx HTML/index.html $ htags -v --gtags $ awk '$1 == "main" @{print $2@}' HTML/MAP D/348.html $ lynx HTML/D/348.html $ cd global $ htags -gv --cvsweb=http://savannah.gnu.org/cgi-bin/viewcvs/global/global/@end example@unnumberedsubsec FILES@table @asis@item @file{GTAGS}Tag file for function definitions.@item @file{GRTAGS}Tag file for function references.@item @file{GSYMS}Tag file for other symbols.@item @file{GPATH}Tag file for path of source files.@item @file{/etc/gtags.conf}, @file{$HOME/.globalrc}Configuration file.@item @file{HTML/index.html}Index file for hypertext.@item @file{HTML/MAP}Mapping file for converting tag into path of hypertext.External system utilize this file. See EXAMPLES.@item @file{HTML/FILEMAP}Mapping file for converting file name into path of hypertext.External system utilize this file.@item @file{HTML/style.css}Style sheet file. This file is generated when the @samp{--xhtml}option is specified.@end table@unnumberedsubsec ENVIRONMENTThe following environment variables affect the execution of htags:@table @asis@item @var{TMPDIR}If this variable is set, its value is used as the directoryto make temporary files. The default is @file{/tmp}.@item @var{GTAGSCONF}If this variable is set, its value is used as theconfiguration file. The default is @file{$HOME/.globalrc}.@item @var{GTAGSLABEL}If this variable is set, its value is used as the labelof configuration file. The default is @code{default}.@item @var{GTAGSCACHE}If this variable is set, its value is used as the size ofbtree cache. The default is 500000 (bytes).@end table@unnumberedsubsec CONFIGURATIONThe following configuration variables affect the execution of htags:If the @samp{--xhtml} option is specified then all definitions ofHTML tag are ignored.Instead, you can customize the appearance using style sheet file(@file{style.css}).@table @asis@item @code{datadir}(string)Shared data directory. The default is '/usr/local/share' butyou can change the value using configure script.Htags lookup templete files in the 'gtags' directoryin this data directory.@item @code{htags_options}(string)Default options for htags. This value is inserted intothe head of arguments.@item @code{xhtml_version}(1.0|1.1)XHTML version. 1.0 and 1.1 are acceptable. The default is 1.0.@item @code{body_begin}(string)Begin tag for body. The default is '<body>'.@item @code{body_end}(string)End tag for body. The default is '</body>'.@item @code{table_begin}(string)Begin tag for table. The default is '<table>'.@item @code{table_end}(string)End tag for table. The default is '</table>'.@item @code{title_begin}(string)Begin tag for Title. The default is '<h1><font color=#cc0000>'.@item @code{title_end}(string)End tag for Title. The default is '</font></h1>'.@item @code{comment_begin}(string)Begin tag for comments. The default is '<i><font color=green>'.@item @code{comment_end}(string)End tag for comments. The default is '</font></i>'.@item @code{dynamic}(bool)Generate object list dynamically.@item @code{sharp_begin}(string)Begin tag for 'define'. The default is '<font color=darkred>'.@item @code{sharp_end}(string)End tag for 'define'. The default is '</font>'.@item @code{brace_begin}(string)Begin tag for brace. The default is '<font color=blue>'.@item @code{brace_end}(string)End tag for brace. The default is '</font>'.@item @code{reserved_begin}(string)Begin tag for reserved word. The default is '<b>'.@item @code{reserved_end}(string)End tag for reserved word. The default is '</b>'.@item @code{position_begin}(string)Begin tag for posiotion mark. The default is '<font color=gray>'.@item @code{position_end}(string)End tag for posiotion mark. The default is '</font>'.@item @code{colorize_warned_line}(boolean)Colorize warned line using @code{warned_line_begin} and @code{warned_line_end}.The default is false.@item @code{warned_line_begin}(string)Begin tag for line which htags warned. The default is '<span style="background-color:yellow">'.@item @code{warned_line_end}(string)End tag for line which htags warned. The default is '</span>'.@item @code{hr}(string)Horizontal rules. The default is '<hr>'.@item @code{ncol}(number)Columns of line number. The default is 4.@item @code{tabs}(number)Tab stop. The default is 8.@item @code{full_path}(boolean)List file names with full path in file index.By default, list just the last component of a path.@item @code{table_list}(boolean)List tags using table tag. The default is false.@item @code{normal_suffix}(string)Suffix for normal html file. The default is 'html'.@item @code{no_map_file}(boolean)Doesn't generate @file{MAP} file. The default is false.@item @code{gzipped_suffix}(string)Suffix for compressed html file. The default is 'ghtml'.@item @code{script_alias}(string)Script alias for safe cgi script (@samp{-S}).@item @code{show_position}(boolean)Show position per function definition. The default is false.@item @code{symbol}(boolean)Make anchors not only for functions but also other symbols.@file{GSYMS} tag file needed.@item @code{definition_header}(no|before|right|after)Position of link header. The default is 'no'.@item @code{other_files}(boolean)File index includes not only source files but also other files. The default is false.@item @code{enable_grep}(boolean)Enable grep search using CGI program. The default is false.When this function is enabled, you cannot move hypertext from source directory.@item @code{enable_idutils}(boolean)Enable id-utils search using CGI program. The default is false.When this function is enabled, you cannot move hypertext from source directory.@item @code{include_file_suffixes}(comma separated list)Suffixes of include file. The default is 'h,hxx,hpp,H,inc.php'.@item @code{langmap}(comma separated list)Language mapping. Each comma-separated map consists ofthe language name, a colon, and a list of file extensions.Default mapping is 'c:.c.h,yacc:.y,asm:.s.S,java:.java,cpp:.c++.cc.cpp.cxx.hxx.hpp.C.H,php:.php.php3.phtml'.@item @code{copy_files}(boolean)Copy files instead of linking.When the @samp{-f} option is used, htags make linksof tag files in @file{cgi-bin} directory by default.@end table@unnumberedsubsec DIAGNOSTICSHtags exits with a non 0 value if an error occurred, 0 otherwise.@unnumberedsubsec MESSAGE FORMATVerbose message has important level. The most important level is 0,the second it 1 and so on. All the message has level numbers leadingblanks.@unnumberedsubsec SEE ALSOgtags-parser(1),global(1),gtags(1).GNU GLOBAL source code tag system@*(http://www.gnu.org/software/global/).@unnumberedsubsec BUGGenerated hypertext is VERY LARGE.In advance, check the space of your disk.PHP supprt is far from complete.@unnumberedsubsec AUTHORTama Communications Corporation.@unnumberedsubsec HISTORYThe htags command appeared in FreeBSD 2.2.2.⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -