Update copyright headers
[qt:qt.git] / config.profiles / harmattan / manpages / lupdate.1
1 .TH lupdate 1 "18 October 2001" "Nokia Corporation and/or its subsidiary(-ies)" \" -*- nroff -*-
2 .\"
3 .\" Copyright (C) 2015 The Qt Company Ltd.
4 .\" Contact: http://www.qt.io/licensing/
5 .\"
6 .\" This file is part of the QtGui module of the Qt Toolkit.
7 .\"
8 .\" $QT_BEGIN_LICENSE:LGPL$
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 Lesser General Public License Usage
18 .\" Alternatively, this file may be used under the terms of the GNU Lesser
19 .\" General Public License version 2.1 as published by the Free Software
20 .\" Foundation and appearing in the file LICENSE.LGPL included in the
21 .\" packaging of this file.  Please review the following information to
22 .\" ensure the GNU Lesser General Public License version 2.1 requirements
23 .\" will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 .\"
25 .\" As a special exception, The Qt Company gives you certain additional
26 .\" rights. These rights are described in The Qt Company LGPL Exception
27 .\" version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 .\"
29 .\" GNU General Public License Usage
30 .\" Alternatively, this file may be used under the terms of the GNU
31 .\" General Public License version 3.0 as published by the Free Software
32 .\" Foundation and appearing in the file LICENSE.GPL included in the
33 .\" packaging of this file.  Please review the following information to
34 .\" ensure the GNU General Public License version 3.0 requirements will be
35 .\" met: http://www.gnu.org/copyleft/gpl.html.
36 .\"
37 .\"
38 .\" $QT_END_LICENSE$
39 .\"
40 .SH NAME
41 lupdate \- update Qt Linguist translation files
42 .SH SYNOPSIS
43 .B lupdate
44 .RI "[ " options " ] " project-file
45 .br
46 .B lupdate
47 .RI "[ " options " ] " source-files " -ts " ts-files
48 .SH DESCRIPTION
49 This page documents the
50 .B Qt Linguist Update
51 tool for the Qt GUI toolkit.
52 .B Lupdate
53 reads a qmake/tmake project file (.pro file), finds the translatable
54 strings in the specified source, header and interface files, and
55 updates the translation files (.ts files) specified in it. The
56 translation files are given to the translator who uses
57 .B Qt Linguist
58 to read the files and insert the translations.
59 .PP
60 The .ts file format is a simple human-readable XML format that can be
61 used with version control systems if required.
62 .PP
63 .SH OPTIONS
64 .TP
65 .I "-help"
66 Display the usage and exit.
67 .TP
68 .I "-noobsolete"
69 Drop all obsolete strings.
70 .TP
71 .I "-verbose"
72 Explain what is being done.
73 .TP
74 .I "-version"
75 Display the version of
76 .B lupdate
77 and exit.
78 .SH USAGE
79 Here is an example .pro file that can be given to
80 .B lupdate:
81 .PP
82 .in +4
83 .nf
84 HEADERS         = funnydialog.h \\
85                   wackywidget.h
86 SOURCES         = funnydialog.cpp \\
87                   main.cpp \\
88                   wackywidget.cpp
89 FORMS           = fancybox.ui
90 TRANSLATIONS    = gnomovision_dk.ts \\
91                   gnomovision_fi.ts \\
92                   gnomovision_no.ts \\
93                   gnomovision_se.ts
94 .fi
95 .in -4
96 .PP
97 When running
98 .B lupdate
99 on this project file, the translatable strings in all the files
100 listed in the HEADERS, SOURCES and FORMS entries will be put in
101 the translation files listed in the TRANSLATIONS entry. Previous
102 translations will be reused as far as possible, and translated
103 strings that have vanished from the source files are marked obsolete.
104 .PP
105 .B Lupdate
106 can also be invoked with a list of C++ source files, .ui files
107 and .ts files:
108 .PP
109 .in +4
110 .nf
111 lupdate *.cpp *.h *.ui -ts gnomovision_dk.ts
112 .fi
113 .in -4
114 .SH "SEE ALSO"
115 .BR lrelease (1)
116 and
117 .BR http://doc.trolltech.com/i18n.html