Add the scripts test.
[tinc] / doc / tinc-gui.8.in
1 .Dd 2011-06-26
2 .Dt TINC-GUI 8
3 .\" Manual page created by:
4 .\" Guus Sliepen <guus@tinc-vpn.org>
5 .Sh NAME
6 .Nm tinc-gui
7 .Nd tinc GUI
8 .Sh SYNOPSIS
9 .Nm
10 .Op Fl n
11 .Op Fl -net Ns = Ns Ar NETNAME
12 .Op Fl -pidfile Ns = Ns Ar FILENAME
13 .Op Fl -help
14 .Sh DESCRIPTION
15 This is a Python/wxWidgets based graphical user interface for tinc, a secure virtual private network (VPN) project.
16 .Nm
17 communicates with
18 .Xr tincd 8
19 to alter and inspect the running VPN's state.
20 It can show the current settings, the list of connections, nodes, subnets, and edges.
21 For now, the debug level can be changed from the GUI, and by right-clicking on a node in the list of connections,
22 a pop-up menu will appear that allows one to disconnect that node.
23 .Sh OPTIONS
24 .Bl -tag -width indent
25 .It Fl n, -net Ns = Ns Ar NETNAME
26 Communicate with tincd(8) connected with
27 .Ar NETNAME .
28 .It Fl -pidfile Ns = Ns Ar FILENAME
29 Use the cookie from
30 .Ar FILENAME
31 to authenticate with a running tinc daemon.
32 If unspecified, the default is
33 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
34 .It Fl -help
35 Display short list of options.
36 .El
37 .Sh BUGS
38 The GUI is not finished yet, the final version will have much more functionality.
39 If you find any bugs, report them to tinc@tinc-vpn.org.
40 .Sh SEE ALSO
41 .Xr tincd 8 ,
42 .Pa http://www.tinc-vpn.org/ .
43 .Pp
44 The full documentation for tinc is maintained as a Texinfo manual.
45 If the info and tinc programs are properly installed at your site,
46 the command
47 .Ic info tinc
48 should give you access to the complete manual.
49 .Pp
50 tinc comes with ABSOLUTELY NO WARRANTY.
51 This is free software, and you are welcome to redistribute it under certain conditions;
52 see the file COPYING for details.
53 .Sh AUTHORS
54 .An "Ivo Timmermans"
55 .An "Guus Sliepen" Aq guus@tinc-vpn.org
56 .Pp
57 And thanks to many others for their contributions to tinc!