"Fossies" - the Fresh Open Source Software Archive

Member "global-6.6.5/doc/htags.ref" (3 Sep 2020, 10550 Bytes) of package /linux/misc/global-6.6.5.tar.gz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "htags.ref": 6.6.4_vs_6.6.5.

    1 @c This file is generated automatically by convert.pl from htags/manual.in.
    2 @unnumberedsubsec NAME
    3 htags - generate a hypertext from a set of source files
    4 @unnumberedsubsec SYNOPSIS
    5 @quotation
    6 htags [-aDfFghInosTvw][-d dbpath][-m name][-t title][dir]@*
    7 @end quotation
    8 @unnumberedsubsec DESCRIPTION
    9 Htags generates a hypertext from a set of source files of
   10 C, Yacc, Java, PHP and assembly.
   12 In advance of using this command, you should execute gtags(1)
   13 in the root directory of a source project.
   14 Then you can execute htags in the same place.
   15 Htags makes a directory named @file{HTML}, and puts a hypertext in it.
   16 You can start browsing at @file{HTML/index.html}.
   18 Since htags generates a static hypertext as long as neither @samp{-D}
   19 nor @samp{-f} option is not specified, you can move it anywhere and browse it
   20 by any browser without any HTTP server. If you use @samp{-D} or @samp{-f}
   21 option, you need to use HTTP server. Though any HTTP server is available,
   22 htags-server(1) is recommended.
   24 This command has so many options.
   25 If you are new to htags, it is recommended to use @samp{--suggest} option.
   26 With that option, htags chooses popular options on your behalf.
   27 @unnumberedsubsec OPTIONS
   28 The following options are available:
   30 @table @asis
   31 @item @samp{-a}, @samp{--alphabet}
   32 Make an alphabetical index suitable for a large project.
   33 @item @samp{--auto-completion}[=limit]
   34 Enable auto-completion facility for the input form.
   35 If limit is specified, number of candidates is limited to the value.
   36 Please note this function requires javascript language in your browser.
   37 @item @samp{-C}, @samp{--directory} dir
   38 Change the directory before doing all the work including parameter analysis.
   39 @item @samp{--caution}
   40 Display a caution message on the top page.
   41 @item @samp{--cflow} cflowfile
   42 Add a call tree by cflow(1). cflowfile must be posix format.
   43 If you use GNU cflow, invoke the command at the project root
   44 directory with the @samp{--format=posix} option.
   45 This option is deprecated; please use @samp{--call-tree} or
   46 @samp{--callee-tree} instead.
   47 @item @samp{--call-tree} callfile
   48 Add a call tree by cflow(1); callfile must be posix format.
   49 If you use GNU cflow, invoke the command at the project root
   50 directory with the @samp{--format=posix} option.
   51 @item @samp{--callee-tree} calleefile
   52 Add a callee tree by cflow(1); calleefile must be posix format.
   53 If you use GNU cflow, invoke the command at the project root
   54 directory with the @samp{--format=posix} and @samp{--reverse} options.
   55 @item @samp{--colorize-warned-line}
   56 Use color to highlight warned lines.
   57 @item @samp{--cvsweb} url
   58 Add a link to cvsweb; url is used as the base of URL.
   59 When directory @file{CVS} exists in the root directory of the project,
   60 the content of @file{CVS/Repository} is used as the relative path from the base.
   61 @item @samp{--cvsweb-cvsroot} cvsroot
   62 Specify cvsroot in cvsweb URL.
   63 @item @samp{-D}, @samp{--dynamic}
   64 Generate a tag list dynamically using CGI program.
   65 Though this option decreases both the size and generation time of
   66 hypertext, you need to start up HTTP server.
   67 @item @samp{-d}, @samp{--dbpath} dbpath
   68 Specify the directory in which @file{GTAGS} exists.
   69 The default is the current directory.
   70 @item @samp{--disable-grep}
   71 Disable grep in the search form (@samp{-f}, @samp{--form}).
   72 @item @samp{--disable-idutils}
   73 Disable idutils in the search form (@samp{-f}, @samp{--form}).
   74 @item @samp{-F}, @samp{--frame}
   75 Use frames for the top page.
   76 @item @samp{-f}, @samp{--form}
   77 Add a search form using CGI program.
   78 You need to start a HTTP server for it.
   79 @item @samp{--fixed-guide}
   80 Put a fixed guide at the bottom of the screen of the browser.
   81 @item @samp{--full-path}
   82 Use full path name in the file index.
   83 By default, use just the last component of a path.
   84 @item @samp{-g}, @samp{--gtags}
   85 Execute gtags(1) before starting job.
   86 The @samp{-v}, @samp{-w} and dbpath options are
   87 passed to gtags.
   88 @item @samp{--gtagsconf} file
   89 Set environment variable @var{GTAGSCONF} to file.
   90 @item @samp{--gtagslabel} label
   91 Set environment variable @var{GTAGSLABEL} to label.
   92 @item @samp{-h}, @samp{--func-header}[=position]
   93 Insert a function header for each function.
   94 By default, htags doesn't generate them.
   95 You can choose the position using position,
   96 which allows one of @samp{before}, @samp{right} or @samp{after} (default).
   97 @item @samp{--help}
   98 Print a usage message.
   99 @item @samp{--html-header} file
  100 Insert a header record derived from file
  101 into the HTML header of each file.
  102 @item @samp{-I}, @samp{--icon}
  103 Use icons instead of text for some links.
  104 @item @samp{--insert-footer} file
  105 Insert custom footer derived from file before @code{</body>} tag.
  106 @item @samp{--insert-header} file
  107 Insert custom header derived from file after @code{<body>} tag.
  108 @item @samp{--item-order} spec
  109 Specify the order of the items in the top page.
  110 The spec is a string consisting of item signs in order.
  111 Each sign means as follows:
  112 @samp{c}: caution; @samp{s}: search form;
  113 @samp{m}: mains; @samp{d}: definitions; @samp{f}: files; @samp{t}: call tree.
  114 The default is @samp{csmdf}.
  115 @item @samp{-m}, @samp{--main-func} name
  116 Specify startup function name; the default is @samp{main}.
  117 @item @samp{--map-file}
  118 Generate file @file{MAP}.
  119 @item @samp{-n}, @samp{--line-number}[=columns]
  120 Print line numbers. By default, don't print line numbers.
  121 The default value of columns is 4.
  122 @item @samp{--no-order-list}
  123 Numbers are not given in list form.
  124 @item @samp{-o}, @samp{--other}
  125 Pick up not only source files but also other files for the file index.
  126 @item @samp{-s}, @samp{--symbol}
  127 Make anchors not only for definitions and references
  128 but also other symbols.
  129 @item @samp{--show-position}
  130 Print the position string per function definition. The string can be
  131 interpreted by general editors in UNIX. The default is false.
  132 @item @samp{--statistics}
  133 Print statistics information.
  134 @item @samp{--suggest}
  135 Htags chooses popular options on behalf of beginners.
  136 It is equivalent to
  137 @samp{-aghInosTxv --show-position --fixed-guide}
  138 now.
  139 @item @samp{--suggest2}
  140 Htags chooses popular options on behalf of beginners.
  141 This option enables frame, AJAX and CGI facility in addition
  142 to the facilities by the @samp{--suggest} option.
  143 It is equivalent to
  144 @samp{--suggest  -DfF --auto-completion --tree-view=filetree}
  145 now.
  146 @item @samp{-T}, @samp{--table-flist}[=rows]
  147 Use @code{<table>} tag to display the file index.
  148 You can optionally specify the number of rows; the default is 5.
  149 @item @samp{-t}, @samp{--title} title
  150 Title of the hypertext.
  151 The default is the last component of the path of the current directory.
  152 @item @samp{--tabs} cols
  153 Tab stops. The default is 8.
  154 @item @samp{--table-list}
  155 Use @code{<table>} tag to display the tag list.
  156 @item @samp{--tree-view}[=type]
  157 Use treeview for the file index.
  158 Please note this function requires javascript language in your browser.
  159 Possible values of type are as follows: treeview, filetree,
  160 treeview-red, treeview-black, treeview-gray,
  161 treeview-famfamfam. The default is treeview.
  162 @item @samp{-v}, @samp{--verbose}
  163 Verbose mode.
  164 @item @samp{--version}
  165 Show version number.
  166 @item @samp{-w}, @samp{--warning}
  167 Print warning messages.
  168 @item dir
  169 The directory in which the result of this command is stored.
  170 The default is the current directory.
  171 @end table
  172 @unnumberedsubsec EXAMPLES
  173 @example
  174 $ gtags -v
  175 $ htags -sanohITvt 'Welcome to XXX source tour!'
  176 $ firefox HTML/index.html
  177 $ htags --suggest2
  178 $ htags-server >& log &
  179 $ firefox
  180 @end example
  181 @unnumberedsubsec FILES
  182 @table @asis
  183 @item @file{GTAGS}
  184 Tag file for definitions.
  185 @item @file{GRTAGS}
  186 Tag file for references.
  187 @item @file{GPATH}
  188 Tag file for source files.
  189 @item @file{gtags.conf}, @file{$HOME/.globalrc}
  190 Configuration data for GNU GLOBAL.
  191 See gtags.conf(5).
  192 @item @file{HTML/FILEMAP}
  193 Mapping file for converting file name into the path of the file.
  194 @item @file{HTML/GTAGSROOT}
  195 If this file exists, CGI program @file{global.cgi} sets
  196 environment variable @var{GTAGSROOT} to the contents of it.
  197 If you move directory @file{HTML} from the original place,
  198 please make this file.
  199 @item @file{HTML/.htaccess}
  200 Local configuration file for Apache. This file is generated when
  201 the @samp{-f} or @samp{-D} options are specified.
  202 @item @file{HTML/index.html}
  203 Start-up file.
  204 @item @file{HTML/MAP}
  205 Mapping file for converting tag name into the path of tag list.
  206 @item @file{HTML/style.css}
  207 Style sheet file.
  208 @item @file{/usr/local/share/gtags/style.css.tmpl}
  209 The template of the style sheet file (@file{HTML/style.css}).
  210 @end table
  211 @unnumberedsubsec ENVIRONMENT
  212 The following environment variables affect the execution of htags:
  214 @table @asis
  215 @item @var{GTAGSCACHE}
  216 The size of the B-tree cache. The default is 50000000 (bytes).
  217 @item @var{GTAGSCONF}
  218 Configuration file.
  219 @item @var{GTAGSLABEL}
  220 Configuration label. The default is @samp{default}.
  221 @item @var{HTAGS_OPTIONS}
  222 The value of this variable is inserted in the head of arguments.
  223 @item @var{TMPDIR}
  224 The location used to stored temporary files. The default is @file{/tmp}.
  225 @item @var{GTAGSFORCECPP}
  226 If this variable is set, each file whose suffix is @file{.h} is treated
  227 as a C++ source file.
  228 @end table
  229 @unnumberedsubsec CONFIGURATION
  230 The following configuration variables affect the execution of htags:
  232 @table @asis
  233 @item @code{datadir}(string)
  234 Shared data directory. The default is @file{/usr/local/share} but
  235 you can change the value using configure script.
  236 Htags looks up template files in the @file{gtags} directory
  237 in this data directory.
  238 @item @code{include_file_suffixes}(comma separated list)
  239 Suffixes of include files. The default is:@*
  240 @samp{h,hh,hxx,hpp,H,inc.php}.
  241 @item @code{langmap}(comma separated list)
  242 Language mapping. Each comma-separated map consists of
  243 the language name, a colon, and a list of file extensions.
  244 Default mapping is:@*
  245 @samp{c:.c.h,yacc:.y,asm:.s.S,java:.java,cpp:.c++.cc.hh.cpp.cxx.hxx.hpp.C.H,php:.php.php3.phtml}.
  246 @end table
  247 @unnumberedsubsec DIAGNOSTICS
  248 Htags exits with a non-0 value if an error occurred, 0 otherwise.
  249 @unnumberedsubsec SEE ALSO
  250 htags-server(1),
  251 global(1),
  252 gtags(1),
  253 gtags.conf(5).
  255 GNU GLOBAL source code tag system@*
  256 (http://www.gnu.org/software/global/).
  257 @unnumberedsubsec BUG
  258 Generated hypertext is VERY LARGE.
  259 In advance, check the space of your disk.
  261 PHP support is far from complete.
  263 The @samp{-f} and @samp{-D} options generate CGI programs.
  264 If you open the hypertext to the public, please recognize security dangers.
  266 Htags does not support plug-in parser.
  267 @unnumberedsubsec AUTHOR
  268 Shigio YAMAGUCHI, Hideki IWAMOTO and others.
  269 @unnumberedsubsec HISTORY
  270 The htags command appeared in FreeBSD 2.2.2.