man1/git-var.1

   1 '\" t
   2 .\"     Title: git-var
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-25
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.47.0.rc0
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-VAR" "1" "2024-09-25" "Git 2\&.47\&.0\&.rc0" "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 .SH "DESCRIPTION"
  38 .sp
  39 Prints a Git logical variable\&. Exits with code 1 if the variable has no value\&.
  40 .SH "OPTIONS"
  41 .PP
  42 \-l
  43 .RS 4
  44 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
  45 \fBgit config \-l\fR\&.)
  46 .RE
  47 .SH "EXAMPLES"
  48 .sp
  49 .if n \{\
  50 .RS 4
  51 .\}
  52 .nf
  53 $ git var GIT_AUTHOR_IDENT
  54 Eric W\&. Biederman <ebiederm@lnxi\&.com> 1121223278 \-0600
  55 .fi
  56 .if n \{\
  57 .RE
  58 .\}
  59 .SH "VARIABLES"
  60 .PP
  61 GIT_AUTHOR_IDENT
  62 .RS 4
  63 The author of a piece of code\&.
  64 .RE
  65 .PP
  66 GIT_COMMITTER_IDENT
  67 .RS 4
  68 The person who put a piece of code into Git\&.
  69 .RE
  70 .PP
  71 GIT_EDITOR
  72 .RS 4
  73 Text editor for use by Git commands\&. The value is meant to be interpreted by the shell when it is used\&. Examples:
  74 \fB~/bin/vi\fR,
  75 \fB$SOME_ENVIRONMENT_VARIABLE\fR,
  76 \fB"C:\eProgram Files\eVim\egvim\&.exe" \-\-nofork\fR\&. The order of preference is the
  77 \fB$GIT_EDITOR\fR
  78 environment variable, then
  79 \fBcore\&.editor\fR
  80 configuration, then
  81 \fB$VISUAL\fR, then
  82 \fB$EDITOR\fR, and then the default chosen at compile time, which is usually
  83 \fIvi\fR\&.
  84 .RE
  85 .PP
  86 GIT_SEQUENCE_EDITOR
  87 .RS 4
  88 Text editor used to edit the
  89 \fItodo\fR
  90 file while running
  91 \fBgit rebase \-i\fR\&. Like
  92 \fBGIT_EDITOR\fR, the value is meant to be interpreted by the shell when it is used\&. The order of preference is the
  93 \fB$GIT_SEQUENCE_EDITOR\fR
  94 environment variable, then
  95 \fBsequence\&.editor\fR
  96 configuration, and then the value of
  97 \fBgit var GIT_EDITOR\fR\&.
  98 .RE
  99 .PP
 100 GIT_PAGER
 101 .RS 4
 102 Text viewer for use by Git commands (e\&.g\&.,
 103 \fIless\fR)\&. The value is meant to be interpreted by the shell\&. The order of preference is the
 104 \fB$GIT_PAGER\fR
 105 environment variable, then
 106 \fBcore\&.pager\fR
 107 configuration, then
 108 \fB$PAGER\fR, and then the default chosen at compile time (usually
 109 \fIless\fR)\&.
 110 .RE
 111 .PP
 112 GIT_DEFAULT_BRANCH
 113 .RS 4
 114 The name of the first branch created in newly initialized repositories\&.
 115 .RE
 116 .PP
 117 GIT_SHELL_PATH
 118 .RS 4
 119 The path of the binary providing the POSIX shell for commands which use the shell\&.
 120 .RE
 121 .PP
 122 GIT_ATTR_SYSTEM
 123 .RS 4
 124 The path to the system
 125 \fBgitattributes\fR(5)
 126 file, if one is enabled\&.
 127 .RE
 128 .PP
 129 GIT_ATTR_GLOBAL
 130 .RS 4
 131 The path to the global (per\-user)
 132 \fBgitattributes\fR(5)
 133 file\&.
 134 .RE
 135 .PP
 136 GIT_CONFIG_SYSTEM
 137 .RS 4
 138 The path to the system configuration file, if one is enabled\&.
 139 .RE
 140 .PP
 141 GIT_CONFIG_GLOBAL
 142 .RS 4
 143 The path to the global (per\-user) configuration files, if any\&.
 144 .RE
 145 .sp
 146 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\&.
 147 .sp
 148 Note that paths are printed even if they do not exist, but not if they are disabled by other environment variables\&.
 149 .SH "SEE ALSO"
 150 .sp
 151 \fBgit-commit-tree\fR(1) \fBgit-tag\fR(1) \fBgit-config\fR(1)
 152 .SH "GIT"
 153 .sp
 154 Part of the \fBgit\fR(1) suite