Subversion Repositories Scribus

Rev

Rev 2084 | Rev 2405 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2084 craig 1
Generic build instructions are available in the INSTALL file. Please read these
2
notes for Scribus-specifc information plus notes about compiling Scribus on
3
particular distributions and operating systems.
4
 
5
REQUIREMENTS AND BUILDING
6
=========================
7
 
8
Install the below packages BEFORE running configure or compiling Scribus:
9
 
10
Requirements:
11
	Qt >= 3.3 (3.3.3 recommended)
2383 mrdocs 12
	Freetype >= 2.1.3 (2.1.9+ recommended)
13
	libart >= 2.3.8+ (2.3.17+ recommended)
2084 craig 14
 
15
Recommended:
16
	CUPS
17
	libtiff >= 3.6.0
18
	Fontconfig >= 2.0
19
	LittleCMS = 1.12 (1.14+ recommended)
20
	LibXML2 >= 2.6.0
21
	GhostScript >= 8.0 (8.15 or greater preferred)
22
	Python >= 2.3
23
	tkinter for the font sampler script
24
	python-imaging for the font sampler preview
25
 
26
If any recommended libraries (and their dev/devel packages or headers) are not
27
installed, some features will be disabled by configure. If you later install
28
any of these dependencies, you will have to re-run configure and re-compile
29
Scribus before the features are enabled.
30
 
31
LIBRARIES IN NON-STANDARD LOCATIONS
32
===================================
33
 
34
You can skip this section unless (a) you have libraries installed in unusual
35
locations such as your home directory and are NOT installing Scribus to the
36
same --prefix as the libraries, or (b) Scribus is not finding libraries that
37
you KNOW you have installed (including the -dev/-devel package if appliccable).
38
 
39
If any of your libraries are in non-standard locations and not on the same
40
--prefix as you're configuring Scribus with, you will need to set some extra
41
environment variables when configuring and compiling Scribus to ensure that
42
configure and gcc can find all the required information. Where
43
/home/fred/libfred is the path to the the directory the lib was installed to
44
(--prefix), eg /usr/local or /home/fred/libfred (*NOT* the lib/ subdirectory
45
the actual library file is in), the following commands to bash should do the
46
trick:
47
 
48
	instdir=/home/fred/libfred
49
	export PKG_CONFIG_PATH="${PKG_CONFIG_PATH}:${instdir}/lib/pkgconfig"
50
	export LIBRARY_PATH="${LIBRARY_PATH}:${instdir}/lib"
51
	export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:${instdir}/lib"
52
	export CPATH="${CPATH}:${instdir}/include"
53
	export PATH="${PATH}:${instdir}/bin"
54
 
55
In most cases, you can get away with just some of them for any given lib, but
56
setting all of those means any of the several methods of finding libraries that
57
might be used should work. These requirements are standard for pretty much any
58
package, they are not specific to Scribus - it's just most packages don't
59
bother to explain this to you ;-)
60
 
61
In general, you should not add "-I/path" directives to `CXXFLAGS', `CPPFLAGS',
62
or `CFLAGS'; that's what `CPATH' is for. Similarly, use `LIBRARY_PATH' rather
63
than adding "-L/path" to `LDFLAGS' when trying to get `ld' to find a library.
64
 
65
`LD_LIBRARY_PATH' may also need to be set when running Scribus later. To avoid
66
this requirement under Linux, add the library path to `/etc/ld.so.conf' (on its
67
own line, nothing but the path, eg "/home/fred/libfred/lib" without the quotes)
68
and run ldconfig as root. Other operating systems have other requirements.
69
 
70
MacOS/X users may need to set `DYLD_LIBRARY_PATH' as well as `LD_LIBRARY_PATH'.
71
 
72
Note that Scribus's build scripts will always find a library installed to the
73
same --prefix as Scribus its self ; no special configuration should be required
74
in that case.  Any failure to do so is a bug and should be reported on
75
http://bugs.scribus.net/ .
76
 
77
REQUIREMENTS - DETAILS
78
======================
79
 
80
We strongly recommend having Qt 3.3.3+. Qt 3.3 is now the *minimum*. Older
81
versions of Qt are *not* supported. If you build Qt from sources, the
82
recommended ./configure switches are the same as used by KDE. Use of other
83
switches aside from those used by distro packages can make trouble shooting
84
issues very difficult at times.
85
See: http://developer.kde.org/build/compile_kde3_3.html
86
 
87
Scribus requires Freetype. If you are compiling from source, you will need to
88
have the freetype headers installed - these can usually be found in a -devel
89
package for your distro.
90
 
91
It is strongly recommended that you install the CUPS development packages if
92
you are compiling Scribus. Without CUPS, Scribus will have significantly
93
reduced printing functionality.
94
 
95
Fontconfig, if installed, will let Scribus find fonts using the same method as
96
most other major desktop applications such as all KDE and GNOME applications.
97
If fontconfig support is installed, Scribus will not search your X font path, X
98
server configuration, or X font server configuration for fonts - it will only
99
use fonts found using fontconfig and any custom font locations configured in
100
the preferences.
101
 
102
Python will be used to add scripting support to Scribus. If Python is not
103
found, or there are no header files for Python installed (usually because you
104
haven't installed the development package), the scripting support will not be
105
enabled.
106
 
107
See the distro-specific notes below for more information on installing and
108
using Scribus with your distro.
109
 
2383 mrdocs 110
If you have a 64-bit version of Qt, sometimes ./configure will not detect the
111
64-bit version headers. Try : ./configure --enable-libsuffix=64 to test for 64-bit
112
versions of libraries.
2084 craig 113
 
2383 mrdocs 114
 
2084 craig 115
DISTRO SPECIFIC BUILD INFORMATION
116
=================================
117
 
118
This section contains information about compiling Scribus that's specific to
119
particular operating systems and Linux distros. More distro-specific
120
information can be found in the README.
121
 
122
Debian
123
======
124
 
125
Recommended packages for compiling from source on Sarge (Debian 3.1):
126
	libqt3-mt-dev (Required)
127
	libfreetype6-dev (Required)
128
	libart-2.0-dev (Required)
129
	libcupsys2-dev
130
	liblcms1-dev
131
	libfontconfig1-dev
132
	libtiff4-dev
133
	libxml2-dev
134
	python2.3-dev  or  python2.4-dev
135
	gs-afpl
136
 
137
You are unlikely to be able to compile Scribus 1.3.x on Debian 3.0 (Woody)
138
without significant upgrades; it is not at all recommended. Scribus 1.3.x
139
should be considered not to support Debian Woody.
140
 
141
More info in the README.
142
 
143
Red Hat / Fedora
144
================
145
 
146
Recommended packages for compiling from source on FC3:
147
	qt-devel (Required)
148
	freetype-devel (Required)
149
	libart_lgpl-devel (Required)
150
	fontconfig-devel
151
	cups-devel
152
	libtiff-devel
153
	libxml2-devel
154
	python-devel
155
	lcms-devel
156
 
157
You can install these packages with 'yum install packagename' as root. You may
158
need to run up2date first to set up your yum configuration. Be patient - the
159
first time you run yum it will take a long time to download the headers for all
160
the security updates that have been released.
161
 
162
More info in the README.
163
 
164
MacOS/X
165
=======
166
 
167
No build instructions yet. Please see the README for info on MacOS/X.
168
 
169
Microsoft Windows
170
=================
171
 
172
No build instructions yet. Please see the README for info on Scribus under
173
Windows.
174
 
175
Other distros/OSes
176
==================
177
 
178
Please feel free to submit a list of package names and versions required to
179
compile Scribus on your distro, or build instructions for your OS.