📄 htags.1
字号:
.\" This file is generated automatically by convert.pl from htags/manual.in..TH HTAGS 1 "April 2005" "GNU Project".SH NAMEhtags \- generate hypertext from source code..SH SYNOPSIS\fBhtags\fP [-acDfFgnosvwx][-d \fIdbpath\fP][-m \fIname\fP][-S \fIcgidir\fP][-t \fItitle\fP][\fIhtmldir\fP].br.SH DESCRIPTION\fBHtags\fP makes hypertext of C, C++, Yacc, Java, PHP and Assembly source code..PPIn advance of using this command, you must execute\fBgtags\fP(1) from the root directory of the source tree.Then you can execute \fBhtags\fP from the same place.\fBHtags\fP makes an directory named \'HTML\' and generateshypertext in it.You can start browsing from \'HTML/index.html\'..PPSince \fBhtags\fP generates static hypertext as long asthe \fB-D\fP or \fB-f\fP option is not specified,you can move it anywhere and browse it with any browser withoutweb server..PPYou must use same parser for both \fBgtags\fP(1) and \fBhtags\fP.If you use the default parser, it is not necessary to consider for it..PP.SH OPTIONSThe following options are available:.TP\fB-a\fP, \fB--alphabet\fPMake an alphabetical function index which is suitablefor a large project..TP\fB--caution\fPInclude caution message to prohibit downloading..TP\fB-c\fP, \fB--compact\fPCompress html files by \fBgzip\fP(1).You need to set up a web server so that \fBgzip\fP(1)is invoked for each compressed file.See \'HTML/.htaccess\' that is generated by htags..TP\fB--cvsweb\fP \fIurl\fPInclude cvsweb URL. \fIurl\fP is used as base of URL..TP\fB--cvsweb-cvsroot\fP \fIcvsroot\fPSpecifies cvsroot in cvsweb URL..TP\fB-D\fP, \fB--dynamic\fPGenerate 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..TP\fB-d\fP, \fB--dbpath\fP \fIdbpath\fPSpecifies the directory in which \'GTAGS\' and \'GRTAGS\'exist. The default is the current directory..TP\fB-f\fP, \fB--form\fPSupport search form using CGI program.You need to set up a web server, and you cannot movethe hypertext from the source directroy..TP\fB-F\fP, \fB--frame\fPUse frame for each part of the contents..TP\fB-g\fP, \fB--gtags\fPExecute \fBgtags\fP(1) before creating hypertext.The \fB-v\fP, \fB-w\fP and \fIdbpath\fP are passed to \fBgtags\fP..TP\fB--gtagsconf\fP \fIfile\fPLoad user's configuration from \fIfile\fP..TP\fB--gtagslabel\fP \fIlabel\fP\fIlabel\fP is used for the label of configuration file.The default is default..TP\fB--insert-header\fP \fIfile\fPInsert custom header derived from \fIfile\fP after <body> tag..TP\fB--insert-footer\fP \fIfile\fPInsert custom footer derived from \fIfile\fP before </body> tag..TP\fB-m\fP, \fB--main-func\fP \fIname\fPSpecify the main function name. The default is main..TP\fB-n\fP, \fB--line-number\fPPrint line numbers. By default, doesn't print them..TP\fB--no-map-file\fPDoesn't generate \'MAP\' and \'FILEMAP\' file.By default, \fBhtags\fP generates them..TP\fB-o\fP, \fB--other\fPPick up not only source files but also other files except forbinary files..TP\fB--statistics\fPPrint statistics information..TP\fB--style-sheet\fP \fIfile\fPLoad style sheet file and insert it into <head> tag.If you use the \fB--xhtml\fP option, you should use\'style.css\' instead..TP\fB-s\fP, \fB--symbol\fPMake anchors not only for functions but also other symbols.\'GSYMS\' tag file needed..TP\fB-S\fP, \fB--secure-cgi\fP \fIcgidir\fPWrite CGI programs into the \fIcgidir\fP to realizea centralised CGI program.Script alias is \'/cgi-bin\' by default.You can overwrite this value using config variablescript_alias in \'gtags.conf\'..TP\fB-t\fP, \fB--title\fP \fItitle\fPThe \fItitle\fP of this hypertext. The default is the lastcomponent of the current directory..TP\fB-v\fP, \fB--verbose\fPVerbose mode..TP\fB-w\fP, \fB--warning\fPPrint warning messages..TP\fB-x\fP, \fB--xhtml\fPGenerate XHTML hypertext instead of HTML.If the \fB--frame\fP option is specified thengenerate XHTML-1.0 Frameset for index.htmland generate XHTML-1.0 Transitional for other files,else if config variablexhtml_version is set to 1\.1 then generateXHTML-1.1 else XHTML 1.0 Transitional..TP\fIhtmldir\fPThe directory in which hypertext is generated.The default is the current directory..SH EXAMPLES.nf $ cd /usr/src/sys # gtags -v # htags -fFnvat 'Welcom to FreeBSD kernel source tour!' $ lynx HTML/index.html.PP $ htags -v --gtags $ awk '$1 == "main" {print $2}' HTML/MAP D/348.html $ lynx HTML/D/348.html.PP $ cd global $ htags -gv --cvsweb=http://savannah.gnu.org/cgi-bin/viewcvs/global/global/.PP.fi.SH FILES.TP\'GTAGS\'Tag file for function definitions..TP\'GRTAGS\'Tag file for function references..TP\'GSYMS\'Tag file for other symbols..TP\'GPATH\'Tag file for path of source files..TP\'/etc/gtags.conf\', \'$HOME/.globalrc\'Configuration file..TP\'HTML/index.html\'Index file for hypertext..TP\'HTML/MAP\'Mapping file for converting tag into path of hypertext.External system utilize this file. See EXAMPLES..TP\'HTML/FILEMAP\'Mapping file for converting file name into path of hypertext.External system utilize this file..TP\'HTML/style.css\'Style sheet file. This file is generated when the \fB--xhtml\fPoption is specified..SH ENVIRONMENTThe following environment variables affect the execution of \fBhtags\fP:.TP\fBTMPDIR\fPIf this variable is set, its value is used as the directoryto make temporary files. The default is \'/tmp\'..TP\fBGTAGSCONF\fPIf this variable is set, its value is used as theconfiguration file. The default is \'$HOME/.globalrc\'..TP\fBGTAGSLABEL\fPIf this variable is set, its value is used as the labelof configuration file. The default is default..TP\fBGTAGSCACHE\fPIf this variable is set, its value is used as the size ofbtree cache. The default is 500000 (bytes)..SH CONFIGURATIONThe following configuration variables affect the execution of \fBhtags\fP:If the \fB--xhtml\fP option is specified then all definitions ofHTML tag are ignored.Instead, you can customize the appearance using style sheet file(\'style.css\')..TPdatadir(string)Shared data directory. The default is '/usr/local/share' butyou can change the value using configure script.\fBHtags\fP lookup templete files in the 'gtags' directoryin this data directory..TPhtags_options(string)Default options for \fBhtags\fP. This value is inserted intothe head of arguments..TPxhtml_version(1.0|1.1)XHTML version. 1.0 and 1.1 are acceptable. The default is 1.0..TPbody_begin(string)Begin tag for body. The default is '<body>'..TPbody_end(string)End tag for body. The default is '</body>'..TPtable_begin(string)Begin tag for table. The default is '<table>'..TPtable_end(string)End tag for table. The default is '</table>'..TPtitle_begin(string)Begin tag for Title. The default is '<h1><font color=#cc0000>'..TPtitle_end(string)End tag for Title. The default is '</font></h1>'..TPcomment_begin(string)Begin tag for comments. The default is '<i><font color=green>'..TPcomment_end(string)End tag for comments. The default is '</font></i>'..TPdynamic(bool)Generate object list dynamically..TPsharp_begin(string)Begin tag for 'define'. The default is '<font color=darkred>'..TPsharp_end(string)End tag for 'define'. The default is '</font>'..TPbrace_begin(string)Begin tag for brace. The default is '<font color=blue>'..TPbrace_end(string)End tag for brace. The default is '</font>'..TPreserved_begin(string)Begin tag for reserved word. The default is '<b>'..TPreserved_end(string)End tag for reserved word. The default is '</b>'..TPposition_begin(string)Begin tag for posiotion mark. The default is '<font color=gray>'..TPposition_end(string)End tag for posiotion mark. The default is '</font>'..TPcolorize_warned_line(boolean)Colorize warned line using warned_line_begin and warned_line_end.The default is false..TPwarned_line_begin(string)Begin tag for line which htags warned. The default is '<span style="background-color:yellow">'..TPwarned_line_end(string)End tag for line which htags warned. The default is '</span>'..TPhr(string)Horizontal rules. The default is '<hr>'..TPncol(number)Columns of line number. The default is 4..TPtabs(number)Tab stop. The default is 8..TPfull_path(boolean)List file names with full path in file index.By default, list just the last component of a path..TPtable_list(boolean)List tags using table tag. The default is false..TPnormal_suffix(string)Suffix for normal html file. The default is 'html'..TPno_map_file(boolean)Doesn't generate \'MAP\' file. The default is false..TPgzipped_suffix(string)Suffix for compressed html file. The default is 'ghtml'..TPscript_alias(string)Script alias for safe cgi script (\fB-S\fP)..TPshow_position(boolean)Show position per function definition. The default is false..TPsymbol(boolean)Make anchors not only for functions but also other symbols.\'GSYMS\' tag file needed..TPdefinition_header(no|before|right|after)Position of link header. The default is 'no'..TPother_files(boolean)File index includes not only source files but also other files. The default is false..TPenable_grep(boolean)Enable grep search using CGI program. The default is false.When this function is enabled, you cannot move hypertext from source directory..TPenable_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..TPinclude_file_suffixes(comma separated list)Suffixes of include file. The default is 'h,hxx,hpp,H,inc.php'..TPlangmap(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'..TPcopy_files(boolean)Copy files instead of linking.When the \fB-f\fP option is used, \fBhtags\fP make linksof tag files in \'cgi-bin\' directory by default..SH DIAGNOSTICS\fBHtags\fP exits with a non 0 value if an error occurred, 0 otherwise..SH "MESSAGE FORMAT"Verbose message has important level. The most important level is 0,the second it 1 and so on. All the message has level numbers leadingblanks..SH "SEE ALSO"\fBgtags-parser\fP(1),\fBglobal\fP(1),\fBgtags\fP(1)..PPGNU GLOBAL source code tag system.br(http://www.gnu.org/software/global/)..SH BUGGenerated hypertext is VERY LARGE.In advance, check the space of your disk..PPPHP supprt is far from complete..SH AUTHORTama Communications Corporation..SH HISTORYThe \fBhtags\fP command appeared in FreeBSD 2.2.2.⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -