Added manpage.
authorMichael Jumper <zhangmaike@users.sourceforge.net>
Sun, 11 Dec 2011 07:45:09 +0000 (23:45 -0800)
committerMichael Jumper <zhangmaike@users.sourceforge.net>
Sun, 11 Dec 2011 07:45:09 +0000 (23:45 -0800)
Makefile.am
man/guacd.8 [new file with mode: 0644]

index 2bc2f5a..2f93be2 100644 (file)
@@ -41,6 +41,7 @@ AM_CFLAGS = -Werror -Wall -pedantic -Iinclude
 
 sbin_PROGRAMS = guacd
 init_SCRIPTS = init.d/guacd
+man_MANS = man/guacd.8
 
 noinst_HEADERS = include/client.h include/log.h
 guacd_SOURCES = src/daemon.c src/client.c src/log.c
diff --git a/man/guacd.8 b/man/guacd.8
new file mode 100644 (file)
index 0000000..9843ea9
--- /dev/null
@@ -0,0 +1,43 @@
+.TH guacd 8 "10 Dec 2011" "version 0.5.0" "Guacamole"
+.
+.SH NAME
+guacd \- Guacamole proxy daemon
+.
+.SH SYNOPSIS
+.B guacd
+[\fB-b\fR \fIHOST\fR]
+[\fB-l\fR \fIPORT\fR]
+[\fB-p\fR \fIFILE\fR]
+.
+.SH DESCRIPTION
+.B guacd
+is the Guacamole proxy daemon used by the Guacamole web application and
+framework. As JavaScript cannot handle binary protocols (like VNC and remote
+desktop) efficiently, a new text-based protocol was developed which would
+contain a common superset of the operations needed for efficient remote
+desktop access, but would be easy for JavaScript programs to process.
+.B guacd
+is the proxy which translates between arbitrary protocols and the Guacamole
+protocol.
+.
+.SH OPTIONS
+.TP
+\fB\-b\fR \fIHOST\fR
+Changes the host or address that
+.B guacd
+listens on.
+.TP
+\fB\-l\fR \fIPORT\fR
+Changes the port that
+.B guacd
+listens on (the default is port 4822).
+.TP
+\fB\-p\fR \fIFILE\fR
+Causes
+.B guacd
+to write the PID of the daemon process to the specified
+file. This is useful for init scripts and is used by the provided init
+script.
+.
+.SH AUTHOR
+Written by Michael Jumper <zhangmaike@users.sourceforge.net>