gtags.conf(5)

1GTAGS.CONF(5)                 File Formats Manual                GTAGS.CONF(5)
2
3
4

NAME

6       gtags.conf - configuration data for GNU GLOBAL
7

SYNOPSIS

9       ´gtags.conf´
10       ´~/.globalrc´
11

DESCRIPTION

13       ´gtags.conf´ has configuration data for global(1), gozilla(1), gtags(1)
14       and htags(1). They look for the following files in this order, and read
15       from the first one that exists and is readable.
16
17       (1) --gtagsconf file
18
19       (2) $GTAGSCONF
20
21       (3) [project root]/gtags.conf
22
23       (4) [project root]/[objdir]/gtags.conf
24
25       (5) $HOME/.globalrc
26
27       (6) /etc/gtags.conf
28
29       (7) [sysconfdir]/gtags.conf
30
31       [sysconfdir]  is  ´/usr/local/etc´ by default; you can change it by the
32       --sysconfdir option of the configure script. [objdir] is ´obj´  by  de‐
33       fault; you can change it by GTAGSOBJDIR or MAKEOBJDIR.
34
35       Its  syntax  is  similar  to  termcap(5) except for some extensions de‐
36       scribed later.  A file includes one or more records. You should  select
37       a  record  using a label.  Default label is ´default´. If GTAGSLABEL is
38       set, its value is used.  Please be aware the meaning  of  ´default´  is
39       different from that of termcap(5).
40
41       Lines  starting with ´#´ are ignored.  A record consists of one or more
42       fields separated by ´:´ and ends with a newline.  The first field  must
43       have  a  label  name. Each field of the rest has a variable definition.
44       There are three types in those variables.
45
46       Boolean: This type has no value; existence of variable means true  else
47       false.
48
49       Number: This type has a number value after ´#´.
50
51       String: This type has a string value after ´=´.
52              Most variables are relevant to string type.
53
54       If data includes ´:´ or newline, you need to quote it by ´\'.  An empty
55       field is permitted, but it doesn't make sense.
56
57       When there is more than one definition, the previous  one  is  adopted.
58       Exceptionally, all values of skip, langmap and gtags_parser are adopted
59       and connected respectively.
60

Variable substitution

62       Variable substitution similar to sh(1) is available.  You can refer  to
63       any  string variable using ´$´ prefix. For example, the following b has
64       a value ´XYZ´.
65       :a=Y:b=X${a}Z:
66

Including another record

68       Tc is a special variable; it reads in definitions  in  another  record.
69       It is similar to the tc of termcap(5).  Its syntax is as follows:
70       tc=label[@file]
71       If only a label is given, tc is read from a record specified by the la‐
72       bel in the same file. If @file is also given, tc is read from a  record
73       specified  by the label in the specified file.  File should be an abso‐
74       lute path, and should not  include  variables.   Different  from  term‐
75       cap(5), you can use tc anytime anywhere.
76

CONFIGURATION

78       About variables for each command, please see each manual.
79
80       You  can  use the following environment variables as a string variable.
81       If these variables are set then environment variables of the same  name
82       are set before command execution.
83       GREP_COLOR
84       GREP_COLORS
85       GTAGSBLANKENCODE
86       GTAGSCACHE
87       GTAGSFORCECPP
88       GTAGSGLOBAL
89       GTAGSGTAGS
90       GTAGSLIBPATH
91       GTAGSLOGGING
92       GTAGSTHROUGH
93       GTAGS_OPTIONS
94       HTAGS_OPTIONS
95       MAKEOBJDIR
96       MAKEOBJDIRPREFIX
97       TMPDIR
98
99       The  following  variables  are also available as a string variable.  By
100       default, each of them has a  directory  path  given  by  the  configure
101       script.
102       bindir
103       datadir
104       libdir
105       localstatedir
106       sysconfdir
107

ENVIRONMENT

109       The  following  environment  variables affect the execution of the com‐
110       mands.
111
112       GTAGSCONF
113              If this variable is set, the value is used  as  a  configuration
114              file.
115
116       GTAGSLABEL
117              If  this  variable  is  set, the value is used as a label of the
118              configuration file.  The default is default.
119

HISTORY

127       The gtags.conf file appeared in GLOBAL-3.0 (1998).
128
129
130
131GNU Project                        Nov 2015                      GTAGS.CONF(5)