Subversion Repositories Scribus

Rev

Rev 2405 | Rev 2514 | 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
2405 craig 112
versions of libraries.
2084 craig 113
 
2405 craig 114
TROUBLESHOOTING
115
===============
2383 mrdocs 116
 
2405 craig 117
If Scribus can't find a library, there are several things you should do.
118
First of all, read `DISTRO SPECIFIC BUILD INFORMATION' below and see if
119
there's anything there for your OS / distro.
120
 
121
Next, ensure you definitely have the library installed, as well as any
122
additional development packages that may be required to use it.  On Linux, make
123
sure to install the "-dev" or "-devel" package for the missing library. After
124
doing this, re-run configure.
125
 
126
If the library is still not found, please read and act on the section above,
127
entitled `LIBRARIES IN NONSTANDARD LOCATIONS'. Check that all those environment
128
variables are set to sensible values. If you are using any other custom CFLAGS,
129
LDFLAGS, CXXFLAGS, CPPFLAGS, etc, then unset or disable them unless you're really
130
sure you know what you're doing. This is doubly true for "optimisation" flags
131
like -mcpu and -march .
132
 
133
If you're still having problems, have a look at config.log (in the same
134
directory as configure) and see if you can tell what the problem is. You'll
135
probably want to use some sort of search command to look for the name of the
136
library that's not being found - config.log is *long*.
137
 
138
If you're still unable to determine what the problem is, please post a message
139
to the Scribus mailing list or report a bug on bugs.scribus.net. If you report
140
a bug, please attach a gzipped copy of config.log. If posting to the mailing
141
list, DO NOT attach config.log - but if possible, please post it on a website
142
or somewhere else we can get to it and provide the address. Otherwise, just
143
email it if someone asks for it. In any problem report, MAKE SURE YOU INCLUDE
144
THE FOLLOWING INFORMATION:
145
    - Operating system or distro, eg "Mac OS X" or "Debian Linux"
146
    - OS or distro version, eg "Panther" or "Fedora Core 3". This is NOT the
147
      Linux kernel version, though you can provide that too.
148
    - Scribus version you're trying to compile, eg "1.2.1" or "1.3 cvs". If
149
      you're building CVS, please make sure you've run "cvs up -Pd -C" (this
150
      WILL erase any patches / custom changes you've made) then re-built
151
      starting at "make -f Makefile.cvs" before reporting a problem. If
152
      you're using a snapshot or CVS, please tell us when you downloaded
153
      it (eg "todays CVS snapshot").
154
    - What compiler you're using. You can get this from `gcc --version'.
155
      if you're using gcc.
156
    - If you're having problems with a particular library, what version
157
      of the library you have installed and where you got it from. eg:
158
      "freetype 2.0.1 from sunfreeware,"
159
      "LittleCMS 1.1.4, compiled myself and installed in /usr/local,"
160
      "freetype 2.1.3 from backports.org,"
161
      "fontconfig 2.2.0 (stock Fedora Core 3 devel package)"
162
      "I installed the qt-3.0.1.rpm and qt-devel-3.0.1.rpm from the CD."
163
    - Check again to make REALLY REALLY SURE you have the devel package
164
      installed.
165
    - Any environment variables you may have set
166
    - Anything else you can think of that might be useful. There's no
167
      such thing as too much information, though please put big files
168
      elsewhere rather than sending them to the mailing list.
169
 
170
It's best if you do a search of the mailing list archives and/or
171
bugs.scribus.net before reporting a problem, too. This is doubly true for
172
development versions of Scribus.
173
 
2084 craig 174
DISTRO SPECIFIC BUILD INFORMATION
175
=================================
176
 
177
This section contains information about compiling Scribus that's specific to
178
particular operating systems and Linux distros. More distro-specific
179
information can be found in the README.
180
 
181
Debian
182
======
183
 
184
Recommended packages for compiling from source on Sarge (Debian 3.1):
185
	libqt3-mt-dev (Required)
186
	libfreetype6-dev (Required)
187
	libart-2.0-dev (Required)
188
	libcupsys2-dev
189
	liblcms1-dev
190
	libfontconfig1-dev
191
	libtiff4-dev
192
	libxml2-dev
193
	python2.3-dev  or  python2.4-dev
194
	gs-afpl
195
 
196
You are unlikely to be able to compile Scribus 1.3.x on Debian 3.0 (Woody)
197
without significant upgrades; it is not at all recommended. Scribus 1.3.x
198
should be considered not to support Debian Woody.
199
 
200
More info in the README.
201
 
202
Red Hat / Fedora
203
================
204
 
2452 craig 205
Recommended packages for compiling from source on FC3 / FC4:
2084 craig 206
	qt-devel (Required)
207
	freetype-devel (Required)
208
	libart_lgpl-devel (Required)
209
	fontconfig-devel
210
	cups-devel
211
	libtiff-devel
212
	libxml2-devel
213
	python-devel
214
	lcms-devel
215
 
216
You can install these packages with 'yum install packagename' as root. You may
2452 craig 217
need to run up2date first to set up your yum configuration (not required on
218
FC4). Be patient - the first time you run yum it may take a long time to
219
download the headers for all the security updates that have been released.
2084 craig 220
 
2452 craig 221
You may also need to 'export QTDIR=/usr/lib/qt-3.3' before running
222
configure or make.
223
 
2084 craig 224
More info in the README.
225
 
226
MacOS/X
227
=======
228
 
229
No build instructions yet. Please see the README for info on MacOS/X.
230
 
231
Microsoft Windows
232
=================
233
 
234
No build instructions yet. Please see the README for info on Scribus under
235
Windows.
236
 
237
Other distros/OSes
238
==================
239
 
240
Please feel free to submit a list of package names and versions required to
241
compile Scribus on your distro, or build instructions for your OS.