gitweb: Pass esc_html_hl_regions() options to esc_html()
[git/jnareb-git.git] / Documentation / git-var.txt
blob5317cc247454b1a080b2609139befeba487d5ff5
1 git-var(1)
2 ==========
4 NAME
5 ----
6 git-var - Show a git logical variable
9 SYNOPSIS
10 --------
11 [verse]
12 'git var' ( -l | <variable> )
14 DESCRIPTION
15 -----------
16 Prints a git logical variable.
18 OPTIONS
19 -------
20 -l::
21         Cause the logical variables to be listed. In addition, all the
22         variables of the git configuration file .git/config are listed
23         as well. (However, the configuration variables listing functionality
24         is deprecated in favor of `git config -l`.)
26 EXAMPLE
27 --------
28         $ git var GIT_AUTHOR_IDENT
29         Eric W. Biederman <ebiederm@lnxi.com> 1121223278 -0600
32 VARIABLES
33 ----------
34 GIT_AUTHOR_IDENT::
35     The author of a piece of code.
37 GIT_COMMITTER_IDENT::
38     The person who put a piece of code into git.
40 GIT_EDITOR::
41     Text editor for use by git commands.  The value is meant to be
42     interpreted by the shell when it is used.  Examples: `~/bin/vi`,
43     `$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe"
44     --nofork`.  The order of preference is the `$GIT_EDITOR`
45     environment variable, then `core.editor` configuration, then
46     `$VISUAL`, then `$EDITOR`, and then finally 'vi'.
48 GIT_PAGER::
49     Text viewer for use by git commands (e.g., 'less').  The value
50     is meant to be interpreted by the shell.  The order of preference
51     is the `$GIT_PAGER` environment variable, then `core.pager`
52     configuration, then `$PAGER`, and then finally 'less'.
54 Diagnostics
55 -----------
56 You don't exist. Go away!::
57     The passwd(5) gecos field couldn't be read
58 Your parents must have hated you!::
59     The passwd(5) gecos field is longer than a giant static buffer.
60 Your sysadmin must hate you!::
61     The passwd(5) name field is longer than a giant static buffer.
63 SEE ALSO
64 --------
65 linkgit:git-commit-tree[1]
66 linkgit:git-tag[1]
67 linkgit:git-config[1]
69 GIT
70 ---
71 Part of the linkgit:git[1] suite