aboutsummaryrefslogtreecommitdiff
path: root/contrib/global/gtags/gtags.1
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/global/gtags/gtags.1')
-rw-r--r--contrib/global/gtags/gtags.123
1 files changed, 15 insertions, 8 deletions
diff --git a/contrib/global/gtags/gtags.1 b/contrib/global/gtags/gtags.1
index ed18616528d3..e6b09e69bc6e 100644
--- a/contrib/global/gtags/gtags.1
+++ b/contrib/global/gtags/gtags.1
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 1996, 1997 Shigio Yamaguchi. All rights reserved.
+.\" Copyright (c) 1996, 1997, 1998 Shigio Yamaguchi. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@@ -28,26 +28,28 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd Sep 12, 1997
+.Dd Oct 10, 1998
.Dt GTAGS 1
.Os BSD 4
.Sh NAME
.Nm gtags
-.Nd create GTAGS, GRTAGS and GSYMS file
+.Nd create tag files for global.
.Sh SYNOPSIS
.Nm gtags
+.Op Fl c
.Op Fl i
.Op Fl o
+.Op Fl w
.Op Fl v
.Op Ar dbpath
.Sh DESCRIPTION
.Nm Gtags
-makes GTAGS, GRTAGS and GSYMS file for
+makes GTAGS, GRTAGS, GSYMS and GPATH 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.
+C, yacc, java 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
@@ -55,13 +57,16 @@ If your source directory is on a read only device like CDROM, specify
of the directory on which make tag files.
.Pp
.Bl -tag -width Ds
+.It Fl c
+make tag files with compact format.
.It Fl i
-update tag files incrementally by files which modified after the tag files were
-last updated.
+update tag files incrementally.
.It Fl o
suppress making GSYMS file.
Use this option if you don't use -s option of
.Xr global 1 .
+.It Fl w
+print warning messages.
.It Fl v
verbose mode.
.Sh FILES
@@ -72,6 +77,8 @@ tag file for function definitions.
tag file for function references.
.It Pa GSYMS
tag file for other symbols.
+.It Pa GPATH
+path index file which is used for incremental updating and compact format.
.El
.Sh DIAGNOSTICS
.Nm Gtags
@@ -85,7 +92,7 @@ exits with a non 0 value if an error occurred, 0 otherwise.
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()
+Assembler support is far from complete. It extracts only ENTRY()
and ALTENTRY() from source file. Probably valid only for FreeBSD and Linux
kernel source.
.br