Merge branch 'cb/maint-orphan-merge-noclobber'
[git/kirr.git] / Documentation / git-var.txt
blob458f3e2755fcc6431757af6178942ef756f6a5bd
1 git-var(1)
2 ==========
4 NAME
5 ----
6 git-var - Show a git logical variable
9 SYNOPSIS
10 --------
11 'git var' ( -l | <variable> )
13 DESCRIPTION
14 -----------
15 Prints a git logical variable.
17 OPTIONS
18 -------
19 -l::
20         Cause the logical variables to be listed. In addition, all the
21         variables of the git configuration file .git/config are listed
22         as well. (However, the configuration variables listing functionality
23         is deprecated in favor of `git config -l`.)
25 EXAMPLE
26 --------
27         $ git var GIT_AUTHOR_IDENT
28         Eric W. Biederman <ebiederm@lnxi.com> 1121223278 -0600
31 VARIABLES
32 ----------
33 GIT_AUTHOR_IDENT::
34     The author of a piece of code.
36 GIT_COMMITTER_IDENT::
37     The person who put a piece of code into git.
39 GIT_EDITOR::
40     Text editor for use by git commands.  The value is meant to be
41     interpreted by the shell when it is used.  Examples: `~/bin/vi`,
42     `$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe"
43     --nofork`.  The order of preference is the `$GIT_EDITOR`
44     environment variable, then `core.editor` configuration, then
45     `$VISUAL`, then `$EDITOR`, and then finally 'vi'.
47 GIT_PAGER::
48     Text viewer for use by git commands (e.g., 'less').  The value
49     is meant to be interpreted by the shell.  The order of preference
50     is the `$GIT_PAGER` environment variable, then `core.pager`
51     configuration, then `$PAGER`, and then finally 'less'.
53 Diagnostics
54 -----------
55 You don't exist. Go away!::
56     The passwd(5) gecos field couldn't be read
57 Your parents must have hated you!::
58     The passwd(5) gecos field is longer than a giant static buffer.
59 Your sysadmin must hate you!::
60     The passwd(5) name field is longer than a giant static buffer.
62 SEE ALSO
63 --------
64 linkgit:git-commit-tree[1]
65 linkgit:git-tag[1]
66 linkgit:git-config[1]
68 Author
69 ------
70 Written by Eric Biederman <ebiederm@xmission.com>
72 Documentation
73 --------------
74 Documentation by Eric Biederman and the git-list <git@vger.kernel.org>.
76 GIT
77 ---
78 Part of the linkgit:git[1] suite