99 lines
3.3 KiB
Groff
99 lines
3.3 KiB
Groff
.\"
|
|
.\" Copyright (c) 1996, 1997 Shigio Yamaguchi. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by Shigio Yamaguchi.
|
|
.\" 4. Neither the name of the author nor the names of any co-contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.Dd Sep 12, 1997
|
|
.Dt GTAGS 1
|
|
.Os BSD 4
|
|
.Sh NAME
|
|
.Nm gtags
|
|
.Nd create GTAGS, GRTAGS and GSYMS file
|
|
.Sh SYNOPSIS
|
|
.Nm gtags
|
|
.Op Fl i
|
|
.Op Fl o
|
|
.Op Fl v
|
|
.Op Ar dbpath
|
|
.Sh DESCRIPTION
|
|
.Nm Gtags
|
|
makes GTAGS, GRTAGS and GSYMS file for
|
|
.Xr global 1 .
|
|
.Nm Gtags
|
|
trace subdirectories, read source files,
|
|
locate symbols and save the information into tag files.
|
|
C, yacc and assembler source files are supported.
|
|
You should execute this command at the root of the source tree.
|
|
.Pp
|
|
If your source directory is on a read only device like CDROM, specify
|
|
.Ar dbpath
|
|
of the directory on which make tag files.
|
|
.Pp
|
|
.Bl -tag -width Ds
|
|
.It Fl i
|
|
update tag files incrementally by files which modified after the tag files were
|
|
last updated.
|
|
.It Fl o
|
|
suppress making GSYMS file.
|
|
Use this option if you don't use -s option of
|
|
.Xr global 1 .
|
|
.It Fl v
|
|
verbose mode.
|
|
.Sh FILES
|
|
.Bl -tag -width tags -compact
|
|
.It Pa GTAGS
|
|
tag file for function definitions.
|
|
.It Pa GRTAGS
|
|
tag file for function references.
|
|
.It Pa GSYMS
|
|
tag file for other symbols.
|
|
.El
|
|
.Sh DIAGNOSTICS
|
|
.Nm Gtags
|
|
exits with a non 0 value if an error occurred, 0 otherwise.
|
|
.Sh SEE ALSO
|
|
.Xr btreeop 1 ,
|
|
.Xr global 1 ,
|
|
.Xr htags 1 ,
|
|
.Xr vi 1 .
|
|
.Sh BUG
|
|
GTAGS, GRTAGS and GSYMS are very large.
|
|
In advance of using this command, check the space of your disk.
|
|
.br
|
|
Assembler support is far from completeness. It extracts only ENTRY()
|
|
and ALTENTRY() from source file. Probably valid only for FreeBSD and Linux
|
|
kernel source.
|
|
.br
|
|
There is no concurrency control about tag files.
|
|
.Sh AUTHORS
|
|
Shigio Yamaguchi (shigio@wafu.netgate.net)
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
command appeared in FreeBSD 2.2.2.
|