Subversion Repositories Scribus

Rev

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

Rev Author Line No. Line
16720 jghali 1
BUILDING SCRIBUS ON MICROSOFT WINDOWS WITH MICROSOFT VISUAL STUDIO
2
==================================================================
3
 
19973 jghali 4
This documentation is minimal and assume you have a decent knowledge of
16720 jghali 5
Microsoft Visual Studio. No help regarding use of Visual Studio and
6
related tools will be provided.
7
 
8
You will need:
20188 jghali 9
- Microsoft Vista, 7 or a more recent version
22757 jghali 10
- Microsoft Visual Studio 2013 or later (for 32/64bit build)
23566 jghali 11
- A recent Qt release built with corresponding Visual Studio version (minimum 5.11, recommended >= 5.12.0)
20188 jghali 12
- Scribus common libraries kit downloaded from http://sourceforge.net/projects/scribus/files/scribus-libs/
13
- Scribus 15x libraries kit downloaded from http://sourceforge.net/projects/scribus/files/scribus-libs/
14
 
22757 jghali 15
It is possible to use Microsoft Visual Studio 2013, 2015 or 2017 Express editions.
16720 jghali 16
 
17
GETTING DEPENDENCIES
18
====================
19
 
20
This is a quick and dirty set of notes that will be filled out once everything's
19104 jghali 21
verified as correct and working. It assumes that you'll be building all your
19973 jghali 22
dependencies at a single root such as C:\Developer. The root *MUST NOT* have spaces
16720 jghali 23
in its path.
24
 
25
 
19973 jghali 26
Building Qt:
27
------------
16720 jghali 28
 
19973 jghali 29
Download the latest Qt 5 release from http://download.qt.io/official_releases/qt/ and unpack it to C:\Developer.
16720 jghali 30
 
19973 jghali 31
Follow instructions in following pages to get Qt build dependencies, noticeably perl, python and ruby:
32
http://doc.qt.io/qt-5/windows-requirements.html
33
http://doc.qt.io/qt-5/windows-building.html
16720 jghali 34
 
19973 jghali 35
Start a command line and import your Visual Studio environment:
36
- for building 32bit : \path\to\visual\studio\VC\vcvarsall.bat x86
37
- for building 64bit : \path\to\visual\studio\VC\vcvarsall.bat x86_amd64
16720 jghali 38
 
20188 jghali 39
Now cd to C:\Developer\qt-everywhere-whatever and run configure:
22152 jghali 40
- Visual Studio 2013 : configure -platform win32-msvc2013 -prefix /path/where/you/want/qt5/to/be/installed -nomake examples -nomake tests -opengl desktop -opensource -mp
41
- Visual Studio 2015 : configure -platform win32-msvc2015 -prefix /path/where/you/want/qt5/to/be/installed -nomake examples -nomake tests -opengl desktop -opensource -mp
16720 jghali 42
 
19973 jghali 43
After configure has finished its work, run nmake. Depending on the number of processors available on your machine, a complete Qt build may
44
take from a few hours to several days. Once Qt has finished building, run following command to install Qt to its install directory:
45
nmake install
16720 jghali 46
 
19973 jghali 47
If you want to build Qt docs, you might want to run following command afterwards:
48
nmake docs
49
nmake install_docs
16720 jghali 50
 
19973 jghali 51
Once you finished building and installing Qt, you can run following command to clean Qt source directory:
52
nmake distclean
16720 jghali 53
 
19973 jghali 54
Building 3rd party libraries:
55
-----------------------------
16720 jghali 56
 
20188 jghali 57
Archives with ready-to-build solutions for scribus dependencies have been made available on Sourceforge:
58
http://sourceforge.net/projects/scribus/files/scribus-libs/
59
These archives can be used to compile all dependencies necessary for Scribus.
16720 jghali 60
 
19973 jghali 61
Two different archives are needed :
20188 jghali 62
- scribus-commmon-libs-YYYYMMDD.7z : common libraries for 14x and trunk, no compilation is required here
63
- scribus-15x-libs-msvcXXXX-YYYYMMDD.7z : Scribus 15x specific libraries used for current Scribus 1.5.x releases
16720 jghali 64
 
20188 jghali 65
These archives are named using a scheme where:
66
- msvcXXXX represents the Visual Studio version needed to compile provided Visual Studio solution
67
- YYYYMMDD represents the date where the archive has been prepared/uploaded to Sourceforge.
16720 jghali 68
 
22757 jghali 69
For building 15x dependencies, archives for Visual Studio 2013 and Visual Studio 2015 are provided. These archives allows to
22152 jghali 70
build libraries  for 32bit and 64bit platforms using the different available toolsets, including the Windows XP compatible ones.
71
The default configuration  allows to build binaries compatible with Windows Vista and up.
16720 jghali 72
 
