maride/guacamole-spice-protocol
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added manpage.

Browse Source
This commit is contained in:
Michael Jumper 2011-12-10 23:45:09 -08:00
parent 3e06b326d9
commit e6fe9e7008
2 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
guacd/Makefile.am
View File

@ -41,6 +41,7 @@ AM_CFLAGS = -Werror -Wall -pedantic -Iinclude
sbin_PROGRAMS = guacd sbin_PROGRAMS = guacd
init_SCRIPTS = init.d/guacd init_SCRIPTS = init.d/guacd
man_MANS = man/guacd.8
noinst_HEADERS = include/client.h include/log.h noinst_HEADERS = include/client.h include/log.h
guacd_SOURCES = src/daemon.c src/client.c src/log.c guacd_SOURCES = src/daemon.c src/client.c src/log.c

43
guacd/man/guacd.8 Normal file
View File

@ -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>