Documentation / git-gui.txton commit Say when --track is useful in the git-checkout docs. (ac15074)
   1git-gui(1)
   2==========
   3
   4NAME
   5----
   6git-gui - A portable graphical interface to Git
   7
   8SYNOPSIS
   9--------
  10'git gui' [<command>] [arguments]
  11
  12DESCRIPTION
  13-----------
  14A Tcl/Tk based graphical user interface to Git.  git-gui focuses
  15on allowing users to make changes to their repository by making
  16new commits, amending existing ones, creating branches, performing
  17local merges, and fetching/pushing to remote repositories.
  18
  19Unlike gitlink:gitk[1], git-gui focuses on commit generation
  20and single file annotation, and does not show project history.
  21It does however supply menu actions to start a gitk session from
  22within git-gui.
  23
  24git-gui is known to work on all popular UNIX systems, Mac OS X,
  25and Windows (under both Cygwin and MSYS).  To the extent possible
  26OS specific user interface guidelines are followed, making git-gui
  27a fairly native interface for users.
  28
  29COMMANDS
  30--------
  31blame::
  32        Start a blame viewer on the specified file on the given
  33        version (or working directory if not specified).
  34
  35browser::
  36        Start a tree browser showing all files in the specified
  37        commit (or 'HEAD' by default).  Files selected through the
  38        browser are opened in the blame viewer.
  39
  40citool::
  41        Start git-gui and arrange to make exactly one commit before
  42        exiting and returning to the shell.  The interface is limited
  43        to only commit actions, slightly reducing the application's
  44        startup time and simplifying the menubar.
  45
  46version::
  47        Display the currently running version of git-gui.
  48
  49
  50Examples
  51--------
  52git gui blame Makefile::
  53
  54        Show the contents of the file 'Makefile' in the current
  55        working directory, and provide annotations for both the
  56        original author of each line, and who moved the line to its
  57        current location.  The uncommitted file is annotated, and
  58        uncommitted changes (if any) are explicitly attributed to
  59        'Not Yet Committed'.
  60
  61git gui blame v0.99.8 Makefile::
  62
  63        Show the contents of 'Makefile' in revision 'v0.99.8'
  64        and provide annotations for each line.  Unlike the above
  65        example the file is read from the object database and not
  66        the working directory.
  67
  68git gui citool::
  69
  70        Make one commit and return to the shell when it is complete.
  71
  72git citool::
  73
  74        Same as 'git gui citool' (above).
  75
  76git gui browser maint::
  77
  78        Show a browser for the tree of the 'maint' branch.  Files
  79        selected in the browser can be viewed with the internal
  80        blame viewer.
  81
  82See Also
  83--------
  84'gitk(1)'::
  85        The git repository browser.  Shows branches, commit history
  86        and file differences.  gitk is the utility started by
  87        git-gui's Repository Visualize actions.
  88
  89Other
  90-----
  91git-gui is actually maintained as an independent project, but stable
  92versions are distributed as part of the Git suite for the convenience
  93of end users.
  94
  95A git-gui development repository can be obtained from:
  96
  97  git clone git://repo.or.cz/git-gui.git
  98
  99or
 100
 101  git clone http://repo.or.cz/r/git-gui.git
 102
 103or browsed online at http://repo.or.cz/w/git-gui.git/[].
 104
 105Author
 106------
 107Written by Shawn O. Pearce <spearce@spearce.org>.
 108
 109Documentation
 110--------------
 111Documentation by Shawn O. Pearce <spearce@spearce.org>.
 112
 113GIT
 114---
 115Part of the gitlink:git[7] suite