summaryrefslogtreecommitdiffstats
path: root/doc/msggrep.texi
blob: a9c48b288149f57c9d426546388fa8bd220f8430 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
@example
msggrep [@var{option}] [@var{inputfile}]
@end example

The @code{msggrep} program extracts all messages of a translation catalog
that match a given pattern or belong to some given source files.

@subsection Input file location

@table @samp
@item @var{inputfile}
Input PO file.

@item -D @var{directory}
@itemx --directory=@var{directory}
Add @var{directory} to the list of directories.  Source files are
searched relative to this list of directories.  The resulting @file{.po}
file will be written relative to the current directory, though.

@end table

If no @var{inputfile} is given or if it is @samp{-}, standard input is read.

@subsection Output file location

@table @samp
@item -o @var{file}
@itemx --output-file=@var{file}
Write output to specified file.

@end table

The results are written to standard output if no output file is specified
or if it is @samp{-}.

@subsection Message selection

@example
  [-N @var{sourcefile}]... [-M @var{domainname}]... [-K @var{msgid-pattern}] [-T @var{msgstr-pattern}]
@end example

A message is selected if
@itemize @bullet
@item it comes from one of the specified source files,
@item or if it comes from one of the specified domains,
@item or if @samp{-K} is given and its key (msgid or msgid_plural) matches
      @var{msgid-pattern},
@item or if @samp{-T} is given and its translation (msgstr) matches
      @var{msgstr-pattern}.
@end itemize

When more than one selection criterion is specified, the set of selected
messages is the union of the selected messages of each criterion.

@var{msgid-pattern} or @var{msgstr-pattern} syntax:
@example
  [-E | -F] [-e @var{pattern} | -f @var{file}]...
@end example
@var{pattern}s are basic regular expressions by default, or extended regular
expressions if -E is given, or fixed strings if -F is given.

@table @samp
@item -N @var{sourcefile}
@itemx --location=@var{sourcefile}
Select messages extracted from @var{sourcefile}.

@item -M @var{domainname}
@itemx --domain=@var{domainname}
Select messages belonging to domain @var{domainname}.

@item -K
@itemx --msgid
Start of patterns for the msgid.

@item -T
@itemx --msgstr
Start of patterns for the msgstr.

@item -E
@itemx --extended-regexp
Specify that @var{pattern} is an extended regular expression.

@item -F
@itemx --fixed-strings
Specify that @var{pattern} is a set of newline-separated strings.

@item -e @var{pattern}
@itemx --regexp=@var{pattern}
Use @var{pattern} as a regular expression.

@item -f @var{file}
@itemx --file=@var{file}
Obtain @var{pattern} from @var{file}.

@item -i
@itemx --ignore-case
Ignore case distinctions.

@end table

@subsection Output details

@c --no-escape and --escape omitted on purpose.  They are not useful.

@table @samp
@item --force-po
Always write an output file even if it contains no message.

@item --indent
Write the .po file using indented style.

@item --no-location
Do not write @samp{#: @var{filename}:@var{line}} lines.

@item --add-location
Generate @samp{#: @var{filename}:@var{line}} lines (default).

@item --strict
Write out a strict Uniforum conforming PO file.  Note that this
Uniforum format should be avoided because it doesn't support the
GNU extensions.

@item -w @var{number}
@itemx --width=@var{number}
Set the output page width.  Long strings in the output files will be
split across multiple lines in order to ensure that each line's width
(= number of screen columns) is less or equal to the given @var{number}.

@item --sort-output
Generate sorted output.  Note that using this option makes it much harder
for the translator to understand each message's context.

@item --sort-by-file
Sort output by file location.

@end table

@subsection Informative output

@table @samp
@item -h
@itemx --help
Display this help and exit.

@item -V
@itemx --version
Output version information and exit.

@end table