doc/intltool-update.8

   1 .TH INTLTOOL-UPDATE 8 "2003-08-02" "intltool"
   2
   3 .SH NAME
   4 intltool-update \- updates PO template file and merge translations with it
   5
   6 .SH SYNOPSIS
   7 .BI intltool-update " [option]..."
   8 .br
   9 .BI intltool-update " LANGCODE"
  10
  11 .SH DESCRIPTION
  12 .B intltool-update
  13 generates new po file templates from source code, and merges existing
  14 translations with these new po templates.
  15 .PP
  16 You must change working directory to the subdirectory containing translations
  17 (usually "\fIpo/\fR") before running \fBintltool-update\fR.
  18
  19 .SH OPTIONS
  20 When executing
  21 .B intltool-update
  22 , only one mode of operation is allowed each time.
  23 .\" -------------------------------------------------------
  24 .SS "Mode of operation"
  25 .\" -------------------------------------------------------
  26 .IP "\fB\-p\fR" 4
  27 .PD 0
  28 .IP "\fB\-\-pot\fR" 4
  29 .PD
  30 Generate po template (.pot) only.
  31 .IP "\fB\-s\fR" 4
  32 .PD 0
  33 .IP "\fB\-\-headers\fR" 4
  34 .PD
  35 Executes \fBintltool-extract\fR(8) to extract strings inside XML/INI
  36 style files listed in \fBPOTFILES.in\fR, and writes the extracted
  37 strings into header files, so that the strings can be recognised
  38 by \fBxgettext\fR(1).
  39 .IP "\fB\-m\fR" 4
  40 .PD 0
  41 .IP "\fB\-\-maintain\fR" 4
  42 .PD
  43 Search for left out files, which should have been listed in
  44 .B POTFILES.in
  45 or
  46 .BR POTFILES.skip "."
  47 A list of all these files are written into another file called
  48 "\fBmissing\fR".
  49 .IP "\fB\-r\fR" 4
  50 .PD 0
  51 .IP "\fB\-\-report\fR" 4
  52 .PD
  53 Display a status report for all translations in the software.
  54 .IP "\fB\-d \fILANGCODE\fR" 4
  55 .PD 0
  56 .IP "\fB\-\-dist \fILANGCODE\fR" 4
  57 .PD
  58 Merge
  59 .BR LANGCODE .po
  60 with existing PO template.
  61 .\" -------------------------------------------------------
  62 .SS "Other options"
  63 .\" -------------------------------------------------------
  64 .
  65 .IP "\fB\-g \fINAME\fR" 4
  66 .PD 0
  67 .IP "\fB\-\-gettext-package\fR=\fINAME\fR" 4
  68 .PD
  69 Manually specify PO template file name, instead of determining the
  70 name automatically from source. Useful with
  71 .BR \-p / \-\-pot
  72 option. This option has an additional effect: the name of current working
  73 directory is no more limited to "po" or "po-*".
  74 .IP "\fB\-o \fIFILENAME\fR" 4
  75 .PD 0
  76 .IP "\fB\-\-output-file\fR=\fIFILENAME\fR" 4
  77 .PD
  78 Manually specify output \fIFILENAME\fR after merging old translation with
  79 PO template. Useful either with
  80 .BR \-d / \-\-dist
  81 option or without any option.
  82 .IP "\fB\-x\fR" 4
  83 .PD 0
  84 .IP "\fB\-\-verbose\fR" 4
  85 .PD
  86 Display lots of feedback.
  87 .IP "\fB\-\-version\fR" 4
  88 Show version information.
  89 .IP "\fB\-\-help\fR" 4
  90 Show usage and basic help information.
  91
  92 .SH EXAMPLES
  93 Creates a new PO template from source code, and name it foo.pot:
  94 .PP
  95 .RS 2
  96 .nf
  97 .ft CW
  98 .ne 1
  99 intltool-update \-\-pot \-\-gettext-package=foo
 100 .ft R
 101 .fi
 102 .RE
 103 .PP
 104 Updates translation file xy.po using existing po template called
 105 "bar.pot", and writes output into "xy1.po":
 106 .PP
 107 .RS 2
 108 .nf
 109 .ft CW
 110 .ne 1
 111 intltool-update \-\-dist \-\-gettext-package=bar \-\-output-file=xy1.po xy
 112 .ft R
 113 .fi
 114 .RE
 115 .PP
 116 Creates new PO template and updates translation file xy.po
 117 (xy.po is overwritten with new content):
 118 .PP
 119 .RS 2
 120 .nf
 121 .ft CW
 122 .ne 1
 123 intltool-update xy
 124 .ft R
 125 .fi
 126 (same as \fBintltool-update \-\-pot && intltool-update \-\-dist xy\fR)
 127 .RE
 128
 129 .SH FILES
 130 .IP "\fBpo/POTFILES.in\fR"
 131 Contains list of source files which contain translatable strings,
 132 one file per line.
 133 .IP "\fBpo/POTFILES.skip\fR"
 134 .PD 0
 135 .IP "\fBpo/POTFILES.ignore\fR (obsolete)"
 136 .PD
 137 Contains list of source files which should be ignored when searching
 138 for translatable strings.
 139
 140 .SH REPORTING BUGS
 141 Report bugs to http://bugs.launchpad.net/intltool
 142
 143 .SH AUTHOR
 144 Darin Adler <darin@bentspoon.com>
 145 .br
 146 Kenneth Christiansen <kenneth@gnu.org>
 147 .br
 148 Maciej Stachowiak <mjs@eazel.com>
 149
 150 .SH SEE ALSO
 151 .BR intltoolize (8),
 152 .BR intltool-prepare (8),
 153 .BR intltool-extract (8),
 154 .BR intltool-merge (8),
 155 .BR xgettext (1)