tqt3/doc/envvars.doc

/****************************************************************************
**
** The environment variables Qt/Embedded takes notice of
**
** Copyright (C) 1992-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 emb-envvars.html

\title Qt/Embedded environment variables

\table
\header \i Variable \i Notes

\row
\i QWS_SW_CURSOR
\i If defined, always use a software mouse cursor even when using an
accelerated driver that supports a hardware cursor

\row
\i QWS_DISPLAY
\i Defines the display type and framebuffer, e.g.
\c{Voodoo3 Mach64:/dev/fb1}
Defaults to an unaccelerated Linux framebuffer driver on \c /dev/fb0.
Valid drivers are QVfb, VGA16, LinuxFb (unaccelerated Linux framebuffer),
Mach64 (accelerated for ATI Mach64 cards such as the Rage Pro),
Voodoo3 (accelerated for the 3dfx Voodoo 3, should also work on Voodoo
Banshee), Matrox (should work on all Matrox graphics cards since the
Matrox Millennium), Transformed (for rotated displays), SVGALIB and
VNC. Transformed displays have a special format: within the
specification should be a multiple of 90 degrees rotation specified as
Rot\<x\>, for instance Transformed:Rot90.

\row
\i TQTDIR
\i If defined this tells Qt/Embedded to where to find its fonts:
fontdir should be in \c $TQTDIR/etc/fonts/. If undefined it's assumed
to be \c /usr/local/qt-embedded

\row
\i QWS_SIZE
\i If defined forces Qt/Embedded into a window of \<width\> x
\<height\> size centred within the screen, e.g. 320x200

\row
\i QWS_NOMTRR
\i If defined, don't use Memory Type Range Registers to define the framebuffer
as write-combined on x86. Write-combining speeds up graphics output.

\row
\i QWS_CARD_SLOT
\i Tells the accelerated drivers which card to attempt to accelerate.
This should be a path in \c /proc/bus/pci. It defaults to
\c /proc/bus/pci/01/00.0 - the first device on the second PCI bus in the
system, which is normally the AGP card.

\row
\i QWS_USB_KEYBOARD
\i If defined, instead of opening \c /dev/tty open the USB low-level
event device defined in QWS_USB_KEYBOARD (e.g. \c /dev/input/event0):
this is useful if you wish to run X and Qt/Embedded side by side on
different framebuffers.

\row
\i QWS_MOUSE_PROTO
\i Defined as \<type\>:\<device\>, e.g. \c{Microsoft:/dev/ttyS0}. If you want to
use a USB mouse directly (separate from X) use \c{MouseMan:/dev/input/mouse0}
or similar. Valid mouse protocls are Auto (automatically sense protocol),
MouseMan, IntelliMouse, Microsoft, QVfbMouse (only useful with QVfb)
and TPanel, a sample touch panel driver.

\row
\i QWS_KEYBOARD
\i Defines the keyboard type. Multiple keyboards can be handled at once,
input will be read from all of them. Valid values:
Buttons (an iPaq button device if QT_QWS_IPAQ is compiled, otherwise
one for the Cassiopeia), QVfbKeyboard (only useful with QVfb),
and TTY (either a USB keyboard or \c /dev/tty depending if QWS_USB_KEYBOARD
is defined)

\endtable

*/