README
1=========
2MultiTerm
3=========
4
5
6.. contents::
7
8
9About
10=====
11
12MultiTerm is similar to Geany's built-in VTE terminal except that it
13supports multiple terminals in tabs and supports different shells in
14each of the terminal tabs.
15
16
17Requirements
18============
19
20MultiTerm depends on the very common VTE library (libvte). In order
21to compile the MultiTerm plugin you will need the development files for
22the VTE library.
23
24MultiTerm is written in Vala and so requires that you have the Vala
25compiler (valac) installed as well as your existing C compiler.
26
27
28Installation
29============
30
31For detailed instructions, see the INSTALL file of the Geany-Plugins package
32this plugin is part of.
33
34
35Usage
36=====
37
38While the user-interface of the plugin will soon be completely revamped,
39at present it adds a new tab to the message area which contains the
40notebook for the Terminals. You can add terminals by clicking on the
41plus button to the right of the tabs and you can close terminals by
42clicking the tab's close button.
43
44The configuration file is also going to change a fair bit soon, but
45it is stored at `~/.config/geany/plugins/multiterm/multiterm.conf` and
46can be tweaked to change the behaviour of the plugin. Eventually there
47will be a GUI to control the preferences, but for now it's just this
48file.
49
50Note that until at least the first release of the MultiTerm plugin the
51configuration file will not be backwards-compatible, so you should
52transfer your settings to a new default configuration file whenever
53rebuilding from source. Moving the old config file out of the way will
54cause a new default config file to be written in its place.
55
56
57License
58=======
59
60MultiTerm is distributed under the terms of the GNU General Public License
61as published by the Free Software Foundation, either version 2 of the
62License, or (at your option) any later version. You should have received a copy
63of the GNU General Public License along with MultiTerm. If not, see
64<http://www.gnu.org/licenses/>.
65
66
67Contact
68=======
69
70You can email me at <matt(at)geany(dor)org>, and I may also be on the
71#geany channel on FreeNode, under the `codebrainz` nickname.
72
73
74Bug reports and feature requests
75--------------------------------
76
77To report a bug or ask for a new feature, please use the Geany-Plugins tracker
78on GitHub: https://github.com/geany/geany-plugins/issues
79