Autogenerated manpages for v2.40.0-rc2
[git-manpages.git] / man1 / git-var.1
blobd5e5c1683643d4d806086d30ebb71bd95cbb5b55
1 '\" t
2 .\"     Title: git-var
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 03/06/2023
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.40.0.rc2
8 .\"  Language: English
9 .\"
10 .TH "GIT\-VAR" "1" "03/06/2023" "Git 2\&.40\&.0\&.rc2" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-var \- Show a Git logical variable
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit var\fR (\-l | <variable>)
36 .fi
37 .sp
38 .SH "DESCRIPTION"
39 .sp
40 Prints a Git logical variable\&. Exits with code 1 if the variable has no value\&.
41 .SH "OPTIONS"
42 .PP
43 \-l
44 .RS 4
45 Cause the logical variables to be listed\&. 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
46 \fBgit config \-l\fR\&.)
47 .RE
48 .SH "EXAMPLES"
49 .sp
50 .if n \{\
51 .RS 4
52 .\}
53 .nf
54 $ git var GIT_AUTHOR_IDENT
55 Eric W\&. Biederman <ebiederm@lnxi\&.com> 1121223278 \-0600
56 .fi
57 .if n \{\
58 .RE
59 .\}
60 .SH "VARIABLES"
61 .PP
62 GIT_AUTHOR_IDENT
63 .RS 4
64 The author of a piece of code\&.
65 .RE
66 .PP
67 GIT_COMMITTER_IDENT
68 .RS 4
69 The person who put a piece of code into Git\&.
70 .RE
71 .PP
72 GIT_EDITOR
73 .RS 4
74 Text editor for use by Git commands\&. The value is meant to be interpreted by the shell when it is used\&. Examples:
75 \fB~/bin/vi\fR,
76 \fB$SOME_ENVIRONMENT_VARIABLE\fR,
77 \fB"C:\eProgram Files\eVim\egvim\&.exe" \-\-nofork\fR\&. The order of preference is the
78 \fB$GIT_EDITOR\fR
79 environment variable, then
80 \fBcore\&.editor\fR
81 configuration, then
82 \fB$VISUAL\fR, then
83 \fB$EDITOR\fR, and then the default chosen at compile time, which is usually
84 \fIvi\fR\&.
85 .RE
86 .PP
87 GIT_SEQUENCE_EDITOR
88 .RS 4
89 Text editor used to edit the
90 \fItodo\fR
91 file while running
92 \fBgit rebase \-i\fR\&. Like
93 \fBGIT_EDITOR\fR, the value is meant to be interpreted by the shell when it is used\&. The order of preference is the
94 \fB$GIT_SEQUENCE_EDITOR\fR
95 environment variable, then
96 \fBsequence\&.editor\fR
97 configuration, and then the value of
98 \fBgit var GIT_EDITOR\fR\&.
99 .RE
101 GIT_PAGER
102 .RS 4
103 Text viewer for use by Git commands (e\&.g\&.,
104 \fIless\fR)\&. The value is meant to be interpreted by the shell\&. The order of preference is the
105 \fB$GIT_PAGER\fR
106 environment variable, then
107 \fBcore\&.pager\fR
108 configuration, then
109 \fB$PAGER\fR, and then the default chosen at compile time (usually
110 \fIless\fR)\&.
113 GIT_DEFAULT_BRANCH
114 .RS 4
115 The name of the first branch created in newly initialized repositories\&.
117 .SH "SEE ALSO"
119 \fBgit-commit-tree\fR(1) \fBgit-tag\fR(1) \fBgit-config\fR(1)
120 .SH "GIT"
122 Part of the \fBgit\fR(1) suite