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

« back to all changes in this revision

Viewing changes to geanylua/INSTALL

  • 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
 
 
2
Important note! If you are upgrading from an older installation, please note
 
3
that the name of the script folder is now changed from /lua/ to /geanylua/ !!!
 
4
 
 
5
 
 
6
 
 
7
These installation instructions are written primarily for a Linux system,
 
8
followed by some additional notes for MS-Windows users.
 
9
 
 
10
If you are installing from the pre-compiled Linux plugin package, you can
 
11
just run the "install.sh" script, to install the plugin, examples, and help
 
12
files into your ~/.geany/plugins directory.
 
13
 
 
14
 
 
15
If you want Geany's syntax highlighter to recognize the plugin's function 
 
16
names you can also modify your  "filetypes.lua" file according to the notes
 
17
in the "geanylua/keywords.list" file.
 
18
 
 
19
 
 
20
For those of you who want to compile the plugin from scratch, keep reading...
 
21
 
 
22
 
 
23
At the time of this writing, building the plugin requires a recent SVN checkout
 
24
of the Geany sources (r2391+), and a properly installed copy of the Lua 5.1.x
 
25
library, headers, and pkg-config script.
 
26
 
 
27
 
 
28
Recent versions of Geany will now install all the necessary headers in
 
29
$PREFIX/include/geany/ along with a pkg-config script that tells configure
 
30
where to find the required files, so  the old --with-geany-src option
 
31
is no longer required. Building should now be as simple as:
 
32
 
 
33
 % configure
 
34
 % make
 
35
 % make install
 
36
 
 
37
The "make install" command copies the files to your personal ~/.geany/plugins/
 
38
directory, so you don't need to be root to install. If you actually do want
 
39
everyone on the system to be able to access to the same copy of the plugin,
 
40
you can add the --enable-sys-install option to the ./configure command line.
 
41
 
 
42
 
 
43
To uninstall the plugin, you should be able to simply type "make uninstall"
 
44
but be warned - although it will try not to remove any of your own personal
 
45
scripts, the folder "geanylua/examples" and all its contents will always be
 
46
removed unconditionally, so any scripts in the examples directory WILL BE LOST!
 
47
 
 
48
 
 
49
 
 
50
===========================  MS-WINDOWS NOTES  ===============================
 
51
 
 
52
The pre-compiled GeanyLua package includes a couple of Visual Basic scripts
 
53
that I hope will simplify installation for most users. The scripts require a
 
54
recent version of Geany (SVN-r2151 or newer) and the Windows VBS scripting
 
55
engine. ( If you have at least Internet Explorer 5.0, you probably have VBS.)
 
56
 
 
57
To install geanylua using the script, just double-click the "win32-install.vbs"
 
58
file and if you don't see any error messages, you should be all set up.
 
59
( Be sure to exit any running instance of Geany before installing! )
 
60
 
 
61
If something goes wrong, you can try installing manually, as follows...
 
62
 
 
63
To install the pre-compiled plugin on Windows, you can copy the "geanylua.dll"
 
64
file to the "plugins" folder in the same place where Geany is installed, that
 
65
would probably be "C:\Program Files\Geany\plugins\geanylua.dll" or somewhere
 
66
like that.
 
67
 
 
68
The exact location where Geany will look for the Lua script files depends on
 
69
your Windows version, your Geany version, and possibly even your environment.
 
70
 
 
71
For user "jane" it could be any one of these:
 
72
 
 
73
Prior to Geany-SVN-2139, the paths would look something like this:
 
74
 
 
75
Win2k:  C:\Documents and Settings\jane\.geany\plugins\geanylua\
 
76
Win98:  C:\.geany\plugins\geanylua\
 
77
MinGW:  C:\msys\1.0\home\jane\.geany\plugins\geanylua\
 
78
 
 
79
 
 
80
As of Geany-SVN-2139, the configuration paths should be more like this:
 
81
 
 
82
Win2k:  C:\Documents and Settings\jane\Application Data\Geanyplugins\geanylua\
 
83
Win98:  C:\Windows\Profiles\jane\Application Data\Geany\plugins\geanylua\
 
84
MinGW:  Geany's config path now ignores the $HOME environment variable.
 
85
 
 
86
Just in case you aren't confused yet, anonymous users on Win98 may need to
 
87
place the files in "C:\Windows\Application Data\Geany\plugins\geanylua\"
 
88
 
 
89
 
 
90
If you want to compile the plugin from the sources on MS-Windows, you will
 
91
need a fairly complete MSYS/MINGW/GTK build system, along with a properly built
 
92
and installed "liblua.a" library, and the Lua headers. ( The "Win32_mingw3_lib"
 
93
package from http://luabinaries.luaforge.net/ worked fine for me. )
 
94
 
 
95
You also need a copy of the file "lua.pc" from the Lua sources somewhere in
 
96
your $PKG_CONFIG_PATH. The libtool I used complains about missing symbols and
 
97
refuses to build the DLL, so you may need to explicitly type "make win32"
 
98
in order to produce the ".libs/geanylua.dll" file.
 
99
 
 
100
The "make install" target is badly broken for Windows, so you will probably
 
101
want to run the "win32-install.vbs" script, or copy the files manually
 
102
to their required locations, as described above.
 
103