RMagick README			16 November 2002
============================================

This package is RMagick 0.9.1. 

RMagick is an interface between the Ruby programming language and the
ImageMagick image processing library.

Disclaimer: this software is not the "RubyMagick" software distributed
by Ryuichi Tamura, nor is it derived from that software. That package 
is available at http://www.acc.ne.jp/~tam/RubyMagick/.

This is a beta release
----------------------

This is a beta release of RMagick. I strongly recommend that you 
install this release only if you are the system administrator and are
willing to install and configure version 1.6.7 of Ruby and version
5.5.1 of ImageMagick from the source files.

Contact information
-------------------

The author of RMagick is Tim Hunter. My email address is
cyclists@nc.rr.com. Please use that email address to report bugs,
ask questions, or just to let me know you're using RMagick!

Prerequisites
-------------

You must be running a Linux distribution. This version of RMagick
does not run on MS Windows.

Before installing RMagick, you must have already installed Version 1.6.7
(or later) of the Ruby language. If you have not already installed this
version of Ruby, you can get it from www.ruby-lang.org.

You must have already installed Version 5.5.1 or later of ImageMagick,
including the source files. RMagick does not work with versions of
ImageMagick earlier than 5.5.1. If you have not already installed this
version of ImageMagick, you can get it from www.imagemagick.org.

ImageMagick uses additional libraries to support some image formats. If
you do not install those libraries you cannot read and write those
image formats. See the README.txt file in the ImageMagick source
distribution package for more information. If you do not install
support for Windows Metafile format images some of the sample programs
will not work. The ImageMagick README.txt file says "ImageMagick
requires libwmf 0.2.5 (or 0.2.2) available from
http://sourceforge.net/projects/wvware/ to render files in the Windows
Meta File (WMF) metafile format."

By default, the install program assumes you have the necessary authority
to install RMagick into the usual Ruby library directories.

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

De-compress the RMagick-0.9.1.tar.gz archive and enter the top
directory. Then type:

    $ ruby install.rb config
    $ ruby install.rb setup
   ($ su)
    # ruby install.rb install

You can also install files into your favorite directory by supplying 
install.rb some options. Try "ruby install.rb --help".

To install the RMagick documentation and create the sample images,
type:

    $ ruby makedoc.rb
    
This program performs the following functions:

1. Copies the RMagick HTML files to $prefix/share/RMagick, where
   $prefix is the same as the $prefix used by install.rb. For example,
   on my system $prefix is /usr/local. You can override this value
   with the --data-dir option. For example,

                  ruby makedoc.rb --data-dir /home/me/rmdoc

2. Modifies references to the ImageMagick documentation in the RMagick
   HTML files to refer to your local copy of the documentation. If the
   makedoc.rb program complains that it can't find the ImageMagick
   documentation, use the --im-doc-dir option to specify the directory,
   or use the --no-im-doc option to suppress the changes. For example,

                  ruby makedoc.rb --im-doc-dir /usr/local/doc/ImageMagick
                  ruby makedoc.rb --no-im-doc-dir

   If you choose the --no-im-doc-dir option, many of the links in the
   RMagick documentation will take you to the ImageMagick web site.

3. Copies the sample programs to the /ex subdirectory and changes the #!
   line in the sample programs to the actual location of the ruby 
   interpreter.

4. Copies the images used as input by the sample programs to the 
   /ex/images subdirectory.

4. Executes each of the sample programs. The images created by the sample
   programs are used as illustrations in the RMagick documentation.
   
KNOWN BUGS
----------
1. gcc 3.2, during the "install.rb setup" step, issues the warning:

   cc1: warning: changing search order for system directory "/usr/local/include"
   cc1: warning:   as it has already been specified as a non-system directory

   This is not a problem.

2. The texture_fill_to_border method doesn't work. The example image is
   also wrong.


Reporting bugs
--------------

Please report bugs in RMagick, its documentation, or its installation
programs to me at cyclists@nc.rr.com. However, I cannot help with Ruby
installation and configuration or ImageMagick installation and configuration.
Please report problems with that software to their respective authors or
distributors.

License
-------
RMagick is copyright 2002 by Timothy P. Hunter

RMagick is distributed under the "Artistic License" included below.
Please note that this license is not a license for the Ruby software or
the ImageMagick software, which are distributed under separate
licenses. If you have questions about the RMagick license please
contact the author at cyclists@nc.rr.com. If you have questions
about the Ruby license or the ImageMagick license please refer to
the legal information included with that software.

