~ubuntu-branches/debian/squeeze/geany-plugins/squeeze

« back to all changes in this revision

Viewing changes to geanygdb/README

  • Committer: Bazaar Package Importer
  • Author(s): Chow Loong Jin
  • Date: 2009-07-10 22:56:41 UTC
  • Revision ID: james.westby@ubuntu.com-20090710225641-xc1126t7pq0jmpos
Tags: upstream-0.17.1
ImportĀ upstreamĀ versionĀ 0.17.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. |(version)| replace:: 0.0.2
 
2
.. |(download_current)| replace:: http://plugins.geany.org/geanygdb/geanygdb-0.0.2.tar.gz
 
3
 
 
4
===============
 
5
GeanyGDB Plugin
 
6
===============
 
7
 
 
8
.. contents::
 
9
 
 
10
About
 
11
=====
 
12
GeanyGDB is a plugin for Geany which provides integrated debugging support
 
13
within Geany via the GNU Debugger (gdb).
 
14
 
 
15
Geany is a small and lightweight integrated development environment using the
 
16
GTK2 toolkit.
 
17
 
 
18
The GNU Debugger is a source-level debugger for C, C++, Fortran, Modula 2 and
 
19
Java programs.
 
20
 
 
21
It was developed and tested on openSUSE-10.3 with GDB-6.7.50. Other recent
 
22
versions of GDB will probably work, but operating systems other than Linux-PC
 
23
will not work, at least not without some considerable hacking.
 
24
 
 
25
 
 
26
Current Version
 
27
===============
 
28
The current stable GeanyGDB release is |(version)|.
 
29
 
 
30
 
 
31
Requirements
 
32
============
 
33
For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries
 
34
and header files. You will also need its dependency libraries and header
 
35
files, such as Pango, Glib and ATK. All these files are available at
 
36
http://www.gtk.org.
 
37
 
 
38
And obviously, you will need have Geany installed. If you have Geany installed
 
39
from the sources, you should be ready to go.
 
40
If you used a prepared package e.g. from your distribution you probably need
 
41
to install an additional package, this might be called geany-dev or geany-devel.
 
42
Please note that in order to compile and use this plugin, you need Geany 0.16
 
43
or later.
 
44
 
 
45
Furthermore you need, of course, a C compiler and the Make tool.
 
46
The GNU versions of these tools are recommended.
 
47
 
 
48
 
 
49
Installation
 
50
============
 
51
See the file `INSTALL <INSTALL.html>`_ for more information.
 
52
 
 
53
 
 
54
Documentation
 
55
=============
 
56
There is no real documentation, but if you hover your mouse over the buttons
 
57
in the "Debug" sidebar panel in Geany the tooltips should give you some idea
 
58
of what to do next. There are also a few "rough draft" notes below:
 
59
 
 
60
Most of the console output from GDB is sent to the "Compiler" message window
 
61
in Geany, and you can send standard commands to GDB using the "Console" entry
 
62
on the debug sidebar. This should be used with caution, since GDB's machine
 
63
interface and console interface don't always play well together.
 
64
 
 
65
Also note that the plugin sets its own internal breakpoint #1 to grab the
 
66
program's PID on startup, so any user-specified breakpoint numbers begin
 
67
at #2, and if you manually delete the #1 breakpoint it will likely cause
 
68
you some problems.
 
69
 
 
70
Whenever the target program hits a breakpoint or encounters a segfault etc.
 
71
it will try to open the appropriate source file and jump to the correct line.
 
72
 
 
73
To examine the state of the program's variables, you can click on the "Stack"
 
74
button in the debug sidebar. Note that the interaction between the plugin and
 
75
the debugger can sometimes be quite slow, so please be patient when waiting
 
76
for the dialogs to open.
 
77
 
 
78
The "Add breakpoint", "Add watchpoint", and "Run to" dialogs will try to
 
79
suggest some values based on your current position in whatever file you
 
80
have open in Geany, but if you don't like the choice, just click the "Clear"
 
81
button and type in whatever you please.
 
82
 
 
83
The plugin tries to enable only the buttons that are relevant to the current
 
84
state, but ocassionally it might end up getting things wrong. If this happens,
 
85
you should be able to click the "Unload" button and everything will be reset.
 
86
 
 
87
If you try to unload the plugin using the plugin manager while it has a
 
88
program loaded, the plugin manager might appear to hang for a few seconds,
 
89
while GDB tries to shut down. Again, just be patient, but note that it is
 
90
much better use the "Unload" button in the debug sidebar before trying to
 
91
disable the plugin.
 
92
 
 
93
 
 
94
Download
 
95
========
 
96
 
 
97
Current Version
 
98
---------------
 
99
 
 
100
============= ================ =================================================
 
101
Geany Version GeanyGDB Version Download
 
102
============= ================ =================================================
 
103
0.16               |(version)| |(download_current)|
 
104
============= ================ =================================================
 
105
 
 
106
Up to date source code can be downloaded here::
 
107
 
 
108
  svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanygdb
 
109
 
 
110
previous Versions
 
111
-----------------
 
112
 
 
113
======================= ================ =========================================================
 
114
Geany Version           GeanyGDB Version Download
 
115
======================= ================ =========================================================
 
116
known to work with 0.14            0.0.1 http://plugins.geany.org/geanygdb/geanydebug-0.0.1.tar.gz
 
117
======================= ================ =========================================================
 
118
 
 
119
 
 
120
Contact
 
121
=======
 
122
Geanys official homepage is http://geany.org/
 
123
 
 
124
mailing list is geany@uvena.de
 
125
 
 
126
eMail to dmaphy@googlemail.com
 
127
 
 
128
meet us in IRC on channels #geany or #geany-de using chat.freenode.net
 
129