blob: ca0cefc1c7ff2d38836a8979daa412cc1bc0f003 [file] [log] [blame]
'\" t
.\" Title: git-gui
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 11/18/2018
.\" Manual: Git Manual
.\" Source: Git 2.20.0.rc0
.\" Language: English
.\"
.TH "GIT\-GUI" "1" "11/18/2018" "Git 2\&.20\&.0\&.rc0" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-gui \- A portable graphical interface to Git
.SH "SYNOPSIS"
.sp
.nf
\fIgit gui\fR [<command>] [arguments]
.fi
.sp
.SH "DESCRIPTION"
.sp
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\&.
.sp
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\&.
.sp
\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\&.
.SH "COMMANDS"
.PP
blame
.RS 4
Start a blame viewer on the specified file on the given version (or working directory if not specified)\&.
.RE
.PP
browser
.RS 4
Start a tree browser showing all files in the specified commit\&. Files selected through the browser are opened in the blame viewer\&.
.RE
.PP
citool
.RS 4
Start
\fIgit gui\fR
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\&.
.RE
.PP
version
.RS 4
Display the currently running version of
\fIgit gui\fR\&.
.RE
.SH "EXAMPLES"
.PP
\fBgit gui blame Makefile\fR
.RS 4
Show the contents of the file
\fIMakefile\fR
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
\fINot Yet Committed\fR\&.
.RE
.PP
\fBgit gui blame v0\&.99\&.8 Makefile\fR
.RS 4
Show the contents of
\fIMakefile\fR
in revision
\fIv0\&.99\&.8\fR
and provide annotations for each line\&. Unlike the above example the file is read from the object database and not the working directory\&.
.RE
.PP
\fBgit gui blame \-\-line=100 Makefile\fR
.RS 4
Loads annotations as described above and automatically scrolls the view to center on line
\fI100\fR\&.
.RE
.PP
\fBgit gui citool\fR
.RS 4
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\&.
.RE
.PP
\fBgit gui citool \-\-amend\fR
.RS 4
Automatically enter the
\fIAmend Last Commit\fR
mode of the interface\&.
.RE
.PP
\fBgit gui citool \-\-nocommit\fR
.RS 4
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
\fBgit-mergetool\fR(1)
.RE
.PP
\fBgit citool\fR
.RS 4
Same as
\fBgit gui citool\fR
(above)\&.
.RE
.PP
\fBgit gui browser maint\fR
.RS 4
Show a browser for the tree of the
\fImaint\fR
branch\&. Files selected in the browser can be viewed with the internal blame viewer\&.
.RE
.SH "SEE ALSO"
.PP
\fBgitk\fR(1)
.RS 4
The Git repository browser\&. Shows branches, commit history and file differences\&. gitk is the utility started by
\fIgit gui\fR\(aqs Repository Visualize actions\&.
.RE
.SH "OTHER"
.sp
\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\&.
.sp
A \fIgit gui\fR development repository can be obtained from:
.sp
.if n \{\
.RS 4
.\}
.nf
git clone git://repo\&.or\&.cz/git\-gui\&.git
.fi
.if n \{\
.RE
.\}
.sp
or
.sp
.if n \{\
.RS 4
.\}
.nf
git clone http://repo\&.or\&.cz/r/git\-gui\&.git
.fi
.if n \{\
.RE
.\}
.sp
or browsed online at \m[blue]\fBhttp://repo\&.or\&.cz/w/git\-gui\&.git/\fR\m[]\&.
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite