"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/gtags.ref" 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.ref  (global-6.6.4):gtags.ref  (global-6.6.5)
@c This file is generated automatically by convert.pl from gtags/manual.in. @c This file is generated automatically by convert.pl from gtags/manual.in.
@unnumberedsubsec NAME @unnumberedsubsec NAME
gtags - create tag files for global gtags - create tag files for global
@unnumberedsubsec SYNOPSIS @unnumberedsubsec SYNOPSIS
@quotation @quotation
gtags [-ciIOqvw][-d tag-file][-f file][dbpath]@* gtags [-ciIOqvw][-C dir][-d tag-file][-f file][dbpath]@*
@end quotation @end quotation
@unnumberedsubsec DESCRIPTION @unnumberedsubsec 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, Gtags recursively collects source files under the current directory,
picks up symbols and writes the cross-reference data into the tag files picks up symbols and writes the cross-reference data into the tag files
(@file{GTAGS}, @file{GRTAGS} and @file{GPATH}). (@file{GTAGS}, @file{GRTAGS} and @file{GPATH}).
If @file{gtags.files} exists in the current directory By default, gtags picks up
or a file is specified by the @samp{-f} option, C, Yacc, assembly language, Java, C++ and PHP source files.
target files are limited by it. Lines starting with @samp{. } are comments.
C, yacc, Assembly, Java, C++ and PHP source files are supported.
Files whose names end in @file{.c}, @file{.h} are assumed to be C source files. Files whose names end in @file{.c}, @file{.h} are assumed to be C source files.
Files whose names end in @file{.y} are assumed to be yacc source files. Files whose names end in @file{.y} are assumed to be Yacc source files.
Files whose names end in @file{.s}, @file{.S} are assumed to be Assembly source Files whose names end in @file{.s}, @file{.S} are assumed to be assembly languag
files. e source files.
Files whose names end in @file{.java} are assumed to be Java source files. Files whose names end in @file{.java} are assumed to be Java source files.
Files whose names end in @file{.c++}, @file{.cc}, @file{.hh}, @file{.cpp}, @file {.cxx}, @file{.hxx}, @file{.hpp}, @file{.C}, @file{.H} are assumed to be C++ sou rce files. Files whose names end in @file{.c++}, @file{.cc}, @file{.hh}, @file{.cpp}, @file {.cxx}, @file{.hxx}, @file{.hpp}, @file{.C}, @file{.H} are assumed to be C++ sou rce files.
Files whose names end in @file{.php}, @file{.php3}, @file{.phtml} are assumed to be PHP source files. Files whose names end in @file{.php}, @file{.php3}, @file{.phtml} are assumed to be PHP source files.
Other files are assumed to be text files. Gtags does not treat binary files. Other files are assumed to be text files. Gtags does not treat binary files.
If @file{gtags.files} exists in the current directory
or a file is specified by the @samp{-f} option,
target files are limited by it. Lines starting with @samp{. } are comments.
@unnumberedsubsec OPTIONS @unnumberedsubsec OPTIONS
The following options are available: The following options are available:
@table @asis @table @asis
@item @samp{--accept-dotfiles} @item @samp{--accept-dotfiles}
Accept files and directories whose names begin with a dot. Accept files and directories whose names begin with a dot.
By default, gtags ignores them. By default, gtags ignores them.
@item @samp{-c}, @samp{--compact} @item @samp{-c}, @samp{--compact}
Make @file{GTAGS} in compact format. Make @file{GTAGS} in compact format.
This option does not influence @file{GRTAGS}, This option does not influence @file{GRTAGS},
because that is always made in compact format. because that is always made in compact format.
@item @samp{-C}, @samp{--directory} dir
Change the directory before doing all the work including parameter analysis.
This option is ignored in @var{GTAGS_OPTIONS}.
Please specify it on the command line directly.
@item @samp{--config}[=name] @item @samp{--config}[=name]
Print the value of config variable name. Print the value of config variable name.
If name is not specified then print all names and values. If name is not specified then print all names and values.
In addition to the variables listed in the ENVIRONMENT section, In addition to the variables listed in the ENVIRONMENT section,
you can refer to install directories by read only variables: you can refer to install directories by read only variables:
@var{bindir}, @var{libdir}, @var{datadir}, @var{localstatedir} and @var{sysconfd ir}. @var{bindir}, @var{libdir}, @var{datadir}, @var{localstatedir} and @var{sysconfd ir}.
@item @samp{-d}, @samp{--dump} tag-file @item @samp{-d}, @samp{--dump} tag-file
Dump a tag file as text to the standard output. Dump a tag file as text to the standard output.
Output format is 'key<tab>data'. This is for debugging. Output format is 'key<tab>data'. This is for debugging.
@item @samp{--explain} @item @samp{--explain}
skipping to change at line 61 skipping to change at line 66
Files which are not on the list are ignored. Files which are not on the list are ignored.
The argument file can be set to @samp{-} to accept a list of The argument file can be set to @samp{-} to accept a list of
files from the standard input. files from the standard input.
File names must be separated by newline. File names must be separated by newline.
To make the list you may use find(1), which has rich options To make the list you may use find(1), which has rich options
for selecting files. for selecting files.
@item @samp{--gtagsconf} file @item @samp{--gtagsconf} file
Set environment variable @var{GTAGSCONF} to file. Set environment variable @var{GTAGSCONF} to file.
@item @samp{--gtagslabel} label @item @samp{--gtagslabel} label
Set environment variable @var{GTAGSLABEL} to label. Set environment variable @var{GTAGSLABEL} to label.
@item @samp{--help}
Print a usage message.
@item @samp{-I}, @samp{--idutils} @item @samp{-I}, @samp{--idutils}
In addition to tag files, make ID database for idutils(1). In addition to tag files, make ID database for idutils(1).
@item @samp{-i}, @samp{--incremental} @item @samp{-i}, @samp{--incremental}
Update tag files incrementally. Update tag files incrementally.
It's better to use global(1) with the @samp{-u} command. It's better to use global(1) with the @samp{-u} command.
@item @samp{-O}, @samp{--objdir} @item @samp{-O}, @samp{--objdir}
Use BSD-style obj directory as the location of tag files. Use BSD-style obj directory as the location of tag files.
If @var{GTAGSOBJDIRPREFIX} is set and @file{$GTAGSOBJDIRPREFIX} directory exists , If @var{GTAGSOBJDIRPREFIX} is set and @file{$GTAGSOBJDIRPREFIX} directory exists ,
gtags creates @file{$GTAGSOBJDIRPREFIX/<current directory>} directory gtags creates @file{$GTAGSOBJDIRPREFIX/<current directory>} directory
and makes tag files in it. and makes tag files in it.
skipping to change at line 95 skipping to change at line 102
@item @samp{--sqlite3} @item @samp{--sqlite3}
Use Sqlite 3 API to make tag files. By default, BSD/DB 1.85 API is used. 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 To use this option, you need to invoke configure script with
@samp{--with-sqlite3} in the build phase. @samp{--with-sqlite3} in the build phase.
@item @samp{--statistics} @item @samp{--statistics}
Print statistics information. Print statistics information.
@item @samp{-q}, @samp{--quiet} @item @samp{-q}, @samp{--quiet}
Quiet mode. Quiet mode.
@item @samp{-v}, @samp{--verbose} @item @samp{-v}, @samp{--verbose}
Verbose mode. Verbose mode.
@item @samp{--version}
Show version number.
@item @samp{-w}, @samp{--warning} @item @samp{-w}, @samp{--warning}
Print warning messages. Print warning messages.
@item dbpath @item dbpath
The directory in which tag files are generated. The directory in which tag files are generated.
The default is the current directory. The default is the current directory.
@end table @end table
@unnumberedsubsec EXAMPLES @unnumberedsubsec EXAMPLES
@example @example
$ ls -F $ ls -F
Makefile src/ lib/ Makefile src/ lib/
skipping to change at line 185 skipping to change at line 194
If the function name is not specified, 'parser' is assumed. If the function name is not specified, 'parser' is assumed.
As a special exception, gtags collects values As a special exception, gtags collects values
from multiple @code{gtags_parser} variables. from multiple @code{gtags_parser} variables.
For these mappings, the first match is adopted. For these mappings, the first match is adopted.
@item @code{gtags_hook} (command line) @item @code{gtags_hook} (command line)
Specify a command line which should be executed at the beginning of gtags Specify a command line which should be executed at the beginning of gtags
after loading configuration file. You can use this hook to update after loading configuration file. You can use this hook to update
@file{gtags.files} dynamically. @file{gtags.files} dynamically.
"./" in it always means the project root directory, since gtags is "./" in it always means the project root directory, since gtags is
always invoked there. always invoked there.
@*
This hook is ignored when the following options are specified:
--version, --help, --config, --dump.
@item @code{icase_path} (boolean) @item @code{icase_path} (boolean)
Ignore case distinctions in the path. Ignore case distinctions in the path.
Suffixes check is affected by this capability. Suffixes check is affected by this capability.
@item @code{langmap} (comma separated list) @item @code{langmap} (comma separated list)
Language mapping. Each comma-separated map consists of Language mapping. Each comma-separated map consists of
a language name, a colon, and a list of file extensions. a language name, a colon, and a list of file extensions.
You can specify a glob pattern surrounded by parentheses instead of an extension You can specify a glob pattern surrounded by parentheses instead of an extension
for the files without extensions (e.g. Make:([Mm]akefile).mak.mk). for the files without extensions (e.g. Make:([Mm]akefile).mak.mk).
As a special exception, gtags collects values As a special exception, gtags collects values
from multiple @code{langmap} variables. from multiple @code{langmap} variables.
skipping to change at line 232 skipping to change at line 244
global(1), global(1),
htags(1), htags(1),
gtags.conf(5). 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/).
@unnumberedsubsec BUG @unnumberedsubsec BUG
@file{GTAGS} and @file{GRTAGS} are very large. @file{GTAGS} and @file{GRTAGS} are very large.
In advance of using this command, check the space of your disk. In advance of using this command, check the space of your disk.
Assembly support is far from complete. Assembly language support is far from complete.
It extracts only @code{ENTRY()} and @code{ALTENTRY()} from source file. It extracts only @code{ENTRY()} and @code{ALTENTRY()} from source file.
Probably valid only for FreeBSD and Linux kernel source. 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.
@unnumberedsubsec AUTHOR @unnumberedsubsec AUTHOR
Shigio YAMAGUCHI, Hideki IWAMOTO and others. Shigio YAMAGUCHI, Hideki IWAMOTO and others.
@unnumberedsubsec HISTORY @unnumberedsubsec HISTORY
The gtags command appeared in FreeBSD 2.2.2. The gtags command appeared in FreeBSD 2.2.2.
 End of changes. 10 change blocks. 
10 lines changed or deleted 24 lines changed or added

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