1 /* This file is generated automatically by convert.pl from global/manual.in. */ 2 const char *progname = "global"; 3 const char *usage_const = "Usage: global [-adEFGilMnNqrstTvx][-S dir][-e] pattern\n\ 4 global -c[dFiIMoOPrsT] prefix\n\ 5 global -f[adlnqrstvx][-L file-list][-S dir] files\n\ 6 global -g[aEGilMnoOqtvVx][-L file-list][-S dir][-e] pattern [files]\n\ 7 global -I[ailMnqtvx][-S dir][-e] pattern\n\ 8 global -P[aEGilMnoOqtvVx][-S dir][-e] pattern\n\ 9 global -p[qrv]\n\ 10 global -u[qv]\n"; 11 const char *help_const = "Commands:\n\ 12 <no command> pattern\n\ 13 No command means tag search command.\n\ 14 Print tags which match to pattern.\n\ 15 By default, print definition tags.\n\ 16 -c, --completion [prefix]\n\ 17 Print symbols which start with prefix.\n\ 18 If prefix is not given, print all symbols.\n\ 19 -f, --file files\n\ 20 Print all tags in the files.\n\ 21 This command implies the -x option.\n\ 22 -g, --grep pattern [files]\n\ 23 Print all lines which match to the pattern.\n\ 24 If files are given, this command searches in those files.\n\ 25 --help\n\ 26 Print a usage message.\n\ 27 -I, --idutils pattern\n\ 28 Print all lines which match to pattern.\n\ 29 This function uses idutils(1) as a search engine.\n\ 30 To use this command, you need to install idutils(1)\n\ 31 in your system and execute gtags(1) with the -I option.\n\ 32 -P, --path [pattern]\n\ 33 Print path names which match to pattern.\n\ 34 If no pattern is given, print all paths in the project.\n\ 35 -p, --print-dbpath\n\ 36 Print location of GTAGS.\n\ 37 --print name\n\ 38 Print location of name, which may be one of:\n\ 39 root, dbpath or conf.\n\ 40 root means project's root directory. dbpath means a directory\n\ 41 where tag databases exist. conf means configuration file.\n\ 42 -u, --update\n\ 43 Update tag files incrementally.\n\ 44 This command internally invokes gtags(1).\n\ 45 You can execute this command anywhere in the project,\n\ 46 differing from gtags(1).\n\ 47 --version\n\ 48 Show version number.\n\ 49 Options:\n\ 50 -a, --absolute\n\ 51 Print absolute path names. By default, print relative path names.\n\ 52 --color when\n\ 53 Use color to highlight the pattern within the line; when may be one of:\n\ 54 never, always or auto (default).\n\ 55 The default color is bold red text on current background; the environment\n\ 56 variable GREP_COLORS (only mt and ms are effective at present)\n\ 57 or GREP_COLOR defines it.\n\ 58 This option is effective to the following commands:\n\ 59 <no command>, -f, -g, -I, -P.\n\ 60 -C, --directory dir\n\ 61 Change the directory before doing all the work including parameter analysis.\n\ 62 -d, --definition\n\ 63 Print locations of definitions.\n\ 64 -e, --regexp pattern\n\ 65 Use pattern as the pattern; useful to protect patterns starting with -.\n\ 66 -E, --extended-regexp\n\ 67 Interpret pattern as a extended regular expression.\n\ 68 This is the default.\n\ 69 --encode-path chars\n\ 70 Convert path characters in chars into a % symbol, followed by the\n\ 71 two-digit hexadecimal representation of the character.\n\ 72 A blank will be converted to %20.\n\ 73 -F, --first-match\n\ 74 End the search without going through all the tag files listed in\n\ 75 GTAGSLIBPATH when tags are found in a tag file. This is the default.\n\ 76 --from-here context\n\ 77 Decide tag type by context. Its syntax should be lineno:path.\n\ 78 If the context is a definition of the pattern then use -r, else if\n\ 79 there is at least one definition of the pattern then use -d,\n\ 80 else use -s.\n\ 81 If this option is specified then -d, -r and -s\n\ 82 on the command line are ignored.\n\ 83 Regular expression is not allowed for pattern.\n\ 84 This option assumes use in conversational environments such as\n\ 85 editors and IDEs.\n\ 86 -G, --basic-regexp\n\ 87 Interpret pattern as a basic regular expression.\n\ 88 The default is an extended regular expression.\n\ 89 --gtagsconf file\n\ 90 Set environment variable GTAGSCONF to file.\n\ 91 --gtagslabel label\n\ 92 Set environment variable GTAGSLABEL to label.\n\ 93 -i, --ignore-case\n\ 94 Ignore case distinctions in the pattern.\n\ 95 -L, --file-list file\n\ 96 Obtain files from file in addition to the arguments.\n\ 97 The argument file can be set to '-' to accept a list of files\n\ 98 from the standard input. File names must be separated by newline.\n\ 99 -l, --local\n\ 100 Print only tags which exist under the current directory.\n\ 101 --literal\n\ 102 Execute literal search instead of regular expression search.\n\ 103 This option works with the tag search command, -g command, \n\ 104 -P command and -I command.\n\ 105 -M, --match-case\n\ 106 Search is case-sensitive. This is the default.\n\ 107 --match-part part\n\ 108 Specify how path name completion should match, where part is one of:\n\ 109 first, last or all (default).\n\ 110 This option is valid only with the -c command in conjunction with -P.\n\ 111 -n, --nofilter\n\ 112 Suppress sort filter and path conversion filter.\n\ 113 -N, --nearness[=start]\n\ 114 Use Nearness sort method (sorting by closest from start) for the output.\n\ 115 By default, alphabetical sort method is used.\n\ 116 This option is effective for the tag search command, -P command\n\ 117 and -g command. As an exception, -g command ignores this\n\ 118 option when files are specified by arguments.\n\ 119 The nearness is defined by how many parent directories to go up to reach\n\ 120 the target. The result of nearness sort is concatenation of the following\n\ 121 ([0]-[n]) in this order. The default of start is the current directory.\n\ 122 \n\ 123 [0] If the start is a file, output of local search in the file.\n\ 124 [1] Output of local search in the start directory except for [0].\n\ 125 [2] Output of local search in the parent directory except for [0]-[1].\n\ 126 [3] Output of local search in the grandparent directory except for [0]-[2].\n\ 127 ... (repeat until the project root directory)\n\ 128 [n] Output of local search in the project root directory except for [0]-[n-1].\n\ 129 \n\ 130 In each directory, they are sorted by alphabetical order.\n\ 131 -O, --only-other\n\ 132 Treat only text files other than source code, like README.\n\ 133 This option is valid only with the -g or -P command.\n\ 134 This option overrides the -o option.\n\ 135 -o, --other\n\ 136 Treat not only source files but also text files other than source code,\n\ 137 like README.\n\ 138 This option is valid only with the -g or -P command.\n\ 139 --path-style format\n\ 140 Print path names using format, which may be one of:\n\ 141 relative, absolute, shorter, abslib or through.\n\ 142 relative means relative path. absolute means absolute path.\n\ 143 shorter means the shorter one of relative and absolute path.\n\ 144 abslib means absolute path for libraries (GTAGSLIBPATH) and relative path\n\ 145 for the rest.\n\ 146 through means the relative path from the project root directory\n\ 147 (internal format of GPATH).\n\ 148 The default is relative.\n\ 149 The --path-style option is given more priority than the -a option.\n\ 150 --print0\n\ 151 Print each record followed by a null character instead of a newline.\n\ 152 -q, --quiet\n\ 153 Quiet mode.\n\ 154 -r, --reference, --rootdir\n\ 155 Print reference tags.\n\ 156 Reference means the reference to a symbol which has definitions.\n\ 157 With the -p option, print the root directory of the project.\n\ 158 --result format\n\ 159 Print out using format, which may be one of:\n\ 160 path (default), ctags, ctags-x, grep or cscope.\n\ 161 The --result=ctags and --result=ctags-x options are\n\ 162 equivalent to the -t and -x options respectively.\n\ 163 The --result option is given more priority than the -t and -x options.\n\ 164 --single-update file\n\ 165 Update tag files using gtags(1) with the --single-update option.\n\ 166 It is considered that file was added, updated or deleted,\n\ 167 and there is no change in other files.\n\ 168 This option implies the -u option.\n\ 169 -s, --symbol\n\ 170 Print other symbol tags.\n\ 171 Other symbol means the reference to a symbol which has no definition.\n\ 172 -S, --scope dir\n\ 173 Print only tags which exist under dir directory.\n\ 174 It is similar to the -l option, but you need not change directory.\n\ 175 -T, --through\n\ 176 Go through all the tag files listed in GTAGSLIBPATH.\n\ 177 By default, stop searching when tag is found.\n\ 178 This option is ignored when either -s, -r\n\ 179 or -l option is specified.\n\ 180 -t, --tags\n\ 181 Use standard ctags format.\n\ 182 -V, --invert-match\n\ 183 Invert the sense of matching, to select non-matching lines.\n\ 184 This option is valid only with the -g or -P commands.\n\ 185 -v, --verbose\n\ 186 Verbose mode.\n\ 187 -x, --cxref\n\ 188 Use standard ctags cxref (with -x) format.\n\ 189 See also:\n\ 190 GNU GLOBAL web site: http://www.gnu.org/software/global/\n\ 191 "; 192