"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "gtags/gtags.1" between
global-6.6.4.tar.gz and global-6.6.5.tar.gz

About: GNU GLOBAL is a source code tag system that works the same way across diverse environments. It is similar to ctags or etags, but it is independent of any editor.

gtags.1  (global-6.6.4):gtags.1  (global-6.6.5)
GTAGS(1) General Commands Manual GTAGS(1) GTAGS(1) General Commands Manual GTAGS(1)
NAME NAME
gtags - create tag files for global gtags - create tag files for global
SYNOPSIS SYNOPSIS
gtags [-ciIOqvw][-d tag-file][-f file][dbpath] gtags [-ciIOqvw][-C dir][-d tag-file][-f file][dbpath]
DESCRIPTION DESCRIPTION
Gtags is used to create tag files for global(1). 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 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´). cross-reference data into the tag files (´GTAGS´, ´GRTAGS´ and ´GPATH´).
By default, gtags picks up C, Yacc, assembly language, Java, C++ and PHP
source files. Files whose names
end in ´.c´, ´.h´ are assumed to be C source files. Files whose names en
d in ´.y´ are assumed to be Yacc
source files. Files whose names end in ´.s´, ´.S´ are assumed to be as
sembly language 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 b
e 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.
If ´gtags.files´ exists in the current directory or a file is specified b y the -f option, target files If ´gtags.files´ exists in the current directory or a file is specified b y the -f option, target files
are limited by it. Lines starting with ´. ´ are comments. are limited by it. Lines starting with ´. ´ are comments.
C, yacc, Assembly, Java, C++ and PHP source files are supported. Files w
hose 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 who
se 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 OPTIONS
The following options are available: The following options are available:
--accept-dotfiles --accept-dotfiles
Accept files and directories whose names begin with a dot. By def ault, gtags ignores them. Accept files and directories whose names begin with a dot. By def ault, gtags ignores them.
-c, --compact -c, --compact
Make ´GTAGS´ in compact format. This option does not influence ´GRTAGS´, because that is always Make ´GTAGS´ in compact format. This option does not influence ´GRTAGS´, because that is always
made in compact format. made in compact format.
-C, --directory dir
Change the directory before doing all the work including paramet
er analysis. This option is
ignored in GTAGS_OPTIONS. Please specify it on the command line d
irectly.
--config[=name] --config[=name]
Print the value of config variable name. If name is not specified Print the value of config variable name. If name is not specifi
then print all names and val- ed then print all names and val-
ues. In addition to the variables listed in the ENVIRONMENT s ues. In addition to the variables listed in the ENVIRONMENT secti
ection, you can refer to install on, you can refer to install
directories by read only variables: bindir, libdir, datadir, local statedir and sysconfdir. directories by read only variables: bindir, libdir, datadir, local statedir and sysconfdir.
-d, --dump tag-file -d, --dump tag-file
Dump a tag file as text to the standard output. Output format is 'key<tab>data'. This is for Dump a tag file as text to the standard output. Output forma t is 'key<tab>data'. This is for
debugging. debugging.
--explain --explain
Explain handling files. Explain handling files.
-f, --file file -f, --file file
Give a list of candidates of target files. Files which are n Give a list of candidates of target files. Files which are not on
ot on the list are ignored. The the list are ignored. The
argument file can be set to ´-´ to accept a list of files from the argument file can be set to ´-´ to accept a list of files from
standard input. File names the standard input. File names
must be separated by newline. To make the list you may use fin must be separated by newline. To make the list you may use find(1
d(1), which has rich options for ), which has rich options for
selecting files. selecting files.
--gtagsconf file --gtagsconf file
Set environment variable GTAGSCONF to file. Set environment variable GTAGSCONF to file.
--gtagslabel label --gtagslabel label
Set environment variable GTAGSLABEL to label. Set environment variable GTAGSLABEL to label.
--help Print a usage message.
-I, --idutils -I, --idutils
In addition to tag files, make ID database for idutils(1). In addition to tag files, make ID database for idutils(1).
-i, --incremental -i, --incremental
Update tag files incrementally. It's better to use global(1) with the -u command. Update tag files incrementally. It's better to use global(1) with the -u command.
-O, --objdir -O, --objdir
Use BSD-style obj directory as the location of tag files. If GTAG SOBJDIRPREFIX is set and ´$GTAG- Use BSD-style obj directory as the location of tag files. If GTAG SOBJDIRPREFIX is set and ´$GTAG-
SOBJDIRPREFIX´ directory exists, gtags creates ´$GTAGSOBJDIRPREFI SOBJDIRPREFIX´ directory exists, gtags creates ´$GTAGSOBJDIRPREFIX
X/<current directory>´ directory /<current directory>´ directory
and makes tag files in it. Though you can use MAKEOBJDIRPREFIX in and makes tag files in it. Though you can use MAKEOBJDIRPREFIX
stead of GTAGSOBJDIRPREFIX, it instead of GTAGSOBJDIRPREFIX, it
is deprecated. If dbpath is specified, this option is ignored. is deprecated. If dbpath is specified, this option is ignored.
--single-update file --single-update file
Update tag files for a single file. It is considered that file wa s added, updated or deleted, and Update tag files for a single file. It is considered that file wa s added, updated or deleted, and
there is no change in other files. This option implies the -i opt ion. there is no change in other files. This option implies the -i opt ion.
--skip-unreadable --skip-unreadable
Skip unreadable files. Skip unreadable files.
--skip-symlink [=type] --skip-symlink [=type]
Skip symbolic links. If type is 'f' then skip only symbolic links for file, else if 'd' then skip Skip symbolic links. If type is 'f' then skip only symbolic links for file, else if 'd' then skip
only symbolic links for directory. The default value of type is ' a' (all symbolic links). only symbolic links for directory. The default value of type is ' a' (all symbolic links).
--sqlite3 --sqlite3
Use Sqlite 3 API to make tag files. By default, BSD/DB 1.85 API i s used. To use this option, you 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 p hase. need to invoke configure script with --with-sqlite3 in the build p hase.
--statistics --statistics
Print statistics information. Print statistics information.
-q, --quiet -q, --quiet
Quiet mode. Quiet mode.
-v, --verbose -v, --verbose
Verbose mode. Verbose mode.
--version
Show version number.
-w, --warning -w, --warning
Print warning messages. Print warning messages.
dbpath The directory in which tag files are generated. The default is th e current directory. dbpath The directory in which tag files are generated. The default is th e current directory.
EXAMPLES EXAMPLES
$ ls -F $ ls -F
Makefile src/ lib/ Makefile src/ lib/
$ gtags -v $ gtags -v
$ global -x main $ global -x main
skipping to change at line 147 skipping to change at line 156
GTAGSFORCECPP GTAGSFORCECPP
If this variable is set, each file whose suffix is ´.h´ is treated as a C++ source file. If this variable is set, each file whose suffix is ´.h´ is treated as a C++ source file.
GTAGSFORCEENDBLOCK GTAGSFORCEENDBLOCK
If this variable is set, each } at the first column brings end of block of 0 level. If this variable is set, each } at the first column brings end of block of 0 level.
GTAGSLABEL GTAGSLABEL
Configuration label. The default is ´default´. Configuration label. The default is ´default´.
GTAGSLOGGING GTAGSLOGGING
If this variable is set, ´$GTAGSLOGGING´ is used as the path name of a log file. There is no If this variable is set, ´$GTAGSLOGGING´ is used as the path name of a log file. There is no
default value. default value.
GTAGS_COMMANDLINE GTAGS_COMMANDLINE
This variable can only be referenced from the hook (see gtags_hook ). Gtags sets its own effective This variable can only be referenced from the hook (see gtags_hook ). Gtags sets its own effective
command line to this variable before calling the hook. Each argu ment is separated by whitespace, command line to this variable before calling the hook. Each argume nt is separated by whitespace,
and real whitespace is represented as '%20'. This is read only. and real whitespace is represented as '%20'. This is read only.
GTAGS_OPTIONS GTAGS_OPTIONS
The value of this variable is inserted in the head of arguments. The value of this variable is inserted in the head of arguments.
GTAGSOBJDIR GTAGSOBJDIR
If this variable is set, it is used as the name of BSD-style ob jdir. The default is ´obj´. If this variable is set, it is used as the name of BSD-styl e objdir. The default is ´obj´.
Though you can use MAKEOBJDIR instead of GTAGSOBJDIR, it is deprec ated. Though you can use MAKEOBJDIR instead of GTAGSOBJDIR, it is deprec ated.
GTAGSOBJDIRPREFIX GTAGSOBJDIRPREFIX
If this variable is set, it is used as the prefix of BSD-style obj dir. The default is ´/usr/obj´. If this variable is set, it is used as the prefix of BSD-style obj dir. The default is ´/usr/obj´.
Though you can use MAKEOBJDIRPREFIX instead of GTAGSOBJDIRPREFIX, it is deprecated. Though you can use MAKEOBJDIRPREFIX instead of GTAGSOBJDIRPREFIX, it is deprecated.
TMPDIR The location used to stored temporary files. The default is ´/tmp´ . TMPDIR The location used to stored temporary files. The default is ´/tmp´ .
CONFIGURATION CONFIGURATION
The following configuration variables affect the execution of gtags. You can see the default value for The following configuration variables affect the execution of gtags. Y ou can see the default value for
each variable with the --config option. each variable with the --config option.
gtags_parser (comma separated list) gtags_parser (comma separated list)
Specify the mapping of language names and plug-in parsers. Each Specify the mapping of language names and plug-in parsers. Each p
part delimited by the comma con- art delimited by the comma con-
sists of a language name, a colon, the shared object path, an opti sists of a language name, a colon, the shared object path, an op
onal colon followed by a func- tional colon followed by a func-
tion name. If the function name is not specified, 'parser' is a tion name. If the function name is not specified, 'parser' is ass
ssumed. As a special exception, umed. As a special exception,
gtags collects values from multiple gtags_parser variables. For t gtags collects values from multiple gtags_parser variables. For
hese mappings, the first match these mappings, the first match
is adopted. is adopted.
gtags_hook (command line) gtags_hook (command line)
Specify a command line which should be executed at the beginning o f gtags after loading configura- Specify a command line which should be executed at the beginning o f gtags after loading configura-
tion file. You can use this hook to update ´gtags.files´ dynamical ly. "./" in it always means the tion file. You can use this hook to update ´gtags.files´ dynamical ly. "./" in it always means the
project root directory, since gtags is always invoked there. project root directory, since gtags is always invoked there.
This hook is ignored when the following options are specified:
--version, --help, --config,
--dump.
icase_path (boolean) icase_path (boolean)
Ignore case distinctions in the path. Suffixes check is affected by this capability. Ignore case distinctions in the path. Suffixes check is affected by this capability.
langmap (comma separated list) langmap (comma separated list)
Language mapping. Each comma-separated map consists of a langu age name, a colon, and a list of Language mapping. Each comma-separated map consists of a langu age name, a colon, and a list of
file extensions. You can specify a glob pattern surrounded by par entheses instead of an extension file extensions. You can specify a glob pattern surrounded by par entheses instead of an extension
for the files without extensions (e.g. Make:([Mm]akefile).mak.mk) . As a special exception, gtags for the files without extensions (e.g. Make:([Mm]akefile).mak.mk) . As a special exception, gtags
collects values from multiple langmap variables. For these mappin gs, the first match is adopted. collects values from multiple langmap variables. For these mappin gs, the first match is adopted.
Default mapping is: 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´. ´c:.c.h,yacc:.y,asm:.s.S,java:.java,cpp:.c++.cc.hh.cpp.cxx.hxx.hpp .C.H,php:.php.php3.phtml´.
skipping to change at line 223 skipping to change at line 235
SEE ALSO SEE ALSO
global(1), htags(1), gtags.conf(5). global(1), htags(1), gtags.conf(5).
GNU GLOBAL source code tag system GNU GLOBAL source code tag system
(http://www.gnu.org/software/global/). (http://www.gnu.org/software/global/).
BUG BUG
´GTAGS´ and ´GRTAGS´ are very large. In advance of using this command, c heck the space of your disk. ´GTAGS´ and ´GRTAGS´ are very large. In advance of using this command, c heck the space of your disk.
Assembly support is far from complete. It extracts only ENTRY() and ALTE Assembly language support is far from complete. It extracts only ENTRY(
NTRY() from source file. Proba- ) and ALTENTRY() from source
bly valid only for FreeBSD and Linux kernel source. file. Probably valid only for FreeBSD and Linux kernel source.
C++ support is deprecated.
There is no concurrency control about tag files. There is no concurrency control about tag files.
AUTHOR AUTHOR
Shigio YAMAGUCHI, Hideki IWAMOTO and others. Shigio YAMAGUCHI, Hideki IWAMOTO and others.
HISTORY HISTORY
The gtags command appeared in FreeBSD 2.2.2. The gtags command appeared in FreeBSD 2.2.2.
GNU Project June 2018 GTAGS(1) GNU Project June 2018 GTAGS(1)
 End of changes. 19 change blocks. 
47 lines changed or deleted 64 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)