]>
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 | -------- | |
7791a1d9 | 10 | [verse] |
37cd4f7e SP |
11 | 'git gui' [<command>] [arguments] |
12 | ||
13 | DESCRIPTION | |
14 | ----------- | |
0b444cdb | 15 | A Tcl/Tk based graphical user interface to Git. 'git gui' focuses |
37cd4f7e SP |
16 | on allowing users to make changes to their repository by making |
17 | new commits, amending existing ones, creating branches, performing | |
18 | local merges, and fetching/pushing to remote repositories. | |
19 | ||
0b444cdb | 20 | Unlike 'gitk', 'git gui' focuses on commit generation |
483bc4f0 | 21 | and single file annotation and does not show project history. |
42d36bb8 | 22 | It does however supply menu actions to start a 'gitk' session from |
0b444cdb | 23 | within 'git gui'. |
37cd4f7e | 24 | |
0b444cdb | 25 | 'git gui' is known to work on all popular UNIX systems, Mac OS X, |
37cd4f7e | 26 | and Windows (under both Cygwin and MSYS). To the extent possible |
0b444cdb | 27 | OS specific user interface guidelines are followed, making 'git gui' |
37cd4f7e SP |
28 | a fairly native interface for users. |
29 | ||
30 | COMMANDS | |
31 | -------- | |
32 | blame:: | |
33 | Start a blame viewer on the specified file on the given | |
34 | version (or working directory if not specified). | |
35 | ||
36 | browser:: | |
37 | Start a tree browser showing all files in the specified | |
3120925c | 38 | commit. Files selected through the |
37cd4f7e SP |
39 | browser are opened in the blame viewer. |
40 | ||
41 | citool:: | |
0b444cdb | 42 | Start 'git gui' and arrange to make exactly one commit before |
37cd4f7e SP |
43 | exiting and returning to the shell. The interface is limited |
44 | to only commit actions, slightly reducing the application's | |
45 | startup time and simplifying the menubar. | |
46 | ||
47 | version:: | |
0b444cdb | 48 | Display the currently running version of 'git gui'. |
37cd4f7e SP |
49 | |
50 | ||
51 | Examples | |
52 | -------- | |
5d2fc913 | 53 | `git gui blame Makefile`:: |
37cd4f7e SP |
54 | |
55 | Show the contents of the file 'Makefile' in the current | |
56 | working directory, and provide annotations for both the | |
57 | original author of each line, and who moved the line to its | |
58 | current location. The uncommitted file is annotated, and | |
59 | uncommitted changes (if any) are explicitly attributed to | |
60 | 'Not Yet Committed'. | |
61 | ||
5d2fc913 | 62 | `git gui blame v0.99.8 Makefile`:: |
37cd4f7e SP |
63 | |
64 | Show the contents of 'Makefile' in revision 'v0.99.8' | |
7f9d77f2 | 65 | and provide annotations for each line. Unlike the above |
37cd4f7e SP |
66 | example the file is read from the object database and not |
67 | the working directory. | |
68 | ||
5d2fc913 | 69 | `git gui blame --line=100 Makefile`:: |
a2df1fb2 AG |
70 | |
71 | Loads annotations as described above and automatically | |
72 | scrolls the view to center on line '100'. | |
73 | ||
5d2fc913 | 74 | `git gui citool`:: |
37cd4f7e SP |
75 | |
76 | Make one commit and return to the shell when it is complete. | |
a2df1fb2 AG |
77 | This command returns a non-zero exit code if the window was |
78 | closed in any way other than by making a commit. | |
79 | ||
5d2fc913 | 80 | `git gui citool --amend`:: |
a2df1fb2 AG |
81 | |
82 | Automatically enter the 'Amend Last Commit' mode of | |
83 | the interface. | |
84 | ||
5d2fc913 | 85 | `git gui citool --nocommit`:: |
a2df1fb2 AG |
86 | |
87 | Behave as normal citool, but instead of making a commit | |
88 | simply terminate with a zero exit code. It still checks | |
89 | that the index does not contain any unmerged entries, so | |
90 | you can use it as a GUI version of linkgit:git-mergetool[1] | |
37cd4f7e | 91 | |
5d2fc913 | 92 | `git citool`:: |
37cd4f7e | 93 | |
db5d6666 | 94 | Same as `git gui citool` (above). |
37cd4f7e | 95 | |
5d2fc913 | 96 | `git gui browser maint`:: |
37cd4f7e SP |
97 | |
98 | Show a browser for the tree of the 'maint' branch. Files | |
99 | selected in the browser can be viewed with the internal | |
100 | blame viewer. | |
101 | ||
56ae8df5 | 102 | SEE ALSO |
37cd4f7e | 103 | -------- |
56ae8df5 | 104 | linkgit:gitk[1]:: |
2de9b711 | 105 | The Git repository browser. Shows branches, commit history |
37cd4f7e | 106 | and file differences. gitk is the utility started by |
0b444cdb | 107 | 'git gui''s Repository Visualize actions. |
37cd4f7e SP |
108 | |
109 | Other | |
110 | ----- | |
0b444cdb | 111 | 'git gui' is actually maintained as an independent project, but stable |
02783075 | 112 | versions are distributed as part of the Git suite for the convenience |
37cd4f7e SP |
113 | of end users. |
114 | ||
7d2f003e | 115 | The official repository of the 'git gui' project can be found at: |
37cd4f7e | 116 | |
7d2f003e | 117 | https://github.com/prati0100/git-gui.git/ |
37cd4f7e | 118 | |
37cd4f7e SP |
119 | GIT |
120 | --- | |
9e1f0a85 | 121 | Part of the linkgit:git[1] suite |