19973 jghali 73
Once you downloaded the two appropriate archives :
20188 jghali 74
- decompress them in the *same* directory so as to get a layout similar to this one :
75
    - your_script_libs_directory
22152 jghali 76
       |- scribus-1.5.x-libs-msvc2015
20188 jghali 77
       |- scribus-common-libs
78
- open the visual studio solution (*.sln) located in the scribus-1.5.x-libs-* directory
79
- build debug and release configurations for all platforms (Win32 and/or x64) you plan to execute scribus on
80
 
19973 jghali 81
If you want to build using a different toolset, you can use msbuild through the command line. To do so you can use the provided
82
build-all-platform-libs.bat script. For example :
22152 jghali 83
- to build with Visual Studio 2015 default toolset for x64 platform: build-all-platform-libs.bat x64 v140
84
- to build with Visual Studio 2015 Windows XP toolset for Win32 platform: build-all-platform-libs.bat Win32 v140_xp
17505 jghali 85
 
19973 jghali 86
BUILDING SCRIBUS
87
====================
17505 jghali 88
 
22757 jghali 89
After having compiled all dependencies, open the Scribus-build-props.props file located in Scribus\win32\msvc2013 or
22152 jghali 90
Scribus\win32\msvc2015 depending on the Visual Studio version you are using in a text editor.
19973 jghali 91
Update the dependency paths to match your system.
17505 jghali 92
 
19973 jghali 93
Open the Visual Studio solution located in same directoy and start building. Note: if you built dependencies with a different
94
toolset than the default one, you should either modify toolset directly in all projects or build the solution through command
95
line using msbuild.
17505 jghali 96
 
19973 jghali 97
After building completed, you will find executables in a Scribus-builds\scribus-$(configuration)-$(platform)-$(platformtoolset)\
98
directory, located in same directory as Scribus sources. Those executables will not function yet. Scribus resources and
99
dependencies must be copied to install directory first.
17505 jghali 100
 
19973 jghali 101
INSTALLING RESOURCES AND DEPENDENCIES
102
=====================================
17505 jghali 103
 
19973 jghali 104
To copy resources to build directory, create a batch script and copy/paste following lines :
17505 jghali 105
 
19973 jghali 106
set SCRIBUS_SRC_PATH=.\Scribus
107
set SCRIBUS_BUILD_ROOT=.\Scribus-builds
22152 jghali 108
set SCRIBUS_INSTALL_PATH=.\Scribus-builds\scribus-debug-win32-v140
17505 jghali 109
 
20453 jghali 110
if not exist %SCRIBUS_INSTALL_PATH%\libs                mkdir %SCRIBUS_INSTALL_PATH%\libs
111
if not exist %SCRIBUS_INSTALL_PATH%\share               mkdir %SCRIBUS_INSTALL_PATH%\share
112
if not exist %SCRIBUS_INSTALL_PATH%\share\doc           mkdir %SCRIBUS_INSTALL_PATH%\share\doc
113
if not exist %SCRIBUS_INSTALL_PATH%\share\plugins       mkdir %SCRIBUS_INSTALL_PATH%\share\plugins
114
if not exist %SCRIBUS_INSTALL_PATH%\share\qml           mkdir %SCRIBUS_INSTALL_PATH%\share\qml
115
 
20188 jghali 116
 copy %SCRIBUS_SRC_PATH%\AUTHORS                        %SCRIBUS_INSTALL_PATH%\share\doc
117
 copy %SCRIBUS_SRC_PATH%\COPYING                        %SCRIBUS_INSTALL_PATH%\share\doc
118
 copy %SCRIBUS_SRC_PATH%\LINKS                          %SCRIBUS_INSTALL_PATH%\share\doc
119
 copy %SCRIBUS_SRC_PATH%\TRANSLATION                    %SCRIBUS_INSTALL_PATH%\share\doc
20453 jghali 120
xcopy %SCRIBUS_SRC_PATH%\doc                            %SCRIBUS_INSTALL_PATH%\share\doc /s /y /i /D
121
xcopy %SCRIBUS_SRC_PATH%\resources\dicts                %SCRIBUS_INSTALL_PATH%\share\dicts /s /y /i /D
122
xcopy %SCRIBUS_SRC_PATH%\resources\editorconfig         %SCRIBUS_INSTALL_PATH%\share\editorconfig /s /y /i /D
20611 jghali 123
xcopy %SCRIBUS_SRC_PATH%\resources\iconsets             %SCRIBUS_INSTALL_PATH%\share\icons /s /y /i /D
20188 jghali 124
 copy %SCRIBUS_SRC_PATH%\resources\iconsets\1_5_0\*.xml %SCRIBUS_INSTALL_PATH%\share\icons /y
