doc/source/en/TortoiseGit/git_doc/git-gui.html.xml

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