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 [-bdenrstvw] 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 function definitions, function references and other symbols.
20
21       Files whose names end in ´.c´ or ´.h´ are assumed to be C source  files
22       and  are  searched  for  C  style routine and macro definitions.  Files
23       whose names end in ´.c++´ ´.cc´ ´.cpp´ ´.cxx´ ´.hxx´ ´.hpp´  ´.C´  ´.H´
24       are  assumed to be C++ source files.  Files whose names end in ´.y´ are
25       assumed to be YACC source files.  Files whose names end in ´.java´  are
26       assumed  to  be  Java  source  files.   Files whose names end in ´.php´
27       ´.php3´ ´.phtml´ are assumed to be PHP source files.  Files whose names
28       end  in  ´.s´  or ´.S´ are assumed to be Assembler source files.  Other
29       files are searched for C style definitions.
30
31       Yacc files each have a special tag. yyparse is the start of the  second
32       section of the yacc file.
33
34       This command is the default parser of GLOBAL source code tag system.
35

OPTIONS

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

DIAGNOSTICS

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

SEE ALSO

87       global(1), gtags(1), htags(1).
88
89       GNU GLOBAL source code tag system
90       (http://www.gnu.org/software/global/).
91

BUG

93       Gtags-parser relies on the input being well formed, and any syntactical
94       errors will completely confuse it.
95
96       Assembler  support is far from complete.  Probably valid only for Free‐
97       BSD and Linux kernel source.
98

AUTHOR

100       Tama Communications Corporation.
101

HISTORY

103       The gtags-parser(gctags) command appeared in FreeBSD 2.2.2.
104
105
106
107GNU Project                        May 2004                    GTAGS-PARSER(1)
Impressum