📄 xref.txt
字号:
used when enclosed in ${ }. For example ${PATH} string will be replaced by the value of PATH environment vari- able. Another usage of -set option is to define project depend- ing values used by Emacs macros. Emacs can retrieve value of an environmnet variable by sending ’-get <name>’ re- quest to xref task. Emacs is currently using following variables to get project depending settings: "compile- file", "compiledir", "compileproject", "run1", "run2", ... , "run5", "runthis" and "run". Those variables are used by ’Emacs IDE’ macros to retrieve commands for com- pilation and running of project program. For example an option: -set run "echo will run now ${nl}a.out" will de- fine run command to print ’will run now’ message and then execute a.out command. When a command string is enclosed in quotas it can contain newline characters to separate sequence of commands. For more info about compile and run commands see on-line Emacs help of the corresponding Xrefactory macros. -brief The output of cross referencing will be in compact form, still readable by xref but rather difficult for human reader. This option is default now. -nobrief The output of cross referencing will contain "comment" records for human readers. -no_enum Don’t cross reference enumerators. -no_mac Don’t cross reference macros. -no_type Don’t cross-reference user defined types. -no_str Don’t cross reference structure records. -no_local Don’t cross reference function arguments and local vari- ables. -no_cfrefs Don’t get cross references from class files. This can de- crease the size of your Tag file. However, because infor- mations about class hierarchy are taken mainly from class files this option may causes that showed class hierar- chies will be incomplete. -html Causes xref to not produce the cross reference file. In- stead it reads a previously generated cross reference file, then it proceeds input files creating browsable files in the HTML format. -htmlroot=dir Write output HTML files into directory hierarchy starting by the dir. This option is meaningful only with combina- tion with -html option. -d dir Equivalent to -htmlroot=dir. -htmltab=number When generating HTML files, set the tabulator to number. -htmllinenums When converting source files into HTML format generate line numbers before source code. -htmlnocolors When converting source files into HTML format do not gen- erate color highlighting of keywords, commentaries and preprocessor directives. -htmlgxlist When converting source files into HTML format generate lists of all usages for each global symbol. -htmllxlist When converting source files into HTML format generate lists of all usages for each local symbol. -htmldirectx When converting source files into HTML format, link the first character of a symbol directly to its cross refer- ences. -htmlfunseparate Causes that HTML files will contain horizontal bar sepa- rating function definitions. -htmlcutpath=<path> This option causes that the output files from the path directory are not stored with full path name under -html- root directory. Rather the path is cut from the full file name. Xref accepts several ’-htmlcutpath’ options. On MS-DOS (QNX) system, the path should be an absolute path but without drive (node) specification. -htmlcutcwd equals ’-htmlcutpath=${CWD}’ cutting current working di- rectory path from html paths. -htmlcutsourcepaths cut also all Java source paths defined by SOURCEPATH en- vironment variable or by -sourcepath option. -htmlcutsuffix Cut language suffix from generated html file names. With this option xref will generate files Class.html instead of Class.java.html (or file.html instead of file.c.html for C language). -htmllinenumlabel=<label> Set the label generated before line number in html docu- ments. For example -htmllinenumlabel=line will generate line<n> labels compatible with links generated by javadoc version 1.4. -htmllinkcolor=<color> This option specifies the color in which links of the HTML document will appear. For example ’-htmllinkcol- or=black’ or ’-htmllinkcolor=#000000’ causes that links will be black. -htmllinenumcolor=<color> This option specifies the color of line numbers for gen- erated HTML. For example ’-htmllinenumcolor=black’ or ’-htmllinenumcolor=#000000’ causes that line numbers will always be black. This option is meaningful only in combi- nation with -htmllinenums option. -htmlnounderline This option causes that links in the HTML document will not be underlined (if your browser support styles). -htmlgenjavadoclinks When generating html generate links to Javadoc documenta- tion for symbols without definition reference. -encoding=<type> This option specifies international encoding of input files. Available values for <type> are ’default’, ’euro- pean’, ’euc’, ’sjis’, ’utf’, ’utf-8’, ’utf-16’, ’utf-16le’ and ’utf-16be’. The ’default’ value results in standard ASCII (and ’utf-8’) characters. If your files contain, for example, 8-bit european characters, then you should include -encoding=european into your project set- ting. -javadocurl=<url> -htmljavadocpath=<url> Specifies URL where existing non-local Javadoc documenta- tion is stored. Both options are equivalent, the -html- javadocpath is obsolete. The default is "-javadocurl=http://java.sun.com/j2se/1.3/docs/api". It is supposed to contain Javadoc documentation of packages for which you do not have source code nor local Javadoc documentation, but the documentation is available on the Internet. See also -javadocpath, -javadocavailable and -htmlgenjavadoclink options. -javadocavailable=<packs> -htmljavadocavailable=<packs> Both options are equivalent, the -htmljavadocavailable is obsolete. The option specifies packages having Javadoc documentation placed on the URL specified by the -javadocurl option. The <packs> string is a list of packages separated by ’:’ sign. For example correct set- ting for standard jdk is: "-javadocavailable=java.ap- plet:java.awt:java.beans:java.io:java.lang:java.math:ja- va.net:java.rmi:java.security:java.sql:java.text:ja- va.util:javax.accessibility:javax.swing:org.omg.COR- BA:org.omg.CosNaming". See also -javadocpath, -javadocurl and -htmlgenjavadoclink options. -htmlzip=<command> This option causes that the command command is called af- ter having created any HTML file. The character ’!’ in- cluded in the command has special meaning and is replaced by the name of the last generated HTML file. For example "-htmlzip=gzip -f !" option causes that all generated HTML files will be zipped. See also ’-htmllinksuffix’ op- tion. -htmllinksuffix=<suf> This option causes that whenever a hypertext link to a file xxx should be generated then in reality a link to the file xxx.suf is generated. This option is meaningful mainly with the ’-htmlzip’ option. For example the combi- nation "-htmlzip=gzip -f !" -htmllinksuffix=.gz causes that all generated HTML files will be compressed and the links are correctly generated to those compressed files. -include file (or -stdop file) This option causes that the file ‘file’ is read and scanned for further options. When used in an .xrefrc file this options includes options defined in file. However, if the included file is modified while xref task is run- ning then xref is unable to automatically reload new op- tions. If you use -include (-stdop) option, and you mod- ify included file, you will need to kill and restart xref server task in order that changes take effect. -no_stdop This option forbids the search of standard option files ’.xrefrc’ and ’Xref.opt’. -mf<n> This option sets the memory factor for cross-references. The larger is the memory factor, the larger is the memory reserved to store cross-references and so xref does not need to swap references on disk so frequently. The de- fault value of n is 1. For example the ’-mf10’ option causes that the memory used for cross-references will be increased by the factor of 10. This option can be used only as command line option. If you use it inside the ~/.xrefrc file it has no effect. -pass<n> Strictly speaking this is not xref option. It is used in the .xrefrc configuration file to describe how to process source files in multiple passes. Multiple passes are necessary if you need to process your C sources for sev- eral initial macro settings. For more informations about this option read the ’xrefrc’ manual page. -keep_old This option is obsolete. It is kept for compatibility reasons only. It is recommended to use multiple passes options of the ’.xrefrc’ file instead. The ’-keep_old’ option causes that the output of cross-referencing is added to existing references from the file specified by the -refs option. All old references of the reference file are kept. -no_cpp_comment When scanning input files, do not consider the string ‘//’ as beginning of a comment ended by end of line. -csuffixes=<suffixes> This option defines list of suffixes (separated by ’:’ character under Unix and ’;’ under MS-Windows) for C source files. Files with those suffixes will be inserted into Tag file and parsed with Xrefactory’s C parser. Suf- fixes should not start by the ’.’ dot character which is considered as suffix separator automatically. For example suffixes "c:tc" mean that files ending by ".c" or ".tc" strings are considered as C input files. -javasuffixes=<suffixes> This option defines list of suffixes (separated by ’:’ character under Unix and ’;’ under MS-Windows) for Java source files. Files with those suffixes will be inserted into Tag file and parsed with Xrefactory’s Java parser. Suffixes should not start by the ’.’ dot character which is consider as suffix separator automatically. For exam- ple, the default value under MS-Windows is -javasuffix- es=java;JAV. -filescasesensitive -filescaseunsensitive This option controls whether xref is considering two file names differing only in cases as the same file or not. By default file names are considered as case sensitive. Set- ting names to be case unsensitive may avoid confusion in C #include directives under MS-Windows system. -errors Report all error messages. -noconversion -crconversion -crlfconversion Options controling end of line character conversions. By default xref automatically determines which character se- quence should be considered as end-of-line. Those options force xref to consider respectively linefeed (-noconver- sion), return (-crconversion), or return followed by linefeed (-crlfconversion) as beginning of next line. Those cases corresponds respectively to Unix, Mac OS and Windows systems. -debug Produce debugging output tracing execution and determin- ing possible source of errors. This option is very use- full if some reactions of xref are inadequate on some in- put. In this case you can run xref with given input file and -debug option. In the produced output you can search for error messages and discover the origin of problems.MORE INFO http://www.xref-tech.comSEE ALSO xrefrc(5), XREF(1)⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -