9843ea991884bbfac9f090adc16039b8b60b9a0a
[guacd.git] / man / guacd.8
1 .TH guacd 8 "10 Dec 2011" "version 0.5.0" "Guacamole"
2 .
3 .SH NAME
4 guacd \- Guacamole proxy daemon
5 .
6 .SH SYNOPSIS
7 .B guacd
8 [\fB-b\fR \fIHOST\fR]
9 [\fB-l\fR \fIPORT\fR]
10 [\fB-p\fR \fIFILE\fR]
11 .
12 .SH DESCRIPTION
13 .B guacd
14 is the Guacamole proxy daemon used by the Guacamole web application and
15 framework. As JavaScript cannot handle binary protocols (like VNC and remote
16 desktop) efficiently, a new text-based protocol was developed which would
17 contain a common superset of the operations needed for efficient remote
18 desktop access, but would be easy for JavaScript programs to process.
19 .B guacd
20 is the proxy which translates between arbitrary protocols and the Guacamole
21 protocol.
22 .
23 .SH OPTIONS
24 .TP
25 \fB\-b\fR \fIHOST\fR
26 Changes the host or address that
27 .B guacd
28 listens on.
29 .TP
30 \fB\-l\fR \fIPORT\fR
31 Changes the port that
32 .B guacd
33 listens on (the default is port 4822).
34 .TP
35 \fB\-p\fR \fIFILE\fR
36 Causes
37 .B guacd
38 to write the PID of the daemon process to the specified
39 file. This is useful for init scripts and is used by the provided init
40 script.
41 .
42 .SH AUTHOR
43 Written by Michael Jumper <zhangmaike@users.sourceforge.net>