From: Guus Sliepen <guus@tinc-vpn.org>
Date: Sun, 26 Jun 2011 11:15:44 +0000 (+0200)
Subject: Add manpage for tinc-gui.
X-Git-Tag: import-tinc-1.1~461
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=6c21b5716b8e9e5ff5def8070f92b76a0f353cb0;p=meshlink

Add manpage for tinc-gui.
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 66de6d93..8f0305e4 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -2,11 +2,11 @@
 
 info_TEXINFOS = tinc.texi
 
-man_MANS = tincd.8 tincctl.8 tinc.conf.5
+man_MANS = tincd.8 tincctl.8 tinc.conf.5 tinc-gui.8
 
-EXTRA_DIST = tincinclude.texi.in tincd.8.in tincctl.8.in tinc.conf.5.in sample-config.tar.gz
+EXTRA_DIST = tincinclude.texi.in tincd.8.in tincctl.8.in tinc.conf.5.in tinc-gui.8.in sample-config.tar.gz
 
-CLEANFILES = *.html tinc.info tincd.8 tincctl.8 tinc.conf.5 tincinclude.texi
+CLEANFILES = *.html tinc.info tincd.8 tincctl.8 tinc.conf.5 tinc-gui.8 tincinclude.texi
 
 # Use `ginstall' in the definition of man_MANS to avoid
 # confusion with the `install' target.  The install rule transforms `ginstall'
@@ -28,6 +28,9 @@ tincd.8.html: tincd.8
 tincctl.8.html: tincctl.8
 	w3mman2html $< > $@
 
+tinc-gui.8.html: tinc-gui.8
+	w3mman2html $< > $@
+
 tinc.conf.5.html: tinc.conf.5
 	w3mman2html $< > $@
 
@@ -38,15 +41,18 @@ substitute = sed \
 	-e s,'@localstatedir\@',"$(localstatedir)",g
 
 tincd.8: tincd.8.in
-	$(substitute) tincd.8.in > tincd.8
+	$(substitute) $< > $@
 
 tincctl.8: tincctl.8.in
-	$(substitute) tincctl.8.in > tincctl.8
+	$(substitute) $< > $@
+
+tinc-gui.8: tinc-gui.8.in
+	$(substitute) $< > $@
 
 tinc.conf.5: tinc.conf.5.in
-	$(substitute) tinc.conf.5.in > tinc.conf.5
+	$(substitute) $< > $@
 
 tincinclude.texi: tincinclude.texi.in
-	$(substitute) tincinclude.texi.in > tincinclude.texi
+	$(substitute) $< > $@
 	
 tinc.texi: tincinclude.texi
diff --git a/doc/tinc-gui.8.in b/doc/tinc-gui.8.in
new file mode 100644
index 00000000..f5ebadb2
--- /dev/null
+++ b/doc/tinc-gui.8.in
@@ -0,0 +1,57 @@
+.Dd 2011-06-26
+.Dt TINC-GUI 8
+.\" Manual page created by:
+.\" Guus Sliepen <guus@tinc-vpn.org>
+.Sh NAME
+.Nm tinc-gui
+.Nd tinc GUI
+.Sh SYNOPSIS
+.Nm
+.Op Fl n
+.Op Fl -net Ns = Ns Ar NETNAME
+.Op Fl -pidfile Ns = Ns Ar FILENAME
+.Op Fl -help
+.Sh DESCRIPTION
+This is a Python/wxWidgets based graphical user interface for tinc, a secure virtual private network (VPN) project.
+.Nm
+communicates with
+.Xr tincd 8
+to alter and inspect the running VPN's state.
+It can show the current settings, the list of connections, nodes, subnets, and edges.
+For now, the debug level can be changed from the GUI, and by right-clicking on a node in the list of connections,
+a pop-up menu will appear that allows one to disconnect that node.
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl n, -net Ns = Ns Ar NETNAME
+Communicate with tincd(8) connected with
+.Ar NETNAME .
+.It Fl -pidfile Ns = Ns Ar FILENAME
+Use the cookie from
+.Ar FILENAME
+to authenticate with a running tinc daemon.
+If unspecified, the default is
+.Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
+.It Fl -help
+Display short list of options.
+.El
+.Sh BUGS
+The GUI is not finished yet, the final version will have much more functionality.
+If you find any bugs, report them to tinc@tinc-vpn.org.
+.Sh SEE ALSO
+.Xr tincd 8 ,
+.Pa http://www.tinc-vpn.org/ .
+.Pp
+The full documentation for tinc is maintained as a Texinfo manual.
+If the info and tinc programs are properly installed at your site,
+the command
+.Ic info tinc
+should give you access to the complete manual.
+.Pp
+tinc comes with ABSOLUTELY NO WARRANTY.
+This is free software, and you are welcome to redistribute it under certain conditions;
+see the file COPYING for details.
+.Sh AUTHORS
+.An "Ivo Timmermans"
+.An "Guus Sliepen" Aq guus@tinc-vpn.org
+.Pp
+And thanks to many others for their contributions to tinc!