/b-gtk/fix-viz

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/b-gtk/fix-viz

« back to all changes in this revision

Viewing changes to README

  • Committer: Szilveszter Farkas (Phanatic)
  • Date: 2006-08-20 13:02:35 UTC
  • mto: (0.14.1 main) (93.1.1 win32.bialix)
  • mto: This revision was merged to the branch mainline in revision 83.
  • Revision ID: Szilveszter.Farkas@gmail.com-20060820130235-62c9c5753f5d8774
Gettext support added.

2006-08-20  Szilveszter Farkas <Szilveszter.Farkas@gmail.com>

    * po/hu.po: added Hungarian traslation
    * Added gettext support to all files.
    * genpot.sh: added olive-gtk.pot generator script

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
bzr-gtk - GTK+ Frontends to various Bazaar commands
2
 
===================================================
3
 
 
4
 
This is a plugin for bzr that contains various GTK+ frontends to 
5
 
Bazaar commands. It currently contains a tool to see the history
6
 
and relationships between the revisions visually and one to 
7
 
view annotated files.
8
 
 
9
 
 
10
 
Dependencies
11
 
------------
12
 
 
13
 
bzr-gtk is written in Python, so doesn't need compiling, however you will
14
 
need the following runtime dependencies:
15
 
 
16
 
  * Python 2.4
17
 
  * Bazaar with the same major version as bzr-gtk
18
 
  * PyGObject
19
 
 
20
 
In order to see graphs in the visualisation tool, you will also need:
21
 
 
22
 
  * PyCairo 1.0 or later
23
 
 
24
 
In order to see syntax highlighted diffs:
25
 
 
26
 
  * GtkSourceView2 Python bindings (on Debian and Ubuntu systems, these
27
 
    are in the python-gtksourceview2 package)
28
 
 
29
 
In order to use the nautilus integration, you will need:
30
 
 
31
 
 * python-nautilus
32
 
 
33
 
For Olive on Windows:
34
 
 
35
 
 * pyWin32 (tested with build 209)
36
 
 
37
 
Installation
38
 
------------
39
 
 
40
 
The easiest way to install bzr-gtk is to either copy or symlink the
41
 
directory into your ~/.bazaar/plugins directory.
42
 
 
43
 
Other ways include doing the same in the bzrlib/plugins directory of
44
 
your bzr working tree, or adding the location of bzr-gtk to your
45
 
BZR_PLUGIN_PATH environment variable.
46
 
 
47
 
Note: the plugin directory of bzr-gtk must be called 'gtk'.
48
 
 
49
 
To use the nautilus integration, either place the nautilus-bzr.py file in
50
 
~/.nautilus/python-extensions or in /usr/lib/nautilus/extensions-1.0/python
51
 
 
52
 
Please note that python-nautilus currently uses the .so file of Python 
53
 
so you will need to have python-dev installed or you need to manually create a 
54
 
libpythonVER.so symlink in /usr/lib (where VER is your version of python, e.g.
55
 
2.4 or 2.5).
56
 
 
57
 
Usage - Visualisation
58
 
---------------------
59
 
 
60
 
Simply run "bzr visualise" (or "bzr viz") while in a bzr working tree or
61
 
branch, a window will appear with the history of the branch and a graph
62
 
connecting the individual revisions.
63
 
 
64
 
You can move through the revision history by clicking or with the arrow
65
 
keys.  You can also use the Back (shortcut '[') and Forward (shortcut ']')
66
 
buttons which move to the previous and next revision from that selected
67
 
(which may not be immediately adjacent in the list).
68
 
 
69
 
Details for the selected revision are shown in the pane at the bottom,
70
 
including the ids of the parent revisions.  Clicking on the go icon next
71
 
to a parent moves the list to that revision; clicking on the view icon
72
 
opens a window to display the difference between the two revisions.
73
 
 
74
 
Usage - annotate
75
 
----------------
76
 
 
77
 
Simply run "bzr gannotate FILENAME" while in a bzr working tree or branch.
78
 
 
79
 
The commit log message is shown in the lower window pane for the selected
80
 
line.  The line number column is searchable; jump to a specific line by typing
81
 
the line number while the annotation pane is in focus. Control-f will also
82
 
initiate a search.
83
 
 
84
 
By default, lines are highlighted according to age. This functionality is a
85
 
crib of emacs' VC-annotate highlighting, and thus works similarly: blue is
86
 
oldest and red is youngest, and an assortment of other colors in-between:
87
 
 
88
 
        blue --> green --> yellow --> orange --> red
89
 
 
90
 
Time spans are scaled; for instance by selecting "1 Day", lines older than a
91
 
day will be highlighted blue, but changes in the past hour will be red and
92
 
lines 2 hours old may be orange. Highlighting can be turned off with --plain
93
 
if overwhelming.
94
 
 
95
 
Usage - diff window
96
 
-------------------
97
 
 
98
 
If you have the gtksourceview python bindings installed, the diff window
99
 
will have syntax highlighting. If the python GConf bindings are installed, 
100
 
the colors will be read from gedit's syntax highlighting configuration
101
 
for the "Diff" language.
102
 
 
103
 
Afterwards, colors from the ~/.colordiffrc file will be read, and will
104
 
override gedit's. Since that file may be written for a dark background
105
 
environment, the file ~/.colordiffrc.bzr-gtk can be used to override
106
 
some values.
107
 
 
108
 
Because gtksourceview is more configurable that colordiff, in addition
109
 
to the 'oldtext', 'newtext', and 'diffstuff' keys, the following keys
110
 
are also accepted: 'location', 'file', 'specialcase'.
111
 
 
112
 
Colors can be specified with names (valid names are those in the
113
 
/usr/share/X11/rgb.txt file), or with a #RRGGBB notation.
114
 
 
115
 
Install on Windows
116
 
------------------
117
 
 
118
 
You can download the dependencies from the following locations:
119
 
 
120
 
 - Python: http://www.python.org/download/releases/2.4.3/
121
 
 - GTK: http://gladewin32.sourceforge.net/
122
 
 - PyGTK: http://www.mapr.ucl.ac.be/~gustin/win32_ports (pygobject and pycairo)
123
 
 - Bazaar: http://bazaar-vcs.org/WindowsDownloads (Python-based should be okay)
124
 
 - pyWin32: http://sourceforge.net/project/showfiles.php?group_id=78018
125
 
 
126
 
As an Administrator, you can install Olive with the standard command:
127
 
 
128
 
 > c:\Python24\python.exe setup.py install
129
 
 
130
 
You can run Olive with this command:
131
 
 
132
 
 > c:\Python24\python.exe c:\Python\Scripts\olive-gtk
133
 
 
134