Update copyright headers
[qt:qt.git] / doc / src / platforms / emb-envvars.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29     \page qt-embedded-envvars.html
30
31     \title Qt for Embedded Linux Environment Variables
32     \ingroup qt-embedded-linux
33
34     These environment variables are relevant to \l{Qt for Embedded Linux}
35     users.
36
37     \table
38     \header \o Variable \o Description
39
40     \row
41     \o \bold POINTERCAL_FILE \target POINTERCAL_FILE
42
43     \o Specifies the file containing the data used to calibrate the
44     pointer device.
45
46     See also QWSCalibratedMouseHandler and \l{Qt for Embedded Linux Pointer
47     Handling}.
48
49     \row
50     \o \bold QT_ONSCREEN_PAINT \target QT_ONSCREEN_PAINT
51
52     \o If defined, the application will render its widgets directly on
53     screen. The affected regions of the screen will not be modified by
54     the screen driver unless another window with a higher focus
55     requests (parts of) the same region.
56
57     Setting this environment variable is equivalent to setting the
58     Qt::WA_PaintOnScreen attribute for all the widgets in the
59     application.
60
61     See also the Qt for Embedded Linux \l{Qt for Embedded Linux Architecture#Graphics
62     Rendering}{graphics rendering} documentation.
63
64     \row
65     \o \bold QWS_SW_CURSOR \target QWS_SW_CURSOR
66     \o If defined, the software mouse cursor is always used (even when using an
67     accelerated driver that supports a hardware cursor).
68
69     \row
70     \o \bold QWS_DISPLAY \target QWS_DISPLAY
71     \o
72
73     Specifies the display type and framebuffer. For example, if the
74     current shell is bash, ksh, zsh or sh:
75
76     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 0
77
78     The valid values for the \c <driver> argument are \c LinuxFb, \c
79     QVFb, \c VNC, \c Transformed, \c Multi and \l
80     {QScreenDriverPlugin::keys()}{keys} identifying custom drivers,
81     and the \c {<display num>} argument is used to separate screens
82     that are using the same screen driver and to enable multiple
83     displays (see the \l {Running Qt for Embedded Linux Applications}
84     documentation for more details).
85
86     The driver specific options are described in the \l{Qt for Embedded Linux
87     Display Management}{display management} documentation.
88
89     \row
90     \o \bold QWS_SIZE \target QWS_SIZE
91     \o
92
93     Specifies the size of the \l{Qt for Embedded Linux} window which is centered
94     within the screen. For example, if the current shell is bash, ksh,
95     zsh or sh:
96
97     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 1
98
99     \row
100     \o \bold QWS_MOUSE_PROTO \target QWS_MOUSE_PROTO
101     \o
102
103     Specifies the driver for pointer handling. For example, if the
104     current shell is bash, ksh, zsh or sh:
105
106     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 2
107
108     The valid values for the \c <driver> argument are \c MouseMan, \c
109     IntelliMouse, \c Microsoft, \c LinuxTP, \c LinuxInput, \c Tslib
110     and \l {QMouseDriverPlugin::keys()}{keys} identifying
111     custom drivers, and the driver specific options are typically a
112     device, e.g., \c /dev/mouse for mouse devices and \c /dev/ts for
113     touch panels.
114
115     Multiple mouse drivers can be specified in one go:
116
117     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 3
118
119     Input will be read from all specified drivers.
120
121     See also \l {Qt for Embedded Linux Pointer Handling}.
122
123     \row
124     \o \bold QWS_KEYBOARD \target QWS_KEYBOARD
125     \o
126
127     Specifies the driver and device for character input. For example, if the
128     current shell is bash, ksh, zsh or sh:
129
130     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 4
131
132     The valid values for the \c <driver> argument are \c TTY,
133     \c LinuxInput and \l {QKbdDriverPlugin::keys()}{keys} identifying custom drivers,
134     and the driver specific options are typically a device, e.g., \c
135     /dev/tty0.
136
137     Multiple keyboard drivers can be specified in one go:
138
139     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 5
140
141     Input will be read from all specified drivers.
142
143     See also \l {Qt for Embedded Linux Character Input}.
144
145     \endtable
146 */