Reword docs (as no longer guacd-specific).

This commit is contained in:
Michael Jumper 2013-06-05 14:59:57 -07:00
parent 99c5a76d1e
commit 3456fc0418

29
README
View File

@ -17,20 +17,23 @@ Distribution-specific documentation is provided on the Guacamole wiki:
------------------------------------------------------------ ------------------------------------------------------------
What is guacd? What is guacamole-server?
------------------------------------------------------------ ------------------------------------------------------------
The guacamole-server package is a set of software which forms the basis of the
Guacamole stack. It consists of guacd, libguac, and several protocol support
libraries.
guacd is the Guacamole proxy daemon used by the Guacamole web application and guacd is the Guacamole proxy daemon used by the Guacamole web application and
framework. As JavaScript cannot handle binary protocols (like VNC and remote framework. As JavaScript cannot handle binary protocols (like VNC and remote
desktop) efficiently, a new test-based protocol was developed which would desktop) efficiently, a new test-based protocol was developed which would
contain a common superset of the operations needed for efficient remote contain a common superset of the operations needed for efficient remote desktop
desktop access, but would be easy for JavaScript programs to process. guacd access, but would be easy for JavaScript programs to process. guacd is the
is the proxy which translates between arbitrary protocols and the Guacamole proxy which translates between arbitrary protocols and the Guacamole protocol.
protocol.
------------------------------------------------------------ ------------------------------------------------------------
Compiling and installing guacd Compiling and installing guacd, libguac, etc.
------------------------------------------------------------ ------------------------------------------------------------
Please note that distribution-specific pre-compiled packages are available from Please note that distribution-specific pre-compiled packages are available from
@ -38,10 +41,10 @@ the files section of the main project site:
http://sourceforge.net/projects/guacamole/files/ http://sourceforge.net/projects/guacamole/files/
guacd is built using the popular GNU Automake, and thus provides the standard All software within guacamole-server is built using the popular GNU Automake,
configure script. Before compiling, you need to have compiled and installed and thus provides the standard configure script. Before compiling, you need to
libguac, the core Guacamole library. This is available from the main Guacamole have compiled and installed libguac, the core Guacamole library. This is
site at http://guac-dev.org/. available from the main Guacamole site at http://guac-dev.org/.
1) Run configure 1) Run configure
@ -63,12 +66,16 @@ site at http://guac-dev.org/.
$ make $ make
guacd will now compile. guacd, libguac, and any available protocol support libraries will now
compile.
3) Install (as root) 3) Install (as root)
# make install # make install
All software that was just built, including documentation, will be
installed.
guacd will install to your /usr/local/sbin directory by default. You can guacd will install to your /usr/local/sbin directory by default. You can
change the install location by using the --prefix option for configure. change the install location by using the --prefix option for configure.