"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "gtags/manual.in" 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.

manual.in  (global-6.6.4):manual.in  (global-6.6.5)
skipping to change at line 29 skipping to change at line 29
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
# #
# This file is converted to the following files: # This file is converted to the following files:
# o command source file (for usage and help). # o command source file (for usage and help).
# o man format reference manual. # o man format reference manual.
# o texinfo format reference manual. # o texinfo format reference manual.
# #
@HEADER GTAGS,1,June 2018,GNU Project @HEADER GTAGS,1,June 2018,GNU Project
@NAME gtags - create tag files for global @NAME gtags - create tag files for global
@SYNOPSIS @SYNOPSIS
@name{gtags} [-ciIOqvw][-d @arg{tag-file}][-f @arg{file}][@arg{dbpath}] @name{gtags} [-ciIOqvw][-C @arg{dir}][-d @arg{tag-file}][-f @arg{file}][@ arg{dbpath}]
@DESCRIPTION @DESCRIPTION
@name{Gtags} is used to create tag files for @xref{global,1}. @name{Gtags} is used to create tag files for @xref{global,1}.
@name{Gtags} recursively collects source files under the current director y, @name{Gtags} recursively collects source files under the current director y,
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}).
By default, @name{gtags} picks up
@LANGMAPSTATEMENT@
Other files are assumed to be text files. Gtags does not treat binary fil
es.
If @file{gtags.files} exists in the current directory If @file{gtags.files} exists in the current directory
or a file is specified by the @option{-f} option, or a file is specified by the @option{-f} option,
target files are limited by it. Lines starting with @samp{. } are comment s. target files are limited by it. Lines starting with @samp{. } are comment s.
@LANGMAPSTATEMENT@
Other files are assumed to be text files. Gtags does not treat binary fil
es.
@OPTIONS @OPTIONS
The following options are available: The following options are available:
@begin_itemize @begin_itemize
@item{@option{--accept-dotfiles}} @item{@option{--accept-dotfiles}}
Accept files and directories whose names begin with a dot. Accept files and directories whose names begin with a dot.
By default, @name{gtags} ignores them. By default, @name{gtags} ignores them.
@item{@option{-c}, @option{--compact}} @item{@option{-c}, @option{--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{@option{-C}, @option{--directory} @arg{dir}}
Change the directory before doing all the work including paramete
r analysis.
This option is ignored in @var{GTAGS_OPTIONS}.
Please specify it on the command line directly.
@item{@option{--config}[=@arg{name}]} @item{@option{--config}[=@arg{name}]}
Print the value of config variable @arg{name}. Print the value of config variable @arg{name}.
If @arg{name} is not specified then print all names and values. If @arg{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} an d @var{sysconfdir}. @var{bindir}, @var{libdir}, @var{datadir}, @var{localstatedir} an d @var{sysconfdir}.
@item{@option{-d}, @option{--dump} @arg{tag-file}} @item{@option{-d}, @option{--dump} @arg{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{@option{--explain}} @item{@option{--explain}}
skipping to change at line 77 skipping to change at line 82
Files which are not on the list are ignored. Files which are not on the list are ignored.
The argument @arg{file} can be set to @val{-} to accept a list of The argument @arg{file} can be set to @val{-} 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 @xref{find,1}, which has rich option s To make the list you may use @xref{find,1}, which has rich option s
for selecting files. for selecting files.
@item{@option{--gtagsconf} @arg{file}} @item{@option{--gtagsconf} @arg{file}}
Set environment variable @var{GTAGSCONF} to @arg{file}. Set environment variable @var{GTAGSCONF} to @arg{file}.
@item{@option{--gtagslabel} @arg{label}} @item{@option{--gtagslabel} @arg{label}}
Set environment variable @var{GTAGSLABEL} to @arg{label}. Set environment variable @var{GTAGSLABEL} to @arg{label}.
@item{@option{--help}}
Print a usage message.
@item{@option{-I}, @option{--idutils}} @item{@option{-I}, @option{--idutils}}
In addition to tag files, make ID database for @xref{idutils,1}. In addition to tag files, make ID database for @xref{idutils,1}.
@item{@option{-i}, @option{--incremental}} @item{@option{-i}, @option{--incremental}}
Update tag files incrementally. Update tag files incrementally.
It's better to use @xref{global,1} with the @option{-u} command. It's better to use @xref{global,1} with the @option{-u} command.
@item{@option{-O}, @option{--objdir}} @item{@option{-O}, @option{--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} d irectory exists, If @var{GTAGSOBJDIRPREFIX} is set and @file{$GTAGSOBJDIRPREFIX} d irectory exists,
@name{gtags} creates @file{$GTAGSOBJDIRPREFIX/<current directory> } directory @name{gtags} creates @file{$GTAGSOBJDIRPREFIX/<current directory> } directory
and makes tag files in it. and makes tag files in it.
skipping to change at line 111 skipping to change at line 118
@item{@option{--sqlite3}} @item{@option{--sqlite3}}
Use Sqlite 3 API to make tag files. By default, BSD/DB 1.85 API i s used. Use Sqlite 3 API to make tag files. By default, BSD/DB 1.85 API i s used.
To use this option, you need to invoke configure script with To use this option, you need to invoke configure script with
@option{--with-sqlite3} in the build phase. @option{--with-sqlite3} in the build phase.
@item{@option{--statistics}} @item{@option{--statistics}}
Print statistics information. Print statistics information.
@item{@option{-q}, @option{--quiet}} @item{@option{-q}, @option{--quiet}}
Quiet mode. Quiet mode.
@item{@option{-v}, @option{--verbose}} @item{@option{-v}, @option{--verbose}}
Verbose mode. Verbose mode.
@item{@option{--version}}
Show version number.
@item{@option{-w}, @option{--warning}} @item{@option{-w}, @option{--warning}}
Print warning messages. Print warning messages.
@item{@arg{dbpath}} @item{@arg{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_itemize @end_itemize
@EXAMPLES @EXAMPLES
@begin_verbatim @begin_verbatim
$ ls -F $ ls -F
Makefile src/ lib/ Makefile src/ lib/
skipping to change at line 201 skipping to change at line 210
If the function name is not specified, 'parser' is assumed. If the function name is not specified, 'parser' is assumed.
As a special exception, @name{gtags} collects values As a special exception, @name{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 @name{gtags} Specify a command line which should be executed at the beginning of @name{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 @name{g tags} is "./" in it always means the project root directory, since @name{g tags} is
always invoked there. always invoked there.
@br
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, @name{gtags} collects values As a special exception, @name{gtags} collects values
from multiple @code{langmap} variables. from multiple @code{langmap} variables.
skipping to change at line 248 skipping to change at line 260
@xref{global,1}, @xref{global,1},
@xref{htags,1}, @xref{htags,1},
@xref{gtags.conf,5}. @xref{gtags.conf,5}.
GNU GLOBAL source code tag system@br GNU GLOBAL source code tag system@br
(http://www.gnu.org/software/global/). (http://www.gnu.org/software/global/).
@BUG @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.
@AUTHOR @AUTHOR
Shigio YAMAGUCHI, Hideki IWAMOTO and others. Shigio YAMAGUCHI, Hideki IWAMOTO and others.
@HISTORY @HISTORY
The @name{gtags} command appeared in FreeBSD 2.2.2. The @name{gtags} command appeared in FreeBSD 2.2.2.
 End of changes. 9 change blocks. 
6 lines changed or deleted 21 lines changed or added

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