TSPSG Installation Guide

Author:: Copyright © 2007-2010 Lёppa <contacts[at]oleksii[dot]name>

Id: install.dox 111 2010-04-27 23:40:22Z laleppa

URL: https://tspsg.svn.sourceforge.net/svnroot/tspsg/trunk/docs/dox/install.dox

Thank you for trying TSPSG. This document will guide you through the steps necessary to compile and run TSPSG.

REQUIREMENTS

To be able compile TSPSG you need to have Qt libraries^[1]. The minimum supported version of Qt is 4.4.0. The recommended version is 4.5.x or higher.

Note:: Please, note that there will be some regressions in functionality if your version of Qt is lower than the recommended.

ASSUMPTIONS

This guide assumes that you already have Qt libraries and all necessary prerequisites installed.

Also, the following assumptions are made:

For Linux/UNIX: lrelease and qmake are avilable in $PATH.
For Windows (minGW) and Symbian: you have installed Qt SDK or prebuilt libraries and have Start Menu items for Qt tools.
For Windows (Visual Studio) and Windows Mobile: the Qt libraries reside in C:\Qt\.
For Windows Mobile: Windows Mobile 5.0 Pocket PC SDK or later is installed.

SUPPORTED PLATFORMS

TSPSG is oficially supported and tested on the following platforms:

Linux: Gentoo AMD64 and Kubuntu 9.10 64-bit AMD.
Windows: Windows XP 32-bit and Windows 7 64-bit.
Windows Mobile: Windows Mobile 6.5 Professional Edition.

By default, executable will go to /usr/bin, COPYING.txt and README.txt will go to /usr/share/TSPSG, translations will go /usr/share/TSPSG/l10n, all docs will go to /usr/share/doc/TSPSG-<VERSION>.

WINDOWS

Note:: Please, read the section NOTES after reading this section.

USING MINGW

Unpack the downloaded source code of TSPSG with your favourite compression software. Now launch the Qt Command Prompt from the Start Menu, navigate to the directory where you unpacked the source and run

lrelease tspsg.pro
qmake tspsg.pro CONFIG+=release
mingw32-make

Note:: Make process may fail with a crash of windres.exe. If you've run into this issue, please, read the section WINDRES.EXE CRASH.

If make step finished without errors you can install TSPSG by running

mingw32-make install

TSPSG will be installed to %PROGRAMFILES%\TSPSG folder (usually, it is C:\Program Files\TSPSG).

USING VISUAL STUDIO

Unpack the downloaded source code of TSPSG with your favourite compression software. Now launch the Visual Studio Command Prompt from the Start Menu, navigate to the directory where you unpacked the source and run

C:\Qt\bin\lrelease tspsg.pro
C:\Qt\bin\qmake tspsg.pro CONFIG+=release
nmake

If make step finished without errors you can install TSPSG by running

nmake install

TSPSG will be installed to %PROGRAMFILES%\TSPSG folder (usually, it is C:\Program Files\TSPSG).

WINDOWS CE/MOBILE

Unpack the downloaded source code of TSPSG with your favourite compression software. Now launch the Visual Studio Command Prompt from the Start Menu and run

set PATH=C:\Qt\bin;\%PATH\%
setcepaths wincewm50pocket-msvc2008

Now navigate to the directory where you unpacked the source and run

lrelease tspsg.pro
qmake tspsg.pro CONFIG+=release
nmake

There is no automated installation process for Windows Mobile build. To install TSPSG on your PDA you need to create a folder on your device and copy the following files to it:

tspsg.exe from release folder in the source directory.
QtCore4.dll and QtGui4.dll from C:\Qt\bin folder.
msvcr90.dll from C:\Program Files\Microsoft Visual Studio 9.0\VC\ce\dll\armv4i folder.
all *.qm files from l10n folder in the source directory to l10n subfolder.

SYMBIAN

Unpack the downloaded source code of TSPSG with your favourite compression software. Now launch the Qt for Symbian Command Prompt from the Start Menu, navigate to the directory where you unpacked the source and run

lrelease tspsg.pro
qmake tspsg.pro CONFIG+=release
make release-gcce

Warning:: You need to unpack the source to the same drive as Symbian SDK and the path must not contain any spaces or TSPSG won't build.

If make step finished without errors you can generate sis installation file by running

make sis

You'll get tspsg.sis file in the source directory. Copy it to your phone and run or install it using Nokia PC Suite.

Note:: You need to install Qt libraries on your device before installing TSPSG. Usually, it should be enough to install qt_installer.sis from the Qt installation directory.

Alternatively, if you have installed Nokia Smart Installer^[2] you can run

make installer_sis

You'll get an tspsg_installer.sis that will automatically download and install the required Qt libraries on TSPSG installation.

Note:: Please, be aware that you have to sign the sis file to be able to install it on your device. You can use Open Signed Online^[3] to quickly sign the sis file for your device. Alternatively, you can try to enable the installation of self-signed files in the phone settings. Please, reffer to your phone manual on the instructions how to do this.

OTHER PLATFORMS, SUPPORTED BY QT

While TSPSG is oficially supported only on Linux, Windows and Windows Mobile it should be possible to compile it on any platform, supported by Qt. To do so, please, refer to the section GENERAL INSTALLATION PROCEDURE for the general build and installation procedure.

UNINSTALLATION

Usually, it is enough to replace install parameter with uninstall in the installation command from the section BUILDING AND INSTALLATION. Alternatively, you can manually delete all installed TSPSG files and directories.

TROUBLESHOOTING

WINDRES.EXE CRASH

When building under Windows using minGW toolchain make process may fail with windres.exe crash (access violation). This is a known bug in windres.exe regarding processing resource files with UTF-8 (cp65001) encoding^[4]. To be able to successfully build TSPSG you will need to download and replace windres.exe with a fixed version. To do this:

Open https://sourceforge.net/projects/mingw/files/ in your favourite browser.
Find and download the latest version of GNU Binutils. At the time of writing this guide it was binutils-2.20.1-2-mingw32-bin.tar.gz.
Unpack the file bin\windres.exe from the downloaded archive to <Your Qt installation path>\mingw\bin\ replacing the existing one.
Now run
```
mingw32-make distclean
```
in the TSPSG directory and repeat the installation process.

NOTES

qmake doesn't always enclose installation paths in quotes. This may cause some files not to be installed or removed when their path contains spaces. In this case it is safe to delete these files and TSPSG installation directory manually.