doc/src/platforms/emb-kmap2qmap.qdoc
changeset 7 f7bc934e204c
equal deleted inserted replaced
3:41300fa6a67c 7:f7bc934e204c
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the documentation of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 /*!
       
    43     \page qt-embedded-kmap2qmap.html
       
    44     \title kmap2qmap
       
    45     \ingroup qt-embedded-linux
       
    46 
       
    47     \c kmap2qmap is a tool to generate keymaps for use on Embedded Linux.
       
    48     The source files have to be in standard Linux \c kmap format that is
       
    49     e.g.  understood by the kernel's \c loadkeys command.  This means you
       
    50     can use the following sources to generate \c qmap files:
       
    51 
       
    52     \list
       
    53     \o The \l {http://lct.sourceforge.net/}{Linux Console Tools (LCT)} project.
       
    54     \o \l {http://www.x.org/}{Xorg} X11 keymaps can be converted to the \c
       
    55     kmap format with the \c ckbcomp utility.
       
    56     \o Since \c kmap files are plain text files, they can also be hand crafted.
       
    57     \endlist
       
    58 
       
    59     The generated \c qmap files are size optimized binary files.
       
    60 
       
    61     \c kmap2qmap is a command line program, that needs at least 2 files as
       
    62     parameters.  The last one will be the generated \c .qmap file, while all
       
    63     the others will be parsed as input \c .kmap files.  For example:
       
    64 
       
    65     \code
       
    66     kmap2qmap i386/qwertz/de-latin1-nodeadkeys.kmap include/compose.latin1.inc de-latin1-nodeadkeys.qmap
       
    67     \endcode
       
    68 
       
    69     \c kmap2qmap does not support all the (pseudo) symbols that the Linux
       
    70     kernel supports.  If you are converting a standard keymap you will get a
       
    71     lot of warnings for things like \c Show_Registers, \c Hex_A, etc.: you
       
    72     can safely ignore those.
       
    73 
       
    74     It also doesn't support numeric symbols (e.g. \c{keycode 1 = 4242},
       
    75     instead of \c{keycode 1 = colon}), since these are deprecated and can
       
    76     change from one kernel version to the other.
       
    77 
       
    78     On the other hand, \c kmap2qmap supports one additional, Qt specific,
       
    79     symbol: \c QtZap.  The built-in US keymap has that symbol mapped tp
       
    80     \c{Ctrl+Alt+Backspace} and it serves as a shortcut to kill your QWS
       
    81     server (similiar to the X11 server).
       
    82 
       
    83     See also \l {Qt for Embedded Linux Character Input}
       
    84 */