| blob | 5ee64b120a475ca4ad839face6bc22546a71ac4a |
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-gui(1)">\r
5 <articleinfo>\r
6 <title>git-gui(1)</title>\r
7 <indexterm>\r
8 <primary>git-gui(1)</primary>\r
9 </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-gui - A portable graphical interface to Git</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git gui</emphasis> [<command>] [arguments]</literallayout>\r
19 </blockquote>\r
20 </simplesect>\r
21 <simplesect id="_description">\r
22 <title>DESCRIPTION</title>\r
23 <simpara>A Tcl/Tk based graphical user interface to Git. <emphasis>git gui</emphasis> focuses\r
24 on allowing users to make changes to their repository by making\r
25 new commits, amending existing ones, creating branches, performing\r
26 local merges, and fetching/pushing to remote repositories.</simpara>\r
27 <simpara>Unlike <emphasis>gitk</emphasis>, <emphasis>git gui</emphasis> focuses on commit generation\r
28 and single file annotation and does not show project history.\r
29 It does however supply menu actions to start a <emphasis>gitk</emphasis> session from\r
30 within <emphasis>git gui</emphasis>.</simpara>\r
31 <simpara><emphasis>git gui</emphasis> is known to work on all popular UNIX systems, Mac OS X,\r
32 and Windows (under both Cygwin and MSYS). To the extent possible\r
33 OS specific user interface guidelines are followed, making <emphasis>git gui</emphasis>\r
34 a fairly native interface for users.</simpara>\r
35 </simplesect>\r
36 <simplesect id="_commands">\r
37 <title>COMMANDS</title>\r
38 <variablelist>\r
39 <varlistentry>\r
40 <term>\r
41 blame\r
42 </term>\r
43 <listitem>\r
44 <simpara>\r
45 Start a blame viewer on the specified file on the given\r
46 version (or working directory if not specified).\r
47 </simpara>\r
48 </listitem>\r
49 </varlistentry>\r
50 <varlistentry>\r
51 <term>\r
52 browser\r
53 </term>\r
54 <listitem>\r
55 <simpara>\r
56 Start a tree browser showing all files in the specified\r
57 commit (or <emphasis>HEAD</emphasis> by default). Files selected through the\r
58 browser are opened in the blame viewer.\r
59 </simpara>\r
60 </listitem>\r
61 </varlistentry>\r
62 <varlistentry>\r
63 <term>\r
64 citool\r
65 </term>\r
66 <listitem>\r
67 <simpara>\r
68 Start <emphasis>git gui</emphasis> and arrange to make exactly one commit before\r
69 exiting and returning to the shell. The interface is limited\r
70 to only commit actions, slightly reducing the application's\r
71 startup time and simplifying the menubar.\r
72 </simpara>\r
73 </listitem>\r
74 </varlistentry>\r
75 <varlistentry>\r
76 <term>\r
77 version\r
78 </term>\r
79 <listitem>\r
80 <simpara>\r
81 Display the currently running version of <emphasis>git gui</emphasis>.\r
82 </simpara>\r
83 </listitem>\r
84 </varlistentry>\r
85 </variablelist>\r
86 </simplesect>\r
87 <simplesect id="_examples">\r
88 <title>Examples</title>\r
89 <variablelist>\r
90 <varlistentry>\r
91 <term>\r
92 <emphasis>git gui blame Makefile</emphasis>\r
93 </term>\r
94 <listitem>\r
95 <simpara>\r
96 Show the contents of the file <emphasis>Makefile</emphasis> in the current\r
97 working directory, and provide annotations for both the\r
98 original author of each line, and who moved the line to its\r
99 current location. The uncommitted file is annotated, and\r
100 uncommitted changes (if any) are explicitly attributed to\r
101 <emphasis>Not Yet Committed</emphasis>.\r
102 </simpara>\r
103 </listitem>\r
104 </varlistentry>\r
105 <varlistentry>\r
106 <term>\r
107 <emphasis>git gui blame v0.99.8 Makefile</emphasis>\r
108 </term>\r
109 <listitem>\r
110 <simpara>\r
111 Show the contents of <emphasis>Makefile</emphasis> in revision <emphasis>v0.99.8</emphasis>\r
112 and provide annotations for each line. Unlike the above\r
113 example the file is read from the object database and not\r
114 the working directory.\r
115 </simpara>\r
116 </listitem>\r
117 </varlistentry>\r
118 <varlistentry>\r
119 <term>\r
120 <emphasis>git gui blame --line=100 Makefile</emphasis>\r
121 </term>\r
122 <listitem>\r
123 <simpara>\r
124 Loads annotations as described above and automatically\r
125 scrolls the view to center on line <emphasis>100</emphasis>.\r
126 </simpara>\r
127 </listitem>\r
128 </varlistentry>\r
129 <varlistentry>\r
130 <term>\r
131 <emphasis>git gui citool</emphasis>\r
132 </term>\r
133 <listitem>\r
134 <simpara>\r
135 Make one commit and return to the shell when it is complete.\r
136 This command returns a non-zero exit code if the window was\r
137 closed in any way other than by making a commit.\r
138 </simpara>\r
139 </listitem>\r
140 </varlistentry>\r
141 <varlistentry>\r
142 <term>\r
143 <emphasis>git gui citool --amend</emphasis>\r
144 </term>\r
145 <listitem>\r
146 <simpara>\r
147 Automatically enter the <emphasis>Amend Last Commit</emphasis> mode of\r
148 the interface.\r
149 </simpara>\r
150 </listitem>\r
151 </varlistentry>\r
152 <varlistentry>\r
153 <term>\r
154 <emphasis>git gui citool --nocommit</emphasis>\r
155 </term>\r
156 <listitem>\r
157 <simpara>\r
158 Behave as normal citool, but instead of making a commit\r
159 simply terminate with a zero exit code. It still checks\r
160 that the index does not contain any unmerged entries, so\r
161 you can use it as a GUI version of <xref linkend="git-mergetool(1)" />\r
162 </simpara>\r
163 </listitem>\r
164 </varlistentry>\r
165 <varlistentry>\r
166 <term>\r
167 <emphasis>git citool</emphasis>\r
168 </term>\r
169 <listitem>\r
170 <simpara>\r
171 Same as <emphasis>git gui citool</emphasis> (above).\r
172 </simpara>\r
173 </listitem>\r
174 </varlistentry>\r
175 <varlistentry>\r
176 <term>\r
177 <emphasis>git gui browser maint</emphasis>\r
178 </term>\r
179 <listitem>\r
180 <simpara>\r
181 Show a browser for the tree of the <emphasis>maint</emphasis> branch. Files\r
182 selected in the browser can be viewed with the internal\r
183 blame viewer.\r
184 </simpara>\r
185 </listitem>\r
186 </varlistentry>\r
187 </variablelist>\r
188 </simplesect>\r
189 <simplesect id="_see_also">\r
190 <title>SEE ALSO</title>\r
191 <variablelist>\r
192 <varlistentry>\r
193 <term>\r
194 <xref linkend="gitk(1)" />\r
195 </term>\r
196 <listitem>\r
197 <simpara>\r
198 The git repository browser. Shows branches, commit history\r
199 and file differences. gitk is the utility started by\r
200 <emphasis>git gui</emphasis>'s Repository Visualize actions.\r
201 </simpara>\r
202 </listitem>\r
203 </varlistentry>\r
204 </variablelist>\r
205 </simplesect>\r
206 <simplesect id="_other">\r
207 <title>Other</title>\r
208 <simpara><emphasis>git gui</emphasis> is actually maintained as an independent project, but stable\r
209 versions are distributed as part of the Git suite for the convenience\r
210 of end users.</simpara>\r
211 <simpara>A <emphasis>git gui</emphasis> development repository can be obtained from:</simpara>\r
212 <literallayout class="monospaced">git clone git://repo.or.cz/git-gui.git</literallayout>\r
213 <simpara>or</simpara>\r
214 <literallayout class="monospaced">git clone http://repo.or.cz/r/git-gui.git</literallayout>\r
215 <simpara>or browsed online at <ulink url="http://repo.or.cz/w/git-gui.git/">http://repo.or.cz/w/git-gui.git/</ulink>[].</simpara>\r
216 </simplesect>\r
217 <simplesect id="_git">\r
218 <title>GIT</title>\r
219 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
220 </simplesect>\r
221 </article>\r