Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 230 lines (164 sloc) 8.41 kb
bbf7f94 Replaces README.bc
rmagick authored
1 h1. RMagick 0.0.0$ README
2
3 h2. YY/MM/DD
4
5 h3. Table of Contents
6
7 * "Introduction":#intro
8 * "Prerequisites":#prereq
9 * "Installing RMagick":#install
10 * "Configuration Options":#config
11 * "Things that can go wrong":#wrong
12 * "Upgrading":#upgrade
13 * "Uninstalling":#uninstall
14 * "More samples":#samples
15 * "Reporting Bugs":#bugs
16 * "Contact Information":#contact
17 * "Credits":#credits
18 * "License":#license
19
20 h2(#intro). Introduction
21
22 RMagick is an interface between the Ruby programming language and the
23 ImageMagick image processing library.
24
25 h2(#prereq). Prerequisites
26
27 *O/S* Linux, *BSD, OS X, Windows 2000, XP, Vista, other *nix-like systems.
28
29 *Ruby* Version 1.8.2 or later. You can get Ruby from "www.ruby-lang.org":http://www.ruby-lang.org.
30 The use of versions of Ruby older than 1.8.4 with RMagick is deprecated. Support will be
31 removed in a future release.
32
33 *ImageMagick* Version 6.3.0 or later. You can get ImageMagick from "www.imagemagick.org":http://www.imagemagick.org.
34
35 h2(#install). Installing RMagick
36
37 First install ImageMagick. Complete and up-to-date instructions for installing
38 ImageMagick on Linux, *BSD, and other *nix-type O/S's are available
39 "here":http://rmagick.rubyforge.org/install-linux.html. Use steps 0, 1, and 2.
40 Similarly, instructions for installing ImageMagick using MacPorts on OS X
41 are available "here":http://rmagick.rubyforge.org/install-osx.html. Use steps
42 1 and 2.
43
44 This release of RMagick uses Minero Aoki's setup.rb script for installation.
45 See the next section for configuration options. Usually you do not need to
46 specify any of these options. You can get more information about setup.rb from
47 his "web site":<http://i.loveruby.net.
48
49 I assume you've already decompressed the tarball, or you wouldn't be reading
50 this. If you have not decompressed the tarball, do so with one of these commands,
51 depending on which tarball you have:
52
53 <pre>
54 tar xvzf RMagick-0.0.0$-tar.gz (gzipped tarball)
55 tar xvjf RMagick-0.0.0$-tar.bz2 (bzipped tarball)
56 7z e RMagick-x.y.z.tar.lzma -so | tar xv (7zipped tarball)
57 </pre>
58
59 Change to the RMagick-0.0.0 directory. If you are not using any
60 configuration options (usually you don't need to) enter the command
61
62 <pre>
63 ruby setup.rb
64 </pre>
65
66 Note that setup.rb executes all the example programs, so this can take
67 some time. This process both builds the example images used in the
68 documentation and validates your RMagick installation.
69
70 After this command completes, make sure you have root privileges (that
71 is, login as root or use su or sudo) and enter the command
72
73 <pre>
74 ruby setup.rb install
75 </pre>
76
77 h2(#config). Configuration options
78
79 Type @ruby setup.rb --help@ to see a list of configuration options. In
80 addition to the regular options, there are a few RMagick-specific options:
81
82 h4. --doc-dir=directory
83
84 Specify the directory to install the RMagick documentation.
85 By default this is $prefix/share/RMagick, where $prefix is the
86 prefix specified by --prefix. For example, to install the
87 documentation in /Users/me/RMagick, specify:
88
89 <pre>
e78cc11 setup.rb, not ./configure
rmagick authored
90 ruby setup.rb --doc-dir=/Users/me/RMagick
bbf7f94 Replaces README.bc
rmagick authored
91 </pre>
92
93 h4. --allow-example-errors
94
95 Normally the documentation installation terminates if 5 examples fail.
96 If you use this option, the installation does not check for failing
97 examples and will always complete. This option is useful if you're
98 having trouble installing RMagick and you want to see all the failing examples.
99
100 h4. -- disable-htmldoc
101
102 By default the install process runs all the RMagick example programs and
103 generates HTML versions of all the examples. This option causes the
104 install process to skip this step. No install verification will take
105 place and no documentation will be installed.
106
107 h2(#wrong). Things that can go wrong
108
109 The "RMagick installation FAQ":http://rmagick.rubyforge.org/install-faq.html
110 has answers to the most commonly reported problems.
111
112 h4. Can't install RMagick. Can't find libMagick or one of the dependent libraries. Check the mkmf.log file for more detailed information.
113
114 Typically this message means that one or more of the libraries that ImageMagick
115 depends on hasn't been installed. Examine the mkmf.log file in the ext/RMagick
116 subdirectory of the installation directory for any error messages. These messages
117 typically contain enough additional information for you to be able to diagnose
118 the problem. Also see "this FAQ":http://rmagick.rubyforge.org/install-faq.html#libmagick.
119
120 h4. Cannot open shared object file
121
122 If you get a message like this:
123
124 <pre>
125 $DIR/RMagick.rb:11:in `require': libMagick.so.0:
126 cannot open shared object file: No such file or directory -
127 $DIR/RMagick2.so (LoadError)
128 </pre>
129
130 you probably do not have the directory in which the ImageMagick library
131 is installed in your load path. An easy way to fix this is to define
132 the directory in the LD_LIBRARY_PATH environment variable. For
133 example, suppose you installed the ImageMagick library libMagick.so in
134 /usr/local/lib. (By default this is where it is installed.) Create the
135 LD_LIBRARY_PATH variable like this:
136
137 <pre>
138 export LD_LIBRARY_PATH=/usr/local/lib
139 </pre>
140
141 On Linux, see @ld(1)@ and @ld.so(8)@ for more information. On other operating
142 systems, see the documentation for the dynamic loading facility.
143
144 h4. No such file or directory - "/tmp/rmagick6872.6"
145
146 When setup.rb is running the examples, if you get a message like this:
147
148 <pre>
149 hook /home/me/src/RMagick-0.0.0/./post-setup.rb failed:
150 No such file or directory - "/tmp/rmagick6872.6"
151 </pre>
152
153 you probably do not have a temporary directory environment variable set. Set
154 the TMPDIR environment variable to your temporary directory. For example:
155
156 <pre>
157 export TMPDIR=/home/me/tmp
158 </pre>
159
160
161 h2(#upgrade). Upgrading
162
163 If you upgrade to a newer release of ImageMagick, make sure you're using a
164 release of RMagick that supports that release. It's safe to install a new
165 release of RMagick over an earlier release.
166
167 h2(#uninstall). Uninstalling
168
169 The uninstall.rb script will uninstall RMagick completely. Make sure you
170 have administrator priviledges. Then run this command:
171
172 <pre>
173 ruby uninstall.rb
174 </pre>
175
176 h2(#samples). More samples
177
178 You can find more sample RMagick programs in the /example directory.
179 These programs are not installed in the RMagick documentation tree.
180
181 h2(#bugs). Reporting bugs
182
183 Please report bugs in RMagick, its documentation, or its installation
184 programs to me via the bug tracker on the "RMagick project page":http://rubyforge.org/projects/rmagick.
185 However, I can't help with Ruby installation and configuration or ImageMagick
186 installation and configuration. Information about reporting problems and
187 getting help for ImageMagick is available at the "ImageMagick web site":http://www.imagemagick.org
188 or the "ImageMagick Forum":http://www.imagemagick.org/discourse-server.
189
190 h2(#contact). Contact Information
191
192 *Author:* Tim Hunter
193
194 *Email:* "rmagick@rubyforge.org":mailto:rmagick@rubyforge.org
195
196 *Web site:* "http://rmagick.rubyforge.org":http://rmagick.rubyforge.org
197
198 h2(#credits). Credits
199
200 Thanks to "ImageMagick Studio LLC":http://www.imagemagick.org for ImageMagick
201 and for hosting the RMagick documentation.
202
203 h2(#license). License
204
205 <pre>
206 Copyright © 2002-2008 by Timothy P. Hunter
207
208 Permission is hereby granted, free of charge, to any person obtaining a
209 copy of this software and associated documentation files (the "Software"),
210 to deal in the Software without restriction, including without limitation
211 the rights to use, copy, modify, merge, publish, distribute, sublicense,
212 and/or sell copies of the Software, and to permit persons to whom the
213 Software is furnished to do so, subject to the following conditions:
214
215 The above copyright notice and this permission notice shall be included in
216 all copies or substantial portions of the Software.
217
218 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
219 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
220 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
221 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
222 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
223 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
224 DEALINGS IN THE SOFTWARE.
225 </pre>
226
227 <hr>
228 This file is marked up using "Textile":http://hobix.com/textile/ and converted
229 to HTML with "RedCloth":http://whytheluckystiff.net/ruby/redcloth/.
Something went wrong with that request. Please try again.