diff options
| -rw-r--r-- | INSTALL | 272 | ||||
| -rw-r--r-- | README | 85 | ||||
| -rw-r--r-- | doc/xs.txt | 20 |
3 files changed, 152 insertions, 225 deletions
@@ -1,237 +1,85 @@ Installation Instructions -************************* +------------------------- -Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, -2006, 2007 Free Software Foundation, Inc. -This file is free documentation; the Free Software Foundation gives -unlimited permission to copy, distribute and modify it. - -Basic Installation -================== +In Brief +~~~~~~~~ -Briefly, the shell commands `./configure; make; make install' should -configure, build, and install this package. The following -more-detailed instructions are generic; see the `README' file for -instructions specific to this package. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, and a -file `config.log' containing compiler output (useful mainly for -debugging `configure'). - - It can also use an optional file (typically called `config.cache' -and enabled with `--cache-file=config.cache' or simply `-C') that saves -the results of its tests to speed up reconfiguring. Caching is -disabled by default to prevent problems with accidental use of stale -cache files. - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If you are using the cache, and at -some point `config.cache' contains results you don't want to keep, you -may remove or edit it. - - The file `configure.ac' (or `configure.in') is used to create -`configure' by a program called `autoconf'. You need `configure.ac' if -you want to change it or regenerate `configure' using a newer version -of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. - - Running `configure' might take a while. While running, it prints - some messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Optionally, type `make check' to run any self-tests that come with - the package. - - 4. Type `make install' to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - - 6. Often, you can also type `make uninstall' to remove the installed - files again. - -Compilers and Options -===================== - -Some systems require unusual options for compilation or linking that the -`configure' script does not know about. Run `./configure --help' for -details on some of the pertinent environment variables. - - You can give `configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here -is an example: - - ./configure CC=c99 CFLAGS=-g LIBS=-lposix - - *Note Defining Variables::, for more details. - -Compiling For Multiple Architectures -==================================== - -You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you can use GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - With a non-GNU `make', it is safer to compile the package for one -architecture at a time in the source code directory. After you have -installed the package for one architecture, use `make distclean' before -reconfiguring for another architecture. - -Installation Names -================== - -By default, `make install' installs the package's commands under -`/usr/local/bin', include files under `/usr/local/include', etc. You -can specify an installation prefix other than `/usr/local' by giving -`configure' the option `--prefix=PREFIX'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -pass the option `--exec-prefix=PREFIX' to `configure', the package uses -PREFIX as the prefix for installing programs and libraries. -Documentation and other data files still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like `--bindir=DIR' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. +The following instructions apply to building libxs from an official release +downloaded from the Crossroads I/O website. For building directly from Git, +see below. -Optional Features -================= - -Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - -There may be some features `configure' cannot figure out automatically, -but needs to determine by the type of machine the package will run on. -Usually, assuming the package is built to be run on the _same_ -architectures, `configure' can figure that out, but if it prints a -message saying it cannot guess the machine type, give it the -`--build=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name which has the form: +On POSIX platforms, libxs uses the standard autotools build system. To +build and install the library, ensure your system has a C++ compiler +installed, and proceed with the following steps: - CPU-COMPANY-SYSTEM +1. Run `./configure`, then `make` to build the library. +2. Optionally, run `make test` to run the built in test suite. +3. Run `make install` as root. +4. On Linux or other platforms which use ld.so for dynamic linking, run + `ldconfig` or equivalent as root to update your systems shared library + cache. -where SYSTEM can have one of these forms: +On Windows, solution files for Visual C++ 2010 are provided in the +`builds/msvc/` subdirectory of the distribution. - OS KERNEL-OS - See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the machine type. +Building from Git +~~~~~~~~~~~~~~~~~ - If you are _building_ compiler tools for cross-compiling, you should -use the option `--target=TYPE' to select the type of system they will -produce code for. +If you are building libxs directly from the Git tree, on POSIX platforms +you will need to generate the `configure` script. This requires that you +have `autoconf` and `automake` installed on your system. To generate +`configure`, run `./autogen.sh`. - If you want to _use_ a cross compiler, that generates code for a -platform different from the build platform, you should specify the -"host" platform (i.e., that on which the generated programs will -eventually be run) with `--host=TYPE'. +Note that documentation in UNIX 'man' and HTML formats will only be built +and installed from a Git tree if you have the `asciidoc` package installed +on your system. -Sharing Defaults -================ +Once you have generated `configure` you can follow the brief steps above. -If you want to set default values for `configure' scripts to share, you -can create a site shell script called `config.site' that gives default -values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. -Defining Variables -================== - -Variables not defined in a site shell script can be set in the -environment passed to `configure'. However, some packages may run -configure again during the build, and the customized values of these -variables may be lost. In order to avoid this problem, you should set -them in the `configure' command line, using `VAR=value'. For example: - - ./configure CC=/usr/local2/bin/gcc - -causes the specified `gcc' to be used as the C compiler (unless it is -overridden in the site shell script). - -Unfortunately, this technique does not work for `CONFIG_SHELL' due to -an Autoconf bug. Until the bug is fixed you can use this workaround: +Optional Features +~~~~~~~~~~~~~~~~~ - CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash +libxs provides several optional features or extensions. These are enabled +using options to `configure`, or special project files for Windows. -`configure' Invocation -====================== +Common optional features, and their options to `configure`: -`configure' recognizes the following options to control how it operates. +ZeroMQ Compatibility:: + Specify `--enable-libzmq` to enable building and installation of the + drop-in `libzmq` compatibility library for ZeroMQ applications. Note + that this will *overwrite* any existing installation of `libzmq` on your + system. For further details refer to `doc/xs_zmq.html` or 'xs_zmq(7)'. -`--help' -`-h' - Print a summary of the options to `configure', and exit. +PGM multicast support:: + Enabled with `--with-pgm` (using the copy of OpenPGM bundled with libxs) + or `--with-system-pgm` (using your system installation of OpenPGM). + Refer to `doc/xs_pgm.html` or 'xs_pgm(7)' for details on usage. -`--version' -`-V' - Print the version of Autoconf used to generate the `configure' - script, and exit. -`--cache-file=FILE' - Enable the cache: use and save the results of the tests in FILE, - traditionally `config.cache'. FILE defaults to `/dev/null' to - disable caching. +Other Common Options +~~~~~~~~~~~~~~~~~~~~ -`--config-cache' -`-C' - Alias for `--cache-file=config.cache'. +Specifying the installation directory:: + libxs is installed in `/usr/local` by default. To change this, specify + the `--prefix` option to `configure`. -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). +Selecting a poller implementation:: + libxs will normally pick the correct poller to use on your platform. If + cross compiling, or building for an older system you may need to + override this using the `--with-poller` option. -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. +Disabling eventfd for older Linux:: + If building libxs to run on an older Linux kernel you may need to + disable eventfd support. This can be done with the `--disable-eventfd` + option. -`configure' also accepts some other, not widely useful, options. Run -`configure --help' for more details. +Disabling building and installing documentation:: + Specifying `--without-documentation` disables any (re-)building or + installation of the AsciiDoc-generated documentation. +Refer to `./configure --help` for a full list of supported options, and +more information on settings affecting the build (e.g. cross compiling, +choosing a particular compiler version, and so on). @@ -1,28 +1,99 @@ Welcome ------- -libxs is a library which extends the standard socket interfaces with features -traditionally provided by specialised messaging middleware products. libxs -sockets provide an abstraction of asynchronous message queues, multiple -messaging patterns, message filtering (subscriptions), seamless access to -multiple transport protocols and more. +Crossroads I/O ("libxs") is a library for building scalable and high +performance distributed applications. It fits between classic BSD sockets, +JMS/AMQP-style message queues, and enterprise message-oriented middleware. +Crossroads I/O extends the standard socket interfaces with features +traditionally provided by specialised messaging middleware products, +providing an abstraction of asynchronous message queues, multiple messaging +patterns, message filtering (subscriptions), seamless access to multiple +transport protocols, and more. -Building and installation +Crossroads I/O provides a native C API for applications. Support for many +more languages is provided by the community through language bindings which +can be found at the Crossroads website. + + +Building and Installation ------------------------- -See the INSTALL file included with the distribution. +The following instructions apply to building libxs from an official release +downloaded from the Crossroads I/O website. For building directly from Git, +refer to the `INSTALL` file included with the libxs distribution. + +On POSIX platforms, libxs uses the standard autotools build system. To +build and install the library, ensure your system has a C++ compiler +installed, and proceed with the following steps: + +1. Run `./configure`, then `make` to build the library. +2. Optionally, run `make test` to run the built in test suite. +3. Run `make install` as root. +4. On Linux or other platforms which use ld.so for dynamic linking, run + `ldconfig` or equivalent as root to update your systems shared library + cache. + +On Windows, solution files for Visual C++ 2010 are provided in the +`builds/msvc/` subdirectory of the distribution. + +Refer to the `INSTALL` file included with the libxs distribution for more +detailed installation instructions. + + +ZeroMQ Compatibility +-------------------- + +Crossroads I/O provides a drop-in 'libzmq' compatibility library for ZeroMQ +language bindings and applications. To enable 'libzmq' compatibility, you +must build your copy of libxs with the `--enable-libzmq` option to +configure, or on Windows by building the appropriate solution file. + +For further details refer to the `doc/xs_zmq.html` or the 'xs_zmq(7)' +manual page included with this distribution. + +NOTE: Enabling this option will *overwrite* any existing installation of +`libzmq` on your system. + + +Reporting Bugs +-------------- + +To report a bug, sign up to the Crossroads I/O development discussion group +at <http://groups.crossroads.io> and post a topic or send an email +describing your problem. + +Prefix the subject of your post with `[BUG]` to catch the developers +attention. + +To ensure that your report is dealt with promptly, please attach a minimal +test case reproducing the bug, ideally written in C. Resources --------- +The libxs development Git tree can be found on Github at +<http://github.com/crossroads-io/libxs>. + +Development is coordinated on the <crossroads-dev@groups.crossroads.io> +mailing list. Vist <http://groups.crossroads.io/> to join or view archives +of previous discussion. + Extensive documentation is provided with the distribution. Refer to doc/xs.html, or "man xs" after you have installed libxs on your system. +Further resources, language bindings, tutorials, and more can be found on +the Crossroads website at <http://www.crossroads.io/>. + + Copying ------- Free use of this software is granted under the terms of the GNU Lesser General Public License (LGPL). For details see the files `COPYING` and `COPYING.LESSER` included with the libxs distribution. + +As a special exception, the copyright holders of libxs grant you the right +to link the library statically with your software. Refer to the end of +the `COPYING.LESSER` file included with the libxs distribution for details. @@ -16,12 +16,20 @@ SYNOPSIS DESCRIPTION ----------- -Crossroads I/O is a library which extends the standard -socket interfaces with features traditionally provided by specialised -_messaging middleware_ products. Crossroads sockets provide an abstraction of -asynchronous _message queues_, multiple _messaging patterns_, message -filtering (_subscriptions_), seamless access to multiple _transport protocols_ -and more. +Crossroads I/O is a library for building scalable and high performance +distributed applications. It fits between classic BSD sockets, +JMS/AMQP-style message queues, and enterprise message-oriented middleware. + +Crossroads I/O extends the standard socket interfaces with features +traditionally provided by specialised _messaging middleware_ products. +Crossroads sockets provide an abstraction of asynchronous _message +queues_, multiple _messaging patterns_, message filtering +(_subscriptions_), seamless access to multiple _transport protocols_ and +more. + +Crossroads I/O provides a native C API for applications. Support for many +more languages is provided by the community through language bindings which +can be found at the Crossroads website. This documentation presents an overview of Crossroads concepts, describes how Crossroads abstract standard sockets and provides a reference manual for the |