guacamole-spice-protocol/libguac
2012-12-02 11:32:07 -08:00
..
doc Remove docbook stylesheet. 2012-12-02 11:32:07 -08:00
include Fix documentation. 2012-12-01 20:11:14 -08:00
m4 Ensure m4/ directory exists, while automatically-added files are not included in commits. 2012-08-11 13:22:27 -07:00
src Mark internal structs as private. 2012-12-01 19:39:22 -08:00
tests Fix expected string for nest test. 2012-10-19 14:21:15 -07:00
.gitignore Ensure m4/ directory exists, while automatically-added files are not included in commits. 2012-08-11 13:22:27 -07:00
AUTHORS More renaming 2010-12-08 13:14:04 -08:00
ChangeLog Update ChangeLog 2012-10-25 11:57:06 -07:00
configure.in Bump version numbers. 2012-08-29 11:23:19 -07:00
LICENSE Added ChangeLog, removed unused files, switched to foreign over GNU 2011-03-01 01:04:29 -08:00
Makefile.am Use Check for unit tests, add unit test stub. 2012-07-22 17:57:31 -07:00
README Updated README to point to new Trac. 2011-12-11 14:49:34 -08:00

------------------------------------------------------------
 About this README
------------------------------------------------------------

This README is intended to provide quick and to-the-point documentation for
technical users intending to compile parts of Guacamole themselves.

Distribution-specific packages are available from the files section of the main
project page:
 
    http://sourceforge.net/projects/guacamole/files/

Distribution-specific documentation is provided on the Guacamole wiki:

    http://guac-dev.org/


------------------------------------------------------------
 What is libguac?
------------------------------------------------------------

libguac is the core library for guacd (the Guacamole proxy) and any protocol
support plugins for guacd.

libguac provides efficient buffered I/O of text and base64 data, as well as
somewhat abstracted functions for sending Guacamole instructions.


------------------------------------------------------------
 Compiling and installing libguac
------------------------------------------------------------

Please note that distribution-specific pre-compiled packages are available from
the files section of the main project site:

    http://sourceforge.net/projects/guacamole/files/

libguac is built using the popular GNU Automake, and thus provides the standard
configure script.

1) Run configure

    $ ./configure

    Assuming all dependencies have been installed, this should succeed without
    errors.

2) Run make

    $ make

    libguac will now compile.

3) Install (as root)

    # make install

    libguac will install to your /usr/local/lib directory by default. You can
    change the install location by using the --prefix option for configure.

    Several header files will also be installed to
    /usr/local/include/guacamole.

    You will need to run ldconfig (as root) so that the library can be found
    when guacd is run:

    # ldconfig


------------------------------------------------------------
 Reporting problems
------------------------------------------------------------

Please report any bugs encountered by opening a new ticket at the Trac system
hosted at:
    
    http://guac-dev.org/trac/