125
 copy %SCRIBUS_SRC_PATH%\resources\iconsets\1_5_1\*.xml %SCRIBUS_INSTALL_PATH%\share\icons /y
21767 jghali 126
xcopy %SCRIBUS_SRC_PATH%\resources\keysets              %SCRIBUS_INSTALL_PATH%\share\keysets /s /y /i /D
20453 jghali 127
xcopy %SCRIBUS_SRC_PATH%\resources\loremipsum           %SCRIBUS_INSTALL_PATH%\share\loremipsum /s /y /i /D
128
xcopy %SCRIBUS_SRC_PATH%\resources\profiles             %SCRIBUS_INSTALL_PATH%\share\profiles /s /y /i /D
129
xcopy %SCRIBUS_SRC_PATH%\resources\swatches             %SCRIBUS_INSTALL_PATH%\share\swatches /s /y /i /D
130
xcopy %SCRIBUS_SRC_PATH%\resources\templates            %SCRIBUS_INSTALL_PATH%\share\templates /s /y /i /D
20188 jghali 131
 copy %SCRIBUS_SRC_PATH%\scribus\scribus.css            %SCRIBUS_INSTALL_PATH%\libs\scribus.css /y
21923 jghali 132
 copy %SCRIBUS_SRC_PATH%\scribus\plugins\tools\pathcut\*.png      %SCRIBUS_INSTALL_PATH%\share\icons\1_5_1 /y
133
 copy %SCRIBUS_SRC_PATH%\scribus\plugins\tools\pathfinder\*.png   %SCRIBUS_INSTALL_PATH%\share\icons\1_5_1 /y
20453 jghali 134
xcopy %SCRIBUS_SRC_PATH%\scribus\plugins\scriptplugin\scripts     %SCRIBUS_INSTALL_PATH%\share\scripts /s /y /i /D
135
xcopy %SCRIBUS_SRC_PATH%\scribus\plugins\scriptplugin\samples     %SCRIBUS_INSTALL_PATH%\share\samples /s /y /i /D
20188 jghali 136
copy  %SCRIBUS_SRC_PATH%\scribus\plugins\import\ps\import.prolog  %SCRIBUS_INSTALL_PATH%\libs\import.prolog
19973 jghali 137
copy  %SCRIBUS_SRC_PATH%\scribus\plugins\barcodegenerator\barcode.ps %SCRIBUS_INSTALL_PATH%\share\plugins\barcode.ps
20188 jghali 138
xcopy %SCRIBUS_SRC_PATH%\scribus\ui\qml                           %SCRIBUS_INSTALL_PATH%\share\qml /s /y
139
copy  %SCRIBUS_SRC_PATH%\scribus\unicodemap\unicodenameslist.txt  %SCRIBUS_INSTALL_PATH%\share\unicodenameslist.txt
20453 jghali 140
 
20076 jghali 141
del   %SCRIBUS_BUILD_ROOT%\*CMake* /s
142
del   %SCRIBUS_BUILD_ROOT%\*MakeFile* /s
17505 jghali 143
 
19973 jghali 144
Adjust SCRIBUS_SRC_PATH, SCRIBUS_BUILD_ROOT and SCRIBUS_INSTALL_PATH as needed and run batch script.
17505 jghali 145
 
19973 jghali 146
To install common libs:
20188 jghali 147
- open the scribus-common-libs directory where you uncompressed 15x/trunk libs
148
- open the copy-dlls-to-15x-build-dir.bat file from scribus-common-libs directory in a text editor
149
- modify the SCRIBUS_BUILDS_DIR, SCRIBUS_LIB_TOOLSET and PYTHON_DIR_* variables appropriately
150
- execute batch file
17505 jghali 151
 
19973 jghali 152
To install version specific libs:
20188 jghali 153
- open the scribus-15x-libs-msvc* directory where you uncompressed Scribus 15x libs
154
- open the copy-*-dlls-to-build-dir.bat file in a text editor
155
- modify the SCRIBUS_BUILDS_DIR and SCRIBUS_LIB_TOOLSET variables appropriately
156
- execute batch file
17505 jghali 157
 
19973 jghali 158
Finally copy Qt DLLs to build directory and Qt plugins directory to "qtplugins" directory.
159
Scribus should now run.
17505 jghali 160
 
19973 jghali 161
Crash problems at runtime? Verify that Scribus and all its dependencies use the same runtime, and that all were built
162
for debug or release configurations and not a mixture of the two. On Windows, it is strictly not recommended to mix
163
debug and release binaries. Doing so is not supported and will usually trigger unpredictable issues and crashes.
16720 jghali 164
 
19973 jghali 165
You can use depends.exe to check that the runtimes match.