From e6fe9e7008acf0860df4c797a22e92f64da37131 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sat, 10 Dec 2011 23:45:09 -0800 Subject: [PATCH] Added manpage. --- guacd/Makefile.am | 1 + guacd/man/guacd.8 | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 guacd/man/guacd.8 diff --git a/guacd/Makefile.am b/guacd/Makefile.am index 2bc2f5aa..2f93be29 100644 --- a/guacd/Makefile.am +++ b/guacd/Makefile.am @@ -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/guacd/man/guacd.8 b/guacd/man/guacd.8 new file mode 100644 index 00000000..9843ea99 --- /dev/null +++ b/guacd/man/guacd.8 @@ -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