updated git doc
[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-var.xml
blob962281d9694117e1f814d8ebf1c9ee3b26d2b210
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-var(1)">\r
5 <articleinfo>\r
6     <title>git-var(1)</title>\r
7 <indexterm>\r
8 <primary>git-var(1)</primary>\r
9 </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-var - Show a git logical variable</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git var</emphasis> ( -l | &lt;variable&gt; )</literallayout>\r
19 </blockquote>\r
20 </simplesect>\r
21 <simplesect id="_description">\r
22 <title>DESCRIPTION</title>\r
23 <simpara>Prints a git logical variable.</simpara>\r
24 </simplesect>\r
25 <simplesect id="_options">\r
26 <title>OPTIONS</title>\r
27 <variablelist>\r
28 <varlistentry>\r
29 <term>\r
30 -l\r
31 </term>\r
32 <listitem>\r
33 <simpara>\r
34         Cause the logical variables to be listed. In addition, all the\r
35         variables of the git configuration file .git/config are listed\r
36         as well. (However, the configuration variables listing functionality\r
37         is deprecated in favor of <emphasis>git config -l</emphasis>.)\r
38 </simpara>\r
39 </listitem>\r
40 </varlistentry>\r
41 </variablelist>\r
42 </simplesect>\r
43 <simplesect id="_example">\r
44 <title>EXAMPLE</title>\r
45 <literallayout class="monospaced">$ git var GIT_AUTHOR_IDENT\r
46 Eric W. Biederman &lt;ebiederm@lnxi.com&gt; 1121223278 -0600</literallayout>\r
47 </simplesect>\r
48 <simplesect id="_variables">\r
49 <title>VARIABLES</title>\r
50 <variablelist>\r
51 <varlistentry>\r
52 <term>\r
53 GIT_AUTHOR_IDENT\r
54 </term>\r
55 <listitem>\r
56 <simpara>\r
57     The author of a piece of code.\r
58 </simpara>\r
59 </listitem>\r
60 </varlistentry>\r
61 <varlistentry>\r
62 <term>\r
63 GIT_COMMITTER_IDENT\r
64 </term>\r
65 <listitem>\r
66 <simpara>\r
67     The person who put a piece of code into git.\r
68 </simpara>\r
69 </listitem>\r
70 </varlistentry>\r
71 <varlistentry>\r
72 <term>\r
73 GIT_EDITOR\r
74 </term>\r
75 <listitem>\r
76 <simpara>\r
77     Text editor for use by git commands.  The value is meant to be\r
78     interpreted by the shell when it is used.  Examples: <emphasis>~/bin/vi</emphasis>,\r
79     <emphasis>$SOME_ENVIRONMENT_VARIABLE</emphasis>, <emphasis>"C:\Program Files\Vim\gvim.exe"\r
80     --nofork</emphasis>.  The order of preference is the <emphasis>$GIT_EDITOR</emphasis>\r
81     environment variable, then <emphasis>core.editor</emphasis> configuration, then\r
82     <emphasis>$VISUAL</emphasis>, then <emphasis>$EDITOR</emphasis>, and then finally <emphasis>vi</emphasis>.\r
83 </simpara>\r
84 </listitem>\r
85 </varlistentry>\r
86 <varlistentry>\r
87 <term>\r
88 GIT_PAGER\r
89 </term>\r
90 <listitem>\r
91 <simpara>\r
92     Text viewer for use by git commands (e.g., <emphasis>less</emphasis>).  The value\r
93     is meant to be interpreted by the shell.  The order of preference\r
94     is the <emphasis>$GIT_PAGER</emphasis> environment variable, then <emphasis>core.pager</emphasis>\r
95     configuration, then <emphasis>$PAGER</emphasis>, and then finally <emphasis>less</emphasis>.\r
96 </simpara>\r
97 </listitem>\r
98 </varlistentry>\r
99 </variablelist>\r
100 </simplesect>\r
101 <simplesect id="_diagnostics">\r
102 <title>Diagnostics</title>\r
103 <variablelist>\r
104 <varlistentry>\r
105 <term>\r
106 You don't exist. Go away!\r
107 </term>\r
108 <listitem>\r
109 <simpara>\r
110     The passwd(5) gecos field couldn't be read\r
111 </simpara>\r
112 </listitem>\r
113 </varlistentry>\r
114 <varlistentry>\r
115 <term>\r
116 Your parents must have hated you!\r
117 </term>\r
118 <listitem>\r
119 <simpara>\r
120     The passwd(5) gecos field is longer than a giant static buffer.\r
121 </simpara>\r
122 </listitem>\r
123 </varlistentry>\r
124 <varlistentry>\r
125 <term>\r
126 Your sysadmin must hate you!\r
127 </term>\r
128 <listitem>\r
129 <simpara>\r
130     The passwd(5) name field is longer than a giant static buffer.\r
131 </simpara>\r
132 </listitem>\r
133 </varlistentry>\r
134 </variablelist>\r
135 </simplesect>\r
136 <simplesect id="_see_also">\r
137 <title>SEE ALSO</title>\r
138 <simpara><xref linkend="git-commit-tree(1)" />\r
139 <xref linkend="git-tag(1)" />\r
140 <xref linkend="git-config(1)" /></simpara>\r
141 </simplesect>\r
142 <simplesect id="_git">\r
143 <title>GIT</title>\r
144 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
145 </simplesect>\r
146 </article>\r