1@c This file is part of the GNU gettext manual. 2@c Copyright (C) 1995-2019 Free Software Foundation, Inc. 3@c See the file gettext.texi for copying conditions. 4 5@pindex msgexec 6@cindex @code{msgexec} program, usage 7@example 8msgexec [@var{option}] @var{command} [@var{command-option}] 9@end example 10 11@cindex apply command to all translations in a catalog 12The @code{msgexec} program applies a command to all translations of a 13translation catalog. 14The @var{command} can be any program that reads a translation from standard 15input. It is invoked once for each translation. Its output becomes 16msgexec's output. @code{msgexec}'s return code is the maximum return code 17across all invocations. 18 19@cindex @code{xargs}, and output from @code{msgexec} 20A special builtin command called @samp{0} outputs the translation, followed 21by a null byte. The output of @samp{msgexec 0} is suitable as input for 22@samp{xargs -0}. 23 24@table @samp 25@item --newline 26@opindex --newline@r{, @code{msgfilter} option} 27Add newline at the end of each input line. 28 29@end table 30 31@vindex MSGEXEC_MSGCTXT@r{, environment variable} 32@vindex MSGEXEC_MSGID@r{, environment variable} 33@vindex MSGEXEC_MSGID_PLURAL@r{, environment variable} 34@vindex MSGEXEC_LOCATION@r{, environment variable} 35@vindex MSGEXEC_PLURAL_FORM@r{, environment variable} 36@vindex MSGEXEC_PREV_MSGCTXT@r{, environment variable} 37@vindex MSGEXEC_PREV_MSGID@r{, environment variable} 38@vindex MSGEXEC_PREV_MSGID_PLURAL@r{, environment variable} 39During each @var{command} invocation, the environment variable 40@code{MSGEXEC_MSGID} is bound to the message's msgid, and the environment 41variable @code{MSGEXEC_LOCATION} is bound to the location in the PO file 42of the message. If the message has a context, the environment variable 43@code{MSGEXEC_MSGCTXT} is bound to the message's msgctxt, otherwise it is 44unbound. If the message has a plural form, environment variable 45@code{MSGEXEC_MSGID_PLURAL} is bound to the message's msgid_plural and 46@code{MSGEXEC_PLURAL_FORM} is bound to the order number of the plural 47actually processed (starting with 0), otherwise both are unbound. 48If the message has a previous msgid (added by @code{msgmerge}), 49environment variable @code{MSGEXEC_PREV_MSGCTXT} is bound to the 50message's previous msgctxt, @code{MSGEXEC_PREV_MSGID} is bound to 51the previous msgid, and @code{MSGEXEC_PREV_MSGID_PLURAL} is bound to 52the previous msgid_plural. 53 54@cindex catalog encoding and @code{msgexec} output 55Note: It is your responsibility to ensure that the @var{command} can cope 56with input encoded in the translation catalog's encoding. If the 57@var{command} wants input in a particular encoding, you can in a first step 58convert the translation catalog to that encoding using the @samp{msgconv} 59program, before invoking @samp{msgexec}. If the @var{command} wants input 60in the locale's encoding, but you want to avoid the locale's encoding, then 61you can first convert the translation catalog to UTF-8 using the 62@samp{msgconv} program and then make @samp{msgexec} work in an UTF-8 63locale, by using the @code{LC_ALL} environment variable. 64 65@subsection Input file location 66 67@table @samp 68@item -i @var{inputfile} 69@itemx --input=@var{inputfile} 70@opindex -i@r{, @code{msgexec} option} 71@opindex --input@r{, @code{msgexec} option} 72Input PO file. 73 74@item -D @var{directory} 75@itemx --directory=@var{directory} 76@opindex -D@r{, @code{msgexec} option} 77@opindex --directory@r{, @code{msgexec} option} 78Add @var{directory} to the list of directories. Source files are 79searched relative to this list of directories. The resulting @file{.po} 80file will be written relative to the current directory, though. 81 82@end table 83 84If no @var{inputfile} is given or if it is @samp{-}, standard input is read. 85 86@subsection Input file syntax 87 88@table @samp 89@item -P 90@itemx --properties-input 91@opindex -P@r{, @code{msgexec} option} 92@opindex --properties-input@r{, @code{msgexec} option} 93Assume the input file is a Java ResourceBundle in Java @code{.properties} 94syntax, not in PO file syntax. 95 96@item --stringtable-input 97@opindex --stringtable-input@r{, @code{msgexec} option} 98Assume the input file is a NeXTstep/GNUstep localized resource file in 99@code{.strings} syntax, not in PO file syntax. 100 101@end table 102 103@subsection Informative output 104 105@table @samp 106@item -h 107@itemx --help 108@opindex -h@r{, @code{msgexec} option} 109@opindex --help@r{, @code{msgexec} option} 110Display this help and exit. 111 112@item -V 113@itemx --version 114@opindex -V@r{, @code{msgexec} option} 115@opindex --version@r{, @code{msgexec} option} 116Output version information and exit. 117 118@end table 119