HTMAKE(1) GLOBAL cgi Utilities HTMAKE(1)NAME
htmake - create GLOBAL hypertext source searchable by gsearch.cgi
SYNOPSIS
htmake [htags options] [--url=base-url] [destdir]
DESCRIPTION
htmake is a wrapper script that creates searchable hypertext from program source code and records information into a path database needed
for a centralised search mechanism.
Prior to using this command you must have installed gsearch.cgi using the htconfig -I option and configured the location of the path data-
base in htmake.conf
Before you can create the hypertext source you need to execute gtags(1) from the root directory of the source tree. htmake is then called
from the same place.
htmake uses htags(1) to create the hypertext with a unique id and htconfig(1) to make the required entries in the path database.
OPTIONS
The following options will be passed to htags(1) if used.
-a Make an alphabetical function index.
-c Compress html. Use gzip(1) with .ghtml suffix.
-C Compress html. Use gzip(1) with .html.gz suffix.
-d tagdir, --tags=gtagsdbpath
Specifies the directory in which GTAGS and GRTAGS exist. The default is the current directory.
-F Use frames for definition index, file index and main view.
-l Make a name tag for each line of hypertext created.
-n Print out the line numbers.
-t title
The title of this hypertext. Defaults to the last component of the current path.
--action=cgi-url
Specify the location search queries are submitted to. Defaults to the value set in htmake.conf or to
http://localhost/cgi-bin/gsearch.cgi
The remaining options are more general or are passed to htconfig(1).
--url=base-url
the base url for your new hypertext source. For best results always use absolute url's here.
eg. http://host/~user/mysource
It defaults to file:/destdir
destdir
The directory in which hypertext is generated. The default is ./HTML
-v, --verbose
Activate the inbuilt screen saver. Give your phosphors a workout.
EXAMPLES
$ cd /usr/src/myprog
$ gtags
$ htmake
$ cd /usr/src/myprog
$ gtags -c
$ htmake -c --url=http://host/~user/prog/HTML
/home/user/public_html/prog
FILES
/etc/gtags/htmake.conf
path database
BUGS
As a wrapper htmake gets to inherit bugs from other software too. Isn't life fun.
This is alpha software - expect anything!
SEE ALSO htconfig(1), htags(1), gtags(1), global(1).
AUTHOR
Ron Lee <ron@debian.org>
CREDITS
Thanks to Shigio Yamaguchi <shigio@gnu.org> for creating GLOBAL and releasing it as free software.
A truly cool productivity tool!
Debian GNU/Linux 27 March 1999 HTMAKE(1)
Check Out this Related Man Page
GTAGS(1) General Commands Manual GTAGS(1)NAME
gtags - create tag files for global.
SYNOPSIS
gtags [-iIqvw][-f file][-n number][dbpath]
DESCRIPTION
Gtags recursively collect the source files under the current directory, pickup symbols and write the cross-reference data into tag files
('GTAGS', 'GRTAGS', 'GSYMS' and 'GPATH'). You should execute this command at the root of the source tree.
C, C++, yacc, java, PHP and Assembly source files are supported. Files whose names end in '.c' or '.h' are assumed to be C source files.
Files whose names end in '.c++' '.cc' '.cpp' '.cxx' '.hxx' '.hpp' '.C' '.H' are assumed to be C++ source files. Files whose names end in
'.y' are assumed to be YACC source files. Files whose names end in '.java' are assumed to be Java source files. Files whose names end in
'.php' '.php3' '.phtml' are assumed to be PHP source files. Files whose names end in '.s' or '.S' are assumed to be Assembly source files.
Other files are assumed to be text files.
OPTIONS
The following options are available:
--config[=name]
Show the value of config variable name. If name is not specified then show whole of config entry.
-f, --file file
Read from file a list of file names which should be considered as the candidate of source files. By default, all files under the
current directory are considered as the candidate. If file is '-', read from standard input. File names must be separated by new-
line.
--gtagsconf file
Load user's configuration from file.
--gtagslabel label
label is used as the label of configuration file. The default is default.
-I, --idutils
Make index files for idutils(1) too.
-i, --incremental
Update tag files incrementally. You had better use global(1) with the -u option.
-n, --max-args number
Maximum number of arguments for gtags-parser(1). By default, gtags invokes gtags-parser with arguments as many as possible to
decrease the frequency of invoking.
-q, --quiet
Quiet mode.
-v, --verbose
Verbose mode.
-w, --warning
Print warning messages.
dbpath The directory in which tag files are generated. The default is the current directory. It is useful when your source directory is
on a read only device like CDROM.
EXAMPLES
$ ls -F
Makefile src/ lib/
$ gtags -v
$ global -x main
main 10 src/main.c main (argc, argv) {
FILES
'GTAGS'
Tag file for function definitions.
'GRTAGS'
Tag file for function references.
'GSYMS'
Tag file for other symbols.
'GPATH'
Tag file for path of source files.
'/etc/gtags.conf', '$HOME/.globalrc'
Configuration file.
ENVIRONMENT
The following environment variables affect the execution of gtags:
GTAGSCONF
If this variable is set, its value is used as the configuration file. The default is '$HOME/.globalrc'.
GTAGSLABEL
If this variable is set, its value is used as the label of configuration file. The default is default.
GTAGSCACHE
If this variable is set, its value is used as the size of B-tree cache. The default is 5000000 (bytes).
GTAGSFORCECPP
If this variable is set, each file whose suffix is 'h' is treated as a C++ source file.
CONFIGURATION
The following configuration variables affect the execution of gtags. You can see the default value for each variable with the --config
option.
GTAGS(string)
If this variable is set, its value is used as the command line of the parser for GTAGS. The default is 'gtags-parser %s'.
GRTAGS(string)
If this variable is set, its value is used as the command line of the parser for GRTAGS. The default is 'gtags-parser -r %s'.
GSYMS(string)
If this variable is set, its value is used as the command line of the parser for GSYMS. The default is 'gtags-parser -s %s'.
icase_path(boolean)
Ignore case distinctions in the path. Suffixes check are affected by this capability.
langmap(comma separated list)
Language mapping. Each comma-separated map consists of the 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'.
skip(comma separated list)
Gtags skips files which are listed in this list. As a special exception, gtags collect values from multiple skip variables. If the
value ends with '/', it assumed as a directory and gtags skips all files under it. If the value start with '/', it assumed relative
path from the root of source directory.
suffixes(comma separated list)
Suffixes of target source file. As a special exception, gtags collect values from multiple suffixes variables. This variable is
obsoleted. If the langmap variable is defined gtags no longer refers this.
DIAGNOSTICS
Gtags exits with a non 0 value if an error occurred, 0 otherwise.
MESSAGE FORMAT
Verbose message has important level. The most important level is 0, the second is 1 and so on. All the message has level numbers leading
blanks.
SEE ALSO gtags-parser(1), global(1), htags(1).
GNU GLOBAL source code tag system
(http://www.gnu.org/software/global/).
BUG
'GTAGS', 'GRTAGS' and 'GSYMS' are very large. In advance of using this command, check the space of your disk.
Assembly support is far from complete. It extracts only ENTRY() and ALTENTRY() from source file. Probably valid only for FreeBSD and
Linux kernel source.
There is no concurrency control about tag files.
AUTHOR
Tama Communications Corporation.
HISTORY
The gtags command appeared in FreeBSD 2.2.2.
GNU Project March 2008 GTAGS(1)