Imported Upstream version 0.19.7
[platform/upstream/gettext.git] / gettext-tools / man / msggrep.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.24.
2 .TH MSGGREP "1" "December 2015" "GNU gettext-tools 0.19.7" GNU
3 .SH NAME
4 msggrep \- pattern matching on message catalog
5 .SH SYNOPSIS
6 .B msggrep
7 [\fIOPTION\fR] [\fIINPUTFILE\fR]
8 .SH DESCRIPTION
9 .\" Add any additional description here
10 .PP
11 Extracts all messages of a translation catalog that match a given pattern
12 or belong to some given source files.
13 .PP
14 Mandatory arguments to long options are mandatory for short options too.
15 .SS "Input file location:"
16 .TP
17 INPUTFILE
18 input PO file
19 .TP
20 \fB\-D\fR, \fB\-\-directory\fR=\fIDIRECTORY\fR
21 add DIRECTORY to list for input files search
22 .PP
23 If no input file is given or if it is -, standard input is read.
24 .SS "Output file location:"
25 .TP
26 \fB\-o\fR, \fB\-\-output\-file\fR=\fIFILE\fR
27 write output to specified file
28 .PP
29 The results are written to standard output if no output file is specified
30 or if it is -.
31 .SS "Message selection:"
32 .IP
33 [-N SOURCEFILE]... [-M DOMAINNAME]...
34 [-J MSGCTXT-PATTERN] [-K MSGID-PATTERN] [-T MSGSTR-PATTERN]
35 [-C COMMENT-PATTERN] [-X EXTRACTED-COMMENT-PATTERN]
36 .PP
37 A message is selected if it comes from one of the specified source files,
38 or if it comes from one of the specified domains,
39 or if \fB\-J\fR is given and its context (msgctxt) matches MSGCTXT-PATTERN,
40 or if \fB\-K\fR is given and its key (msgid or msgid_plural) matches MSGID-PATTERN,
41 or if \fB\-T\fR is given and its translation (msgstr) matches MSGSTR-PATTERN,
42 or if \fB\-C\fR is given and the translator's comment matches COMMENT-PATTERN,
43 or if \fB\-X\fR is given and the extracted comment matches EXTRACTED-COMMENT-PATTERN.
44 .PP
45 When more than one selection criterion is specified, the set of selected
46 messages is the union of the selected messages of each criterion.
47 .PP
48 MSGCTXT-PATTERN or MSGID-PATTERN or MSGSTR-PATTERN or COMMENT-PATTERN or
49 EXTRACTED-COMMENT-PATTERN syntax:
50 .IP
51 [-E | \fB\-F]\fR [-e PATTERN | \fB\-f\fR FILE]...
52 .PP
53 PATTERNs are basic regular expressions by default, or extended regular
54 expressions if \fB\-E\fR is given, or fixed strings if \fB\-F\fR is given.
55 .TP
56 \fB\-N\fR, \fB\-\-location\fR=\fISOURCEFILE\fR
57 select messages extracted from SOURCEFILE
58 .TP
59 \fB\-M\fR, \fB\-\-domain\fR=\fIDOMAINNAME\fR
60 select messages belonging to domain DOMAINNAME
61 .TP
62 \fB\-J\fR, \fB\-\-msgctxt\fR
63 start of patterns for the msgctxt
64 .TP
65 \fB\-K\fR, \fB\-\-msgid\fR
66 start of patterns for the msgid
67 .TP
68 \fB\-T\fR, \fB\-\-msgstr\fR
69 start of patterns for the msgstr
70 .TP
71 \fB\-C\fR, \fB\-\-comment\fR
72 start of patterns for the translator's comment
73 .TP
74 \fB\-X\fR, \fB\-\-extracted\-comment\fR
75 start of patterns for the extracted comment
76 .TP
77 \fB\-E\fR, \fB\-\-extended\-regexp\fR
78 PATTERN is an extended regular expression
79 .TP
80 \fB\-F\fR, \fB\-\-fixed\-strings\fR
81 PATTERN is a set of newline-separated strings
82 .TP
83 \fB\-e\fR, \fB\-\-regexp\fR=\fIPATTERN\fR
84 use PATTERN as a regular expression
85 .TP
86 \fB\-f\fR, \fB\-\-file\fR=\fIFILE\fR
87 obtain PATTERN from FILE
88 .TP
89 \fB\-i\fR, \fB\-\-ignore\-case\fR
90 ignore case distinctions
91 .TP
92 \fB\-v\fR, \fB\-\-invert\-match\fR
93 output only the messages that do not match any
94 selection criterion
95 .SS "Input file syntax:"
96 .TP
97 \fB\-P\fR, \fB\-\-properties\-input\fR
98 input file is in Java .properties syntax
99 .TP
100 \fB\-\-stringtable\-input\fR
101 input file is in NeXTstep/GNUstep .strings syntax
102 .SS "Output details:"
103 .TP
104 \fB\-\-color\fR
105 use colors and other text attributes always
106 .TP
107 \fB\-\-color\fR=\fIWHEN\fR
108 use colors and other text attributes if WHEN.
109 WHEN may be 'always', 'never', 'auto', or 'html'.
110 .TP
111 \fB\-\-style\fR=\fISTYLEFILE\fR
112 specify CSS style rule file for \fB\-\-color\fR
113 .TP
114 \fB\-\-no\-escape\fR
115 do not use C escapes in output (default)
116 .TP
117 \fB\-\-escape\fR
118 use C escapes in output, no extended chars
119 .TP
120 \fB\-\-force\-po\fR
121 write PO file even if empty
122 .TP
123 \fB\-\-indent\fR
124 indented output style
125 .TP
126 \fB\-\-no\-location\fR
127 suppress '#: filename:line' lines
128 .TP
129 \fB\-n\fR, \fB\-\-add\-location\fR
130 preserve '#: filename:line' lines (default)
131 .TP
132 \fB\-\-strict\fR
133 strict Uniforum output style
134 .TP
135 \fB\-p\fR, \fB\-\-properties\-output\fR
136 write out a Java .properties file
137 .TP
138 \fB\-\-stringtable\-output\fR
139 write out a NeXTstep/GNUstep .strings file
140 .TP
141 \fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
142 set output page width
143 .TP
144 \fB\-\-no\-wrap\fR
145 do not break long message lines, longer than
146 the output page width, into several lines
147 .TP
148 \fB\-\-sort\-output\fR
149 generate sorted output
150 .TP
151 \fB\-\-sort\-by\-file\fR
152 sort output by file location
153 .SS "Informative output:"
154 .TP
155 \fB\-h\fR, \fB\-\-help\fR
156 display this help and exit
157 .TP
158 \fB\-V\fR, \fB\-\-version\fR
159 output version information and exit
160 .SH AUTHOR
161 Written by Bruno Haible.
162 .SH "REPORTING BUGS"
163 Report bugs to <bug-gnu-gettext@gnu.org>.
164 .SH COPYRIGHT
165 Copyright \(co 2001-2010 Free Software Foundation, Inc.
166 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
167 .br
168 This is free software: you are free to change and redistribute it.
169 There is NO WARRANTY, to the extent permitted by law.
170 .SH "SEE ALSO"
171 The full documentation for
172 .B msggrep
173 is maintained as a Texinfo manual.  If the
174 .B info
175 and
176 .B msggrep
177 programs are properly installed at your site, the command
178 .IP
179 .B info msggrep
180 .PP
181 should give you access to the complete manual.