INSTALL

$Id: INSTALL,v 1.7 2008/08/20 12:30:00 ianmacd Exp $

Requirements
------------

Ruby/AWS depends on Ruby 1.8.6 or later and the REXML library. Happily, Ruby
1.8.0 and later come with REXML as standard, so you don't need to do anything
to obtain it.


Installation
------------

There are two ways to install Ruby/AWS.

The standard way, which requires no extra software, uses Minero Aoki's
setup.rb script. Extensive documentation for this script can be found at the
end of this document.

The following commands should be enough to install the package:

  $ ruby setup.rb config
  $ ruby setup.rb setup
  # ruby setup.rb install

  ("#" line may require root privilege)

Alternatively, the RubyGems packaging system may be used:

  $ wget http://www.caliban.org/files/ruby/ruby-aaws-x.x.x.gem
  # gem install ruby-aaws-x.x.x.gem

  ("#" line may require root privilege)

Or even just:

  # gem install ruby-aaws

  ("#" line may require root privilege)

See http://www.rubygems.org/ for more information on using RubyGems.


Documentation
-------------

Documentation is minimal in this alpha version of Ruby/AWS.

To create HTML documentation for Ruby/AWS, use rdoc as follows:

  $ rdoc -SUx CVS lib

rdoc has been bundled with Ruby since 1.8.1.



-----------------------------------------------------------------------------

Full instructions for setup.rb:

Details
-------
    
  Usage of install.rb/setup.rb is:

      ruby install.rb <global options>
      ruby install.rb [<global options>] <task> [<task options>]

    
    -q,--quiet
        suppress message outputs
    --verbose
        output messages verbosely (default)
    -h,--help
        prints help and quit
    -v,--version
        prints version and quit
    --copyright
        prints copyright and quit
    
  These are acceptable tasks:
    config
        saves configurations
    show
        prints current configurations
    setup
        compiles extentions
    install
        installs files
    clean
        cleans created files
    
  Task Options for Config
  -----------------------
    
    --prefix=PATH
        a prefix of the installing directory path
    --std-ruby=PATH
        the directory for standard ruby libraries
    --site-ruby-common=PATH
        the directory for version-independent non-standard
        ruby libraries
    --site-ruby=PATH
        the directory for non-standard ruby libraries
    --bin-dir=PATH
        the directory for commands
    --rb-dir=PATH
        the directory for ruby scripts
    --so-dir=PATH
        the directory for ruby extentions
    --data-dir=PATH
        the directory for shared data
    --ruby-path=PATH
        path to set to #! line
    --ruby-prog=PATH
        the ruby program using for installation
    --make-prog=NAME
        the make program to compile ruby extentions
    --without-ext
        forces to install.rb never to compile/install
        ruby extentions.
    --rbconfig=PATH
        your rbconfig.rb to load
    
  You can view default values of these options by typing

      $ ruby install.rb --help

    
  In addition, setup.rb accepts these options:
    --with=NAME,NAME,NAME...
        package names which you want to install
    --without=NAME,NAME,NAME...
        package names which you do not want to install
    
  [NOTE] You can pass options for extconf.rb like this:

      ruby install.rb config -- --with-tklib=/usr/lib/libtk-ja.so.8.0

    
  Task Options for Install
  ------------------------
    
    --no-harm
        prints what to do and done nothing really.
    --prefix=PATH
        a prefix of the installing directory path.
        This option may help binary package maintainers.
        A default value is an empty string.
    
Installing Programs with setup.rb
=================================
    
Quick Start
-----------
    
  Type these lines on command line:
  ("#" line may require root privilege)

      $ ruby setup.rb config
      $ ruby setup.rb setup
      # ruby setup.rb install

    
Details
-------
    
  Usage of setup.rb is:

      ruby setup.rb <global options>
      ruby setup.rb [<global options>] <task> [<task options>]

    
  Global Options
  --------------
    
    -q,--quiet
        suppress message outputs
    --verbose
        output messages verbosely (default)
    -h,--help
        prints help and quit
    -v,--version
        prints version and quit
    --copyright
        prints copyright and quit
    
  These are acceptable tasks:
    config
        Checks and saves configurations.
    show
        Prints current configurations.
    setup
        Compiles ruby extentions.
    install
        Installs files.
    clean
        Cleans created files.
    distclean
        Cleans created files.
    
  Task Options for CONFIG
  -----------------------
    
    --prefix=PATH
        a prefix of the installing directory path
    --std-ruby=PATH
        the directory for standard ruby libraries
    --site-ruby-common=PATH
        the directory for version-independent non-standard
        ruby libraries
    --site-ruby=PATH
        the directory for non-standard ruby libraries
    --bin-dir=PATH
        the directory for commands
    --rb-dir=PATH
        the directory for ruby scripts
    --so-dir=PATH
        the directory for ruby extentions
    --data-dir=PATH
        the directory for shared data
    --ruby-path=PATH
        path to set to #! line
    --ruby-prog=PATH
        the ruby program using for installation
    --make-prog=NAME
        the make program to compile ruby extentions
    --without-ext
        forces to setup.rb never to compile/install
        ruby extentions.
    --rbconfig=PATH
        your rbconfig.rb to load
    
  You can view default values of these options by typing

      $ ruby setup.rb --help

    
  If there's the directory named "packages",
  You can also use these options:
    --with=NAME,NAME,NAME...
        Package names which you want to install.
    --without=NAME,NAME,NAME...
        Package names which you do not want to install.
    
  [NOTE] You can pass options for extconf.rb like this:

      ruby setup.rb config -- --with-tklib=/usr/lib/libtk-ja.so.8.0

    
  Task Options for INSTALL
  ------------------------
    
    --no-harm
        prints what to do and done nothing really.
    --prefix=PATH
        The prefix of the installing directory path.
        This option may help binary package maintainers.
        A default value is an empty string.