summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@nokia.com>2010-08-20 16:41:56 +0200
committerLeena Miettinen <riitta-leena.miettinen@nokia.com>2010-08-20 16:42:21 +0200
commit2d9451341d60df6743903a57a14153eb2b34a49f (patch)
tree66f8b93db97343d720d53802b2e384d7f10b29eb
parenta9b8e2e8c90b1a64752843522a32722faef71521 (diff)
downloadqt-creator-2d9451341d60df6743903a57a14153eb2b34a49f.tar.gz
Doc - Pull out instructions for setting up development environments for Maemo and Symbian, to reuse the topics in Nokia Qt SDK documentation (with if defines)
-rw-r--r--doc/maemodev.qdoc593
-rw-r--r--doc/qt-defines.qdocconf3
-rw-r--r--doc/qtcreator.qdoc571
-rw-r--r--doc/qtcreator.qdocconf2
-rw-r--r--doc/symbiandev.qdoc154
5 files changed, 750 insertions, 573 deletions
diff --git a/doc/maemodev.qdoc b/doc/maemodev.qdoc
new file mode 100644
index 0000000000..2ffeab5e5b
--- /dev/null
+++ b/doc/maemodev.qdoc
@@ -0,0 +1,593 @@
+/*!
+
+ \contentspage index.html
+ \if defined(qcmanual)
+ \previouspage creator-project-generic.html
+ \else
+ \previouspage creator-developing-symbian.html
+ \endif
+ \page creator-developing-maemo.html
+ \if defined(qcmanual)
+ \nextpage creator-developing-symbian.html
+ \else
+ \nextpage smartinstaller.html
+ \endif
+
+ \title Setting Up Development Environment for Maemo
+
+ Maemo is a software platform developed by Nokia for smartphones and
+ Internet Tablets. The Maemo SDK provides an open development environment
+ for different applications on top of the Maemo platform. The necessary
+ tools from the Maemo SDK are also included in the Nokia Qt SDK.
+ The whole tool chain that you need to create, build, debug, run, and deploy
+ Maemo applictions is installed and configured when you install the Nokia
+ Qt SDK.
+
+ \if defined(qcmanual)
+ Maemo 5 is based on the Linux 2.6 operating system. For more
+ information about the Maemo platform, see
+ \l{http://maemo.org/intro/platform/}{Software Platform} on the Maemo web site.
+ \endif
+
+ For more information about developing applications for the Maemo 5
+ platform, select \gui {Help > Index} and look for \gui {Platform Notes},
+ or see
+ \l{http://doc.qt.nokia.com/qt-maemo-4.6/platform-notes.html}{Platform Notes - Maemo 5}.
+
+ \section1 Hardware and Software Requirements
+
+ To build and run Qt applications for Maemo, you need the following:
+ \list
+ \o Nokia N900 device with software update release 1.2 (V10.2010.19-1)
+ or later installed.
+
+ \if defined(qcmanual)
+ \o MADDE cross-platform Maemo development
+ tool (installed as part of the Nokia Qt SDK).
+
+ For more information about MADDE pertaining to its
+ installation, configuration, and deployment on the device, see
+ \l{http://wiki.maemo.org/MADDE}{Introduction to MADDE}.
+ \endif
+
+ \o Nokia USB drivers.
+
+ Only needed if you develop on Windows and if you use a USB connection
+ to run applications on the device. The drivers are
+ installed as part of the Nokia Qt SDK. You can also download them from
+ \l{https://garage.maemo.org/frs/?group_id=801&release_id=2655}{PC Connectivity}
+ on the Maemo web site. Download and install the latest
+ PC_Connectivity_<version>.exe (at the time of writing,
+ PC_Connectivity_0.9.4.exe).
+
+ \endlist
+
+ The Qt Creator/MADDE integration is supported on the following platforms:
+ \list
+ \o Linux (32 bit and 64 bit)
+ \o Windows (32 bit and 64 bit)
+ \omit \o Mac OS 10.5 Leopard, or higher \endomit
+ \endlist
+
+ \note The only supported build system for Maemo in Qt
+ Creator is qmake.
+
+ \section1 Setting Up the Nokia N900
+
+ You can connect your device to your development PC using either a USB or
+ WLAN connection.
+
+ For the device, you need to use a tool called Mad Developer to create the
+ device-side end point for USB and WLAN connections. It provides no
+ diagnostics functions but is essential for creating connections between the
+ device and your development PC.
+
+ To use a WLAN connection, you must activate WLAN on the device and connect
+ it to the same WLAN as the development PC. The network address is displayed
+ in the Mad Developer.
+
+ To use an USB connection, you need to set up the Nokia N900 as a network device
+ on the development PC.
+
+ \note If you plan to connect your development PC to the Nokia N900 only over WLAN, you can
+ ignore the USB-specific parts in the following sections.
+
+ \section2 Installing and Configuring Mad Developer
+
+ Install Mad Developer on a device and configure
+ a connection between the development PC and the device.
+
+ To install and configure Mad Developer:
+
+ \list 1
+ \o On the Nokia N900, select \gui{Download} > \gui{Development} > \gui{mad-developer}
+ to install the Mad Developer software package.
+ \o Click \gui {Mad Developer} to start the Mad Developer application.
+
+ \o To use a WLAN connection, activate WLAN on the device and connect
+ to the same network as the development PC. You can see the network
+ address in the \gui wlan0 field.
+
+ \o To use an USB connection:
+
+ \list a
+
+ \o If you are using Microsoft Windows as development host, you must
+ change the driver loaded for instantiating the connection.
+ In the Mad Developer, select \gui{Manage USB} and select \gui{Load g_ether}.
+
+ \o To set up the USB settings, click \gui Edit on the \gui usb0 row and
+ confirm by clicking \gui Configure.
+
+ \note By default, you do not need to make changes. The \gui usb0 row
+ displays the IP address 192.168.2.15.
+
+ \endlist
+
+ \o Select \gui{Developer Password} to generate a password for a freshly
+ created user called \bold developer. The password stays valid for as long
+ as the password generation dialog is open. You enter the password when
+ you configure the connection in Qt Creator.
+
+ \image qtcreator-mad-developer-screenshot.png
+ \endlist
+
+ \section1 Installing Qt Mobility APIs
+
+ To develop applications that use the Qt Mobility APIs, you must install the
+ APIs on the devices. The APIs are not available in the Nokia N900 package
+ manager, and therefore, you must install them from the command line as the
+ root user. To become the root user you must first install \c rootsh from the
+ application manager.
+
+ \list 1
+
+ \o On the device, install \c rootsh from the \gui {Application Manager}.
+
+ \o In \gui Programs, select \c {X Terminal} to open a terminal window.
+
+ \o To switch to the root user, enter the following command:
+ \c{sudo gainroot}
+
+ \o To install Qt Mobility libraries, enter the following command:
+ \c{apt-get install libqtm-*}
+
+ \o To confirm the installation, enter: \c Y
+
+ \o Close the terminal.
+
+ \endlist
+
+ \section1 Setting Up Network Connectivity on Development PC
+
+ Use the network configuration tools on your platform to specify the
+ connection to the device on the development PC. You need to do this
+ only if you use an USB connection.
+
+ \section2 Linux
+
+ The device uses the IP address 192.168.2.15 with the subnet 255.255.255.0
+ for its USB connection by default, so you can create the network interface
+ with a different address inside the same subnet too.
+
+ \note If you have changed the IP address of the device when configuring
+ Mad Developer, you need to reflect those changes in your development PC USB
+ network settings.
+
+ Run the following command in a shell as root user:
+ \c{ifconfig usb0 192.168.2.14 up}
+
+ \section2 Windows
+
+ When you connect the device to your Windows PC, Windows tries to install a
+ driver for the Linux USB Ethernet connection. In the
+ \gui{Found New Hardware Wizard}, select \gui{No, not this time} in the
+ first dialog and \gui{Install the software automatically} in the second
+ dialog.
+
+ To specify a network connection:
+
+ \list 1
+
+ \o Open the Network Connections window.
+
+ \o Select the Linux USB Ethernet
+ connection that is displayed as a new Local Area Connection.
+
+ \o Edit the \gui {Internet Protocol Version 4 (TCP/IPv4)} properties
+ to specify the IP address for the connection.
+ In the \gui {Use the following IP address} field, enter the following values:
+ \list
+ \o \gui {IP Address}: \bold {192.168.2.14}
+ \o \gui SubnetMask: \bold {255.255.255.0}
+ \o \gui {Default gateway}: leave this field empty
+ \endlist
+
+ \endlist
+
+ Depending on
+ your version of Microsoft Windows you may have to unplug and re-plug the
+ Nokia N900 to reload the driver with its configuration accordingly.
+
+ \if defined(qcmanual)
+ \section1 Setting Up MADDE
+
+ If you install Nokia Qt SDK, the MADDE package is installed and
+ configured automatically on your development PC and you can omit this task.
+
+ \list 1
+
+ \o Download the MADDE installer file for your platform from the
+ \l{http://wiki.maemo.org/MADDE}{MADDE} site.
+
+ \o Execute the installer and follow the instructions.
+
+ \o To see which targets are available, run \c{mad-admin list targets}.
+
+ \o To install the target that starts with the string \bold fremantle, use the command:
+ \c{mad-admin create fremantle-qt-xxx}
+
+ \o In Qt Creator, register the MADDE tool chain:
+
+ \image qtcreator-screenshot-toolchain.png
+
+ \list a
+
+ \o Select \gui Tools > \gui Options... > \gui Qt4 > \gui{Qt Versions}.
+
+ \o Click \inlineimage qtcreator-windows-add.png,
+ to add a new Qt version.
+
+ The \gui{qmake Location} is the qmake
+ executable in \c{<MADDE dir>/targets/<fremantle target>/bin}.
+
+ \endlist
+
+ \endlist
+
+ When you have installed the target, you have a toolchain and a sysroot
+ environment for cross-compiling.
+ \endif
+
+ \section1 Configuring Connections in Qt Creator
+
+ To be able to run and debug applications on the Maemo emulator and
+ devices, you must set up a connection to the emulator and the device in the
+ Qt Creator build and run settings.
+ \if defined(qcmanual)
+ If you install Nokia Qt SDK, the
+ necessary software is installed and configured automatically and you
+ only need to configure a connection to the device.
+
+ By default, you create the connection as the \e developer user. This
+ protects real user data on the device from getting corrupted during
+ testing. If you write applications that use Mobility APIs, you might want
+ to test them with real user data. To create a connection as a user, specify
+ the \gui Username and \gui Password in Qt Creator. For more information, see
+ \l{Testing with User Data}.
+ \endif
+
+ You can protect the connections between Qt Creator and the Maemo emulator
+ or a device by using either a password or an SSH key. You must always
+ use a password for the initial connection, but can then deploy an SSH
+ key and use it for subsequent connections. If you use a password, you
+ must generate it in Mad Developer and enter it in Qt Creator every time
+ you connect to the Maemo emulator or to a device.
+
+ If you do not have an SSH key, you can create it in Qt Creator.
+ Encrypted keys are not supported. For more
+ information, see
+ \if defined(qcmanual)
+ \l{Generating SSH Keys}.
+ \else
+ the Qt Creator Manual.
+ \endif
+
+ \if defined(qcmanual)
+ To configure connections between Qt Creator and the Maemo emulator or
+ device:
+
+ \list 1
+
+ \o If you install the Maemo emulator (QEMU) separately, you must
+ specify parameters to access it:
+
+ \list a
+
+ \o Start Mad Developer in the emulator.
+
+ \o Click \gui {Developer Password} to generate a password for
+ the connection.
+
+ \o In Qt Creator, select \gui {Tools > Options... > Projects >
+ Maemo Device Configurations > Add} to add a new configuration.
+
+ \image qtcreator-maemo-emulator-connection.png
+
+ \o In the \gui {Configuration name} field, enter a name for
+ the connection.
+
+ \o In the \gui {Device type} field, select \gui {Maemo emulator}.
+
+ \o In the \gui {Authentication type} field, select \gui Password
+ for the initial connection.
+
+ \o In the \gui Password field, enter the password from the Mad
+ Developer for the initial connection.
+
+ You can use the default values for the other fields.
+
+ \o Click \gui Test to test the connection.
+
+ \o To avoid having to specify the password every time you connect
+ to the Maemo emulator, click \gui {Deploy Key...} and select
+ the file that contains your public key.
+
+ \o When you have deployed the key to the device, change the
+ configuration to use the SSH key for protection.
+
+ \image qtcreator-maemo-emulator-connection-key.png
+
+ The default location of the private key file is displayed in the
+ \gui {Private key file} field.
+
+ \endlist
+
+ If you installed the Nokia Qt SDK, a connection has been configured
+ and you only need to specify the password and deploy the SSH key.
+
+ \o To deploy applications and run them remotely, specify parameters
+ for accessing devices:
+
+ \list a
+
+ \o Connect your device to the development PC via an USB cable or
+ a WLAN. For an USB connection, you are prompted to select the mode
+ to use. Choose \gui{PC suite mode}.
+
+ \note If you experience connection problems due to a USB port issue,
+ switch to a different port or use WLAN to connect to the device.
+
+ \o Select \gui Tools > \gui Options... > \gui Projects >
+ \gui{Maemo Device Configurations > Add}, and add a new configuration for a
+ \gui {Remote device}.
+
+ \image qtcreator-screenshot-devconf.png
+
+ \o In the \gui {Host name} field, enter the IP address from the
+ \gui usb0 or \gui wlan0 field in Mad Developer.
+
+ \o Specify the other settings in the same way as for a Maemo emulator
+ connection.
+
+ \o Click \gui Test to test the connection.
+
+ \o Click \gui OK to close the dialog.
+
+ \endlist
+
+ \o To specify build and run settings:
+
+ \list a
+
+ \o Open a project for an application you want to develop for your
+ Nokia N900.
+
+ \o Click \gui Projects to open the projects mode.
+
+ \o In the \gui{Build Settings} section, choose the MADDE Qt version.
+
+ \image qtcreator-screenshot-build-settings.png
+
+ \o In the \gui{Run Settings} section, click \gui Add to add a new
+ run configuration.
+
+ \o Set a name and select the device configuration.
+
+ \image qtcreator-screenshot-run-settings.png
+
+ \note You can either add separate run settings for both the Maemo
+ emulator connection and the device connection or select the
+ \gui {Device configuration} before you run the application.
+
+ \endlist
+
+ \endlist
+
+ \else
+
+ The Nokia Qt SDK installation program configured a default connection
+ to the Maemo emulator. You only need to specify the
+ password and deploy the SSH key.
+
+ \list 1
+
+ \o To specify authentication for the connection to the Maemo emulator:
+
+ \list a
+
+ \o Start Mad Developer in the emulator.
+
+ \o Click \gui {Developer Password} to generate a password for
+ the connection.
+
+ \o In Qt Creator, select \gui {Tools > Options... > Projects >
+ Maemo Device Configurations > Maemo emulator} to specify the
+ password.
+
+ \image qtcreator-maemo-emulator-connection.png
+
+ \o In the \gui {Authentication type} field, select \gui Password
+ for the initial connection.
+
+ \o In the \gui Password field, enter the password from the Mad
+ Developer for the initial connection.
+
+ You can use the default values for the other fields.
+
+ \o Click \gui Test to test the connection.
+
+ \o To avoid having to specify the password every time you connect
+ to the Maemo emulator, click \gui {Deploy Key...} and select
+ the file that contains your public key.
+
+ \o When you have deployed the key to the device, change the
+ configuration to use the SSH key for protection.
+
+ \image qtcreator-maemo-emulator-connection-key.png
+
+ The default location of the private key file is displayed in the
+ \gui {Private key file} field.
+
+ \endlist
+
+ \o To deploy applications and run them remotely, specify parameters
+ for accessing devices:
+
+ \list a
+
+ \o Connect your device to the development PC via an USB cable or
+ a WLAN. For an USB connection, you are prompted to select the mode
+ to use. Choose \gui{PC suite mode}.
+
+ \note If you experience connection problems due to a USB port issue,
+ switch to a different port or use WLAN to connect to the device.
+
+ \o Select \gui Tools > \gui Options... > \gui Projects >
+ \gui{Maemo Device Configurations > Add}, and add a new configuration for a
+ \gui {Remote device}.
+
+ \image qtcreator-screenshot-devconf.png
+
+ \o In the \gui {Host name} field, enter the IP address from the
+ \gui usb0 or \gui wlan0 field in Mad Developer.
+
+ \o Specify the other settings in the same way as for a Maemo emulator
+ connection.
+
+ \o Click \gui Test to test the connection.
+
+ \o Click \gui OK to close the dialog.
+
+ \endlist
+
+ \o To specify build and run settings:
+
+ \list a
+
+ \o Open a project for an application you want to develop for your
+ Nokia N900.
+
+ \o Click \gui Projects to open the projects mode.
+
+ \o In the \gui{Build Settings} section, choose the MADDE Qt version
+ that was registered by the installation program.
+
+ \image qtcreator-screenshot-build-settings.png
+
+ \o In the \gui{Run Settings} section, click \gui Add to add a new
+ run configuration.
+
+ \o Set a name and select the device configuration.
+
+ \image qtcreator-screenshot-run-settings.png
+
+ \note You can either add separate run settings for both the Maemo
+ emulator connection and the device connection or select the
+ \gui {Device configuration} before you run the application.
+
+ \o Click the \gui Run button to build and run the application.
+
+ \endlist
+
+ \endlist
+ \endif
+
+ \if defined(qcmanual)
+ \section2 Testing with User Data
+
+ To run your application as the default user, you must first assign a password
+ for the user account and then create the connection to the device as the
+ user:
+
+ \list 1
+
+ \o On the device, in \gui Programs, select \c {X Terminal} to open a
+ terminal window.
+
+ \o To switch to the root user, enter the following command:
+ \c{sudo gainroot}
+
+ \o To specify the password, enter the following command:
+ \c {passwd user}
+
+ \o In Qt Creator, Select \gui Tools > \gui Options... > \gui Projects >
+ \gui{Maemo Device Configurations}.
+
+ \o Specify the username \c user and the password in the device configuration.
+
+ \endlist
+
+ \section2 Generating SSH Keys
+
+ If you do not have an SSH public and private key pair, you can generate it
+ in Qt Creator. You can specify key length and the key algorithm, RSA or DSA.
+ If you only use the keys to protect connections to the Maemo emulator or
+ device, you can use the default values.
+
+ \list 1
+
+ \o Select \gui {Tools > Options... > Projects > Maemo Device Configurations
+ > Generate SSH Key...}.
+
+ \o Click \gui {Generate SSH Key}.
+
+ \image qtcreator-ssh-key-configuration.png "SSH Key Configuration dialog"
+
+ \o Click \gui {Save Public Key...} to select the location to save the
+ public key.
+
+ \o Click \gui {Save Private Key...} to specify the location to save the
+ private key.
+
+ \o Click \gui Close to close the dialog.
+
+ \endlist
+ \endif
+
+ \section1 Troubleshooting
+
+ The addresses used in this example might be reserved by some other application
+ in your network. If you cannot establish a connection, try the following optional
+ configurations:
+
+ \table
+
+ \header
+ \o usb0 in Mad Developer on Device
+ \o USB Network on Development PC
+ \o Host Name in Qt Creator Build Settings
+
+ \row
+ \o 172.30.7.15 255.255.255.0
+ \o 172.30.7.14 255.255.255.0
+ \o 172.30.7.15
+
+ \row
+ \o 10.133.133.15
+ \o 10.133.133.14
+ \o 10.133.133.15
+
+ \row
+ \o 192.168.133.15
+ \o 192.168.133.14
+ \o 192.168.133.15
+
+ \note You cannot use the value localhost for connections to a device.
+
+ \endtable
+
+ \note VPN connections might block the device connection.
+
+*/
+
diff --git a/doc/qt-defines.qdocconf b/doc/qt-defines.qdocconf
index a9e8bbd23f..75c21ed7fe 100644
--- a/doc/qt-defines.qdocconf
+++ b/doc/qt-defines.qdocconf
@@ -11,7 +11,8 @@ defines = Q_QDOC \
QT_DEPRECATED \
Q_NO_USING_KEYWORD \
__cplusplus \
- qtquick
+ qtquick \
+ qcmanual
versionsym = QT_VERSION_STR
diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc
index 3aedb6d390..c8bb90b9d3 100644
--- a/doc/qtcreator.qdoc
+++ b/doc/qtcreator.qdoc
@@ -5402,465 +5402,6 @@
/*!
-
- \contentspage index.html
- \previouspage creator-project-generic.html
- \page creator-developing-maemo.html
- \nextpage creator-developing-symbian.html
-
- \title Setting Up Development Environment for Maemo
-
- Maemo is a software platform developed by Nokia for smartphones and
- Internet Tablets. The Maemo SDK provides an open development environment
- for different applications on top of the Maemo platform. The necessary
- tools from the Maemo SDK are also included in the Nokia Qt SDK.
- The whole tool chain that you need to create, build, debug, run, and deploy
- Maemo applictions is installed and configured when you install the Nokia
- Qt SDK.
-
- Maemo 5 is based on the Linux 2.6 operating system. For more
- information about the Maemo platform, see
- \l{http://maemo.org/intro/platform/}{Software Platform} on the Maemo web site.
-
- For more information about developing applications for the Maemo 5
- platform, select \gui {Help > Index} and look for \gui {Platform Notes},
- or see
- \l{http://doc.qt.nokia.com/qt-maemo-4.6/platform-notes.html}{Platform Notes - Maemo 5}.
-
- \section1 Hardware and Software Requirements
-
- To build and run Qt applications for Maemo, you need the following:
- \list
- \o Nokia N900 device with software update release 1.2 (V10.2010.19-1)
- or later installed.
- \o MADDE cross-platform Maemo development
- tool (installed as part of the Nokia Qt SDK).
-
- For more information about MADDE pertaining to its
- installation, configuration, and deployment on the device, see
- \l{http://wiki.maemo.org/MADDE}{Introduction to MADDE}.
-
- \o Nokia USB drivers.
-
- Only needed if you develop on Windows and if you use a USB connection
- to run applications on the device. The drivers are
- installed as part of the Nokia Qt SDK. You can also download them from
- \l{https://garage.maemo.org/frs/?group_id=801&release_id=2655}{PC Connectivity}
- on the Maemo web site. Download and install the latest
- PC_Connectivity_<version>.exe (at the time of writing,
- PC_Connectivity_0.9.4.exe).
-
- \endlist
-
- The Qt Creator/MADDE integration is supported on the following platforms:
- \list
- \o Linux (32 bit and 64 bit)
- \o Windows (32 bit and 64 bit)
- \omit \o Mac OS 10.5 Leopard, or higher \endomit
- \endlist
-
- \note The only supported build system for Maemo in Qt
- Creator is qmake.
-
- \section1 Setting Up the Nokia N900
-
- You can connect your device to your development PC using either a USB or
- WLAN connection.
-
- For the device, you need to use a tool called Mad Developer to create the
- device-side end point for USB and WLAN connections. It provides no
- diagnostics functions but is essential for creating connections between the
- device and your development PC.
-
- To use a WLAN connection, you must activate WLAN on the device and connect
- it to the same WLAN as the development PC. The network address is displayed
- in the Mad Developer.
-
- To use an USB connection, you need to set up the Nokia N900 as a network device
- on the development PC.
-
- \note If you plan to connect your development PC to the Nokia N900 only over WLAN, you can
- ignore the USB-specific parts in the following sections.
-
- \section2 Installing and Configuring Mad Developer
-
- Install Mad Developer on a device and configure
- a connection between the development PC and the device.
-
- To install and configure Mad Developer:
-
- \list 1
- \o On the Nokia N900, select \gui{Download} > \gui{Development} > \gui{mad-developer}
- to install the Mad Developer software package.
- \o Click \gui {Mad Developer} to start the Mad Developer application.
-
- \o To use a WLAN connection, activate WLAN on the device and connect
- to the same network as the development PC. You can see the network
- address in the \gui wlan0 field.
-
- \o To use an USB connection:
-
- \list a
-
- \o If you are using Microsoft Windows as development host, you must
- change the driver loaded for instantiating the connection.
- In the Mad Developer, select \gui{Manage USB} and select \gui{Load g_ether}.
-
- \o To set up the USB settings, click \gui Edit on the \gui usb0 row and
- confirm by clicking \gui Configure.
-
- \note By default, you do not need to make changes. The \gui usb0 row
- displays the IP address 192.168.2.15.
-
- \endlist
-
- \o Select \gui{Developer Password} to generate a password for a freshly
- created user called \bold developer. The password stays valid for as long
- as the password generation dialog is open. You enter the password when
- you configure the connection in Qt Creator.
-
- \image qtcreator-mad-developer-screenshot.png
- \endlist
-
- \section1 Installing Qt Mobility APIs
-
- To develop applications that use the Qt Mobility APIs, you must install the
- APIs on the devices. The APIs are not available in the Nokia N900 package
- manager, and therefore, you must install them from the command line as the
- root user. To become the root user you must first install \c rootsh from the
- application manager.
-
- \list 1
-
- \o On the device, install \c rootsh from the \gui {Application Manager}.
-
- \o In \gui Programs, select \c {X Terminal} to open a terminal window.
-
- \o To switch to the root user, enter the following command:
- \c{sudo gainroot}
-
- \o To install Qt Mobility libraries, enter the following command:
- \c{apt-get install libqtm-*}
-
- \o To confirm the installation, enter: \c Y
-
- \o Close the terminal.
-
- \endlist
-
- \section1 Setting Up Network Connectivity on Development PC
-
- Use the network configuration tools on your platform to specify the
- connection to the device on the development PC. You need to do this
- only if you use an USB connection.
-
- \section2 Linux
-
- The device uses the IP address 192.168.2.15 with the subnet 255.255.255.0
- for its USB connection by default, so you can create the network interface
- with a different address inside the same subnet too.
-
- \note If you have changed the IP address of the device when configuring
- Mad Developer, you need to reflect those changes in your development PC USB
- network settings.
-
- Run the following command in a shell as root user:
- \c{ifconfig usb0 192.168.2.14 up}
-
- \section2 Windows
-
- When you connect the device to your Windows PC, Windows tries to install a
- driver for the Linux USB Ethernet connection. In the
- \gui{Found New Hardware Wizard}, select \gui{No, not this time} in the
- first dialog and \gui{Install the software automatically} in the second
- dialog.
-
- To specify a network connection:
-
- \list 1
-
- \o Open the Network Connections window.
-
- \o Select the Linux USB Ethernet
- connection that is displayed as a new Local Area Connection.
-
- \o Edit the \gui {Internet Protocol Version 4 (TCP/IPv4)} properties
- to specify the IP address for the connection.
- In the \gui {Use the following IP address} field, enter the following values:
- \list
- \o \gui {IP Address}: \bold {192.168.2.14}
- \o \gui SubnetMask: \bold {255.255.255.0}
- \o \gui {Default gateway}: leave this field empty
- \endlist
-
- \endlist
-
- Depending on
- your version of Microsoft Windows you may have to unplug and re-plug the
- Nokia N900 to reload the driver with its configuration accordingly.
-
- \section1 Setting Up MADDE
-
- If you install Nokia Qt SDK, the MADDE package is installed and
- configured automatically on your development PC and you can omit this task.
-
- \list 1
-
- \o Download the MADDE installer file for your platform from the
- \l{http://wiki.maemo.org/MADDE}{MADDE} site.
-
- \o Execute the installer and follow the instructions.
-
- \o To see which targets are available, run \c{mad-admin list targets}.
-
- \o To install the target that starts with the string \bold fremantle, use the command:
- \c{mad-admin create fremantle-qt-xxx}
-
- \o In Qt Creator, register the MADDE tool chain:
-
- \image qtcreator-screenshot-toolchain.png
-
- \list a
-
- \o Select \gui Tools > \gui Options... > \gui Qt4 > \gui{Qt Versions}.
-
- \o Click \inlineimage qtcreator-windows-add.png,
- to add a new Qt version.
-
- The \gui{qmake Location} is the qmake
- executable in \c{<MADDE dir>/targets/<fremantle target>/bin}.
-
- \endlist
-
- \endlist
-
- When you have installed the target, you have a toolchain and a sysroot
- environment for cross-compiling.
-
- \section1 Configuring Connections in Qt Creator
-
- To be able to run and debug applications on the Maemo emulator and
- devices, you must set up a connection to the emulator and the device in the
- Qt Creator build and run settings. If you install Nokia Qt SDK, the
- necessary software is installed and configured automatically and you
- only need to configure a connection to the device.
-
- By default, you create the connection as the \e developer user. This
- protects real user data on the device from getting corrupted during
- testing. If you write applications that use Mobility APIs, you might want
- to test them with real user data. To create a connection as a user, specify
- the \gui Username and \gui Password in Qt Creator. For more information, see
- \l{Testing with User Data}.
-
- You can protect the connections between Qt Creator and the Maemo emulator
- or a device by using either a password or an SSH key. You must always
- use a password for the initial connection, but can then deploy an SSH
- key and use it for subsequent connections. If you use a password, you
- must generate it in Mad Developer and enter it in Qt Creator every time
- you connect to the Maemo emulator or to a device.
-
- If you do not have an SSH key, you can create it in Qt Creator.
- Encrypted keys are not supported. For more
- information, see \l{Generating SSH Keys}.
-
- To configure connections between Qt Creator and the Maemo emulator or
- device:
-
- \list 1
-
- \o If you install the Maemo emulator (QEMU) separately, you must
- specify parameters to access it:
-
- \list a
-
- \o Start Mad Developer in the emulator.
-
- \o Click \gui {Developer Password} to generate a password for
- the connection.
-
- \o In Qt Creator, select \gui {Tools > Options... > Projects >
- Maemo Device Configurations > Add} to add a new configuration.
-
- \image qtcreator-maemo-emulator-connection.png
-
- \o In the \gui {Configuration name} field, enter a name for
- the connection.
-
- \o In the \gui {Device type} field, select \gui {Maemo emulator}.
-
- \o In the \gui {Authentication type} field, select \gui Password
- for the initial connection.
-
- \o In the \gui Password field, enter the password from the Mad
- Developer for the initial connection.
-
- You can use the default values for the other fields.
-
- \o Click \gui Test to test the connection.
-
- \o To avoid having to specify the password every time you connect
- to the Maemo emulator, click \gui {Deploy Key...} and select
- the file that contains your public key.
-
- \o When you have deployed the key to the device, change the
- configuration to use the SSH key for protection.
-
- \image qtcreator-maemo-emulator-connection-key.png
-
- The default location of the private key file is displayed in the
- \gui {Private key file} field.
-
- \endlist
-
- If you installed the Nokia Qt SDK, a connection has been configured
- and you only need to specify the password and deploy the SSH key.
-
- \o To deploy applications and run them remotely, specify parameters
- for accessing devices:
-
- \list a
-
- \o Connect your device to the development PC via an USB cable or
- a WLAN. For an USB connection, you are prompted to select the mode
- to use. Choose \gui{PC suite mode}.
-
- \note If you experience connection problems due to a USB port issue,
- switch to a different port or use WLAN to connect to the device.
-
- \o Select \gui Tools > \gui Options... > \gui Projects >
- \gui{Maemo Device Configurations > Add}, and add a new configuration for a
- \gui {Remote device}.
-
- \image qtcreator-screenshot-devconf.png
-
- \o In the \gui {Host name} field, enter the IP address from the
- \gui usb0 or \gui wlan0 field in Mad Developer.
-
- \o Specify the other settings in the same way as for a Maemo emulator
- connection.
-
- \o Click \gui Test to test the connection.
-
- \o Click \gui OK to close the dialog.
-
- \endlist
-
- \o To specify build and run settings:
-
- \list a
-
- \o Open a project for an application you want to develop for your
- Nokia N900.
-
- \o Click \gui Projects to open the projects mode.
-
- \o In the \gui{Build Settings} section, choose the MADDE Qt version.
-
- \image qtcreator-screenshot-build-settings.png
-
- \o In the \gui{Run Settings} section, click \gui Add to add a new
- run configuration.
-
- \o Set a name and select the device configuration.
-
- \image qtcreator-screenshot-run-settings.png
-
- \note You can either add separate run settings for both the Maemo
- emulator connection and the device connection or select the
- \gui {Device configuration} before you run the application.
-
- \endlist
-
- \endlist
-
- \section2 Testing with User Data
-
- To run your application as the default user, you must first assign a password
- for the user account and then create the connection to the device as the
- user:
-
- \list 1
-
- \o On the device, in \gui Programs, select \c {X Terminal} to open a
- terminal window.
-
- \o To switch to the root user, enter the following command:
- \c{sudo gainroot}
-
- \o To specify the password, enter the following command:
- \c {passwd user}
-
- \o In Qt Creator, Select \gui Tools > \gui Options... > \gui Projects >
- \gui{Maemo Device Configurations}.
-
- \o Specify the username \c user and the password in the device configuration.
-
- \endlist
-
- \section2 Generating SSH Keys
-
- If you do not have an SSH public and private key pair, you can generate it
- in Qt Creator. You can specify key length and the key algorithm, RSA or DSA.
- If you only use the keys to protect connections to the Maemo emulator or
- device, you can use the default values.
-
- \list 1
-
- \o Select \gui {Tools > Options... > Projects > Maemo Device Configurations
- > Generate SSH Key...}.
-
- \o Click \gui {Generate SSH Key}.
-
- \image qtcreator-ssh-key-configuration.png "SSH Key Configuration dialog"
-
- \o Click \gui {Save Public Key...} to select the location to save the
- public key.
-
- \o Click \gui {Save Private Key...} to specify the location to save the
- private key.
-
- \o Click \gui Close to close the dialog.
-
- \endlist
-
- \section1 Troubleshooting
-
- The addresses used in this example might be reserved by some other application
- in your network. If you cannot establish a connection, try the following optional
- configurations:
-
- \table
-
- \header
- \o usb0 in Mad Developer on Device
- \o USB Network on Development PC
- \o Host Name in Qt Creator Build Settings
-
- \row
- \o 172.30.7.15 255.255.255.0
- \o 172.30.7.14 255.255.255.0
- \o 172.30.7.15
-
- \row
- \o 10.133.133.15
- \o 10.133.133.14
- \o 10.133.133.15
-
- \row
- \o 192.168.133.15
- \o 192.168.133.14
- \o 192.168.133.15
-
- \note You cannot use the value localhost for connections to a device.
-
- \endtable
-
- \note VPN connections might block the device connection.
-
-*/
-
-
-/*!
\contentspage index.html
\previouspage creator-debugging-helpers.html
\page creator-maemo-emulator.html
@@ -5999,118 +5540,6 @@
/*!
\contentspage index.html
- \previouspage creator-developing-maemo.html
- \page creator-developing-symbian.html
- \nextpage creator-project-managing-sessions.html
-
- \title Setting Up Development Environment for Symbian
-
- For more information about developing applications for the Symbian
- platform, select \gui {Help > Index} and look for \gui {Platform Notes},
- or see
- \l{http://doc.qt.nokia.com/4.6/platform-notes-symbian.html}{Platform Notes - Symbian}.
-
- \section1 Hardware and Software Requirements
-
- Windows is the only development platform for the Symbian target
- supported at the moment.
-
- For deploying and running applications on the device, you need the
- following:
- \list
- \o The Nokia USB drivers that come with \e{PC Suite} or \e{Ovi Suite}
- \o The \l{http://tools.ext.nokia.com/trk/}{App TRK} application for
- your device
- \o The \e{qt_installer.sis} package installed on the device, that is
- delivered with the Qt SDK
- \o \e {Qt Mobility APIs} installed on the device, if you use them in
- applications
- \endlist
-
- To run your applications in the Symbian emulator, you also need
- to install Carbide.c++ v2.0.0 or higher.
-
- \section1 Installing Required Applications on Devices
-
- The Nokia Qt SDK installation program creates shortcuts for installing
- the required applications on Symbian devices (you can also use any of
- the standard methods for installing applications on devices):
-
- \list 1
-
- \o Connect the device to the development PC with an USB cable in
- PC Suite Mode. If you have not previously used the device with Ovi Suite
- or PC Suite, all the necessary drivers are installed automatically.
- This takes approximately one minute.
-
- \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install Qt to Symbian
- device} and follow the instructions on the screen to install Qt 4.6.2
- libraries on the device.
-
- \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install QtMobility to Symbian
- device} and follow the instructions on the screen to install Qt
- mobility libraries on the device.
-
- \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install TRK to Symbian
- device} and follow the instructions on the screen to install the TRK
- debugging application on the device.
-
- \note To check the Symbian platform version of your device, see
- \l{http://www.forum.nokia.com/devices}{Device Details}.
-
- \endlist
-
- \note If errors occur during the installation, copy the .sis files from
- \c {<NokiaQtSDK_install_path>\Symbian\sis} to the device using USB storage
- mode. Then install them from the file manager on the device.
-
- \section1 Adding Symbian Platform SDKs
-
- Nokia Qt SDK contains all the tools you need for developing Qt applications for
- Symbian devices. To use Symbian APIs directly in your applications, you can
- install additional Symbian Platform SDKs:
-
- \list
- \o \l{http://www.forum.nokia.com/main/resources/tools_and_sdks/S60SDK/}
- {S60 Platform SDK 3rd Edition FP1 or higher}.
- \o Either the GCCE ARM Toolchain that is included in the Symbian
- SDKs, or RVCT 2.2 [build 686] or later (which is not available free
- of charge)(Your environment needs to find the compiler in the PATH).
- \o Qt for Symbian 4.6.2 or later, installed into the Symbian SDKs you want
- to use.
-
- \endlist
-
- \section2 Setting Up Qt Creator
-
- When you run Qt Creator after installing the Symbian SDK and Qt for
- Symbian, the installed SDKs and their corresponding Qt versions are
- automatically detected. For each detected Symbian SDK with Qt, a special entry
- is made in the Qt version management settings in \gui{Tools} >
- \gui{Options...} > \gui{Qt4} > \gui{Qt Versions}.
-
- \note If you manually add a Qt version for Symbian, you must
- also manually specify the Symbian SDK to use for this version.
-
- \image qtcreator-qt4-qtversions-win-symbian.png
-
- If you want to run your applications in the Symbian emulator, you need to
- point Qt Creator to the Metrowerks Compiler that you want to use, by
- setting the \gui{Carbide directory} of the Qt version to the corresponding
- Carbide.c++ installation directory.
-
- You can check which Symbian SDKs and corresponding Qt versions are found in the
- \gui{Tools} > \gui{Options...} > \gui{Qt4} > \gui{S60 SDKs} preference
- page.
-
- \image qtcreator-qt4-s60sdks.png
-
-
-
-*/
-
-/*!
- \contentspage index.html
\previouspage creator-usability.html
\page adding-plugins.html
\nextpage creator-visual-editor.html
diff --git a/doc/qtcreator.qdocconf b/doc/qtcreator.qdocconf
index 9b4e2a29b2..285be65d55 100644
--- a/doc/qtcreator.qdocconf
+++ b/doc/qtcreator.qdocconf
@@ -14,7 +14,7 @@ indexes = qt.index
include(qt-defines.qdocconf)
-sources.fileextensions = "qtcreator.qdoc addressbook-sdk.qdoc"
+sources.fileextensions = "qtcreator.qdoc maemodev.qdoc symbiandev.qdoc addressbook-sdk.qdoc"
qhp.projects = QtCreator
diff --git a/doc/symbiandev.qdoc b/doc/symbiandev.qdoc
new file mode 100644
index 0000000000..98ac737b83
--- /dev/null
+++ b/doc/symbiandev.qdoc
@@ -0,0 +1,154 @@
+/*!
+ \contentspage index.html
+ \if defined(qcmanual)
+ \previouspage creator-developing-maemo.html
+ \else
+ \previouspage nokiaqtsdk-gs.html
+ \endif
+ \page creator-developing-symbian.html
+ \if defined(qcmanual)
+ \nextpage creator-project-managing-sessions.html
+ \else
+ \nextpage creator-developing-maemo.html
+ \endif
+
+ \title Setting Up Development Environment for Symbian
+
+ For more information about developing applications for the Symbian
+ platform, select \gui {Help > Index} and look for \gui {Platform Notes},
+ or see
+ \l{http://doc.qt.nokia.com/4.6/platform-notes-symbian.html}{Platform Notes - Symbian}.
+
+ \section1 Hardware and Software Requirements
+
+ Windows is the only development platform for the Symbian target
+ supported at the moment.
+
+ For deploying and running applications on the device, you need the
+ following:
+ \list
+ \o The Nokia USB drivers that come with \e{PC Suite} or \e{Ovi Suite}
+ \o The
+ \if defined(qcmanual)
+ \l{http://tools.ext.nokia.com/trk/}{App TRK}
+ \else
+ \e {App TRK}
+ \endif
+ application for your device
+ \o The \e{qt_installer.sis} package installed on the device, that is
+ delivered with the Qt SDK
+ \o \e {Qt Mobility APIs} installed on the device, if you use them in
+ applications
+ \endlist
+
+ \if defined(qcmanual)
+ To run your applications in the Symbian emulator, you also need
+ to install Carbide.c++ v2.0.0 or higher.
+ \endif
+
+ \section1 Installing Required Applications on Devices
+
+ The Nokia Qt SDK installation program creates shortcuts for installing
+ the required applications on Symbian devices (you can also use any of
+ the standard methods for installing applications on devices):
+
+ \list 1
+
+ \o Connect the device to the development PC with an USB cable in
+ PC Suite Mode. If you have not previously used the device with Ovi Suite
+ or PC Suite, all the necessary drivers are installed automatically.
+ This takes approximately one minute.
+
+ \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install Qt to Symbian
+ device} and follow the instructions on the screen to install Qt 4.6.2
+ libraries on the device.
+
+ \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install QtMobility to Symbian
+ device} and follow the instructions on the screen to install Qt
+ mobility libraries on the device.
+
+ \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install TRK to Symbian
+ device} and follow the instructions on the screen to install the TRK
+ debugging application on the device.
+
+ \note To check the Symbian platform version of your device, see
+ \l{http://www.forum.nokia.com/devices}{Device Details}.
+
+ \endlist
+
+ \note If errors occur during the installation, copy the .sis files from
+ \c {<NokiaQtSDK_install_path>\Symbian\sis} to the device using USB storage
+ mode. Then install them from the file manager on the device.
+
+ \if defined(qcmanual)
+ \section1 Adding Symbian Platform SDKs
+
+ Nokia Qt SDK contains all the tools you need for developing Qt applications for
+ Symbian devices. To use Symbian APIs directly in your applications, you can
+ install additional Symbian Platform SDKs:
+
+ \list
+ \o \l{http://www.forum.nokia.com/main/resources/tools_and_sdks/S60SDK/}
+ {S60 Platform SDK 3rd Edition FP1 or higher}.
+ \o Either the GCCE ARM Toolchain that is included in the Symbian
+ SDKs, or RVCT 2.2 [build 686] or later (which is not available free
+ of charge)(Your environment needs to find the compiler in the PATH).
+ \o Qt for Symbian 4.6.2 or later, installed into the Symbian SDKs you want
+ to use.
+
+ \endlist
+
+ \section2 Setting Up Qt Creator
+
+ When you run Qt Creator after installing the Symbian SDK and Qt for
+ Symbian, the installed SDKs and their corresponding Qt versions are
+ automatically detected. For each detected Symbian SDK with Qt, a special entry
+ is made in the Qt version management settings in \gui{Tools} >
+ \gui{Options...} > \gui{Qt4} > \gui{Qt Versions}.
+
+ \note If you manually add a Qt version for Symbian, you must
+ also manually specify the Symbian SDK to use for this version.
+
+ \image qtcreator-qt4-qtversions-win-symbian.png
+
+ If you want to run your applications in the Symbian emulator, you need to
+ point Qt Creator to the Metrowerks Compiler that you want to use, by
+ setting the \gui{Carbide directory} of the Qt version to the corresponding
+ Carbide.c++ installation directory.
+
+ You can check which Symbian SDKs and corresponding Qt versions are found in the
+ \gui{Tools} > \gui{Options...} > \gui{Qt4} > \gui{S60 SDKs} preference
+ page.
+
+ \image qtcreator-qt4-s60sdks.png
+
+ \else
+
+ \section1 Building and Running Applications
+
+ You can test your application on a device by building and running
+ it from Qt Creator for the \gui {Symbian Device} target.
+
+ \list 1
+
+ \o Connect the device to the development PC through a USB cable.
+ The target selector displays a green check mark when a
+ device is connected.
+
+ \image qtcreator-qt4-symbian-device-connected.png
+
+ The tool tip of the target selector shows more details about the actual
+ device that will be used when you run your application.
+
+ \o Start the \gui{App TRK} application on your device and deny the
+ Bluetooth connection.
+
+ \o Select \gui Options to select USB as connection type.
+
+ \o Click the \gui Run button in Qt Creator.
+
+ \endlist
+
+ \endif
+
+*/