Improve performance of edge updates.
[tinc] / gui / README.gui
1 This experimental GUI is written in Python with wxPython widgets. You need to
2 have both installed for it to work. After starting tinc with either tincd or
3 tincctl, you can start the gui:
4
5 tincd -n vpn
6 tinc-gui -n vpn
7
8 If the GUI cannot find the pid file (for example if it is not in
9 /var/run), you can specify its location manually:
10
11 tinc-gui --pidfile /usr/local/var/run/tinc.vpn.pid
12
13 The following things sort of work:
14
15 - Changing the debug level from the settings page
16 - Viewing the list of connections, nodes, edges and subnets. These lists will
17   be refreshed once per second.
18 - Right-clicking on a connection brings up a popup menu, which allows you to
19   close a connection.
20
21 Python was chosen to enable rapid application development, wxWidgets for its
22 cross-platform compatibility and platform-native widgets. Once the GUI is
23 matured, it will probably rewritten in C++ to allow static linking and easy
24 distribution, without needing to install both Python and wxWidgets.