Imported Upstream version 0.19.7
[platform/upstream/gettext.git] / gettext-tools / man / msgfilter.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.24.
2 .TH MSGFILTER "1" "December 2015" "GNU gettext-tools 0.19.7" GNU
3 .SH NAME
4 msgfilter \- edit translations of message catalog
5 .SH SYNOPSIS
6 .B msgfilter
7 [\fIOPTION\fR] \fIFILTER \fR[\fIFILTER-OPTION\fR]
8 .SH DESCRIPTION
9 .\" Add any additional description here
10 .PP
11 Applies a filter to all translations of a translation catalog.
12 .PP
13 Mandatory arguments to long options are mandatory for short options too.
14 .SS "Input file location:"
15 .TP
16 \fB\-i\fR, \fB\-\-input\fR=\fIINPUTFILE\fR
17 input PO file
18 .TP
19 \fB\-D\fR, \fB\-\-directory\fR=\fIDIRECTORY\fR
20 add DIRECTORY to list for input files search
21 .PP
22 If no input file is given or if it is -, standard input is read.
23 .SS "Output file location:"
24 .TP
25 \fB\-o\fR, \fB\-\-output\-file\fR=\fIFILE\fR
26 write output to specified file
27 .PP
28 The results are written to standard output if no output file is specified
29 or if it is -.
30 .PP
31 The FILTER can be any program that reads a translation from standard input
32 and writes a modified translation to standard output.
33 .SS "Filter input and output:"
34 .TP
35 \fB\-\-newline\fR
36 add a newline at the end of input and
37 remove a newline from the end of output
38 .SS "Useful FILTER-OPTIONs when the FILTER is 'sed':"
39 .TP
40 \fB\-e\fR, \fB\-\-expression\fR=\fISCRIPT\fR
41 add SCRIPT to the commands to be executed
42 .TP
43 \fB\-f\fR, \fB\-\-file\fR=\fISCRIPTFILE\fR
44 add the contents of SCRIPTFILE to the commands
45 to be executed
46 .TP
47 \fB\-n\fR, \fB\-\-quiet\fR, \fB\-\-silent\fR
48 suppress automatic printing of pattern space
49 .SS "Input file syntax:"
50 .TP
51 \fB\-P\fR, \fB\-\-properties\-input\fR
52 input file is in Java .properties syntax
53 .TP
54 \fB\-\-stringtable\-input\fR
55 input file is in NeXTstep/GNUstep .strings syntax
56 .SS "Output details:"
57 .TP
58 \fB\-\-color\fR
59 use colors and other text attributes always
60 .TP
61 \fB\-\-color\fR=\fIWHEN\fR
62 use colors and other text attributes if WHEN.
63 WHEN may be 'always', 'never', 'auto', or 'html'.
64 .TP
65 \fB\-\-style\fR=\fISTYLEFILE\fR
66 specify CSS style rule file for \fB\-\-color\fR
67 .TP
68 \fB\-\-no\-escape\fR
69 do not use C escapes in output (default)
70 .TP
71 \fB\-E\fR, \fB\-\-escape\fR
72 use C escapes in output, no extended chars
73 .TP
74 \fB\-\-force\-po\fR
75 write PO file even if empty
76 .TP
77 \fB\-\-indent\fR
78 indented output style
79 .TP
80 \fB\-\-keep\-header\fR
81 keep header entry unmodified, don't filter it
82 .TP
83 \fB\-\-no\-location\fR
84 suppress '#: filename:line' lines
85 .TP
86 \fB\-n\fR, \fB\-\-add\-location\fR
87 preserve '#: filename:line' lines (default)
88 .TP
89 \fB\-\-strict\fR
90 strict Uniforum output style
91 .TP
92 \fB\-p\fR, \fB\-\-properties\-output\fR
93 write out a Java .properties file
94 .TP
95 \fB\-\-stringtable\-output\fR
96 write out a NeXTstep/GNUstep .strings file
97 .TP
98 \fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
99 set output page width
100 .TP
101 \fB\-\-no\-wrap\fR
102 do not break long message lines, longer than
103 the output page width, into several lines
104 .TP
105 \fB\-s\fR, \fB\-\-sort\-output\fR
106 generate sorted output
107 .TP
108 \fB\-F\fR, \fB\-\-sort\-by\-file\fR
109 sort output by file location
110 .SS "Informative output:"
111 .TP
112 \fB\-h\fR, \fB\-\-help\fR
113 display this help and exit
114 .TP
115 \fB\-V\fR, \fB\-\-version\fR
116 output version information and exit
117 .SH AUTHOR
118 Written by Bruno Haible.
119 .SH "REPORTING BUGS"
120 Report bugs to <bug-gnu-gettext@gnu.org>.
121 .SH COPYRIGHT
122 Copyright \(co 2001-2010 Free Software Foundation, Inc.
123 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
124 .br
125 This is free software: you are free to change and redistribute it.
126 There is NO WARRANTY, to the extent permitted by law.
127 .SH "SEE ALSO"
128 The full documentation for
129 .B msgfilter
130 is maintained as a Texinfo manual.  If the
131 .B info
132 and
133 .B msgfilter
134 programs are properly installed at your site, the command
135 .IP
136 .B info msgfilter
137 .PP
138 should give you access to the complete manual.