"Fossies" - the Fresh Open Source Software Archive

Member "global-6.6.5/doc/gtags.conf.ref" (3 Sep 2020, 4098 Bytes) of package /linux/misc/global-6.6.5.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "gtags.conf.ref": 6.6.4_vs_6.6.5.

    1 @c This file is generated automatically by convert.pl from libutil/manual.in.
    2 @unnumberedsubsec NAME
    3 gtags.conf - configuration data for GNU GLOBAL
    4 @unnumberedsubsec SYNOPSIS
    5 @quotation
    6 @file{gtags.conf}@*
    7 @file{~/.globalrc}@*
    8 @end quotation
    9 @unnumberedsubsec DESCRIPTION
   10 @file{gtags.conf} has configuration data for global(1), gozilla(1),
   11 gtags(1) and htags(1). They look for the following files in this order,
   12 and read from the first one that exists and is readable.
   13 @table @asis
   14 @item (1) --gtagsconf file
   15 @item (2) $GTAGSCONF
   16 @item (3) [project root]/gtags.conf
   17 @item (4) [project root]/[objdir]/gtags.conf
   18 @item (5) $HOME/.globalrc
   19 @item (6) /etc/gtags.conf
   20 @item (7) [sysconfdir]/gtags.conf
   21 @end table
   22 
   23 [sysconfdir] is @file{/usr/local/etc} by default; you can change it by the --sysconfdir
   24 option of the configure script. [objdir] is @file{obj} by default; you can change it
   25 by @var{GTAGSOBJDIR} or @var{MAKEOBJDIR}.
   26 
   27 Its syntax is similar to termcap(5) except for some extensions described later.
   28 A file includes one or more records. You should select a record using a label.
   29 Default label is @samp{default}. If @var{GTAGSLABEL} is set, its value is used.
   30 Please be aware the meaning of @samp{default} is different from that of termcap(5).
   31 
   32 Lines starting with @samp{#} are ignored.
   33 A record consists of one or more fields separated by @samp{:} and ends with a newline.
   34 The first field must have a label name. Each field of the rest has a variable definition.
   35 There are three types in those variables.
   36 @table @asis
   37 @item Boolean: This type has no value; existence of variable means true else false.
   38 @item Number: This type has a number value after @samp{#}.
   39 @item String: This type has a string value after @samp{=}.
   40 @end table
   41 Most variables are relevant to string type.
   42 
   43 If data includes @samp{:} or newline, you need to quote it by @samp{\}.
   44 An empty field is permitted, but it doesn't make sense.
   45 
   46 When there is more than one definition, the previous one is adopted. 
   47 Exceptionally, all values of skip, langmap and gtags_parser are
   48 adopted and connected respectively.
   49 @unnumberedsubsec Variable substitution
   50 Variable substitution similar to sh(1) is available.
   51 You can refer to any string variable using @samp{$} prefix. For example, the following
   52 b has a value @samp{XYZ}.
   53 @example
   54 :a=Y:b=X$@{a@}Z:
   55 @end example
   56 @unnumberedsubsec Including another record
   57 Tc is a special variable; it reads in definitions in another record.
   58 It is similar to the tc of termcap(5).
   59 Its syntax is as follows:@*
   60 tc=label[@@file]@*
   61 If only a label is given, tc is read from a record specified by the label
   62 in the same file. If @@file is also given, tc is read from a record
   63 specified by the label in the specified file.
   64 File should be an absolute path, and should not include variables.
   65 Different from termcap(5), you can use tc anytime anywhere.
   66 @unnumberedsubsec CONFIGURATION
   67 About variables for each command, please see each manual.
   68 
   69 You can use the following environment variables as a string variable.
   70 If these variables are set then environment variables of the same name are set before
   71 command execution.@*
   72 GREP_COLOR@*
   73 GREP_COLORS@*
   74 GTAGSBLANKENCODE@*
   75 GTAGSCACHE@*
   76 GTAGSFORCECPP@*
   77 GTAGSGLOBAL@*
   78 GTAGSGTAGS@*
   79 GTAGSLIBPATH@*
   80 GTAGSLOGGING@*
   81 GTAGSTHROUGH@*
   82 GTAGS_OPTIONS@*
   83 HTAGS_OPTIONS@*
   84 MAKEOBJDIR@*
   85 MAKEOBJDIRPREFIX@*
   86 TMPDIR@*
   87 
   88 The following variables are also available as a string variable.
   89 By default, each of them has a directory path given by the configure
   90 script.@*
   91 bindir@*
   92 datadir@*
   93 libdir@*
   94 localstatedir@*
   95 sysconfdir@*
   96 @unnumberedsubsec ENVIRONMENT
   97 The following environment variables affect the execution of the commands.
   98 
   99 @table @asis
  100 @item @var{GTAGSCONF}
  101 If this variable is set, the value is used as a configuration file.
  102 @item @var{GTAGSLABEL}
  103 If this variable is set, the value is used as a label of the configuration file.
  104 The default is default.
  105 @end table
  106 @unnumberedsubsec SEE ALSO
  107 global(1),
  108 gozilla(1),
  109 gtags(1),
  110 htags(1).
  111 
  112 GNU GLOBAL source code tag system@*
  113 (http://www.gnu.org/software/global/).
  114 @unnumberedsubsec HISTORY
  115 The gtags.conf file appeared in GLOBAL-3.0 (1998).