summaryrefslogtreecommitdiff
path: root/Documentation/git-var.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-var.txt')
-rw-r--r--Documentation/git-var.txt50
1 files changed, 28 insertions, 22 deletions
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index e2f4c0901b..44ff9541df 100644
--- a/Documentation/git-var.txt
+++ b/Documentation/git-var.txt
@@ -3,24 +3,25 @@ git-var(1)
NAME
----
-git-var - Show a git logical variable
+git-var - Show a Git logical variable
SYNOPSIS
--------
-'git var' [ -l | <variable> ]
+[verse]
+'git var' ( -l | <variable> )
DESCRIPTION
-----------
-Prints a git logical variable.
+Prints a Git logical variable.
OPTIONS
-------
-l::
Cause the logical variables to be listed. In addition, all the
- variables of the git configuration file .git/config are listed
+ variables of the Git configuration file .git/config are listed
as well. (However, the configuration variables listing functionality
- is deprecated in favor of 'git config -l'.)
+ is deprecated in favor of `git config -l`.)
EXAMPLE
--------
@@ -34,16 +35,29 @@ GIT_AUTHOR_IDENT::
The author of a piece of code.
GIT_COMMITTER_IDENT::
- The person who put a piece of code into git.
+ The person who put a piece of code into Git.
-Diagnostics
------------
-You don't exist. Go away!::
- The passwd(5) gecos field couldn't be read
-Your parents must have hated you!::
- The passwd(5) gecos field is longer than a giant static buffer.
-Your sysadmin must hate you!::
- The passwd(5) name field is longer than a giant static buffer.
+GIT_EDITOR::
+ Text editor for use by Git commands. The value is meant to be
+ interpreted by the shell when it is used. Examples: `~/bin/vi`,
+ `$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe"
+ --nofork`. The order of preference is the `$GIT_EDITOR`
+ environment variable, then `core.editor` configuration, then
+ `$VISUAL`, then `$EDITOR`, and then the default chosen at compile
+ time, which is usually 'vi'.
+ifdef::git-default-editor[]
+ The build you are using chose '{git-default-editor}' as the default.
+endif::git-default-editor[]
+
+GIT_PAGER::
+ Text viewer for use by Git commands (e.g., 'less'). The value
+ is meant to be interpreted by the shell. The order of preference
+ is the `$GIT_PAGER` environment variable, then `core.pager`
+ configuration, then `$PAGER`, and then the default chosen at
+ compile time (usually 'less').
+ifdef::git-default-pager[]
+ The build you are using chose '{git-default-pager}' as the default.
+endif::git-default-pager[]
SEE ALSO
--------
@@ -51,14 +65,6 @@ linkgit:git-commit-tree[1]
linkgit:git-tag[1]
linkgit:git-config[1]
-Author
-------
-Written by Eric Biederman <ebiederm@xmission.com>
-
-Documentation
---------------
-Documentation by Eric Biederman and the git-list <git@vger.kernel.org>.
-
GIT
---
Part of the linkgit:git[1] suite