gtags-parser(1)

1GTAGS-PARSER(1)             General Commands Manual            GTAGS-PARSER(1)
2
3
4

NAME

6       gtags-parser - print cross reference list for gtags.
7

SYNOPSIS

9       gtags-parser [-bdenqrstvw] file ...
10

DESCRIPTION

12       Gtags-parser print cross reference list for gtags(1) from the specified
13       C, C++, yacc, java, PHP and Assembly source to standard  output.   Each
14       line  of  output  contains  the  object  name, the line number which it
15       appears, the file in which it is defined, and a line image separated by
16       white-space.  It's same with the output of ctags(1) with -x option.
17
18       Depending  upon the options provided to gtags-parser, objects will con‐
19       sist of object definitions, object references and other symbols.
20
21       Files whose names end in ´.c´ or ´.h´ are assumed to be C source files.
22       Files  whose names end in ´.c++´ ´.cc´ ´.cpp´ ´.cxx´ ´.hxx´ ´.hpp´ ´.C´
23       ´.H´ are assumed to be C++ source files.  Files whose names end in ´.y´
24       are  assumed to be YACC source files.  Files whose names end in ´.java´
25       are assumed to be Java source files.  Files whose names end  in  ´.php´
26       ´.php3´ ´.phtml´ are assumed to be PHP source files.  Files whose names
27       end in ´.s´ or ´.S´ are assumed to be  Assembly  source  files.   Other
28       files are searched for C style definitions.
29
30       Yacc  files each have a special tag. yyparse is the start of the second
31       section of the yacc file.
32
33       This command is the default parser of GLOBAL source code tag system.
34

OPTIONS

36       The following options are available:
37
38       -b, --begin-block
39              Force level 1 block to begin when reach the left  brace  at  the
40              first column.  (C only)
41
42       -e, --end-block
43              Force  level  1  block  to end when reach the right brace at the
44              first column.  (C only)
45
46       -n, --no-tags
47              Suppress output of tags. It is useful to use with -w option.
48
49       -q, --quiet
50              Quiet mode.
51
52       -r, --reference
53              Locate object references instead of object definitions.  ´GTAGS´
54              is  needed  at  the  current directory.  (C, C++ and Java source
55              only) By default, locate object definitions.
56
57       -s, --symbol
58              Collect symbols other than object  definitions  and  references.
59              By default, locate object definitions.
60
61       -v, --verbose
62              Verbose mode.
63
64       -w, --warning
65              Print warning message.
66
67       --langmap=map
68              Language  mapping.  Each  comma-separated   map  consists of the
69              language name, a colon, and a list of file extensions.   Default
70              mapping                                                       is
71              'c:.c.h,yacc:.y,asm:.s.S,java:.java,cpp:.c++.cc.cpp.cxx.hxx.hpp.C.H,php:.php.php3.phtml'.
72
73       The  -r  and  -s  options  override  each other; the last one specified
74       determines the method used.
75

ENVIRONMENT

77       The following environment variables  affect  the  execution  of  gtags-
78       parser:
79
80       GTAGSFORCECPP
81              If  this  variable  is  set,  each  file  whose suffix is 'h' is
82              treated as a C++ source file.
83

DIAGNOSTICS

85       Gtags-parser exits with a non 0 value if an error  occurred,  0  other‐
86       wise.  Duplicate objects are not considered errors.
87

BUG

95       Gtags-parser relies on the input being well formed, and any syntactical
96       errors will completely confuse it.
97

AUTHOR

99       Tama Communications Corporation.
100

HISTORY

102       The gtags-parser(gctags) command appeared in FreeBSD 2.2.2.
103
104
105
106GNU Project                       March 2008                   GTAGS-PARSER(1)