rmagick 1.15.17 → 2.0.0

data/README.txt

@@ -1,6 +1,6 @@
-RMagick 1.15.17 README
+RMagick 2.0.0 README
 ================================
-12/05/08
+12/27/07
 --------
 
 Table Of Contents
@@ -8,11 +8,10 @@ Table Of Contents
 
 * [Introduction] [intro]
 * [Contact Information] [contact]
+* [What's new?] [new]
 * [Prerequisites] [prereq]
-* [Tips for installing and configuring ImageMagick and GraphicsMagick] [tips]
 * [Installing RMagick] [install]
   + [Configuration options] [options]
-  + [Running the configure and make scripts] [scripts]
 * [Things that can go wrong] [uhoh]
 * [Upgrading] [upgrade]
 * [Uninstalling] [uninstall]
@@ -25,7 +24,7 @@ Table Of Contents
 <h2 id="intro">Introduction</h2>
 
 RMagick is an interface between the Ruby programming language and the
-ImageMagick and GraphicsMagick image processing libraries.
+ImageMagick image processing library.
 
 <h2 id="contact">Contact Information</h2>
 
@@ -35,195 +34,133 @@ __Email:__ <rmagick@rubyforge.org>
 
 __RubyForge:__ <http://rubyforge.org/projects/rmagick/>
 
+<h2 id="new">What's new?</h2>
+RMagick 2.0.0 incorporates all changes and bug fixes from RMagick 1.15.12.
+Additionally,
+
+* The installation procedure is pure Ruby.
+* The minimum version of Ruby is 1.8.2.
+* The minimum version of ImageMagick is 6.3.0.
+* GraphicsMagick is not supported.
+* The following GraphicsMagick-only methods are no longer available:
+Image#grayscale\_pseudo\_class, Image#statistics.
+* The following deprecated methods are no longer available:
+Image#random\_channel\_threshold, Image#channel\_threshold, Image#montage=,
+Image#image\_type=, Image::Info#tile\_info, Image#tile\_info=,
+Image::Info#tile, Image::Info#tile=, Image::Info#subimage, Image::Info#subimage=,
+Image::Info#subrange, Image::Info#subrange=, Magick.set_monitor.
+* The following methods have been added:
+Image::Info#stroke=, Image::Info#stroke\_width= and Image::Info#undercolor=,
+Draw#fill_pattern= and Draw#stroke\_pattern=, Image#destroy!, Image#destroyed?,
+Image#check\_destroyed, Magick.trace\_proc, Image.combine, Image#separate,
+Image#distort, Image#each\_pixel.
+* Magick::MaxRGB is deprecated (but still available). Use Magick::QuantumRange
+instead.
+* RMagick works with the Q32 version of ImageMagick.
+
+Various other minor bug fixes and upgrades.
+
 <h2 id="prereq">Prerequisites</h2>
 
 __O/S:__ Linux, Sun Solaris, Cygwin, FreeBSD, OS X.
 
-__Ruby__ 1.6.7 or later. You can get Ruby from <http://www.ruby-lang.org>.
-RVG requires Ruby 1.8.
-
-Either __ImageMagick__ 6.0.0 or later, or any release of
-__GraphicsMagick__.  GraphicsMagick is a friendly fork of ImageMagick
-5.5.1.  You can get ImageMagick from <http://www.imagemagick.org>.  You
-can get GraphicsMagick from <http://www.graphicsmagick.org>.  ImageMagick
-and GraphicsMagick have slightly different capabilities.  Please consult
-their web sites if you have questions.
-
-<h2 id="tips">Tips for installing and configuring ImageMagick and GraphicsMagick</h2>
-
-See <http://rmagick.rubyforge.org/install-faq.html> for the latest version
-of these tips.
-
-If you are installing RMagick by compiling the source code, I strongly
-encourage you to install the latest version of ImageMagick or
-GraphicsMagick _from source_.  If you have never installed ImageMagick or
-GraphicsMagick before, I also strongly encourage you to read the
-README.txt file as many times as is necessary for you to understand how to
-configure it.  ImageMagick and GraphicsMagick are large and complicated
-programs and can be difficult to configure.  Follow these tips to minimize
-the amount of time you'll spend and your frustration level.
-
-_Do not_ simply type `./configure` and expect the defaults to be correct
-for you.  Since you are installing ImageMagick/GraphicsMagick to use with
-Ruby, consider whether you want to skip ImageMagick's/GraphicMagick's
-support for Perl and C++ by using the `--without-perl` and
-`--without-magick-plus-plus` options.  Doing so will speed up the
-installation process and save some disk space.  You will almost certainly
-want to specify the `--enable-shared` and `--disable-static` options.
-
-Determine which image formats you are interested in using and make sure
-that you have installed the libraries that ImageMagick/GraphicsMagick uses
-to process these formats.  ImageMagick and GraphicsMagick use additional
-libraries to support some image formats.  If you do not install those
-libraries you cannot read and write those image formats.  You will need to
-configure ImageMagick/GraphicsMagick to support the JPG, PNG, TIFF, and
-WMF formats in order to execute all the RMagick sample programs.  See
-ImageMagick's or GraphicMagick's README.txt file for more information.
-
-Once you have determined the configuration options you need, run the
-configure script.  When it completes, read the summary output to see if
-configuration worked the way you expected.  Here's an example of the
-summary output from ImageMagick's configure script.  Notice that the
-result of each option is listed in the "Configured value" column.
-
-
-                      Option                        Value
-    -------------------------------------------------------------------------
-    Shared libraries  --enable-shared=yes           yes
-    Static libraries  --enable-static=no            no
-    Module support    --with-modules=yes            yes
-    GNU ld            --with-gnu-ld=yes             yes
-    LZW support       --enable-lzw=yes              yes
-    Quantum depth     --with-quantum-depth=8        8
-
-    Delegate Configuration:
-    BZLIB             --with-bzlib=yes              yes
-    DPS               --with-dps=yes                yes
-    FlashPIX          --with-fpx=yes                no
-    FreeType 2.0      --with-ttf=yes                yes
-    Ghostscript       None                          gs (7.07.2)
-    Ghostscript fonts --with-gs-font-dir=default    /usr/share/fonts/default/Type1/
-    Ghostscript lib   --with-gslib=no               no
-    Graphviz          --with-dot=yes                no
-    JBIG              --with-jbig=yes               no
-    JPEG v1           --with-jpeg=yes               yes
-    JPEG-2000         --with-jp2=yes                no
-    LCMS              --with-lcms=yes               yes
-    Magick++          --with-magick-plus-plus=no    no
-    PERL              --with-perl=no                no
-    PNG               --with-png=yes                yes
-    TIFF              --with-tiff=yes               yes
-    Windows fonts     --with-windows-font-dir=/mnt/windows/windows/fonts    /mnt/windows/windows/fonts/
-    WMF               --with-wmf=yes                yes
-    X11               --with-x=                     yes
-    XML               --with-xml=yes                yes
-    ZLIB              --with-zlib=yes               yes
-
-    X11 Configuration:
-      X_CFLAGS     = -I/usr/X11R6/include
-      X_PRE_LIBS   = -lSM -lICE
-      X_LIBS       = -L/usr/X11R6/lib
-      X_EXTRA_LIBS =
-
-If the results are not what you wanted, install any missing libraries,
-choose new or different options, or whatever it takes, erase the
-config.cache file, and re-run `configure`.  Repeat as often as necessary
-before moving to the `make` and `make install` steps.
-
-Detailed information about all of ImageMagick's and GraphicsMagick's
-configuration options may be found in their README.txt and INSTALL.txt
-files.
-
-#### Windows Metafile Format
-As noted in the ImageMagick and GraphicsMagick README.txt files, to
-support images in the Windows Metafile format, ImageMagick/GraphicsMagick
-requires an additional library.  Without this library some of the RMagick
-sample programs will not work.  ImageMagick and GraphicsMagick require
-libwmf 0.2.5, 0.2.7, or 0.2.2 to support the WMF format.  (Avoid libwmf
-0.2.6!)
-
-<h2 id="install">Installing RMagick</h2>
-
-Installing RMagick is much simpler than installing ImageMagick or
-GraphicsMagick.  Note that the make step runs all the example programs.
-This process both builds the example images used in the documentation and
-validates your RMagick installation.  This step can take 5-15 minutes
-depending on the speed of your computer.
+__Ruby__ 1.8.2 or later. You can get Ruby from <http://www.ruby-lang.org>.
 
-<h4 id="options">Configuration Options</h4>
+__ImageMagick__ 6.3.0 or later.  You can get ImageMagick from
+<http://www.imagemagick.org>.
 
-Type `./configure --help` to see a list of configuration options.  In
-addition to the regular options, there are a few RMagick-specific options:
+<h2 id="install">Installation</h2>
 
-* --with-doc-dir=_directory_
-    >  Specify the directory to install the RMagick documentation.
-    >  By default this is $prefix/share/RMagick, where $prefix is the
-    >  prefix specified by --prefix. For example, to install the
-    >  documentation in /home/user/RMagick, specify:
+The installation procedure for RMagick 2.0.0 is different from that used
+in earlier releases. Before installing RMagick, you must install ImageMagick.
+Complete and up-to-date instructions for installing ImageMagick on Linux,
+*BSD, and other *nix-type O/S's are available
+at <http://rmagick.rubyforge.org/install-linux.html>, steps 0, 1, 2.
+Similarly, instructions for installing ImageMagick using MacPorts
+on OS X are available at <http://rmagick.rubyforge.org/install-osx.html>,
+steps 1 and 2. After installing
+ImageMagick, use the instructions in the next section to install RMagick.
 
-    >  `./configure --with-doc-dir=/home/user/RMagick`
+<h2 id="install">Installing RMagick 2.0.0</h2>
 
-* --enable-allow-example-errors
-    >  Normally the documentation installation terminates if 5 examples fail.
-    >  If you use this option, the installation does not check for failing
-    >  examples and will always complete. This option is useful if you're having
-    >  trouble installing RMagick and you want to see all the failing examples.
+This release of RMagick uses Minero Aoki's setup.rb script for installation.
+See the next section for configuration options. Usually you do not need to
+specify any of these options. You can get more information about setup.rb from
+his web site <http://i.loveruby.net>
 
-* --disable-htmldoc (or --enable-htmldoc=no)
-    >  By default the install process runs all the RMagick example programs
-    >  and generates HTML versions of all the examples. This option causes
-    >  the install process to skip this step. No documentation is installed.
+I assume you've already decompressed the tarball, or you wouldn't be reading
+this. If you have not decompressed the tarball, do so with this command:
 
-* --with-graphics-magick
-    >  If you have both ImageMagick and GraphicsMagick installed, this option will
-    >  force RMagick to be configured with GraphicsMagick.
+    tar xvzf RMagick-2.0.0-tar.gz
 
-* --with-so-dir=_directory_
-    >  The directory for ruby extensions.
+or
 
-* --with-ruby-path=_directory_
-    >  The path to set the !# line in Ruby scripts. The default is $prefix/bin/ruby.
+    tar xvjf RMagick-2.0.0-tar.bz2
 
-* --with-ruby-prog=_name_
-    >  The name of the Ruby executable. The default is `ruby`.
+Change to the RMagick-2.0.0 directory. If you are not using any
+configuration options (usually you don't need to) enter the command
 
-* --with-make-prog=_name_
-    >  The name of the `make` program.
+    ruby setup.rb
 
-* --with-rbconfig=_directory_
-    > The directory of the rbconfig.rb file to use.  The default is Ruby's
-    > rbconfig.
+Note that setup.rb executes all the example programs, so this can take
+some time.  This process both builds the example images used in the
+documentation and validates your RMagick installation.
 
-<h4 id="scripts">Running the <code>configure</code> and <code>make</code> scripts</h4>
+After this command completes, make sure you have root priviledges (that
+is, login as root or use su or sudo) and enter the command
 
-De-compress the RMagick-1.15.17.tar.gz archive and enter the top
-directory.  Then type:
+    ruby setup.rb install
 
-    $ ./configure <configuration options>
-    $ make
-    ($ su)
-    $ make install
-    (optionally)
-    $ make clean
+<h4 id="options">Configuration Options</h4>
+
+Type `ruby setup.rb --help` to see a list of configuration options.  In
+addition to the regular options, there are a few RMagick-specific options:
+
+* --doc-dir=_directory_
+    >  Specify the directory to install the RMagick documentation.
+    >  By default this is $prefix/share/RMagick, where $prefix is the
+    >  prefix specified by --prefix. For example, to install the
+    >  documentation in /Users/me/RMagick, specify:
+
+    >  `./configure --doc-dir=/Users/me/RMagick`
+
+* --allow-example-errors
+    >  Normally the documentation installation terminates if 5 examples fail.
+    >  If you use this option, the installation does not check for failing
+    >  examples and will always complete. This option is useful if you're
+    >  having trouble installing RMagick and you want to see all the failing examples.
+
+* --disable-htmldoc
+    >  By default the install process runs all the RMagick example programs
+    >  and generates HTML versions of all the examples. This option causes
+    >  the install process to skip this step. No install verification occurs
+    >  and no documentation is installed.
 
 <h2 id="uhoh">Things that can go wrong</h2>
 
-#### Can't install RMagick. Can't find libMagick or one of the dependent libraries. Check the config.log file for more detailed information.
-The message can also refer to "libGraphicsMagick". Typically this message means that one or more of the libraries that Imagemagick/GraphicsMagick depends on hasn't been installed. Examine the config.log file in the installation directory for any error messages. These messages typically contain enough additional information for you to be able to diagnose the problem.
+The RMagick installation FAQ [<http://rmagick.rubyforge.org/install-faq.html>]
+has answers to the most commonly reported problems.
+
+#### Can't install RMagick. Can't find libMagick or one of the dependent libraries. Check the mkmf.log file for more detailed information.
+Typically this message means that one or more of the libraries that ImageMagick
+depends on hasn't been installed. Examine the mkmf.log file in the ext/RMagick
+subdirectory of the installation directory for any error messages. These messages
+typically contain enough additional information for you to be able to diagnose
+the problem. Also see <http://rmagick.rubyforge.org/install-faq.html#libmagick>.
 
 #### Cannot open shared object file
 When make is running the examples, if you get a message like this:
 
-    /home/you/RMagick-1.15.17/lib/RMagick.rb:11:in `require': libMagick.so.0:
+    /home/you/RMagick-2.0.0/lib/RMagick.rb:11:in `require': libMagick.so.0:
       cannot open shared object file: No such file or directory -
-      /home/you/RMagick-1.15.17/ext/RMagick/RMagick.so (LoadError)
+      /home/you/RMagick-2.0.0/ext/RMagick/RMagick.so (LoadError)
 
-you probably do not have the directory in which the ImageMagick or GraphicsMagick
-library is installed in your load path. An easy way to fix this is to define the
-directory in the LD\_LIBRARY\_PATH environment variable. For example, suppose you
-installed the GraphicsMagick library libGraphicsMagick.so in /usr/local/lib.
-(By default this is where it is installed.) Create the LD\_LIBRARY\_PATH variable
-like this:
+you probably do not have the directory in which the ImageMagick library
+is installed in your load path.  An easy way to fix this is to define
+the directory in the LD\_LIBRARY\_PATH environment variable.  For
+example, suppose you installed the ImageMagick library libMagick.so in
+/usr/local/lib.  (By default this is where it is installed.) Create the
+LD\_LIBRARY\_PATH variable like this:
 
     export LD_LIBRARY_PATH=/usr/local/lib
 
@@ -233,7 +170,7 @@ systems, see the documentation for the dynamic loading facility.
 #### No such file or directory - "/tmp/rmagick6872.6"
 When make is running the examples, if you get a message like this:
 
-    hook /home/me/src/RMagick-1.15.17/./post-setup.rb failed:
+    hook /home/me/src/RMagick-2.0.0/./post-setup.rb failed:
     No such file or directory - "/tmp/rmagick6872.6"
 
 you probably do not have a temporary directory environment variable set. Set
@@ -243,16 +180,16 @@ the TMPDIR environment variable to your temporary directory. For example:
 
 <h2 id="upgrade">Upgrading</h2>
 
-If you upgrade to a newer release of ImageMagick or GraphicsMagick, make sure
-you're using a release of RMagick that supports that release. Usually I put out
-a new release of RMagick with every new release of ImageMagick. It's safe to
-install a newer release of RMagick over an earlier release.
+If you upgrade to a newer release of ImageMagick, make sure you're using a
+release of RMagick that supports that release. It's safe to install a newer
+release of RMagick over an earlier release.
 
 <h2 id="uninstall">Uninstalling</h2>
 
-The `uninstall` target will uninstall RMagick completely:
+The `uninstall.rb` script will uninstall RMagick completely. Make sure you
+have administrator priviledges. Then run this command:
 
-    make uninstall
+    ruby uninstall.rb
 
 <h2 id="samples">More samples</h2>
 
@@ -264,21 +201,20 @@ These programs are not installed in the RMagick documentation tree.
 Please report bugs in RMagick, its documentation, or its installation
 programs to me via the bug tracker on the [RMagick project page at
 RubyForge](http://rubyforge.org/projects/rmagick).  However, I can't help
-with Ruby installation and configuration or ImageMagick or GraphicsMagick
-installation and configuration.  Please report problems with that software
-to their respective authors or distributors.
+with Ruby installation and configuration or ImageMagick
+installation and configuration. Information about reporting problems and
+getting help for ImageMagick is available at the ImageMagick web site
+(http://www.imagemagick.org).
 
 <h2 id="credits">Credits</h2>
 
 Thanks to
 
-   * Simple Systems, for hosting the RMagick documentation online.
    * ImageMagick Studio LLC, for ImageMagick and for hosting the RMagick documentation.
-   * Kaspar Schiess and Brett DiFrischia, for the MS Windows gems.
 
 <h2 id="license">License</h2>
 
-   >  Copyright � 2002-2008 by Timothy P. Hunter
+   >  Copyright � 2002-2007 by Timothy P. Hunter
    >
    >  Permission is hereby granted, free of charge, to any person obtaining a
    >  copy of this software and associated documentation files (the "Software"),
@@ -315,11 +251,10 @@ The HTML version was produced with [BlueCloth](http://bluecloth.rubyforge.org).
 
 [intro]: #intro
 [contact]: #contact
+[new]: #new
 [prereq]: #prereq
-[tips]: #tips
 [install]: #install
 [options]: #options
-[scripts]: #scripts
 [uhoh]: #uhoh
 [upgrade]: #upgrade
 [uninstall]: #uninstall

data/build_tarball.rake

@@ -0,0 +1,205 @@
+
+# Build the tar.gz, tar.bz2, and .gem files for an RMagick Release
+
+# To use: cd to $HOME
+# run:    rake -f path/to/build_tarball.rake clean
+#         rake -f path/to/build_tarball.rake release=tag beta=whatever
+#
+# Specify the release as release=RMagick_x-y-z or nothing if release=HEAD
+# Specify a beta Release as beta=beta1
+
+require 'rubygems'
+require 'bluecloth'
+require 'find'
+require 'fileutils'
+include FileUtils
+
+
+CVSSERVER = ":ext:rmagick@rubyforge.org/var/cvs/rmagick"
+
+
+# CVS_Tag is the CVS tag for this release. Dist_Directory is CVS_Tag,
+# modified for use as a directory name.
+if ENV.include?("release")
+  CVS_Tag = ENV["release"]
+  Dist_Directory = CVS_Tag.tr('_-','-.')
+else
+  CVS_Tag = "HEAD"
+  Dist_Directory = "RMagick-0.0.0"
+end
+
+
+# RMagick_Version is just X.Y.Z
+RMagick_Version = Dist_Directory.sub(/RMagick-/, "")
+
+# RMagick_Version2 is X.Y.Z + "-beta1" if beta=beta1
+RMagick_Version2 = RMagick_Version + (ENV.include?("beta") ? "-" + ENV["beta"] : "")
+
+# Release is RMagick-X.Y.Z, plus "-beta1" if beta=beta1
+Release = Dist_Directory + (ENV.include?("beta") ? "-" + ENV["beta"] : "")
+
+README = "README.html"
+MANIFEST = "ext/RMagick/MANIFEST"
+
+
+
+
+# Change the version number placeholders in a file.
+# Returns an array of lines from the file.
+def reversion(name)
+  now = Time.new
+  now = now.strftime("%m/%d/%y")
+
+  lines = File.readlines name
+  lines.each do |line|
+    line.gsub!(%r{0\.0\.0\$}, RMagick_Version2)
+    line.gsub!(%r{0\.0\.0}, RMagick_Version)
+    line.gsub!(%r{YY/MM/DD}, now)
+  end
+  lines
+end
+
+
+
+
+# Rewrite a file containing embedded version number placeholders.
+def reversion_file(name)
+  lines = reversion(name)
+  tmp_name = name + "_tmp"
+  mv name, tmp_name
+  begin
+    File.open(name, "w") { |f| f.write lines }
+  rescue
+    mv tmp_name, name
+  ensure
+    rm tmp_name
+  end
+end
+
+
+
+
+task :extconf do
+  Dir.chdir(Dist_Directory) { reversion_file "ext/RMagick/extconf.rb" }
+end
+
+
+
+
+task :gemspec do
+  Dir.chdir(Dist_Directory) { reversion_file "rmagick.gemspec" }
+end
+
+
+
+
+task "README.bc" do
+  Dir.chdir Dist_Directory do
+    reversion_file "README.txt"
+    body = File.readlines "README.txt"
+    body = BlueCloth.new(body.join).to_html + "\n"
+    File.open("README.bc", "w") { |f| f.write body }
+  end
+end
+
+
+
+
+task README => "README.bc" do
+  puts "writing #{README}"
+  Dir.chdir Dist_Directory do
+    File.open(README, "w") do |html|
+      html.write <<END_HTML_HEAD
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+    <title>RMagick #{RMagick_Version2} README</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+    <meta name="GENERATOR" content="BlueCloth">
+  </head>
+  <body>
+END_HTML_HEAD
+      html.write File.readlines("README.bc")
+      html.write <<END_HTML_TAIL
+  </body>
+</html>
+END_HTML_TAIL
+    end
+  end
+end
+
+
+
+
+task :doc do
+  Dir.chdir(File.join(Dist_Directory, "doc")) do
+      FileList["*.html"].each { |d| reversion_file(d) }
+  end
+end
+
+
+
+
+# Remove files we don't want in the tarball.
+# Ensure files are not executable. (ref: bug #10080)
+task :fix_files do
+    Dir.chdir Dist_Directory do
+        rm_rf "test", :verbose => true
+        rm "lib/rvg/to_c.rb", :verbose => true
+        rm "README.bc", :verbose => true
+        chmod 0644, FileList["doc/*.html", "doc/ex/*.rb", "doc/ex/images/*", "examples/*.rb"]
+    end
+end
+
+
+
+
+task :manifest do
+  now = Time.new
+  now = now.strftime("%H:%M:%S %m/%d/%y")
+  puts "generating #{MANIFEST}"
+
+  Dir.chdir Dist_Directory do
+    File.open(MANIFEST, "w") do |f|
+      f.puts "MANIFEST for #{Release} - #{now}\n\n"
+      Find.find('.') do |name|
+        next if File.directory? name
+        f.puts name[2..-1]    # remove leading "./"
+      end
+    end
+  end
+end
+
+
+
+
+task :export do
+  sh "cvs -d#{CVSSERVER}  export -r #{CVS_Tag} -d #{Dist_Directory} RMagick"
+end
+
+
+
+
+task :collateral => ["README.html", :gemspec, :extconf, :doc]
+
+GEM = Dist_Directory.downcase + ".gem"
+
+task :default => [:export, :collateral, :fix_files, :manifest] do
+  sh "tar cvfz #{Release}.tar.gz #{Dist_Directory}"
+  sh "tar cvfj #{Release}.tar.bz2 #{Dist_Directory}"
+  Dir.chdir(Dist_Directory) do
+    sh "gem build rmagick.gemspec"
+    mv GEM, "../", :verbose => true
+  end
+end
+
+
+
+
+task :clean do
+  rm_rf Dist_Directory, :verbose => true
+  rm_rf Release+".tar.gz", :verbose => true
+  rm_rf Release+".tar.bz2", :verbose => true
+  rm_rf GEM, :verbose => true
+end
+