global-6.6.5.tar.gz: global-6.6.5/libutil/manual.in

"Fossies" - the Fresh Open Source Software Archive

Member "global-6.6.5/libutil/manual.in" (3 Sep 2020, 5119 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 "manual.in":

6.6.4_vs_6.6.5.

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