gtags man page

gtags — create tag files for global.

Synopsis

gtags [-ciIOqvw][-d tag-file][-f file][dbpath]

Description

Gtags is used to create tag files for global(1).

Gtags recursively collects source files under the current directory, picks up symbols and writes the cross-reference data into the tag files (´GTAGS´, ´GRTAGS´ and ´GPATH´).

If ´gtags.files´ exists or the -f option is specified, target files are limited by it. Lines starting with ´. ´ are comments.

C, yacc, Assembly, Java, C++ and PHP source files are supported. Files whose names end in ´.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 ´.s´, ´.S´ are assumed to be Assembly source files. Files whose names end in ´.java´ are assumed to be Java source files. Files whose names end in ´.c++´, ´.cc´, ´.hh´, ´.cpp´, ´.cxx´, ´.hxx´, ´.hpp´, ´.C´, ´.H´ are assumed to be C++ source files. Files whose names end in ´.php´, ´.php3´, ´.phtml´ are assumed to be PHP source files. Other files are assumed to be text files. Gtags does not treat binary files.

Options

The following options are available:

--accept-dotfiles
Accept files and directories whose names begin with a dot. By default, gtags ignores them.
-c, --compact
Make ´GTAGS´ in compact format. This option does not influence ´GRTAGS´, because that is always made in compact format.
--config[=name]
Print the value of config variable name. If name is not specified then print all names and values. In addition to the variables listed in the Environment section, you can refer install directories by read only variables: bindir, libdir, datadir, localstatedir and sysconfdir.
-d, --dump tag-file
Dump a tag file as text to the standard output. Output format is 'key<tab>data'. This is for debugging.
--explain
Explain handling files.
-f, --file file
Browse through all files whose names are listed in file. The argument file can be set to ´-´ to accept a list of files from the standard input. File names must be separated by newline.
--gtagsconf file
Set environment variable GTAGSCONF to file.
--gtagslabel label
Set environment variable GTAGSLABEL to label.
-I, --idutils
In addition to tag files, make ID database for idutils(1).
-i, --incremental
Update tag files incrementally. It's better to use global(1) with the -u command.
-O, --objdir
Use BSD-style objdir as the location of tag files. If ´$MAKEOBJDIRPREFIX´ directory exists, gtags creates ´$MAKEOBJDIRPREFIX/<current directory>´ directory and makes tag files in it. If dbpath is specified, this option is ignored.
--single-update file
Update tag files for a single file. It is considered that file was added, updated or deleted, and there is no change in other files. This option implies the -i option.
--skip-unreadable
Skip unreadable files.
--sqlite3
Use Sqlite 3 API to make tag files. By default, BSD/DB 1.85 API is used. To use this option, you need to invoke configure script with --with-sqlite3 in the build phase.
--statistics
Print statistics information.
-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.

Examples

$ ls -F
Makefile      src/    lib/
$ gtags -v
$ global -x main
main              10 src/main.c  main (argc, argv) {

Files

´GTAGS´
Tag file for definitions.
´GRTAGS´
Tag file for references.
´GPATH´
Tag file for source files.
´gtags.conf´, ´$HOME/.globalrc´
See gtags.conf(5).
´gtags.files´
The list of candidates of target files.

Environment

The following environment variables affect the execution of gtags:

GTAGSCACHE
The size of the B-tree cache. The default is 50000000 (bytes).
GTAGSCONF
Configuration file.
GTAGSFORCECPP
If this variable is set, each file whose suffix is ´.h´ is treated as a C++ source file.
GTAGSFORCEENDBLOCK
If this variable is set, each } at the first column brings end of block of 0 level.
GTAGSLABEL
Configuration label. The default is ´default´.
GTAGSLOGGING
If this variable is set, ´$GTAGSLOGGING´ is used as the path name of a log file. There is no default value.
GTAGS_OPTIONS
The value of this variable is inserted in the head of arguments.
MAKEOBJDIR
If this variable is set, ´$MAKEOBJDIR´ is used as the name of BSD-style objdir. The default is ´obj´.
MAKEOBJDIRPREFIX
If this variable is set, ´$MAKEOBJDIRPREFIX´ is used as the prefix of BSD-style objdir. The default is ´/usr/obj´.
TMPDIR
The location used to stored temporary files. The default is ´/tmp´.

Configuration

The following configuration variables affect the execution of gtags. You can see the default value for each variable with the --config option.

gtags_parser (comma separated list)
Specify the mapping of language names and plug-in parsers. Each part delimited by the comma consists of the language name, a colon, the shared object path, an optional colon followed by a function name. If the function name is not specified, 'parser' is assumed. As a special exception, gtags collects values from multiple gtags_parser variables.
icase_path (boolean)
Ignore case distinctions in the path. Suffixes check is 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. As a special exception, gtags collects values from multiple langmap variables. Default mapping is:
´c:.c.h,yacc:.y,asm:.s.S,java:.java,cpp:.c++.cc.hh.cpp.cxx.hxx.hpp.C.H,php:.php.php3.phtml´.
skip (comma separated list)
Gtags skips files and directories which are given in this list. As a special exception, gtags collects values from multiple skip variables. If the value ends with ´/´, it is assumed as a directory and gtags skips all files under it. The value may include glob patterns (*, ?, [...], [!...], [^...]). If the value starts with ´/´, it is assumed a relative path name from the root directory of the project. You cannot use glob patterns for a path name.

Diagnostics

Gtags exits with a non-0 value if an error occurred, 0 otherwise.

See Also

global(1), htags(1), gtags.conf(5).

GNU GLOBAL source code tag system
(http://www.gnu.org/software/global/).

Bug

´GTAGS´ and ´GRTAGS´ 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

Shigio YAMAGUCHI, Hideki IWAMOTO and others.

History

The gtags command appeared in FreeBSD 2.2.2.

Referenced By

global(1), globash(1), gozilla(1), gtags.conf(5), gtags-cscope(1), htags(1), htags-server(1).

February 2015 GNU Project