GLOBAL(1)

💅 GLOBAL(1) — bestie, it's the global manual 💅

so this is GLOBAL(1), filed under General Commands Manual, and it's the whole vibe guide to global — the tool that finds where your symbols live. buckle up, it's long, but we're getting through it together 🫶

---

🎀 NAME 🎀

global — print locations of given symbols ✨

---

🦋 SYNOPSIS 🦋

global [-adEFGilMnNqrstTvx][-S dir][-e] pattern
global -c[dFiIMoOPqrsTv] prefix
global -f[adlnqrstvx][-L file-list][-S dir] files
global -g[aEGilMnoOqtvVx][-L file-list][-S dir][-e] pattern [files]
global -I[ailMnqtvx][-S dir][-e] pattern
global -P[aEGilMnoOqtvVx][-S dir][-e] pattern
global -p[qrv]
global -u[qv]

---

✨ DESCRIPTION ✨

global finds locations of given symbols in C, Yacc, Java, PHP and assembly source files, and it prints the path name, the line number and the line image of those locations. and no, it's not just definitions — global can locate references and other symbols too. versatile queen 👑

global can treat a source tree — that's a directory that has sub-directories and source files — as a project. but listen: before you use this command, you must run gtags(1) at the root directory of the project you want to investigate, to make tag files. do that first, fr fr. after that you can use the global command anywhere in the project — you don't have to tell it where the tag file is, it locates it by itself. self-sufficient icon 💅

