Add support to pass in a socket
[guacd.git] / man / guacd.8
1 .TH guacd 8 "6 May 2012" "version 0.6.1" "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 [\fB-f\fR]
12 .
13 .SH DESCRIPTION
14 .B guacd
15 is the Guacamole proxy daemon used by the Guacamole web application and
16 framework. As JavaScript cannot handle binary protocols (like VNC and remote
17 desktop) efficiently, a new text-based protocol was developed which would
18 contain a common superset of the operations needed for efficient remote
19 desktop access, but would be easy for JavaScript programs to process.
20 .B guacd
21 is the proxy which translates between arbitrary protocols and the Guacamole
22 protocol.
23 .
24 .SH OPTIONS
25 .TP
26 \fB\-b\fR \fIHOST\fR
27 Changes the host or address that
28 .B guacd
29 listens on.
30 .TP
31 \fB\-l\fR \fIPORT\fR
32 Changes the port that
33 .B guacd
34 listens on (the default is port 4822).
35 .TP
36 \fB\-p\fR \fIFILE\fR
37 Causes
38 .B guacd
39 to write the PID of the daemon process to the specified
40 file. This is useful for init scripts and is used by the provided init
41 script.
42 .TP
43 \fB\-f\fR
44 Causes
45 .B guacd
46 to run in the foreground, rather than automatically forking into the
47 background.
48 .
49 .SH AUTHOR
50 Written by Michael Jumper <zhangmaike@users.sourceforge.net>