summaryrefslogtreecommitdiffstats
path: root/tools/linguist/lupdate/lupdate.1
blob: 80b7429b38f614b6efb848713d75448053874d79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
.TH lupdate 1 "18 October 2001" "Nokia Corporation and/or its subsidiary(-ies)" \" -*- nroff -*-
.\"
.\" Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
.\" All rights reserved.
.\" Contact: Nokia Corporation (qt-info@nokia.com)
.\"
.\" This file is part of the QtGui module of the Qt Toolkit.
.\"
.\" $QT_BEGIN_LICENSE:LGPL$
.\" No Commercial Usage
.\" This file contains pre-release code and may not be distributed.
.\" You may use this file in accordance with the terms and conditions
.\" contained in the Technology Preview License Agreement accompanying
.\" this package.
.\"
.\" GNU Lesser General Public License Usage
.\" Alternatively, this file may be used under the terms of the GNU Lesser
.\" General Public License version 2.1 as published by the Free Software
.\" Foundation and appearing in the file LICENSE.LGPL included in the
.\" packaging of this file.  Please review the following information to
.\" ensure the GNU Lesser General Public License version 2.1 requirements
.\" will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
.\"
.\" In addition, as a special exception, Nokia gives you certain additional
.\" rights.  These rights are described in the Nokia Qt LGPL Exception
.\" version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
.\"
.\" If you have questions regarding the use of this file, please contact
.\" Nokia at qt-info@nokia.com.
.\"
.\"
.\"
.\"
.\"
.\"
.\"
.\"
.\" $QT_END_LICENSE$
.\"
.SH NAME
lupdate \- update Qt Linguist translation files
.SH SYNOPSIS
.B lupdate
.RI "[ " options " ] " project-file
.br
.B lupdate
.RI "[ " options " ] " source-files " -ts " ts-files
.SH DESCRIPTION
This page documents the
.B Qt Linguist Update
tool for the Qt GUI toolkit.
.B Lupdate
reads a qmake/tmake project file (.pro file), finds the translatable
strings in the specified source, header and interface files, and
updates the translation files (TS files) specified in it. The
translation files are given to the translator who uses
.B Qt Linguist
to read the files and insert the translations.
.PP
The TS file format is a simple human-readable XML format that can be
used with version control systems if required.
.PP
.SH OPTIONS
.TP
.I "-disable-heuristic {sametext|similartext|number}"
Disable the named merge heuristic. Can be specified multiple times.
.TP
.I "-extensions <ext>[,<ext>...]"
Process files with the given extensions only.
The extension list must be separated with commas, not with whitespace.
Default: 'ui,c,c++,cc,cpp,cxx,ch,h,h++,hh,hpp,hxx'.
.TP
.I "-help"
Display the usage and exit.
.TP
.I "-locations {absolute|relative|none}"
Specify/override how source code references are saved in TS files.
Default is absolute.
.TP
.I "-no-obsolete"
Drop all obsolete strings.
.TP
.I "-no-recursive"
Do not recursively scan the following directories.
.TP
.I "-no-sort"
Do not sort contexts in TS files.
.TP
.I "-pluralonly"
Only include plural form messages.
.TP
.I "-pro <filename>"
Name of a .pro file. Useful for files with .pro
file syntax but different file suffix
.TP
.I "-recursive"
Recursively scan the following directories.
.TP
.I "-silent"
Do not explain what is being done.
.TP
.I "-source-language <language>[_<region>]"
Specify/override the language of the source strings. Defaults to
POSIX if not specified and the file does not name it yet.
.TP
.I "-target-language <language>[_<region>]"
Specify/override the language of the translation.
The target language is guessed from the file name if this option
is not specified and the file contents name no language yet.
.I "-version"
Display the version of
.B lupdate
and exit.
.SH USAGE
Here is an example .pro file that can be given to
.B lupdate:
.PP
.in +4
.nf
HEADERS         = funnydialog.h \\
                  wackywidget.h
SOURCES         = funnydialog.cpp \\
                  main.cpp \\
                  wackywidget.cpp
FORMS           = fancybox.ui
TRANSLATIONS    = gnomovision_dk.ts \\
                  gnomovision_fi.ts \\
                  gnomovision_no.ts \\
                  gnomovision_se.ts
.fi
.in -4
.PP
When running
.B lupdate
on this project file, the translatable strings in all the files
listed in the HEADERS, SOURCES and FORMS entries will be put in
the translation files listed in the TRANSLATIONS entry. Previous
translations will be reused as far as possible, and translated
strings that have vanished from the source files are marked obsolete.
.PP
.B lupdate
can also be invoked with a list of C++ source files, UI files
and TS files:
.PP
.in +4
.nf
lupdate *.cpp *.h *.ui -ts gnomovision_dk.ts
.fi
.in -4
.SH "SEE ALSO"
.BR lrelease (1)
and
.BR http://qt.nokia.com/doc/i18n.html