Update draft release notes to 1.8.4
[git/mingw.git] / Documentation / git-var.txt
blob44ff9541df1f5dd432d37b5828bfb800f66dfae8
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 the default chosen at compile
47     time, which is usually 'vi'.
48 ifdef::git-default-editor[]
49     The build you are using chose '{git-default-editor}' as the default.
50 endif::git-default-editor[]
52 GIT_PAGER::
53     Text viewer for use by Git commands (e.g., 'less').  The value
54     is meant to be interpreted by the shell.  The order of preference
55     is the `$GIT_PAGER` environment variable, then `core.pager`
56     configuration, then `$PAGER`, and then the default chosen at
57     compile time (usually 'less').
58 ifdef::git-default-pager[]
59     The build you are using chose '{git-default-pager}' as the default.
60 endif::git-default-pager[]
62 SEE ALSO
63 --------
64 linkgit:git-commit-tree[1]
65 linkgit:git-tag[1]
66 linkgit:git-config[1]
68 GIT
69 ---
70 Part of the linkgit:git[1] suite