annotate PLUGINS_HOWTO @ 14504:7be98514555e

[gaim-migrate @ 17223] Move doc/HOWTO to PLUGINS_HOWTO. Someone should add a section to the bottom of our C Plugin HOWTO that describes how to compile a C plugin outside of the Gaim source tree, and give a really small example Makefile committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Sun, 10 Sep 2006 20:05:53 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14504
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
1 For information on writing a plugin for Gaim, go
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
2 http://gaim.sourceforge.net/api/ and see the HOWTOs in the
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
3 "Related Pages" section.
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
4
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
5 You can also generate this documentation locally by installing
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
6 doxygen and graphviz dot, then running "make docs" in the Gaim
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
7 source tree. The documentation will be in the docs/html directory.
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
8
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
9 This next paragraph is old and possibly out of date:
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
10 Compilation of the plugins is fairly straight-forward; there is a
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
11 Makefile in this directory that has a rule for making the .so file
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
12 from a .c file. No modification of the Makefile should be necessary,
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
13 unless if you simply want to type 'make' to have it made; otherwise,
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
14 'make filename.so' will take filename.c and make the .so plugin from
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
15 it. If you need to link in with extra libraries, you can set the
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
16 environment variable PLUGIN_LIBS to be the libraries you want to link
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
17 with.
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
18
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
19 It should be possible to compile plugins outside of the Gaim source
7be98514555e [gaim-migrate @ 17223]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
20 tree, which is a much cleaner solution.