.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH MSGGREP "1" "December 2024" "GNU gettext-tools 0.23.1" "User Commands"
.SH NAME
msggrep \- pattern matching on message catalog
.SH SYNOPSIS
.B msggrep
[\fI\,OPTION\/\fR] [\fI\,INPUTFILE\/\fR]
.SH DESCRIPTION
.\" Add any additional description here
.PP
Extracts all messages of a translation catalog that match a given pattern
or belong to some given source files.
.PP
Mandatory arguments to long options are mandatory for short options too.
.SS "Input file location:"
.TP
INPUTFILE
input PO file
.TP
\fB\-D\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
add DIRECTORY to list for input files search
.PP
If no input file is given or if it is \-, standard input is read.
.SS "Output file location:"
.TP
\fB\-o\fR, \fB\-\-output\-file\fR=\fI\,FILE\/\fR
write output to specified file
.PP
The results are written to standard output if no output file is specified
or if it is \-.
.SS "Message selection:"
.IP
[\-N SOURCEFILE]... [\-M DOMAINNAME]...
[\-J MSGCTXT\-PATTERN] [\-K MSGID\-PATTERN] [\-T MSGSTR\-PATTERN]
[\-C COMMENT\-PATTERN] [\-X EXTRACTED\-COMMENT\-PATTERN]
.PP
A message is selected if it comes from one of the specified source files,
or if it comes from one of the specified domains,
or if \fB\-J\fR is given and its context (msgctxt) matches MSGCTXT\-PATTERN,
or if \fB\-K\fR is given and its key (msgid or msgid_plural) matches MSGID\-PATTERN,
or if \fB\-T\fR is given and its translation (msgstr) matches MSGSTR\-PATTERN,
or if \fB\-C\fR is given and the translator's comment matches COMMENT\-PATTERN,
or if \fB\-X\fR is given and the extracted comment matches EXTRACTED\-COMMENT\-PATTERN.
.PP
When more than one selection criterion is specified, the set of selected
messages is the union of the selected messages of each criterion.
.PP
MSGCTXT\-PATTERN or MSGID\-PATTERN or MSGSTR\-PATTERN or COMMENT\-PATTERN or
EXTRACTED\-COMMENT\-PATTERN syntax:
.IP
[\-E | \fB\-F]\fR [\-e PATTERN | \fB\-f\fR FILE]...
.PP
PATTERNs are basic regular expressions by default, or extended regular
expressions if \fB\-E\fR is given, or fixed strings if \fB\-F\fR is given.
.TP
\fB\-N\fR, \fB\-\-location\fR=\fI\,SOURCEFILE\/\fR
select messages extracted from SOURCEFILE
.TP
\fB\-M\fR, \fB\-\-domain\fR=\fI\,DOMAINNAME\/\fR
select messages belonging to domain DOMAINNAME
.TP
\fB\-J\fR, \fB\-\-msgctxt\fR
start of patterns for the msgctxt
.TP
\fB\-K\fR, \fB\-\-msgid\fR
start of patterns for the msgid
.TP
\fB\-T\fR, \fB\-\-msgstr\fR
start of patterns for the msgstr
.TP
\fB\-C\fR, \fB\-\-comment\fR
start of patterns for the translator's comment
.TP
\fB\-X\fR, \fB\-\-extracted\-comment\fR
start of patterns for the extracted comment
.TP
\fB\-E\fR, \fB\-\-extended\-regexp\fR
PATTERN is an extended regular expression
.TP
\fB\-F\fR, \fB\-\-fixed\-strings\fR
PATTERN is a set of newline\-separated strings
.TP
\fB\-e\fR, \fB\-\-regexp\fR=\fI\,PATTERN\/\fR
use PATTERN as a regular expression
.TP
\fB\-f\fR, \fB\-\-file\fR=\fI\,FILE\/\fR
obtain PATTERN from FILE
.TP
\fB\-i\fR, \fB\-\-ignore\-case\fR
ignore case distinctions
.TP
\fB\-v\fR, \fB\-\-invert\-match\fR
output only the messages that do not match any
selection criterion
.SS "Input file syntax:"
.TP
\fB\-P\fR, \fB\-\-properties\-input\fR
input file is in Java .properties syntax
.TP
\fB\-\-stringtable\-input\fR
input file is in NeXTstep/GNUstep .strings syntax
.SS "Output details:"
.TP
\fB\-\-color\fR
use colors and other text attributes always
.TP
\fB\-\-color\fR=\fI\,WHEN\/\fR
use colors and other text attributes if WHEN.
WHEN may be 'always', 'never', 'auto', or 'html'.
.TP
\fB\-\-style\fR=\fI\,STYLEFILE\/\fR
specify CSS style rule file for \fB\-\-color\fR
.TP
\fB\-\-no\-escape\fR
do not use C escapes in output (default)
.TP
\fB\-\-escape\fR
use C escapes in output, no extended chars
.TP
\fB\-\-force\-po\fR
write PO file even if empty
.TP
\fB\-\-indent\fR
indented output style
.TP
\fB\-\-no\-location\fR
suppress '#: filename:line' lines
.TP
\fB\-n\fR, \fB\-\-add\-location\fR
preserve '#: filename:line' lines (default)
.TP
\fB\-\-strict\fR
strict Uniforum output style
.TP
\fB\-p\fR, \fB\-\-properties\-output\fR
write out a Java .properties file
.TP
\fB\-\-stringtable\-output\fR
write out a NeXTstep/GNUstep .strings file
.TP
\fB\-w\fR, \fB\-\-width\fR=\fI\,NUMBER\/\fR
set output page width
.TP
\fB\-\-no\-wrap\fR
do not break long message lines, longer than
the output page width, into several lines
.TP
\fB\-\-sort\-output\fR
generate sorted output
.TP
\fB\-\-sort\-by\-file\fR
sort output by file location
.SS "Informative output:"
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit
.TP
\fB\-V\fR, \fB\-\-version\fR
output version information and exit
.SH AUTHOR
Written by Bruno Haible.
.SH "REPORTING BUGS"
Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext>
or by email to <bug\-gettext@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2001\-2024 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The full documentation for
.B msggrep
is maintained as a Texinfo manual.  If the
.B info
and
.B msggrep
programs are properly installed at your site, the command
.IP
.B info msggrep
.PP
should give you access to the complete manual.