man1/git-gui.1

   1 '\" t
   2 .\"     Title: git-gui
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-10-06
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.47.0
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-GUI" "1" "2024-10-06" "Git 2\&.47\&.0" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-gui \- A portable graphical interface to Git
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit gui\fR [<command>] [<arguments>]
  36 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 A Tcl/Tk based graphical user interface to Git\&. \fIgit gui\fR 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\&.
  40 .sp
  41 Unlike \fIgitk\fR, \fIgit gui\fR focuses on commit generation and single file annotation and does not show project history\&. It does however supply menu actions to start a \fIgitk\fR session from within \fIgit gui\fR\&.
  42 .sp
  43 \fIgit gui\fR 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 \fIgit gui\fR a fairly native interface for users\&.
  44 .SH "COMMANDS"
  45 .PP
  46 blame
  47 .RS 4
  48 Start a blame viewer on the specified file on the given version (or working directory if not specified)\&.
  49 .RE
  50 .PP
  51 browser
  52 .RS 4
  53 Start a tree browser showing all files in the specified commit\&. Files selected through the browser are opened in the blame viewer\&.
  54 .RE
  55 .PP
  56 citool
  57 .RS 4
  58 Start
  59 \fIgit gui\fR
  60 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\(cqs startup time and simplifying the menubar\&.
  61 .RE
  62 .PP
  63 version
  64 .RS 4
  65 Display the currently running version of
  66 \fIgit gui\fR\&.
  67 .RE
  68 .SH "EXAMPLES"
  69 .PP
  70 \fBgit gui blame Makefile\fR
  71 .RS 4
  72 Show the contents of the file
  73 \fIMakefile\fR
  74 in the current working directory, and provide annotations for both the original author of each line, and who moved the line to its current location\&. The uncommitted file is annotated, and uncommitted changes (if any) are explicitly attributed to
  75 \fINot Yet Committed\fR\&.
  76 .RE
  77 .PP
  78 \fBgit gui blame v0\&.99\&.8 Makefile\fR
  79 .RS 4
  80 Show the contents of
  81 \fIMakefile\fR
  82 in revision
  83 \fIv0\&.99\&.8\fR
  84 and provide annotations for each line\&. Unlike the above example the file is read from the object database and not the working directory\&.
  85 .RE
  86 .PP
  87 \fBgit gui blame \-\-line=100 Makefile\fR
  88 .RS 4
  89 Loads annotations as described above and automatically scrolls the view to center on line
  90 \fI100\fR\&.
  91 .RE
  92 .PP
  93 \fBgit gui citool\fR
  94 .RS 4
  95 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\&.
  96 .RE
  97 .PP
  98 \fBgit gui citool \-\-amend\fR
  99 .RS 4
 100 Automatically enter the
 101 \fIAmend Last Commit\fR
 102 mode of the interface\&.
 103 .RE
 104 .PP
 105 \fBgit gui citool \-\-nocommit\fR
 106 .RS 4
 107 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
 108 \fBgit-mergetool\fR(1)
 109 .RE
 110 .PP
 111 \fBgit citool\fR
 112 .RS 4
 113 Same as
 114 \fBgit gui citool\fR
 115 (above)\&.
 116 .RE
 117 .PP
 118 \fBgit gui browser maint\fR
 119 .RS 4
 120 Show a browser for the tree of the
 121 \fImaint\fR
 122 branch\&. Files selected in the browser can be viewed with the internal blame viewer\&.
 123 .RE
 124 .SH "SEE ALSO"
 125 .PP
 126 \fBgitk\fR(1)
 127 .RS 4
 128 The Git repository browser\&. Shows branches, commit history and file differences\&. gitk is the utility started by
 129 \fIgit gui\fR\*(Aqs Repository Visualize actions\&.
 130 .RE
 131 .SH "OTHER"
 132 .sp
 133 \fIgit gui\fR is actually maintained as an independent project, but stable versions are distributed as part of the Git suite for the convenience of end users\&.
 134 .sp
 135 The official repository of the \fIgit gui\fR project can be found at:
 136 .sp
 137 .if n \{\
 138 .RS 4
 139 .\}
 140 .nf
 141 https://github\&.com/j6t/git\-gui
 142 .fi
 143 .if n \{\
 144 .RE
 145 .\}
 146 .SH "GIT"
 147 .sp
 148 Part of the \fBgit\fR(1) suite