summaryrefslogtreecommitdiff
path: root/Documentation/git-citool.txt
diff options
context:
space:
mode:
authorShawn O. Pearce <spearce@spearce.org>2007-06-21 04:51:00 (GMT)
committerJunio C Hamano <gitster@pobox.com>2007-06-23 05:32:32 (GMT)
commit37cd4f7e820da82e5731c06b7ebf83963d796e5e (patch)
tree8233136378d5c9e815115ea5a4086840727e94fa /Documentation/git-citool.txt
parent47ee8ed292f14e819d8e449a56c2de02d1892483 (diff)
downloadgit-37cd4f7e820da82e5731c06b7ebf83963d796e5e.zip
git-37cd4f7e820da82e5731c06b7ebf83963d796e5e.tar.gz
git-37cd4f7e820da82e5731c06b7ebf83963d796e5e.tar.bz2
Document git-gui, git-citool as mainporcelain manual pages
Jakub Narebski pointed out that the git-gui blame viewer is not a widely known feature, but is incredibly useful. Part of the issue is advertising. Up until now we haven't even referenced git-gui from within the core Git manual pages, mostly because I just wasn't sure how I wanted to supply git-gui documentation to end-users, or how that documentation should integrate with the core Git documentation. Based upon Jakub's comment that many users may not even know that the gui is available in a stock Git distribution I'm offering up two basic manual pages: git-citool and git-gui. These should offer enough of a starting point for users to identify that the gui exists, and how to start it. Future releases of git-gui may contain their own documentation system available from within a running git-gui. But not today. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-citool.txt')
-rw-r--r--Documentation/git-citool.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/Documentation/git-citool.txt b/Documentation/git-citool.txt
new file mode 100644
index 0000000..5217ab2
--- /dev/null
+++ b/Documentation/git-citool.txt
@@ -0,0 +1,32 @@
+git-citool(1)
+=============
+
+NAME
+----
+git-citool - Graphical alternative to git-commit
+
+SYNOPSIS
+--------
+'git citool'
+
+DESCRIPTION
+-----------
+A Tcl/Tk based graphical interface to review modified files, stage
+them into the index, enter a commit message and record the new
+commit onto the current branch. This interface is an alternative
+to the less interactive gitlink:git-commit[1] program.
+
+git-citool is actually a standard alias for 'git gui citool'.
+See gitlink:git-gui[1] for more details.
+
+Author
+------
+Written by Shawn O. Pearce <spearce@spearce.org>.
+
+Documentation
+--------------
+Documentation by Shawn O. Pearce <spearce@spearce.org>.
+
+GIT
+---
+Part of the gitlink:git[7] suite