Update references to online documentation.
[qt:qt-ios-plaszma.git] / tools / linguist / lrelease / lrelease.1
1 .TH lrelease 1 "18 October 2001" "Nokia Corporation and/or its subsidiary(-ies)" \" -*- nroff -*-
2 .\"
3 .\" Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4 .\" Contact: Nokia Corporation (qt-info@nokia.com)
5 .\" 
6 .\" This file is part of the QtGui module of the Qt Toolkit.
7 .\" 
8 .\" $QT_BEGIN_LICENSE:LGPL$
9 .\" No Commercial Usage
10 .\" This file contains pre-release code and may not be distributed.
11 .\" You may use this file in accordance with the terms and conditions
12 .\" contained in the either Technology Preview License Agreement or the
13 .\" Beta Release License Agreement.
14 .\" 
15 .\" GNU Lesser General Public License Usage
16 .\" Alternatively, this file may be used under the terms of the GNU Lesser
17 .\" General Public License version 2.1 as published by the Free Software
18 .\" Foundation and appearing in the file LICENSE.LGPL included in the
19 .\" packaging of this file.  Please review the following information to
20 .\" ensure the GNU Lesser General Public License version 2.1 requirements
21 .\" will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22 .\" 
23 .\" In addition, as a special exception, Nokia gives you certain
24 .\" additional rights. These rights are described in the Nokia Qt LGPL
25 .\" Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26 .\" package.
27 .\" 
28 .\" GNU General Public License Usage
29 .\" Alternatively, this file may be used under the terms of the GNU
30 .\" General Public License version 3.0 as published by the Free Software
31 .\" Foundation and appearing in the file LICENSE.GPL included in the
32 .\" packaging of this file.  Please review the following information to
33 .\" ensure the GNU General Public License version 3.0 requirements will be
34 .\" met: http://www.gnu.org/copyleft/gpl.html.
35 .\" 
36 .\" If you are unsure which license is appropriate for your use, please
37 .\" contact the sales department at http://qt.nokia.com/contact.
38 .\" $QT_END_LICENSE$
39 .\" 
40 .SH NAME
41 lrelease \- generate Qt message files from Qt Linguist translation files
42 .SH SYNOPSIS
43 .B lrelease
44 .RI "[ " options " ] " project-file
45 .br
46 .B lrelease
47 .RI "[ " options " ] " ts-files " [ -qm " qm-file " ]"
48 .SH DESCRIPTION
49 This page documents the
50 .B Qt Linguist Release
51 tool for the Qt GUI toolkit.
52 .B Lrelease
53 reads a qmake/tmake project file (.pro file) and converts the
54 translation files (TS files) specified in it into Qt message files
55 (QM files) used by the application to translate.
56 .PP
57 The QM file format is a compact binary format that provides
58 extremely fast lookups for translations and that is used by Qt.
59 .SH OPTIONS
60 .TP
61 .I "-help"
62 Display the usage and exit.
63 .TP
64 .I "-compress"
65 Compress the QM files.
66 .TP
67 .I "-nounfinished"
68 Do not include unfinished translations.
69 .TP
70 .I "-removeidentical"
71 If the translated text is the same as
72 the source text, do not include the message.
73 .TP
74 .I "-silent"
75 Do not explain what is being done.
76 .TP
77 .I "-version"
78 Display the version of
79 .B lrelease
80 and exit.
81 .SH USAGE
82 Here is an example .pro file that can be given to
83 .B lrelease:
84 .PP
85 .in +4
86 .nf
87 HEADERS         = funnydialog.h \\
88                   wackywidget.h
89 SOURCES         = funnydialog.cpp \\
90                   main.cpp \\
91                   wackywidget.cpp
92 FORMS           = fancybox.ui
93 TRANSLATIONS    = gnomovision_dk.ts \\
94                   gnomovision_fi.ts \\
95                   gnomovision_no.ts \\
96                   gnomovision_se.ts
97 .fi
98 .in -4
99 .PP
100 When running
101 .B lrelease
102 on this project file, the Qt message files gnomovision_dk.qm,
103 gnomovision_fi.qm, gnomovision_no.qm and gnomovision_se.qm will be
104 generated from gnomovision_dk.ts, gnomovision_fi.ts,
105 gnomovision_no.ts and gnomovision_se.ts, respectively.
106 .PP
107 .B Lrelease
108 can also be invoked with a list of TS files to convert:
109 .PP
110 .in +4
111 .nf
112 lrelease gnomovision_*.ts
113 .fi
114 .in -4
115 .SH "SEE ALSO"
116 .BR lupdate (1)
117 and
118 .BR http://qt.nokia.com/doc/i18n.html