blob: 9ee34d49cf2f1784a683735a297177639b699164 [file] [log] [blame]
'\" t
.\" Title: git-var
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024-04-29
.\" Manual: Git Manual
.\" Source: Git 2.45.0
.\" Language: English
.\"
.TH "GIT\-VAR" "1" "2024\-04\-29" "Git 2\&.45\&.0" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-var \- Show a Git logical variable
.SH "SYNOPSIS"
.sp
.nf
\fIgit var\fR (\-l | <variable>)
.fi
.sp
.SH "DESCRIPTION"
.sp
Prints a Git logical variable\&. Exits with code 1 if the variable has no value\&.
.SH "OPTIONS"
.PP
\-l
.RS 4
Display the logical variables\&. In addition, all the variables of the Git configuration file \&.git/config are listed as well\&. (However, the configuration variables listing functionality is deprecated in favor of
\fBgit config \-l\fR\&.)
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
$ git var GIT_AUTHOR_IDENT
Eric W\&. Biederman <ebiederm@lnxi\&.com> 1121223278 \-0600
.fi
.if n \{\
.RE
.\}
.SH "VARIABLES"
.PP
GIT_AUTHOR_IDENT
.RS 4
The author of a piece of code\&.
.RE
.PP
GIT_COMMITTER_IDENT
.RS 4
The person who put a piece of code into Git\&.
.RE
.PP
GIT_EDITOR
.RS 4
Text editor for use by Git commands\&. The value is meant to be interpreted by the shell when it is used\&. Examples:
\fB~/bin/vi\fR,
\fB$SOME_ENVIRONMENT_VARIABLE\fR,
\fB"C:\eProgram Files\eVim\egvim\&.exe" \-\-nofork\fR\&. The order of preference is the
\fB$GIT_EDITOR\fR
environment variable, then
\fBcore\&.editor\fR
configuration, then
\fB$VISUAL\fR, then
\fB$EDITOR\fR, and then the default chosen at compile time, which is usually
\fIvi\fR\&.
.RE
.PP
GIT_SEQUENCE_EDITOR
.RS 4
Text editor used to edit the
\fItodo\fR
file while running
\fBgit rebase \-i\fR\&. Like
\fBGIT_EDITOR\fR, the value is meant to be interpreted by the shell when it is used\&. The order of preference is the
\fB$GIT_SEQUENCE_EDITOR\fR
environment variable, then
\fBsequence\&.editor\fR
configuration, and then the value of
\fBgit var GIT_EDITOR\fR\&.
.RE
.PP
GIT_PAGER
.RS 4
Text viewer for use by Git commands (e\&.g\&.,
\fIless\fR)\&. The value is meant to be interpreted by the shell\&. The order of preference is the
\fB$GIT_PAGER\fR
environment variable, then
\fBcore\&.pager\fR
configuration, then
\fB$PAGER\fR, and then the default chosen at compile time (usually
\fIless\fR)\&.
.RE
.PP
GIT_DEFAULT_BRANCH
.RS 4
The name of the first branch created in newly initialized repositories\&.
.RE
.PP
GIT_SHELL_PATH
.RS 4
The path of the binary providing the POSIX shell for commands which use the shell\&.
.RE
.PP
GIT_ATTR_SYSTEM
.RS 4
The path to the system
\fBgitattributes\fR(5)
file, if one is enabled\&.
.RE
.PP
GIT_ATTR_GLOBAL
.RS 4
The path to the global (per\-user)
\fBgitattributes\fR(5)
file\&.
.RE
.PP
GIT_CONFIG_SYSTEM
.RS 4
The path to the system configuration file, if one is enabled\&.
.RE
.PP
GIT_CONFIG_GLOBAL
.RS 4
The path to the global (per\-user) configuration files, if any\&.
.RE
.sp
Most path values contain only one value\&. However, some can contain multiple values, which are separated by newlines, and are listed in order from highest to lowest priority\&. Callers should be prepared for any such path value to contain multiple items\&.
.sp
Note that paths are printed even if they do not exist, but not if they are disabled by other environment variables\&.
.SH "SEE ALSO"
.sp
\fBgit-commit-tree\fR(1) \fBgit-tag\fR(1) \fBgit-config\fR(1)
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite