aboutsummaryrefslogtreecommitdiffstats
path: root/doc/pinguctl.8.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/pinguctl.8.in')
-rw-r--r--doc/pinguctl.8.in38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/pinguctl.8.in b/doc/pinguctl.8.in
new file mode 100644
index 0000000..dce74a6
--- /dev/null
+++ b/doc/pinguctl.8.in
@@ -0,0 +1,38 @@
+.Dd October 19, 2011
+.Dt PINGUCTL 8 Linux
+.Os
+
+.Sh NAME
+.Nm pinguctl
+.Nd pingu administration client
+
+.Sh SYNOPSIS
+.Nm
+.Op Fl a SOCKETPATH
+.Op Ar command ...
+
+.Sh DESCRIPTION
+Connects to a running pingu daemon and query status information.
+.Bl -tag -width indent
+.It Fl a
+Use SOCKETPATH as administration socket instead of the default @DEFAULT_ADM_SOCKET@
+.El
+
+.Sh COMMANDS
+The following commands are valid:
+.Bl -tag -width indent
+.It Ar gateway-status
+Show the status of the gateways.
+.It Ar host-status
+Show the status of the hosts.
+.El
+
+
+.Sh FILES
+@DEFAULT_ADM_SOCKET@
+
+.Sh AUTHORS
+.An Natanael Copa
+.Aq ncopa@alpinelinux.org
+
+