]>
Commit | Line | Data |
---|---|---|
37cd4f7e SP |
1 | git-gui(1) |
2 | ========== | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-gui - A portable graphical interface to Git | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
10 | 'git gui' [<command>] [arguments] | |
11 | ||
12 | DESCRIPTION | |
13 | ----------- | |
0b444cdb | 14 | A Tcl/Tk based graphical user interface to Git. 'git gui' focuses |
37cd4f7e SP |
15 | on allowing users to make changes to their repository by making |
16 | new commits, amending existing ones, creating branches, performing | |
17 | local merges, and fetching/pushing to remote repositories. | |
18 | ||
0b444cdb | 19 | Unlike 'gitk', 'git gui' focuses on commit generation |
483bc4f0 | 20 | and single file annotation and does not show project history. |
42d36bb8 | 21 | It does however supply menu actions to start a 'gitk' session from |
0b444cdb | 22 | within 'git gui'. |
37cd4f7e | 23 | |
0b444cdb | 24 | 'git gui' is known to work on all popular UNIX systems, Mac OS X, |
37cd4f7e | 25 | and Windows (under both Cygwin and MSYS). To the extent possible |
0b444cdb | 26 | OS specific user interface guidelines are followed, making 'git gui' |
37cd4f7e SP |
27 | a fairly native interface for users. |
28 | ||
29 | COMMANDS | |
30 | -------- | |
31 | blame:: | |
32 | Start a blame viewer on the specified file on the given | |
33 | version (or working directory if not specified). | |
34 | ||
35 | browser:: | |
36 | Start a tree browser showing all files in the specified | |
7f9d77f2 | 37 | commit (or 'HEAD' by default). Files selected through the |
37cd4f7e SP |
38 | browser are opened in the blame viewer. |
39 | ||
40 | citool:: | |
0b444cdb | 41 | Start 'git gui' and arrange to make exactly one commit before |
37cd4f7e SP |
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 | ||
46 | version:: | |
0b444cdb | 47 | Display the currently running version of 'git gui'. |
37cd4f7e SP |
48 | |
49 | ||
50 | Examples | |
51 | -------- | |
52 | git 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 | ||
61 | git gui blame v0.99.8 Makefile:: | |
62 | ||
63 | Show the contents of 'Makefile' in revision 'v0.99.8' | |
7f9d77f2 | 64 | and provide annotations for each line. Unlike the above |
37cd4f7e SP |
65 | example the file is read from the object database and not |
66 | the working directory. | |
67 | ||
a2df1fb2 AG |
68 | git gui blame --line=100 Makefile:: |
69 | ||
70 | Loads annotations as described above and automatically | |
71 | scrolls the view to center on line '100'. | |
72 | ||
37cd4f7e SP |
73 | git gui citool:: |
74 | ||
75 | Make one commit and return to the shell when it is complete. | |
a2df1fb2 AG |
76 | This command returns a non-zero exit code if the window was |
77 | closed in any way other than by making a commit. | |
78 | ||
79 | git gui citool --amend:: | |
80 | ||
81 | Automatically enter the 'Amend Last Commit' mode of | |
82 | the interface. | |
83 | ||
84 | git gui citool --nocommit:: | |
85 | ||
86 | Behave as normal citool, but instead of making a commit | |
87 | simply terminate with a zero exit code. It still checks | |
88 | that the index does not contain any unmerged entries, so | |
89 | you can use it as a GUI version of linkgit:git-mergetool[1] | |
37cd4f7e SP |
90 | |
91 | git citool:: | |
92 | ||
db5d6666 | 93 | Same as `git gui citool` (above). |
37cd4f7e SP |
94 | |
95 | git gui browser maint:: | |
96 | ||
97 | Show a browser for the tree of the 'maint' branch. Files | |
98 | selected in the browser can be viewed with the internal | |
99 | blame viewer. | |
100 | ||
56ae8df5 | 101 | SEE ALSO |
37cd4f7e | 102 | -------- |
56ae8df5 | 103 | linkgit:gitk[1]:: |
37cd4f7e SP |
104 | The git repository browser. Shows branches, commit history |
105 | and file differences. gitk is the utility started by | |
0b444cdb | 106 | 'git gui''s Repository Visualize actions. |
37cd4f7e SP |
107 | |
108 | Other | |
109 | ----- | |
0b444cdb | 110 | 'git gui' is actually maintained as an independent project, but stable |
02783075 | 111 | versions are distributed as part of the Git suite for the convenience |
37cd4f7e SP |
112 | of end users. |
113 | ||
0b444cdb | 114 | A 'git gui' development repository can be obtained from: |
37cd4f7e SP |
115 | |
116 | git clone git://repo.or.cz/git-gui.git | |
117 | ||
118 | or | |
119 | ||
120 | git clone http://repo.or.cz/r/git-gui.git | |
121 | ||
122 | or browsed online at http://repo.or.cz/w/git-gui.git/[]. | |
123 | ||
124 | Author | |
125 | ------ | |
126 | Written by Shawn O. Pearce <spearce@spearce.org>. | |
127 | ||
128 | Documentation | |
129 | -------------- | |
130 | Documentation by Shawn O. Pearce <spearce@spearce.org>. | |
131 | ||
132 | GIT | |
133 | --- | |
9e1f0a85 | 134 | Part of the linkgit:git[1] suite |