tools/linguist/lupdate/lupdate.1
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 .TH lupdate 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 .\" All rights reserved.
       
     5 .\" Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 .\"
       
     7 .\" This file is part of the QtGui module 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 .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 "-disable-heuristic {sametext|similartext|number}"
       
    66 Disable the named merge heuristic. Can be specified multiple times.
       
    67 .TP
       
    68 .I "-extensions <ext>[,<ext>...]"
       
    69 Process files with the given extensions only.
       
    70 The extension list must be separated with commas, not with whitespace.
       
    71 Default: 'ui,c,c++,cc,cpp,cxx,ch,h,h++,hh,hpp,hxx'.
       
    72 .TP
       
    73 .I "-help"
       
    74 Display the usage and exit.
       
    75 .TP
       
    76 .I "-locations {absolute|relative|none}"
       
    77 Specify/override how source code references are saved in TS files.
       
    78 Default is absolute.
       
    79 .TP
       
    80 .I "-no-obsolete"
       
    81 Drop all obsolete strings.
       
    82 .TP
       
    83 .I "-no-recursive"
       
    84 Do not recursively scan the following directories.
       
    85 .TP
       
    86 .I "-no-sort"
       
    87 Do not sort contexts in TS files.
       
    88 .TP
       
    89 .I "-pluralonly"
       
    90 Only include plural form messages.
       
    91 .TP
       
    92 .I "-pro <filename>"
       
    93 Name of a .pro file. Useful for files with .pro
       
    94 file syntax but different file suffix
       
    95 .TP
       
    96 .I "-recursive"
       
    97 Recursively scan the following directories.
       
    98 .TP
       
    99 .I "-silent"
       
   100 Do not explain what is being done.
       
   101 .TP
       
   102 .I "-source-language <language>[_<region>]"
       
   103 Specify/override the language of the source strings. Defaults to
       
   104 POSIX if not specified and the file does not name it yet.
       
   105 .TP
       
   106 .I "-target-language <language>[_<region>]"
       
   107 Specify/override the language of the translation.
       
   108 The target language is guessed from the file name if this option
       
   109 is not specified and the file contents name no language yet.
       
   110 .I "-version"
       
   111 Display the version of
       
   112 .B lupdate
       
   113 and exit.
       
   114 .SH USAGE
       
   115 Here is an example .pro file that can be given to
       
   116 .B lupdate:
       
   117 .PP
       
   118 .in +4
       
   119 .nf
       
   120 HEADERS         = funnydialog.h \\
       
   121                   wackywidget.h
       
   122 SOURCES         = funnydialog.cpp \\
       
   123                   main.cpp \\
       
   124                   wackywidget.cpp
       
   125 FORMS           = fancybox.ui
       
   126 TRANSLATIONS    = gnomovision_dk.ts \\
       
   127                   gnomovision_fi.ts \\
       
   128                   gnomovision_no.ts \\
       
   129                   gnomovision_se.ts
       
   130 .fi
       
   131 .in -4
       
   132 .PP
       
   133 When running
       
   134 .B lupdate
       
   135 on this project file, the translatable strings in all the files
       
   136 listed in the HEADERS, SOURCES and FORMS entries will be put in
       
   137 the translation files listed in the TRANSLATIONS entry. Previous
       
   138 translations will be reused as far as possible, and translated
       
   139 strings that have vanished from the source files are marked obsolete.
       
   140 .PP
       
   141 .B lupdate
       
   142 can also be invoked with a list of C++ source files, UI files
       
   143 and TS files:
       
   144 .PP
       
   145 .in +4
       
   146 .nf
       
   147 lupdate *.cpp *.h *.ui -ts gnomovision_dk.ts
       
   148 .fi
       
   149 .in -4
       
   150 .SH "SEE ALSO"
       
   151 .BR lrelease (1)
       
   152 and
       
   153 .BR http://qt.nokia.com/doc/i18n.html