| 1 | /*! \page install TSPSG Installation Guide |
---|
| 2 | |
---|
| 3 | \author Copyright © 2007-2010 Lёppa <contacts[at]oleksii[dot]name> |
---|
| 4 | $Id: install.dox 121 2010-06-22 13:38:24Z laleppa $ |
---|
| 5 | $URL: https://tspsg.svn.sourceforge.net/svnroot/tspsg/trunk/docs/dox/install.dox $ |
---|
| 6 | |
---|
| 7 | Thank you for trying \b TSPSG. This document will guide you through the |
---|
| 8 | steps necessary to compile and run \b TSPSG. |
---|
| 9 | |
---|
| 10 | <hr> |
---|
| 11 | |
---|
| 12 | \section i_toc Table of Contents |
---|
| 13 | |
---|
| 14 | -# \ref i_s1 |
---|
| 15 | -# \ref i_s2 |
---|
| 16 | -# \ref i_s3 |
---|
| 17 | -# \ref i_s4 |
---|
| 18 | -# \ref i_s41 |
---|
| 19 | -# \ref i_s42 |
---|
| 20 | -# \ref i_s43 |
---|
| 21 | -# \ref i_s431 |
---|
| 22 | -# \ref i_s432 |
---|
| 23 | -# \ref i_s44 |
---|
| 24 | -# \ref i_s45 |
---|
| 25 | -# \ref i_s46 |
---|
| 26 | -# \ref i_s5 |
---|
| 27 | -# \ref i_s6 |
---|
| 28 | -# \ref i_s61 |
---|
| 29 | -# \ref i_s7 |
---|
| 30 | -# \ref i_s8 |
---|
| 31 | |
---|
| 32 | <hr> |
---|
| 33 | |
---|
| 34 | \section i_s1 REQUIREMENTS |
---|
| 35 | |
---|
| 36 | To be able compile \b TSPSG you need to have <em>Qt libraries</em>\anchor cr1<sup>\ref r1 "[1]"</sup>. The minimum |
---|
| 37 | supported version of \em Qt is <b>4.4.0</b>. The recommended version is <b>4.5.x</b> |
---|
| 38 | or higher. |
---|
| 39 | |
---|
| 40 | \note Please, note that there will be some regressions in functionality |
---|
| 41 | if your version of \em Qt is lower than the recommended. |
---|
| 42 | |
---|
| 43 | <hr><hr> |
---|
| 44 | |
---|
| 45 | \section i_s2 ASSUMPTIONS |
---|
| 46 | |
---|
| 47 | This guide assumes that you already have <em>Qt libraries</em> and all necessary |
---|
| 48 | prerequisites installed. |
---|
| 49 | |
---|
| 50 | Also, the following assumptions are made: |
---|
| 51 | |
---|
| 52 | - For \b Linux/UNIX: \c lrelease and \c qmake are avilable in \c $PATH. |
---|
| 53 | - For \b Windows (\em minGW) and \b Symbian: you have installed <em>Qt SDK</em> or |
---|
| 54 | prebuilt libraries and have Start Menu items for Qt tools. |
---|
| 55 | - For \b Windows (<em>Visual Studio</em>) and <b>Windows Mobile</b>: the <em>Qt libraries</em> |
---|
| 56 | reside in <tt>C:\\Qt\\</tt>. |
---|
| 57 | - For <b>Windows Mobile</b>: <em>Windows Mobile 5.0 Pocket PC SDK</em> or later is |
---|
| 58 | installed. |
---|
| 59 | |
---|
| 60 | <hr><hr> |
---|
| 61 | |
---|
| 62 | \section i_s3 SUPPORTED PLATFORMS |
---|
| 63 | |
---|
| 64 | \b TSPSG is oficially supported and tested on the following platforms: |
---|
| 65 | |
---|
| 66 | - <b>Linux</b>: <em>Gentoo AMD64</em> and <em>Kubuntu 9.10 64-bit AMD</em>. |
---|
| 67 | - <b>Windows</b>: <em>Windows XP 32-bit</em> and <em>Windows 7 64-bit</em>. |
---|
| 68 | - <b>Windows Mobile</b>: <em>Windows Mobile 6.5 Professional Edition</em>. |
---|
| 69 | |
---|
| 70 | <hr><hr> |
---|
| 71 | |
---|
| 72 | \section i_s4 BUILDING AND INSTALLATION |
---|
| 73 | |
---|
| 74 | \subsection i_s41 GENERAL INSTALLATION PROCEDURE |
---|
| 75 | |
---|
| 76 | On most platforms the general building and installation procedure is: |
---|
| 77 | |
---|
| 78 | -# Run \c lrelease to generate binary translation files (.qm) from the |
---|
| 79 | source (.ts). |
---|
| 80 | -# Run \c qmake with \c CONFIG+=release parameter to generate makefiles. |
---|
| 81 | -# Run make utility (e.g., \c make, \c nmake, \c mingw32-make) to build \b TSPSG. |
---|
| 82 | -# Run make utility with \c install parameter. |
---|
| 83 | |
---|
| 84 | \note It is important to run \c lrelease before \c qmake, or \c qmake will not |
---|
| 85 | "pick up" the translations when generating installation rules. |
---|
| 86 | |
---|
| 87 | <hr> |
---|
| 88 | |
---|
| 89 | \subsection i_s42 LINUX/UNIX |
---|
| 90 | |
---|
| 91 | Open a shell, navigate to the directory where you have \b TSPSG source |
---|
| 92 | downloaded and type |
---|
| 93 | |
---|
| 94 | \verbatim |
---|
| 95 | tar xvjf tspsg-<VERSION>-src.tar.bz2 |
---|
| 96 | cd tspsg-<VERSION>-src |
---|
| 97 | \endverbatim |
---|
| 98 | |
---|
| 99 | where \<VERSION> is the version of \b TSPSG you downloaded. Now run |
---|
| 100 | |
---|
| 101 | \verbatim |
---|
| 102 | lrelease tspsg.pro |
---|
| 103 | qmake tspsg.pro |
---|
| 104 | make |
---|
| 105 | \endverbatim |
---|
| 106 | |
---|
| 107 | In some cases you may need to type |
---|
| 108 | |
---|
| 109 | \verbatim |
---|
| 110 | qmake tspsg.pro CONFIG+=release |
---|
| 111 | \endverbatim |
---|
| 112 | |
---|
| 113 | If make step finished without errors you can install \b TSPSG by running |
---|
| 114 | |
---|
| 115 | \verbatim |
---|
| 116 | sudo make install |
---|
| 117 | \endverbatim |
---|
| 118 | |
---|
| 119 | or |
---|
| 120 | |
---|
| 121 | \verbatim |
---|
| 122 | su |
---|
| 123 | make install |
---|
| 124 | \endverbatim |
---|
| 125 | |
---|
| 126 | depending on your distribution. |
---|
| 127 | |
---|
| 128 | By default, executable will go to \c /usr/bin, \c COPYING.txt and \c README.txt will go |
---|
| 129 | to \c /usr/share/TSPSG, translations will go \c /usr/share/TSPSG/l10n, all docs |
---|
| 130 | will go to <tt>/usr/share/doc/TSPSG-\<VERSION></tt>. |
---|
| 131 | |
---|
| 132 | <hr> |
---|
| 133 | |
---|
| 134 | \subsection i_s43 WINDOWS |
---|
| 135 | |
---|
| 136 | \note Please, read the section \ref i_s7 after reading this section. |
---|
| 137 | |
---|
| 138 | \subsubsection i_s431 USING MINGW |
---|
| 139 | |
---|
| 140 | Unpack the downloaded source code of \b TSPSG with your favourite |
---|
| 141 | compression software. Now launch the <em>Qt Command Prompt</em> from the Start |
---|
| 142 | Menu, navigate to the directory where you unpacked the source and run |
---|
| 143 | |
---|
| 144 | \verbatim |
---|
| 145 | lrelease tspsg.pro |
---|
| 146 | qmake tspsg.pro CONFIG+=release |
---|
| 147 | mingw32-make |
---|
| 148 | \endverbatim |
---|
| 149 | |
---|
| 150 | \note Make process may fail with a crash of \c windres.exe. If you've run |
---|
| 151 | into this issue, please, read the section \ref i_s61. |
---|
| 152 | |
---|
| 153 | If make step finished without errors you can install \b TSPSG by running |
---|
| 154 | |
---|
| 155 | \verbatim |
---|
| 156 | mingw32-make install |
---|
| 157 | \endverbatim |
---|
| 158 | |
---|
| 159 | \b TSPSG will be installed to \c \%PROGRAMFILES\%\\TSPSG folder (usually, it is |
---|
| 160 | <tt>C:\\Program Files\\TSPSG</tt>). |
---|
| 161 | |
---|
| 162 | |
---|
| 163 | \subsubsection i_s432 USING VISUAL STUDIO |
---|
| 164 | |
---|
| 165 | Unpack the downloaded source code of \b TSPSG with your favourite |
---|
| 166 | compression software. Now launch the <em>Visual Studio Command Prompt</em> from |
---|
| 167 | the Start Menu, navigate to the directory where you unpacked the source |
---|
| 168 | and run |
---|
| 169 | |
---|
| 170 | \verbatim |
---|
| 171 | C:\Qt\bin\lrelease tspsg.pro |
---|
| 172 | C:\Qt\bin\qmake tspsg.pro CONFIG+=release |
---|
| 173 | nmake |
---|
| 174 | \endverbatim |
---|
| 175 | |
---|
| 176 | If make step finished without errors you can install \b TSPSG by running |
---|
| 177 | |
---|
| 178 | \verbatim |
---|
| 179 | nmake install |
---|
| 180 | \endverbatim |
---|
| 181 | |
---|
| 182 | \b TSPSG will be installed to \c \%PROGRAMFILES\%\\TSPSG folder (usually, it is |
---|
| 183 | <tt>C:\\Program Files\\TSPSG</tt>). |
---|
| 184 | |
---|
| 185 | <hr> |
---|
| 186 | |
---|
| 187 | \subsection i_s44 WINDOWS CE/MOBILE |
---|
| 188 | |
---|
| 189 | Unpack the downloaded source code of \b TSPSG with your favourite |
---|
| 190 | compression software. Now launch the <em>Visual Studio Command Prompt</em> from |
---|
| 191 | the Start Menu and run |
---|
| 192 | |
---|
| 193 | \verbatim |
---|
| 194 | set PATH=C:\Qt\bin;\%PATH\% |
---|
| 195 | setcepaths wincewm50pocket-msvc2008 |
---|
| 196 | \endverbatim |
---|
| 197 | |
---|
| 198 | Now navigate to the directory where you unpacked the source and run |
---|
| 199 | |
---|
| 200 | \verbatim |
---|
| 201 | lrelease tspsg.pro |
---|
| 202 | qmake tspsg.pro CONFIG+=release |
---|
| 203 | nmake |
---|
| 204 | \endverbatim |
---|
| 205 | |
---|
| 206 | There is no automated installation process for Windows Mobile build. To |
---|
| 207 | install \b TSPSG on your PDA you need to create a folder on your device |
---|
| 208 | and copy the following files to it: |
---|
| 209 | |
---|
| 210 | - \b tspsg.exe from \c release folder in the source directory. |
---|
| 211 | - \b QtCore4.dll and \c QtGui4.dll from \c C:\\Qt\\bin folder. |
---|
| 212 | - \b msvcr90.dll from <tt>C:\\Program Files\\Microsoft Visual Studio 9.0\\VC\\ce\\dll\\armv4i</tt> folder. |
---|
| 213 | - all <b>*.qm</b> files from \c l10n folder in the source directory to \c l10n subfolder. |
---|
| 214 | |
---|
| 215 | <hr> |
---|
| 216 | |
---|
| 217 | \section i_s45 SYMBIAN |
---|
| 218 | |
---|
| 219 | Unpack the downloaded source code of \b TSPSG with your favourite |
---|
| 220 | compression software. Now launch the <em>Qt for Symbian Command Prompt</em> from |
---|
| 221 | the Start Menu, navigate to the directory where you unpacked the source |
---|
| 222 | and run |
---|
| 223 | |
---|
| 224 | \verbatim |
---|
| 225 | lrelease tspsg.pro |
---|
| 226 | qmake tspsg.pro CONFIG+=release |
---|
| 227 | make release-gcce |
---|
| 228 | \endverbatim |
---|
| 229 | |
---|
| 230 | \warning You need to unpack the source to the <em>same drive</em> as <em>Symbian SDK</em> |
---|
| 231 | and the path <em>must not contain any spaces</em> or \b TSPSG won't build. |
---|
| 232 | |
---|
| 233 | If make step finished without errors you can generate sis installation |
---|
| 234 | file by running |
---|
| 235 | |
---|
| 236 | \verbatim |
---|
| 237 | make sis |
---|
| 238 | \endverbatim |
---|
| 239 | |
---|
| 240 | You'll get \c tspsg.sis file in the source directory. Copy it to your |
---|
| 241 | phone and run or install it using <em>Nokia PC Suite</em>. |
---|
| 242 | |
---|
| 243 | \note You need to install <em>Qt libraries</em> on your device before installing |
---|
| 244 | \b TSPSG. Usually, it should be enough to install \c qt_installer.sis from |
---|
| 245 | the Qt installation directory. |
---|
| 246 | |
---|
| 247 | Alternatively, if you have installed <em>Nokia Smart Installer</em>\anchor cr2<sup>\ref r2 "[2]"</sup> you can run |
---|
| 248 | |
---|
| 249 | \verbatim |
---|
| 250 | make installer_sis |
---|
| 251 | \endverbatim |
---|
| 252 | |
---|
| 253 | You'll get an \c tspsg_installer.sis that will automatically download and |
---|
| 254 | install the required <em>Qt libraries</em> on \b TSPSG installation. |
---|
| 255 | |
---|
| 256 | \note Please, be aware that you have to sign the sis file to be able to |
---|
| 257 | install it on your device. You can use <em>Open Signed Online</em>\anchor cr3<sup>\ref r3 "[3]"</sup> to quickly |
---|
| 258 | sign the sis file for your device. Alternatively, you can try to enable |
---|
| 259 | the installation of self-signed files in the phone settings. Please, |
---|
| 260 | reffer to your phone manual on the instructions how to do this. |
---|
| 261 | |
---|
| 262 | <hr> |
---|
| 263 | |
---|
| 264 | \subsection i_s46 OTHER PLATFORMS, SUPPORTED BY QT |
---|
| 265 | |
---|
| 266 | While \b TSPSG is oficially supported only on \b Linux, \b Windows and <b>Windows |
---|
| 267 | Mobile</b> it should be possible to compile it on any platform, supported |
---|
| 268 | by \em Qt. To do so, please, refer to the section \ref i_s41 for the general build |
---|
| 269 | and installation procedure. |
---|
| 270 | |
---|
| 271 | <hr><hr> |
---|
| 272 | |
---|
| 273 | \section i_s5 UNINSTALLATION |
---|
| 274 | |
---|
| 275 | Usually, it is enough to replace \c install parameter with \c uninstall |
---|
| 276 | in the installation command from the section \ref i_s4. Alternatively, you can manually |
---|
| 277 | delete all installed \b TSPSG files and directories. |
---|
| 278 | |
---|
| 279 | <hr><hr> |
---|
| 280 | |
---|
| 281 | \section i_s6 TROUBLESHOOTING |
---|
| 282 | |
---|
| 283 | \subsection i_s61 WINDRES.EXE CRASH |
---|
| 284 | |
---|
| 285 | When building under \b Windows using <em>minGW</em> toolchain make process may fail |
---|
| 286 | with \c windres.exe crash (access violation). This is a known bug in |
---|
| 287 | \c windres.exe regarding processing resource files with \c UTF-8 (\c cp65001) |
---|
| 288 | encoding\anchor cr4<sup>\ref r4 "[4]"</sup>. To be able to successfully build \b TSPSG you will need to |
---|
| 289 | download and replace \c windres.exe with a fixed version. To do this: |
---|
| 290 | |
---|
| 291 | -# Open https://sourceforge.net/projects/mingw/files/ in your |
---|
| 292 | favourite browser. |
---|
| 293 | -# Find and download the latest version of <em>GNU Binutils</em>. At the time |
---|
| 294 | of writing this guide it was \c binutils-2.20.1-2-mingw32-bin.tar.gz. |
---|
| 295 | -# Unpack the file \c bin\windres.exe from the downloaded archive to |
---|
| 296 | <tt>\<Your Qt installation path>\\mingw\\bin\\</tt> replacing the existing one. |
---|
| 297 | -# Now run |
---|
| 298 | \verbatim |
---|
| 299 | mingw32-make distclean |
---|
| 300 | \endverbatim |
---|
| 301 | in the \b TSPSG directory and repeat the installation process. |
---|
| 302 | |
---|
| 303 | <hr><hr> |
---|
| 304 | |
---|
| 305 | \section i_s7 NOTES |
---|
| 306 | |
---|
| 307 | \c qmake doesn't always enclose installation paths in quotes. This may |
---|
| 308 | cause some files not to be installed or removed when their path |
---|
| 309 | contains spaces. In this case it is safe to delete these files and \b TSPSG |
---|
| 310 | installation directory manually. |
---|
| 311 | |
---|
| 312 | <hr><hr> |
---|
| 313 | |
---|
| 314 | \section i_s8 REFERNECES |
---|
| 315 | |
---|
| 316 | -# \ref cr1 "^" \anchor r1 http://qt.nokia.com/ |
---|
| 317 | -# \ref cr1 "^" \anchor r2 http://qt.nokia.com/developer/nokia-smart-installer-for-symbian |
---|
| 318 | -# \ref cr2 "^" \anchor r3 https://www.symbiansigned.com/app/page/public/openSignedOnline.do |
---|
| 319 | -# \ref cr3 "^" \anchor r4 http://sourceware.org/bugzilla/show_bug.cgi?id=10165 |
---|
| 320 | */ |
---|