tqt3/doc/installation.doc

/****************************************************************************
**
** Installation page
**
** Copyright (C) 2000-2008 Trolltech ASA.  All rights reserved.
**
** This file is part of the TQt GUI Toolkit.
**
** This file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free
** Software Foundation and appearing in the files LICENSE.GPL2
** and LICENSE.GPL3 included in the packaging of this file.
** Alternatively you may (at your option) use any later version
** of the GNU General Public License if such license has been
** publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free TQt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.QPL
** included in the packaging of this file.  Licensees holding valid Qt
** Commercial licenses may use this file in accordance with the Qt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

/*! \page installation.html

\title Installation

The installation procedure is different for the different TQt platforms:

\list
 \i \link install-x11.html Qt/X11 \endlink
 \i \link install-win.html Qt/Windows \endlink
 \i \link install-mac.html Qt/Mac \endlink
 \i \link emb-install.html Qt/Embedded \endlink
\endlist

*/

/*! \page install-x11.html

\title Installing Qt/X11

You may need to be root, depending on the permissions of the directories
where you choose to install Qt.

\list 1
\i  Unpack the archive if you have not done so already:

\code
    cd /usr/local
    gunzip qt-x11-version.tar.gz    # uncompress the archive
    tar xf qt-x11-version.tar       # unpack it
\endcode

    This creates the directory /usr/local/qt-\e version containing the
    files from the main archive.

    Rename qt-\e version to qt (or make a symlink):

\code
    mv qt-version qt
\endcode

    The rest of this file assumes that TQt is installed in \c /usr/local/qt.

\i  Set some environment variables in the file \c .profile (or \c .login,
    depending on your shell) in your home directory. Create the
    file if it is not there already.

    \list
    \i TQTDIR -- the directory in which you're building Qt
    \i PATH -- to locate the moc program and other TQt tools
    \i MANPATH -- to access the TQt man pages
    \i LD_LIBRARY_PATH -- for the shared TQt library
    \endlist

    This is done like this:

    In \c .profile (if your shell is bash, ksh, zsh or sh), add the
    following lines:

\code
    TQTDIR=/usr/local/qt
    PATH=$TQTDIR/bin:$PATH
    MANPATH=$TQTDIR/man:$MANPATH
    LD_LIBRARY_PATH=$TQTDIR/lib:$LD_LIBRARY_PATH

    export TQTDIR PATH MANPATH LD_LIBRARY_PATH
\endcode

    In \c .login (in case your shell is csh or tcsh), add the following lines:

\code
    setenv TQTDIR /usr/local/qt
    setenv PATH $TQTDIR/bin:$PATH
    setenv MANPATH $TQTDIR/man:$MANPATH
    setenv LD_LIBRARY_PATH $TQTDIR/lib:$LD_LIBRARY_PATH
\endcode

    After you have done this, you will need to login again, or
    re-source the profile before continuing, so that at least \c $TQTDIR
    is set.  The installation will give an error message and not
    proceed otherwise.

    On AIX set LIBPATH and on HP-UX set SHLIB_PATH instead of LD_LIBRARY_PATH.

    Note that the SGI MIPSpro o32 and Sun WorkShop 5.0 targets are no
    longer supported as of TQt 3.3.

\i  Install your license file as \c $HOME/.qt-license.
    For the free edition and evaluation version, you do not need a license
    file.

\i  Compile the TQt library, and build the example programs,
    the tutorial and the tools (e.g. \link designer-manual.book Qt
    Designer\endlink) as follows.

    Type:
\code
    ./configure
\endcode

    This will configure the TQt library for your machine. Note that
    GIF support is turned off by default. Run \c{./configure -help}
    to get a list of configuration options. Read \c PLATFORMS for a
    list of supported platforms.

    To create the library and compile all examples and the tutorial:
\code
    make
\endcode
    If you have problems, see
    \l{http://www.trolltech.com/platforms/}.

\i  In very few cases you may need to run \c /sbin/ldconfig or something
    similar at this point if you are using shared libraries.

    If you have problems running the example programs, e.g. messages like
\code
    can't load library 'libtqt.so.2'
\endcode
    you probably need to put a reference to the qt library in a
    configuration file and run \c /sbin/ldconfig as root on your system.
    And don't forget to \c set LD_LIBRARY_PATH as explained in 2) above.

\i  The online HTML documentation is installed in \c /usr/local/qt/doc/html/
    The main page is \c{/usr/local/qt/doc/html/index.html}.
    The man pages are installed in \c{/usr/local/qt/doc/man/}.
    The documentation is also accessible using \link assistant.book Qt
    Assistant\endlink.
\endlist

You're done.  TQt is now installed.

*/

