|
Size: 2648
Comment:
|
Size: 3841
Comment: Added comment about finding the "contrib" directory on linux. -formv09@yahoo.com
|
| 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 | ''Author: Chris Mason'' === Overview === The hgk extension allows browsing the history of a repository in a graphical way. It's a direct port of the gitk tool used with git and requires Tcl/Tk version 8.4 or later, which is not being distributed with Mercurial. The hgk.py extension adds a {{{view}}} command as well as |
| Line 6: | Line 14: |
| hgk is found in the contrib directory. | === Configuration === hgk is found in the contrib directory. Linux note: the contrib directory may not be installed by default either from the direct download or from a distribution. You can find it in the main Mercurial tar.gz from the download section. Either make the entire contrib directory accessible to those who need it, or just 'hgk' (Ex: place 'hgk' somewhere in the path, or specify it's exact location as per the instructions below.) WARNING: if you fetch the contrib directory by hand, be careful to get the one that matches your version of Mercurial! |
| Line 10: | Line 20: |
| not one in a repository). You can specify an absolute path: | not one in a repository). You can specify an absolute path: |
| Line 51: | Line 61: |
| === 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 }}} |
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's a direct port of the gitk tool used with git and requires Tcl/Tk version 8.4 or later, which is not being distributed with Mercurial.
The hgk.py extension adds a view command as well as other interfaces that hgk uses to communicate with Mercurial in a git-like manner.
Configuration
hgk is found in the contrib directory. Linux note: the contrib directory may not be installed by default either from the direct download or from a distribution. You can find it in the main Mercurial tar.gz from the download section. Either make the entire contrib directory accessible to those who need it, or just 'hgk' (Ex: place 'hgk' somewhere in the path, or specify it's exact location as per the instructions below.) WARNING: if you fetch the contrib directory by hand, be careful to get the one that matches your version of Mercurial!
hgk.py is located in the hgext directory.
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:
[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=
You would also need to add hgk to your search path, or specify the path to hgk in your .hgrc file:
[hgk] path=/location/of/hgk
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.