/*! \page install TSPSG Installation Guide \author Copyright © 2007-2011 Lёppa $Id: $Format:%h %ai %an$ $ $URL: http://tspsg.info/ $ Thank you for trying \b TSPSG. This document will guide you through the steps necessary to compile and run \b TSPSG.
\section i_toc Table of Contents -# \ref i_s1 -# \ref i_s2 -# \ref i_s3 -# \ref i_s4 -# \ref i_s41 -# \ref i_s42 -# \ref i_s43 -# \ref i_s44 -# \ref i_s441 -# \ref i_s442 -# \ref i_s45 -# \ref i_s46 -# \ref i_s47 -# \ref i_s5 -# \ref i_s6 -# \ref i_s61 -# \ref i_s7 -# \ref i_s8
\section i_s1 REQUIREMENTS To be able compile \b TSPSG you need to have Qt libraries\anchor cr1\ref r1 "[1]". The minimum supported version of \em Qt is 4.5.0. The recommended version is 4.6.x or higher. \note Please, note that there will be some regressions in functionality if your version of \em Qt is lower than the recommended.
\section i_s2 ASSUMPTIONS This guide assumes that you already have Qt libraries and all necessary prerequisites installed. Also, the following assumptions are made: - For \b Linux/UNIX/BSD: \c lrelease and \c qmake are avilable in \c $PATH. - For \b Windows (\em minGW) and \b Symbian: you have installed Qt SDK or prebuilt libraries and have Start Menu items for Qt tools. - For \b 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.
\section i_s3 SUPPORTED PLATFORMS \b 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.
\section i_s4 BUILDING AND INSTALLATION \subsection i_s41 GENERAL INSTALLATION PROCEDURE To be able ot build \b TSPSG you need to have the following Qt modules: \em QtCore, \em QtGui and \em QtSvg. The first two are required, the last one is optional. To get support for additional image formats (i.e., \b JPEG and \b TIFF) you'll additionally need corresponding Qt imageformats plugins. If you want to build \b TSPSG without \b SVG support add \c nosvg to \c qmake \c CONFIG parameter, so that qmake command will typically be: \verbatim qmake CONFIG+=release CONFIG+=nosvg \endverbatim This way you will not depend on \em QtSvg module but will not be able to export solution graph in \b SVG format. \b TSPSG uses \c qmake \c PREFIX parameter to determine installation path for make install command. If you don't specify it when running \c qmake, it will be assigned the default value depending on the platform: \c \%PROGRAMFILES\% environment variable (usually, it is C:\\Program Files)\
PlatformDefault \c PREFIX value
\b Linux/UNIX/BSD\c /usr
\b Windows
Windows CE/Mobile\\Program Files
\b Symbian
\note Please, note that there are no installation and/or packaging rules for \b MacOS and other platforms not mentioned in this table. By default, \b TSPSG uses precompiled header when being built. If you experience problems with it you may add \c CONFIG+=nopch parameter to \c qmake to disable the generation and use of the precompiled header.
\subsection i_s42 GENERAL INSTALLATION PROCEDURE On most platforms the general building and installation procedure is: -# Run \c lrelease to generate binary translation files (.qm) from the source (.ts). -# Run \c qmake with \c CONFIG+=release parameter to generate makefiles. -# Run make utility (e.g., \c make, \c nmake, \c mingw32-make) to build \b TSPSG. -# Run make utility with \c install parameter. \note It is important to run \c lrelease before \c qmake, or \c qmake will not "pick up" the translations when generating installation rules.
\subsection i_s43 LINUX/UNIX/BSD Open a shell, navigate to the directory where you have \b TSPSG source downloaded and type \verbatim tar xvjf tspsg--src.tar.bz2 cd tspsg--src \endverbatim where \ is the version of \b TSPSG you downloaded. Now run \verbatim lrelease tspsg.pro qmake tspsg.pro make \endverbatim In some cases you may need to type \verbatim qmake tspsg.pro CONFIG+=release \endverbatim If make step finished without errors you can install \b TSPSG by running \verbatim sudo make install \endverbatim or \verbatim su make install \endverbatim depending on your distribution. The executable goes to \c \/bin; \c COPYING, \c ChangeLog.txt, \c README.txt and \c INSTALL.txt go to \c \/share/doc/TSPSG-\.
\subsection i_s44 WINDOWS \b TSPSG will be installed to \c \\\TSPSG folder. \note Please, read the section \ref i_s7 after reading this section. \subsubsection i_s441 USING MINGW Unpack the downloaded source code of \b 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 \verbatim lrelease tspsg.pro qmake tspsg.pro CONFIG+=release mingw32-make \endverbatim \note Make process may fail with a crash of \c windres.exe. If you've run into this issue, please, read the section \ref i_s61. If make step finished without errors you can install \b TSPSG by running \verbatim mingw32-make install \endverbatim \subsubsection i_s442 USING VISUAL STUDIO Unpack the downloaded source code of \b 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 \verbatim C:\Qt\bin\lrelease tspsg.pro C:\Qt\bin\qmake tspsg.pro CONFIG+=release nmake \endverbatim If make step finished without errors you can install \b TSPSG by running \verbatim nmake install \endverbatim
\subsection i_s45 WINDOWS CE/MOBILE Unpack the downloaded source code of \b TSPSG with your favourite compression software. Now launch the Visual Studio Command Prompt from the Start Menu and run \verbatim set PATH=C:\Qt\bin;\%PATH\% setcepaths wincewm50pocket-msvc2008 \endverbatim Now navigate to the directory where you unpacked the source and run \verbatim lrelease tspsg.pro qmake tspsg.pro CONFIG+=release nmake \endverbatim There is no automated installation process for Windows Mobile build. To install \b TSPSG on your PDA you need to create a folder on your device and copy the following files to it: - \b tspsg.exe from \c release folder in the source directory. - \b QtCore4.dll and \c QtGui4.dll from \c C:\\Qt\\bin folder. - \b msvcr90.dll from C:\\Program Files\\Microsoft Visual Studio 9.0\\VC\\ce\\dll\\armv4i folder. - all *.qm files from \c l10n folder in the source directory to \c l10n subfolder.
\section i_s46 SYMBIAN Unpack the downloaded source code of \b 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 \verbatim lrelease tspsg.pro qmake tspsg.pro CONFIG+=release make release-gcce \endverbatim \warning You need to unpack the source to the same drive as Symbian SDK and the path must not contain any spaces or \b TSPSG won't build. If make step finished without errors you can generate sis installation file by running \verbatim make sis \endverbatim You'll get \c 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 \b TSPSG. Usually, it should be enough to install \c qt_installer.sis from the Qt installation directory. Alternatively, if you have installed Nokia Smart Installer\anchor cr2\ref r2 "[2]" you can run \verbatim make installer_sis \endverbatim You'll get an \c tspsg_installer.sis that will automatically download and install the required Qt libraries on \b 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\anchor cr3\ref r3 "[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.
\subsection i_s47 OTHER PLATFORMS, SUPPORTED BY QT While \b TSPSG is oficially supported only on \b Linux, \b Windows and Windows Mobile it should be possible to compile it on any platform, supported by \em Qt. To do so, please, refer to the section \ref i_s41 for the general build and installation procedure.
\section i_s5 UNINSTALLATION Usually, it is enough to replace \c install parameter with \c uninstall in the installation command from the section \ref i_s4. Alternatively, you can manually delete all installed \b TSPSG files and directories.
\section i_s6 TROUBLESHOOTING \subsection i_s61 WINDRES.EXE CRASH When building under \b Windows using minGW toolchain make process may fail with \c windres.exe crash (access violation). This is a known bug in \c windres.exe regarding processing resource files with \c UTF-8 (\c cp65001) encoding\anchor cr4\ref r4 "[4]". To be able to successfully build \b TSPSG you will need to download and replace \c 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 \c binutils-2.20.1-2-mingw32-bin.tar.gz. -# Unpack the file \c bin\windres.exe from the downloaded archive to \\\mingw\\bin\\ replacing the existing one. -# Now run \verbatim mingw32-make distclean \endverbatim in the \b TSPSG directory and repeat the installation process.
\section i_s7 NOTES \c 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 \b TSPSG installation directory manually.
\section i_s8 REFERNECES -# \ref cr1 "^" \anchor r1 http://qt.nokia.com/ -# \ref cr1 "^" \anchor r2 http://qt.nokia.com/developer/nokia-smart-installer-for-symbian -# \ref cr2 "^" \anchor r3 https://www.symbiansigned.com/app/page/public/openSignedOnline.do -# \ref cr3 "^" \anchor r4 http://sourceware.org/bugzilla/show_bug.cgi?id=10165 */