/*! \page install-win.html

\title Installing Qt/Windows

The Qt/Windows distribution is distributed as a self-extracting archive
with a built-in installer. Just follow the installation wizard.

*/
*/

/*! \page install-mac.html

\title Installing Qt/Mac

You may need to be logged in as root, depending on the permissions of
the directories where you choose to install Qt.

\list 1
\i  Unpack the archive if you have not done so already:

\code
    cd /Developer
    gnutar xzf qt-mac-version.tar.gz
\endcode

    This creates the directory /Developer/qt-\e version containing the
    files from the main archive.

    Rename qt-\e version to qt (or make a symlink):

\code
    mv qt-version qt
\endcode

    The rest of this file assumes that TQt is unpacked in \c /Developer/qt.

\i  Set some environment variables in the file \c .profile (or \c .login,
    depending on your shell) in your home directory. Create the
    file if it is not there already.

    \list
    \i TQTDIR -- the directory in which you're building Qt
    \i PATH -- to locate the moc program and other TQt tools
    \i MANPATH -- to access the TQt man pages
    \i LD_LIBRARY_PATH -- for the shared TQt library
    \endlist

    This is done like this:

    In \c .profile (if your shell is bash, ksh, zsh or sh), add the
    following lines:

\code
    TQTDIR=/Developer/qt
    PATH=$TQTDIR/bin:$PATH
    MANPATH=$TQTDIR/man:$MANPATH
    DYLD_LIBRARY_PATH=$TQTDIR/lib:$DYLD_LIBRARY_PATH

    export TQTDIR PATH MANPATH DYLD_LIBRARY_PATH
\endcode

    In \c .login (in case your shell is csh or tcsh), add the following lines:

\code
    setenv TQTDIR /Developer/qt
    setenv PATH $TQTDIR/bin:$PATH
    setenv MANPATH $TQTDIR/man:$MANPATH
    setenv DYLD_LIBRARY_PATH $TQTDIR/lib:$DYLD_LIBRARY_PATH
\endcode

    After you have done this, you will need to login again, or
    re-source the profile before continuing.

\i  If you have the commercial edition of Qt, install your license
    file as \c $HOME/.qt-license.

\i  Compile the TQt library, and build the example programs,
    the tutorial and the tools (e.g. \link designer-manual.book Qt
    Designer\endlink) as follows.

    Type:
\code
    cd $TQTDIR
    ./configure
\endcode

    This will configure the TQt library for your machine. Note that
    GIF support is turned off by default. Run \c{./configure -help}
    to get a list of configuration options.

    To create the library and compile all examples and the tutorial:
\code
    make
\endcode
    If you have problems, see
    \l{http://www.trolltech.com/platforms/}.

\i  Once you have built Qt, it is ready to use. If TQt has not been
    configured with the -static option, then in order to be able to
    launch TQt applications from the Finder you must place the relevant
    libraries in a directory where they can be found. We recommend
    making these symbolic links (if you have configured TQt with -thread
    please change the libtqt below with libtqt-mt):

\code
    ln -sf $TQTDIR/lib/libtqt.3.dylib /usr/lib
    ln -sf $TQTDIR/lib/libtqui.1.dylib /usr/lib
\endcode

    You may need to have 'administrator' access to do this, (in which
    case, precede each command with \c sudo', e.g. \c{sudo ln -s ...}). If
    you use sudo you'll be prompted for the administrator password.

    If you do not have administrator access, or you would prefer to do
    a user install (rather than system install) of the libraries you
    can do (if you have configured TQt with -thread please change the libtqt
    below with libtqt-mt):

\code
    ln -sf $TQTDIR/lib/libtqt.3.dylib $HOME/lib
    ln -sf $TQTDIR/lib/libtqui.1.dylib $HOME/lib
\endcode
\endlist

That's all! TQt is now installed. Qt's documentation can be read with
Qt Assistant or by any web browser; the contents page is
\c $TQTDIR/doc/html/index.html.

*/