summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorCarl Worth <cworth@cworth.org>2005-08-24 06:17:39 +0000
committerCarl Worth <cworth@cworth.org>2005-08-24 06:17:39 +0000
commit19c25d63c2c4dd7a178e90df81b711ba667cbdd1 (patch)
treec0352c2b226c4aa7368b9d410943d7635e61218a /INSTALL
parent985d8571d2266715229d5e1e9d2037897240d6ce (diff)
Add some more detailed build instructions.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL118
1 files changed, 113 insertions, 5 deletions
diff --git a/INSTALL b/INSTALL
index 8ff0f362..445bb83f 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,9 +1,117 @@
-This package uses automake, in order to generate the Makefiles use:
+Quick-start build instructions
+------------------------------
+1) Configure the package:
- $ autogen.sh
+ ./configure
-After that, standard build procedures apply:
+2) Compile it:
- $ make
- # make install
+ make
+3) Install it:
+
+ make install
+
+This final step may require temporary root access (eg. with sudo) if
+you don't have write permission to the directory in which cairo will
+be installed.
+
+More detailed build instructions
+--------------------------------
+
+1) Configure the package
+
+ The first step in building cairo is to configure the package by
+ running the configure script. The configure script attempts to
+ automatically detect as much as possible about your system. So,
+ you should primarily just accept its defaults by running:
+
+ ./configure
+
+ The configure script does accept a large number of options for
+ fine-tuning its behavior. See "./configure --help" for a complete
+ list. The most commonly used options are discussed here.
+
+ --prefix=PREFIX
+
+ This option specifies the directory under which the software
+ should be installed. By default configure will choose a
+ directory such as /usr/local. If you would like to install
+ cairo to some other location, pass the director to configure
+ with the --prefix option. For example:
+
+ ./configure --prefix=/opt/cairo
+
+ would install cairo into the /opt/cairo directory. You could
+ also choose a prefix directory within your home directory if
+ you don't have write access to any system-wide directory.
+
+ After installing into a custom prefix, you will need to set
+ some environment variables to allow the software to be
+ found. Assuming the /opt/cairo prefix and assuming you are
+ using the bash shell, the following environment variables
+ should be set:
+
+ PKG_CONFIG_PATH=/opt/cairo/lib/pkgconfig
+ LD_LIBRARY_PATH=/opt/cairo/lib
+ export PKG_CONFIG_PATH LD_LIBRARY_PATH
+
+ --enable-ps
+ --enable-pdf
+ --enable-quartz
+ --enable-atsui
+ --enable-xcb
+
+ Some of cairo's backends are marked as experimental and will
+ not be built by default. If you would like to build and
+ experiment with these backends, you will need to pass one of
+ the above options to the configure script. You may need to
+ have certain libraries installed first as discussed in the
+ dependencies section of the README file.
+
+ --disable-xlib
+ --disable-win32
+ --disable-png
+ --disable-glitz
+ --disable-freetype
+
+ Cairo's configure script detects the libraries needed to build
+ each stable backend, and when it finds them, enables each
+ backend. If you would like to override this detection and
+ disable a backend, (even when it would be possible to build
+ it), use one of the options above to disable the backend.
+
+2) Compile the package:
+
+ This step is very simple. Just:
+
+ make
+
+ The Makefiles included with cairo are designed to work on as many
+ different systems as possible.
+
+ When cairo is compiled, you can also run some automated tests of
+ cairo with:
+
+ make check
+
+ NOTE: Some versions of X servers will cause the -xlib tests to
+ report failures in make check even when cairo is working just
+ fine. If you see failures in nothing but -xlib tests, please
+ examine the corresponding -xlib-out.png images and compare them to
+ the -ref.png reference images (the -xlib-diff.png images might also
+ be useful). If the results seem "close enough" please do not report
+ a bug against cairo as the "failures" you are seeing are just due
+ to subtle variations in X server implementations.
+
+3) Install the package:
+
+ The final step is to install the package with:
+
+ make install
+
+ If you are installing to a system-wide location you may need to
+ temporarily acquite root access in order to perform this
+ operation. A good way to do this is to use the sudo program:
+
+ sudo make install