============================================================================

Preamble

The intent of this document is to state the conditions under which a
Package may be copied, such that the Copyright Holder maintains some
semblance of artistic control over the development of the package,
while giving the users of the package the right to use and distribute
the Package in a more-or-less customary fashion, plus the right to make
reasonable modifications.

Definitions


	"Package" refers to the collection of files distributed by the
	Copyright Holder, and derivatives of that collection of files
	created through textual modification.


	"Standard Version" refers to such a Package if it has not been
	modified, or has been modified in accordance with the wishes
	of the Copyright Holder as specified below.


	"Copyright Holder" is whoever is named in the copyright or
	copyrights for the package.


	"You" is you, if you're thinking about copying or distributing
	this Package.


	"Reasonable copying fee" is whatever you can justify on the
	basis of media cost, duplication charges, time of people involved,
	and so on.  (You will not be required to justify it to the
	Copyright Holder, but only to the computing community at large
	as a market that must bear the fee.)


	"Freely Available" means that no fee is charged for the item
	itself, though there may be fees involved in handling the item.
	It also means that recipients of the item may redistribute it
	under the same conditions they received it.


You may make and give away verbatim copies of the source form of the
Standard Version of this Package without restriction, provided that you
duplicate all of the original copyright notices and associated disclaimers.


You may apply bug fixes, portability fixes and other modifications
derived from the Public Domain or from the Copyright Holder.  A Package
modified in such a way shall still be considered the Standard Version.


You may otherwise modify your copy of this Package in any way, provided
that you insert a prominent notice in each changed file stating how and
when you changed that file, and provided that you do at least ONE of the
following:


place your modifications in the Public Domain or otherwise make them
    Freely Available, such as by posting said modifications to Usenet or
    an equivalent medium, or placing the modifications on a major archive
    site such as uunet.uu.net, or by allowing the Copyright Holder to include
    your modifications in the Standard Version of the Package.

    
use the modified Package only within your corporation or organization.

    


rename any non-standard executables so the names do not conflict
    with standard executables, which must also be provided, and provide
    a separate manual page for each non-standard executable that clearly
    documents how it differs from the Standard Version.

    

make other distribution arrangements with the Copyright Holder.



You may distribute the programs of this Package in object code or
executable form, provided that you do at least ONE of the following:


distribute a Standard Version of the executables and library files,
    together with instructions (in the manual page or equivalent) on where
    to get the Standard Version.

    
accompany the distribution with the machine-readable source of
    the Package with your modifications.

    


give non-standard executables non-standard names, and clearly
    document the differences in manual pages (or equivalent), together
    with instructions on where to get the Standard Version.

    

make other distribution arrangements with the Copyright Holder.



You may charge a reasonable copying fee for any distribution of this
Package.  You may charge any fee you choose for support of this
Package.  You may not charge a fee for this Package itself.  However,
you may distribute this Package in aggregate with other (possibly
commercial) programs as part of a larger (possibly commercial) software
distribution provided that you do not advertise this Package as a
product of your own.  You may embed this Package's interpreter within
an executable of yours (by linking); this shall be construed as a mere
form of aggregation, provided that the complete Standard Version of the
interpreter is so embedded.


The scripts and library files supplied as input to or produced as
output from the programs of this Package do not automatically fall
under the copyright of this Package, but belong to whomever generated
them, and may be sold commercially, and may be aggregated with this
Package.  If such scripts or library files are aggregated with this
Package via the so-called "undump" or "unexec" methods of producing a
binary executable image, then distribution of such an image shall
neither be construed as a distribution of this Package nor shall it
fall under the restrictions of Paragraphs 3 and 4, provided that you do
not represent such an executable image as a Standard Version of this
Package.


C subroutines (or comparably compiled subroutines in other
languages) supplied by you and linked into this Package in order to
emulate subroutines and variables of the language defined by this
Package shall not be considered part of this Package, but are the
equivalent of input as in Paragraph 6, provided these subroutines do
not change the language in any way that would cause it to fail the
regression tests for the language.


Aggregation of this Package with a commercial distribution is always
permitted provided that the use of this Package is embedded; that is,
when no overt attempt is made to make this Package's interfaces visible
to the end user of the commercial distribution.  Such use shall not be
construed as a distribution of this Package.






				The End

The name of the Copyright Holder may not be used to endorse or promote
products derived from this software without specific prior written permission.


 THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

============================================================================
