aboutsummaryrefslogtreecommitdiffstats
path: root/doc/pinguctl.txt.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/pinguctl.txt.in')
-rw-r--r--doc/pinguctl.txt.in47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/pinguctl.txt.in b/doc/pinguctl.txt.in
new file mode 100644
index 0000000..8488ce7
--- /dev/null
+++ b/doc/pinguctl.txt.in
@@ -0,0 +1,47 @@
+PINGUCTL(8)
+===========
+:doctype: manpage
+
+
+NAME
+----
+pinguctl - pingu administration client
+
+
+SYNOPSIS
+--------
+*pinguctl* [*-a* 'SOCKETPATH'] command
+
+
+DESCRIPTION
+-----------
+Connects to a running pingu daemon and query status information.
+
+
+OPTIONS
+-------
+*-a* 'SOCKETPATH'::
+ Use SOCKETPATH as administration socket instead of the default
+ '@DEFAULT_ADM_SOCKET@'
+
+
+COMMANDS
+--------
+The following commands are valid:
+
+*gateway-status*::
+ Show the status of the gateways.
+
+*host-status*::
+ Show the status of the hosts.
+
+
+FILES
+-----
+@DEFAULT_ADM_SOCKET@
+
+
+AUTHORS
+-------
+Natanael Copa
+