INSTALLATION INSTRUCTIONS

To build, you must have Python >=2, a working gnome-vfs2 dev install,
and GNU diff, patch and tar.  Under Linux, these should already be
packaged for you.  For Windows, see INSTALL.CYGWIN.  For OS X, you can
use either pkgsrc

  http://www.netbsd.org/Documentation/software/packages.html

or fink

  http://fink.sf.net

-----

First, unpack the tarball

  $ tar -zxvf ArX-2.2.0.tar.gz

If your version of tar does not understand the -z option, go now and
get GNU tar. It is required for ArX to work properly. Once the tarball
is unpacked, change into the directory

  $ cd ArX-2.2.0

Now run configure.  If you want to install ArX in /home/dcoyote/ArX, type

  % ./configure --prefix=/home/dcoyote/ArX

If you do not specify a --prefix argument then everything will be
placed in /usr/local.  There is no simple way to uninstall except
deleting the install directory (e.g. rm -rf /home/dcoyote/ArX).

Configure will attempt to guess various parameters about your system.
If you see something that it does wrong, you can override it's choices
by specifiying it on the command line.  For example, to compile with
debugging options

  % ./configure CXXFLAGS="-g -Wall" --prefix=/home/dcoyote/ArX

A list of most of the things that you might need to specify are

  CXX           The C++ compiler and linker
  CPPFLAGS      Additional flags for the C preprocessor (useful for includes)
  CXXFLAGS      Additional flags for the C++ compiler
  LDFLAGS       Additional flags for the linker
  
  ARXTAR        The locations of the tar, diff and patch programs.  They 
  ARXDIFF       must be the GNU versions.
  ARXPATCH

  ARXGPG        The location of Gnu Privacy Guard (gpg).  This is only
                required if you want to make or verify archive signatures.

  PYTHON_BIN    The location of Python

  PYTHON_INCLUDE_DIR
                The location of Python.h for building python modules.
                
  ARXPKGCONFIG  The name of the pkg-config command, used for getting the
                correct build flags for gnome-vfs2.  If you created
                your own gnome-vfs2 library in a non-standard
                location, then you will have to specify this.

Once everything has been configured, you can build it by running
"make".  That just calls the included SCons in tools/scons, so if you
have SCons installed, you can just type "scons".  To install, "make
install" (or "scons install").  If you dislike typing and are somewhat
confident, just typing "make install" or "scons install" will build
and install everything.  A single executable "arx" will be installed
in the bin subdirectory and html and PDF documentation will be
installed in the share/doc/arx subdirectory.

There are some tests in the tests/ directory, but they are mostly
useful for developers.

To install the Python bindings, you must have Swig 1.3 installed.
"make python" or "scons python" will build and install everything
required.  To actually use it, you have to set the environment
variables LD_LIBRARY_PATH and PYTHONPATH using something like

  export LD_LIBRARY_PATH=/home/dcoyote/ArX/lib:${LD_LIBRARY_PATH}
  export PYTHONPATH=/home/dcoyote/ArX/lib/python2.3:${PYTHONPATH}

Once you have ArX installed and in your path, you can invoke it

  % arx
  Invoke a sub-command of arx.
  usage: arx command [options] [arguments]
  
  All commands take the following options:
   -h -H --help                  print a help message specific to that command
   --silent                      no output
   --quiet                       only output errors
   --default-output              default output
   --report                      slightly verbose output
   --verbose                     maximal output
   --                            mark the end of options
  
  The -- option is useful for explicitly ending the list of options. This
  is useful if a filename, for example, might be mistaken for an option.
  
  In addition, you can specify the following options instead of a command.
  
   -V --version                  print version info
   -h --help                     display this help
   -H --help-commands            display a list of subcommands