you can specify a regular expression for pattern. global understands two different versions of regular expression syntax: basic and extended (that one's the default). iykyk 🌈

---

💖 COMMANDS 💖

the following commands are available:

• <no command> pattern — no command means the tag search command. prints tags which match pattern. by default, it prints definition tags.
• -c, --completion[=limit] [prefix] — print symbols which start with prefix. if prefix isn't given, print all symbols. if limit is given, print up to limit lines. ✨
• -f, --file files — print all tags in the files. this command implies the -x option.
• -g, --grep pattern [files] — print all lines which match the pattern. if files are given, this command searches in those files. 🔍
• --help — print a usage message.
• -I, --idutils pattern — print all lines which match to pattern. this function uses idutils(1) as a search engine. to use this command, you need to install idutils(1) in your system and execute gtags(1) with the -I option. (yes, both. no shortcuts 🫠)
• -P, --path [pattern] — print path names which match to pattern. if no pattern is given, print all paths in the project.
• -p, --print-dbpath — print location of GTAGS.
• --print name — print location of name, which may be one of: root, dbpath or conf. root means project's root directory. dbpath means a directory where tag databases exist. conf means configuration file.
• -u, --update — update tag files incrementally. this command internally invokes gtags(1). you can execute this command anywhere in the project — differing from gtags(1). iconic behaviour honestly 💅
• --version — show version number.

---

🌸 OPTIONS 🌸

the following options are available:

• -a, --absolute — print absolute path names. by default, it prints relative path names.
• --color when — use color to highlight the pattern within the line; when may be one of: never, always or auto (default). the default color is bold red text on current background; the environment variable GREP_COLORS (only mt and ms are effective at present) or GREP_COLOR defines it. this option is effective to the following commands: <no command>, -f, -g, -I, -P. 🌈
• -C, --directory dir — change the directory before doing all the work, including parameter analysis.
• -d, --definition — print locations of definitions.
• -e, --regexp pattern — use pattern as the pattern; useful to protect patterns starting with -. (protect her 🥺)
• -E, --extended-regexp — interpret pattern as a extended regular expression. this is the default.
• --encode-path chars — convert path characters in chars into a % symbol, followed by the two-digit hexadecimal representation of the character. a blank will be converted to %20.
• -F, --first-match — end the search without going through all the tag files listed in GTAGSLIBPATH when tags are found in a tag file. this is the default.
• --from-here context — decide tag type by context. its syntax should be lineno:path. if the context is a definition of the pattern then use -r, else if there is at least one definition of the pattern then use -d, else use -s. if this option is specified then -d, -r and -s on the command line are ignored. regular expression is not allowed for pattern. this option assumes use in conversational environments such as editors and IDEs. 🧠
• -G, --basic-regexp — interpret pattern as a basic regular expression. the default is an extended regular expression.
• --gtagsconf file — set environment variable GTAGSCONF to file.
• --gtagslabel label — set environment variable GTAGSLABEL to label.
• -i, --ignore-case — ignore case distinctions in the pattern.
• -L, --file-list file — obtain files from file in addition to the arguments. the argument file can be set to - to accept a list of files from the standard input. file names must be separated by newline.
• -l, --local — print only tags which exist under the current directory.
• --literal — execute literal search instead of regular expression search. this option works with the tag search command, -g command, -P command and -I command.
• -M, --match-case — search is case-sensitive. this is the default.
• --match-part part — specify how path name completion should match, where part is one of: first, last or all (default). this option is valid only with the -c command in conjunction with -P.
• -n, --nofilter — suppress sort filter and path conversion filter.
• -N, --nearness[=start] — use Nearness sort method (sorting by closest from start) for the output. by default, alphabetical sort method is used. this option is effective for the tag search command, -P command and -g command. as an exception, -g command ignores this option when files are specified by arguments. the nearness is defined by how many parent directories to go up to reach the target. the result of nearness sort is concatenation of the following ([0]-[n]) in this order. the default of start is the current directory.
  • [0] If the start is a file, output of local search in the file.
  • [1] Output of local search in the start directory except for [0].
  • [2] Output of local search in the parent directory except for [0]-[1].
  • [3] Output of local search in the grandparent directory except for [0]-[2].
  • ... (repeat until the project root directory)
  • [n] Output of local search in the project root directory except for [0]-[n-1].

in each directory, they are sorted by alphabetical order.

• -O, --only-other — treat only text files other than source code, like README. this option is valid only with the -g or -P command. this option overrides the -o option. 🚨
• -o, --other — treat not only source files but also text files other than source code, like README. this option is valid only with the -g or -P command.
• --path-style format — print path names using format, which may be one of: relative, absolute, shorter, abslib or through. relative means relative path. absolute means absolute path. shorter means the shorter one of relative and absolute path. abslib means absolute path for libraries (GTAGSLIBPATH) and relative path for the rest. through means the relative path from the project root directory (internal format of GPATH). when this style is used, GTAGSLIBPATH is ignored. the default is relative. the --path-style option is given more priority than the -a option.
• --print0 — print each record followed by a null character instead of a newline.
• -q, --quiet — quiet mode. 🤫
• -r, --reference, --rootdir — print reference tags. reference means the reference to a symbol which has definitions. with the -p option, print the root directory of the project.
• --result format — print out using format, which may be one of: path (default), ctags, ctags-x, grep or cscope. the --result=ctags and --result=ctags-x options are equivalent to the -t and -x options respectively. the --result option is given more priority than the -t and -x options.
• --single-update file — update tag files using gtags(1) with the --single-update option. it is considered that file was added, updated or deleted, and there is no change in other files. this option implies the -u option.
• -s, --symbol — print other symbol tags. other symbol means the reference to a symbol which has no definition.
• -S, --scope dir — print only tags which exist under dir directory. it is similar to the -l option, but you need not change directory. 💫
• -T, --through — go through all the tag files listed in GTAGSLIBPATH. by default, stop searching when tag is found. this option is ignored when either -s, -r or -l option is specified.
• -t, --tags — use standard ctags format.
• -V, --invert-match — invert the sense of matching, to select non-matching lines. this option is valid only with the -g or -P commands.
• -v, --verbose — verbose mode. (she's chatty 💬)
• -x, --cxref — use standard ctags cxref (with -x) format.

✨ EXAMPLES ✨

Okay bestie, storytime 📖✨ here's the whole vibe in action. Imagine a project with Makefile, src/, lib/ — you run gtags, and boom 💥 tag files appear. Watch:

$ ls -F
Makefile      src/    lib/
$ gtags
$ ls G*
GPATH   GRTAGS  GTAGS
$ global main
src/main.c
$ (cd src; global main)
main.c
$ global -x main
main              10 src/main.c  main (argc, argv) {
$ global -f src/main.c
main              10 src/main.c  main (argc, argv) {
func1             55 src/main.c  func1() {
func2             72 src/main.c  func2() {
func3            120 src/main.c  func3() {
$ global -x '^[sg]et'
set_num           20 lib/util.c  set_num(values) {
get_num           30 lib/util.c  get_num() {
$ global -rx set_num
set_num          113 src/op.c            set_num(32);
set_num          225 src/opop.c               if (set_num(0) > 0) {
$ global strlen
$ (cd /usr/src/sys; gtags)
$ export GTAGSLIBPATH=/usr/src/sys
$ global -a strlen
/usr/src/sys/libkern/strlen.c
$ (cd /usr/src/lib; gtags)
$ GTAGSLIBPATH=/usr/src/lib:/usr/src/sys
$ global -a strlen
/usr/src/lib/libc/string/strlen.c

Like, the way it searches from a subdir and then uses GTAGSLIBPATH for library functions? Obsessed, fr fr 🫶

---

📁 FILES 📁

• GTAGS — tag file for definitions. The main character of the tag trio 👑
• GRTAGS — tag file for references.
• GPATH — tag file for source files.
• GTAGSROOT — if environment variable GTAGSROOT is not set and file GTAGSROOT exists in the same directory as GTAGS then global sets GTAGSROOT to the contents of the file.
• gtags.conf, $HOME/.globalrc — configuration data for GNU Global. See gtags.conf(5).

---

🌱 ENVIRONMENT 🌱

The following environment variables affect the execution of global:

• GREP_COLOR — the color to use for --color; GREP_COLORS has precedence.
• GREP_COLORS — the color (mt or ms) to use for --color; see grep(1).
• GTAGSBLANKENCODE — if this variable is set, the --encode-path=" <TAB>" option is specified.
• GTAGSCACHE — the size of the B-tree cache. The default is 50000000 (bytes).
• GTAGSCONF — configuration file.
• GTAGSDBPATH — the directory in which the tag files exist. This value is ignored when GTAGSROOT is not defined. Use of this variable is not recommended 🙅‍♀️
• GTAGSFORCECPP — if this variable is set, each file whose suffix is .h is treated as a C++ source file.
• GTAGSLABEL — configuration label. The default is default.
• GTAGSLIBPATH — if this variable is set, it is used as the path to search for library functions. If the given symbol is not found in the current project, global also searches in these paths. Since only GTAGS is targeted in the retrieval, this variable is ignored when -r or -s is specified.
• GTAGSLOGGING — if this variable is set, $GTAGSLOGGING is used as the path name of a log file. There is no default value.
• GTAGSROOT — the root directory of the project. Usually, it is recognized by existence of GTAGS. Use of this variable is not recommended 🙅‍♀️
• GTAGSTHROUGH — if this variable is set, the -T option is specified.
• GTAGSOBJDIR, MAKEOBJDIR — if eigher of the two variable is set, it is used as the name of BSD-style objdir. The former is given priority. The default is obj.
• GTAGSOBJDIRPREFIX, MAKEOBJDIRPREFIX — if eigher of the two variable is set, it is used as the prefix of BSD-style objdir. The former is given priority. The default is /usr/obj.

---

⚙️ CONFIGURATION ⚙️

The following configuration variables affect the execution of global:

• icase_path (boolean) — ignore case distinctions in pattern.

---

🩺 DIAGNOSTICS 🩺

Global exits with a non-0 value if an error occurred, 0 otherwise. So zero is the slay, non-zero is the "bestie we have a problem" 💀

---

👀 SEE ALSO 👀

• gtags(1), htags(1), less(1), gtags.conf(5).
• GNU Global source code tag system (http://www.gnu.org/software/global/).

---

👑 AUTHOR 👑

Shigio YAMAGUCHI, Hideki IWAMOTO and others.

---

📜 HISTORY 📜

The global command appeared in FreeBSD 2.2.2.

---

That's the whole page, bestie! This gem is from the GNU Project, dated May 2015, and it's GLOBAL(1) — periodt 💅✨