|
Size: 2597
Comment:
|
Size: 4176
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| Mercurial includes a tool called hgk that allows browsing the history of a repository in a GUI. It's a direct port of the gitk tool used with git. Hgk requires Tcl/Tk version 8.4 or later. | ## page was renamed from UsingHgk == Hgk extension == '''This extension is currently being distributed along with Mercurial.''' |
| Line 3: | Line 5: |
| To use hgk, you'll want to install the hgk.py extension which adds a view command as well as other interfaces that hgk uses to communicate with Mercurial in a git-like manner. |
''Author: Chris Mason'' |
| Line 6: | Line 7: |
| Both hgk and hgk.py are found in the contrib directory. | === Overview === The {{{hgk}}} extension allows browsing the history of a repository in a graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is not distributed with Mercurial.) |
| Line 8: | Line 10: |
| To load an extension, you add it to your .hgrc file (you have to use your global $HOME/.hgrc file, not one in a repository). You can specify an absolute path: |
=== Configuration === {{{hgk}}} consists of two parts: a Tcl script that does the displaying and querying of information, and an extension to mercurial named {{{hgk.py}}}, which provides hooks for {{{hgk}}} to get information. {{{hgk}}} can be found in the {{{contrib}}} directory, and {{{hgk.py}}} can be found in the {{{hgext}}} directory. To load the {{{hgext.py}}} extension, add it to your .hgrc file (you have to use your global $HOME/.hgrc file, not one in a repository). You can specify an absolute path: |
| Line 23: | Line 28: |
| You would also need to add hgk to your search path, or specify the path to hgk in your .hgrc file: | The {{{hg view}}} command will launch the {{{hgk}}} Tcl script. For this command to work, {{{hgk}}} must be in your search path. Alternately, you can specify the path to {{{hgk}}} in your .hgrc file: |
| Line 29: | Line 34: |
<!> '''Note''': Many Linux distributions include the {{{hgk.py}}} extension in the mercurial package, but not the {{{hgk}}} Tcl script. If this is the case, you can find it in the contrib directory of the main Mercurial tar.gz from the download section. WARNING: if you fetch the contrib directory by hand, be careful to get the one that matches your version of Mercurial! Be aware that {{{hgk}}} requires {{{/usr/bin/wish}}} - which (at least on Fedora) is in the {{{tk}}} package. |
|
| Line 50: | Line 57: |
| === Configuration for Windows NT === Under Windows NT, we need to make sure Hg can invoke the hgk script. So, assuming you have Tcl/Tk installed, create a file called {{{hgk.cmd}}} with the following content (just replace the path to the hgk script on your system): {{{ @wish C:\path\to\hgk %* }}} As with the Unix environment, you need to add {{{hgk.cmd}}} to the search path, or specify the path to hgk in your mercurial.ini file: {{{ [hgk] path=C:\location\of\hgk.cmd }}} |
|
| Line 73: | Line 92: |
=== Notes === The {{{hgk}}} Tcl script is a direct port of the {{{gitk}}} tool used with git. The {{{hgk.py}}} extension allows {{{hgk}}} to interact with mercurial in a git-like manner. ---- CategoryExtension |
Hgk extension
This extension is currently being distributed along with Mercurial.
Author: Chris Mason
Overview
The hgk extension allows browsing the history of a repository in a graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is not distributed with Mercurial.)
Configuration
hgk consists of two parts: a Tcl script that does the displaying and querying of information, and an extension to mercurial named hgk.py, which provides hooks for hgk to get information. hgk can be found in the contrib directory, and hgk.py can be found in the hgext directory.
To load the hgext.py extension, add it to your .hgrc file (you have to use your global $HOME/.hgrc file, not one in a repository). You can specify an absolute path:
[extensions] hgk=/usr/local/lib/hgk.py
Mercurial can also scan the default python library path for a file named 'hgk.py' if you set hgk empty:
[extensions] hgk=
The hg view command will launch the hgk Tcl script. For this command to work, hgk must be in your search path. Alternately, you can specify the path to hgk in your .hgrc file:
[hgk] path=/location/of/hgk
Note: Many Linux distributions include the hgk.py extension in the mercurial package, but not the hgk Tcl script. If this is the case, you can find it in the contrib directory of the main Mercurial tar.gz from the download section. WARNING: if you fetch the contrib directory by hand, be careful to get the one that matches your version of Mercurial! Be aware that hgk requires /usr/bin/wish - which (at least on Fedora) is in the tk package.
In version 0.7, this extension is named "hgit" (without the .py) and does not provide the view command. You must invoke hgk directly.
Now hg help will show the new commands provided by the hgk extension:
$ hg help ... status show changed files in the working directory tag add a tag for the current tip or a given revision tags list repository tags tip show the tip revision unbundle apply a changegroup file undo undo the last commit or pull update update or merge working directory verify verify the integrity of the repository version output version and copyright information view start interactive history viewer $ hg view
Configuration for Windows NT
Under Windows NT, we need to make sure Hg can invoke the hgk script. So, assuming you have Tcl/Tk installed, create a file called hgk.cmd with the following content (just replace the path to the hgk script on your system):
@wish C:\path\to\hgk %*
As with the Unix environment, you need to add hgk.cmd to the search path, or specify the path to hgk in your mercurial.ini file:
[hgk] path=C:\location\of\hgk.cmd
Keyboard Accelerators
The following key combinations can be used to perform certain actions:
Ctrl+q quit Ctrl+f find Ctrl+= or Ctrl+<Keypad +> increase font size Ctrl+- or Ctrl+<Keypad -> decrease font size Ctrl+g, Return, or '/' find next match Ctrl+r or '?' find previous match Arrow-up select previous changeset Arrow-down select next changeset Page-up or 'p' scroll changeset list up one page Page-down or 'n' scroll changeset list down one page Delete, Backspace or 'b' scroll viewed changeset up one page Space scroll viewed changeset down one page 'd' scroll viewed changeset down 18 lines 'u' scroll viewed changeset up 18 lines
Selected font size will be saved in ~/.gitk and reused in the next session.
Notes
The hgk Tcl script is a direct port of the gitk tool used with git. The hgk.py extension allows hgk to interact with mercurial in a git-like manner.