Merge branch 'maint'

[git.git] / Documentation / git-gui.txt

diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt
index ea1e4ce62447d7f2d450d93647cc745326f44f5b..d0bc98b85289b42727afc903a50e9e83d37def35 100644 (file)
--- a/Documentation/git-gui.txt
+++ b/Documentation/git-gui.txt
@@ -11,19 +11,19 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-A Tcl/Tk based graphical user interface to Git.  `git-gui` focuses
+A Tcl/Tk based graphical user interface to Git.  'git-gui' focuses
 on allowing users to make changes to their repository by making
 new commits, amending existing ones, creating branches, performing
 local merges, and fetching/pushing to remote repositories.
 
-Unlike `gitk`, `git-gui` focuses on commit generation
+Unlike 'gitk', 'git-gui' focuses on commit generation
 and single file annotation and does not show project history.
-It does however supply menu actions to start a `gitk` session from
-within `git-gui`.
+It does however supply menu actions to start a 'gitk' session from
+within 'git-gui'.
 
-`git-gui` is known to work on all popular UNIX systems, Mac OS X,
+'git-gui' is known to work on all popular UNIX systems, Mac OS X,
 and Windows (under both Cygwin and MSYS).  To the extent possible
-OS specific user interface guidelines are followed, making `git-gui`
+OS specific user interface guidelines are followed, making 'git-gui'
 a fairly native interface for users.
 
 COMMANDS
@@ -38,13 +38,13 @@ browser::
        browser are opened in the blame viewer.
 
 citool::
-       Start `git-gui` and arrange to make exactly one commit before
+       Start 'git-gui' and arrange to make exactly one commit before
        exiting and returning to the shell.  The interface is limited
        to only commit actions, slightly reducing the application's
        startup time and simplifying the menubar.
 
 version::
-       Display the currently running version of `git-gui`.
+       Display the currently running version of 'git-gui'.
 
 
 Examples
@@ -65,13 +65,32 @@ git gui blame v0.99.8 Makefile::
        example the file is read from the object database and not
        the working directory.
 
+git gui blame --line=100 Makefile::
+
+       Loads annotations as described above and automatically
+       scrolls the view to center on line '100'.
+
 git gui citool::
 
        Make one commit and return to the shell when it is complete.
+       This command returns a non-zero exit code if the window was
+       closed in any way other than by making a commit.
+
+git gui citool --amend::
+
+       Automatically enter the 'Amend Last Commit' mode of
+       the interface.
+
+git gui citool --nocommit::
+
+       Behave as normal citool, but instead of making a commit
+       simply terminate with a zero exit code. It still checks
+       that the index does not contain any unmerged entries, so
+       you can use it as a GUI version of linkgit:git-mergetool[1]
 
 git citool::
 
-       Same as 'git gui citool' (above).
+       Same as `git gui citool` (above).
 
 git gui browser maint::
 
@@ -84,15 +103,15 @@ SEE ALSO
 linkgit:gitk[1]::
        The git repository browser.  Shows branches, commit history
        and file differences.  gitk is the utility started by
-       `git-gui`'s Repository Visualize actions.
+       'git-gui''s Repository Visualize actions.
 
 Other
 -----
-`git-gui` is actually maintained as an independent project, but stable
+'git-gui' is actually maintained as an independent project, but stable
 versions are distributed as part of the Git suite for the convenience
 of end users.
 
-A `git-gui` development repository can be obtained from:
+A 'git-gui' development repository can be obtained from:
 
   git clone git://repo.or.cz/git-gui.git