aboutsummaryrefslogtreecommitdiff
path: root/doc/wyslij-po.texi
blob: 32edb56e675edcb579576595249af85603654250 (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename wyslij-po.info
@settitle Wyslij-po Manual
@c %**end of header
@setchapternewpage odd

@defcodeindex pr
@defcodeindex op

@syncodeindex op cp
@syncodeindex pr cp

@include version.texi
@include values.texi

@macro xopindex{option,text}
@opindex \option\, --\option\ @r{option, \text\}
@end macro

@macro opsummary{option}
@ifclear ANCHOR--\option\
@set ANCHOR--\option\ 1
@anchor{--\option\}
@end ifclear
@xopindex{\option\, summary}
@end macro

@ifinfo
@dircategory Translator Tools
@direntry
* wyslij-po: (wyslij-po).   Submit PO files to the Translation Project.
@end direntry
@end ifinfo

@copying
Copyright @copyright{} 2007-2021 Sergey Poznyakoff

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``Wyslij-po Manual'',
and with the Back-Cover Texts as in (a) below. A copy of the license
is included in the section entitled ``GNU Free Documentation License''.

(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
this Manual, like GNU software. Help the software be free.''
@end copying

@titlepage
@title Wyslij-po Manual
@subtitle version @value{VERSION}, @value{UPDATED}
@author Sergey Poznyakoff.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@ifnothtml
@page
@summarycontents
@page
@end ifnothtml
@contents

@node Top, Intro, (dir), (dir)

@ifinfo
@chapter Wyslij-po 
This edition of the @cite{Wyslij-po Manual}, last updated @value{UPDATED},
documents Wyslij-po Version @value{VERSION}.
@end ifinfo

@menu
* Intro::               Introduction to Wyslij-po.
* Submit::              Submitting Translations.
* Dry-run::             Debugging, Verbose Output and Dry-run Mode.
* Config::              Configuration Files.
* Langtab::             Language Tables.
* Reporting Bugs::      How to Report a Bug.

Appendices

* Build::               How to build the package.
* Invoke::              Invocation summary.
* Copying This Manual:: The GNU Free Documentation License.
* Concept Index::       Index of Concepts.

@detailmenu
 --- The Detailed Node Listing ---

Submitting Translations.

* Verification::
* Message::
* Sending::

@end detailmenu
@end menu

@node Intro, Submit, Top, Top
@chapter Introduction to Wyslij-po
@cindex wyslij-po
@cindex Internationalization
@cindex i18n
@cindex Localization
@cindex l18n
  It is a common practice for a program to be documented and to
produce its diagnostics in English. Whether this practice is good or
bad is a topic of a separate discussion. However it is, the waste
majority of us would prefer their computer to speak our native
language instead. This goal is already achieved for many free software
programs, and is going to be achieved for still more of them using the
methods called @dfn{internationalization} and @dfn{localization}. These
terms are often written abbreviated as @dfn{i18n} and @dfn{l10n},
correspondingly. In short, @dfn{i18n} consists in modifying a program
in such a way that, while still producing its output in English, it
would allow this output to be translated to any given language on the
fly. Similarly, @dfn{l10n} consists in supplying an already
internationalized program enough information for it to be able to
translate its output to a particular language. Both terms are
discussed in further detail in @ref{Concepts, I18n, I18n, gettext, GNU
gettext manual}.

@cindex @acronym{PO} file
  While internationalization is usually taken care of by programmers,
localization is the responsibility of translators. Usually this
process consists of creating a special file, called @dfn{@acronym{PO} file},
which is basically a table of all the messages a given program ever
issues, which, for each such message, lists its translation (or
translations) to a given language (@pxref{PO Files, The Format of PO
Files, PO Files, gettext, GNU gettext manual}).

@cindex Translation Project
@cindex @acronym{TP}
  When a translator finishes a given @acronym{PO} file, he submits it via
electronic mail to the @dfn{free Translation Project}
(@uref{@value{TPURL}}), or @acronym{TP} for short,
which acts as a repository for the existing translations. It is from
the Translation Project that maintainers download @acronym{PO} files for
inclusion into their project while preparing them for the release.

  There are several ways to submit a translation. First, it can, of
course, be submitted manually. Secondly, you can use @kbd{M}
(@code{po-send-mail}) command in GNU Emacs @dfn{po-mode}
(@pxref{PO Files, The Format of PO
Files, PO Files, gettext, GNU gettext manual}). 
Finally, you can use some specialized program to do that. 

@cindex wyslij-po
  If you select the last possibility, @command{wyslij-po} is for you.
It is a specialized program which verifies @acronym{PO} files and
submits them to the @acronym{TP}.  

  The program name@footnote{It should more properly have been written
@samp{wy@'slij-po}.} means @samp{send-po} in Polish and is
pronounced roughly like @samp{vishleey-po}.  

@cindex GNU Mailutils
@cindex Mailutils
  The program is built using @uref{http://www.gnu.org/software/mailutils,
GNU Mailutils} --- a powerful collection of libraries and utilities
for handling electronic mail. 
  
@node Submit, Dry-run, Intro, Top
@chapter Submitting Translations.

  To submit one or several @acronym{PO} files, simply give them as
arguments to @command{wyslij-po} in the command line, like this:

@example
$ wyslij-po pl.po uk.po bg.po
@end example

  For each file, specified in the command line, the utility will do
the following steps:

@enumerate 1
@item Retrieve @acronym{PO} headers
@cindex @acronym{PO} headers

@acronym{PO} headers contain important information about the
translation. These headers are stored in the first entry of each
@acronym{PO} file. 

@item Restore canonical @acronym{PO} name.
@anchor{canonical-name}

A canonical @acronym{PO} name consists of the project name and
version, separated by dash, which are followed by a dot, the language
code as per @acronym{ISO} 639, and the suffix @samp{.po}. To determine the
canonical name, @command{wyslij-po} uses the contents of
@code{Project-Id-Version} and @code{Language-Team} @acronym{PO}
headers. The value of @code{Project-Id-Version} supplies the name and
version of the project this file is for, and the value of
@code{Language-Team} gives the full name of the language served by
this @acronym{PO}. This full name is then looked up in a @dfn{language
table} - a special file listing for each language name its @acronym{ISO} 639
code (@pxref{Langtab}), and the code found is then used. For example,
if the two headers in question were:

@example
Project-Id-Version: cflow 1.2
Language-Team: Polish 
       <translation-team-pl@@lists.sourceforge.net>
@end example

@noindent
then the canonical name for that file is @file{cflow-1.2.pl.po}.

@item Verify the consistency of @acronym{PO} file.

This step ensures that the file corresponds to the latest version of
the package in question and that it does not contain obvious
formatting errors. For the detailed description of the checks
performed, see @ref{Verification}, below.

@item Form the message to be submitted.

The message is a @acronym{MIME} 1.0 message, whose body contains the
compressed @acronym{PO} file, and the headers contain the necessary
registration information (@pxref{Message}).

@item Send the message.

@xref{Sending}, below.
@end enumerate

The following sections describe each step in detail.

@menu
* Verification::
* Message::
* Sending::
@end menu

@node Verification
@section Verification
@cindex @acronym{PO} verification
@cindex Verification of @acronym{PO} files
 Before constructing a submission message, @command{wyslij-po} first
verifies if the @acronym{PO} file in question matches several
important conditions. It is done in order to reduce the unwanted
traffic and the impact on the @acronym{TP} mail server and robot.

 As of version @value{VERSION}, the following tests are implemented:

@enumerate 1
@item @acronym{PO} revision date.

 The values of the @acronym{PO} headers @code{PO-Revision-Date} and
@code{POT-Creation-Date} are compared. If @code{POT-Creation-Date} is
after @code{PO-Revision-Date}, the @acronym{PO} file is obviously
outdated and therefore it is not submitted. 

 This test is controlled by the following command line options:
 
@table @option
@item --verify-po-time
Verify @acronym{PO} modification time (default).

@item --no-verify-po-time
Disable @acronym{PO} modification time verification.
@end table

 In configuration file, this test is controlled by the
@code{verify-po-time} boolean statement (@pxref{Config, verify-po-time}).

@item Package version

 This test verifies if this @acronym{PO} file is created for 
the latest version of the package available. To verify this the following 
algorithm is used. First, the @dfn{textual domain url} is built using the 
following schema:

@example
@value{TPDOMAINURL}
@end example

@noindent
where @code{@value{DOMAINVAR}} is replaced with the project name
obtained from the @code{Project-Id-Version} @acronym{PO} header.

Then, the contents of this page is retrieved, and the following
extended @dfn{regular expression} is executed over it:

@example
The current template for this domain is <a href=".[^"]*/(.[^"]*)">
@end example

If the expression matches, the value of the first parenthesized
subexpression is retrieved, the optional @samp{.pot} suffix is removed
from it and the result is compared with the value of
@code{Project-Id-Version} @acronym{PO} header, converted as described
in @ref{canonical-name}. The two strings must be equal in order for
the test to succeed.

 This test is controlled by the following command line options:
 
@table @option
@item --verify-version
Enable package version verification (default).

@item --no-verify-version
Disable package version verification.
@end table

 In configuration file, this test is controlled by the
@code{verify-version} boolean statement (@pxref{Config, verify-version}).

 Two configuration file statements are provided for tuning this test.
The @code{tp-url} statement changes the textual domain template (@pxref{Config,
tp-url}) and the @code{pot-regex} statement changes the regular
expression (@pxref{Config, pot-regex}).
@end enumerate

@node Message
@section Message

  The minimal message headers are:

@example
From: @var{sender}
To: @var{robot-address}
Subject: TP-Robot @var{canonical-name}
X-Mailer: wyslij-po @value{VERSION}
@end example

  Where:

@table @var
@item sender
 The email of the sender. Unless otherwise specified, it is
constructed by concatenating the actual user name, a @samp{@@} sign,
and the host name of the local host.

@xopindex{from, described}
 This value can be set explicitly using @option{--from} (@option{-F})
command line option. When used without additional arguments, as in:

@example
$ wyslij-po -F pl.po
@end example

@noindent
this option instructs @command{wyslij-po} to extract sender name
from the value of @code{Last-Translator} @acronym{PO} header. This is
equivalent to setting @code{from-po true} in the configuration file
(@pxref{Config, from-po}). 

 This option can also be used with an explicit argument, which
specifies the email to be used as a sender address. It is important to
remember that when the short option form is used, this argument must
follow the option letter immediately, without any intervening whitespace.
If the long option form is used, this argument must be delimited from
the option name by an equals sign with no extra whitespace on either
side of it. The following invocations illustrate this:

@example
wyslij-po -Ftrans@@gnu.org.ua
wyslij-po --from=trans@@gnu.org.ua
@end example

 This can be requested in configuration file by using @code{from}
statement (@pxref{Config, from}).

@item robot-address
@xopindex{to,described}
 The email of the @acronym{TP} robot. By default it is:

@example
@value{TPROBOT}
@end example

 It can be changed using @option{--to} (@option{-t}) command line
option, or @code{to} configuration statement (@pxref{Config, to}).

@item canonical-name
The canonical name of the @acronym{PO} file. It is determined as
described in @ref{canonical-name}.
@end table

@xopindex{cc,described}
 Additionally, you can require the message to be copied to any number
of emails by using @option{--cc} command line option or @code{cc}
configuration statement. In both cases, the argument is a string
containing a comma-separated list of valid email addresses, as in:

@example
$ wyslij-po --cc "tp-keeper@@dom.ain,root@@remote.org"
@end example

@xopindex{bcc,described}
 If you wish to make those additional addresses invisible, use
@option{--bcc} command line option (or @code{bcc} configuration
statement) instead.
 
@xopindex{fcc,described}
 The @option{--fcc} option specifies the folder to store the copy of
the message into. Its argument is any @dfn{mailbox @acronym{URL}}
supported by Mailutils (@pxref{URL, URL, URL, mailutils, GNU Mailutils
Manual}). For example, the following option will place copies of the
@acronym{PO} files in the @acronym{MH} folder @file{Mail/sent}:

@example
$ wyslij-po --fcc mh://Mail/sent
@end example

 In configuration file, this is done via the @code{fcc} 
statement (@pxref{Config, fcc}).

@anchor{gzip}
@cindex gzip
@xopindex{gzip, described}
@xopindex{compress, described}
 The @acronym{PO} file contents is by default sent in compressed
form. To produce it, @command{gzip} program is used (@pxref{Overview,
Overview, , gzip, Gzip Manual}). Notice, that the @command{gzip}
binary must be in your @env{PATH}, otherwise @command{wyslij-po}
won't be able to find it. You can specify the full path to the
binary and/or supply any additional options by using the
@option{--gzip} (@option{--compress}) command line option.
For example, to use @file{/usr/bin/gzip} with the highest possible
compression level, use:

@example
$ wyslij-po --gzip "/usr/bin/gzip -c --best"
@end example

 Use @code{compress} statement to set the compression command from the
configuration file (@pxref{Config, compress}).

 Notice, that when setting compression command (either from command line
or from configuration file), @emph{you must always include
@option{-c} option in the @command{gzip} command line}.
 
 Yet another way to supply additional arguments to @command{gzip} is
by using @env{GZIP} environment variable (@pxref{Environment,
Environment, Environment, gzip, Gzip Manual}).

@node Sending
@section Sending
@cindex sending messages
@cindex mailer
  As any mailutils-based program, @command{wyslij-po} uses a special
logical entity called @dfn{mailer} in order to actually submit
messages. By default it uses the MTA facilities of the machine it runs
on, so you usually don't have to explicitly specify which mailer to
use. There may, however, be some cases when this becomes necessary.
This section describes how to do so.
  
@cindex @acronym{URL}, mailer
@cindex mailer @acronym{URL}
  A mailer is specified by its @dfn{@acronym{URL}}. An @acronym{URL}
begins with a protocol specification. Two protocol specifications are
currently supported: @samp{sendmail} and @samp{smtp}. The former
means to use a @command{sendmail}-compatible program to send mails.
Such a program must be able to read mail from its standard input and
must support the following options:

@table @option
@item -oi
Do not treat '.' as message terminator.

@item -f @var{addr}
Use @var{addr} as the address of the sender.

@item -t
Get recipient addresses from the message.
@end table

These conditions are met by most existing @acronym{MTA} programs, such
as @command{exim} or @command{postfix} (to say nothing of
@command{sendmail} itself).

Following the protocol specification is the @dfn{mailer location}, which
is separated from it with a colon. For the @samp{sendmail} protocol,
the mailer location sets the full file name of the sendmail-compatible
@acronym{MTA} binary, for example:

@example
sendmail:/usr/sbin/sendmail
@end example

A special form of a sendmail @acronym{URL}, consisting of protocol
specification only (@samp{sendmail:}) is also allowed. It means
``use the sendmail binary from the @code{_PATH_SENDMAIL}
macro in your @file{/usr/include/paths.h} file''. This is the default
mailer. 

The @samp{smtp} protocol means to use an @acronym{SMTP} server directly.
In this case the mailer location consists of two slashes,
followed by the @acronym{IP} address or host name of the @acronym{SMTP}
server, and, optionally, the port number. If the port number is
present, it is separated from the rest of @acronym{URL} by a colon.
For example: 

@example
@group
smtp://remote.server.net
smtp://remote.server.net:24
@end group
@end example

@xopindex{mailer, described}
The @acronym{URL} of the mailer to use is set using @option{--mailer}
(@option{-M}) command line option. For example:

@example
$ wyslij-po --mailer=smtp://127.0.0.1 pl.po
@end example

An alternative way is to set it in the configuration file, using
@code{mailer} statement (@pxref{Mailer Statement,
Mailer Statement,, mailutils, GNU Mailutils Manual}).

As an example of a rather extreme approach, here is how to deliver
mails directly to the @acronym{TP} mail server:

@example
$ wyslij-po --mailer=smtp://mail.vrijschrift.org @dots{}
@end example

@node Dry-run, Config, Submit, Top
@chapter Debugging, Verbose Output and Dry-run Mode.

  Usually @command{wyslij-po} operates silently. It issues a
diagnostics only if something serious has happened (an error, for
example). You may wish to change this behavior in order to trace the
progress of the submission.

@xopindex{verbose, described}
  The @option{--verbose} command line option instructs the program to
increase its verbosity level. Each occurrence of this option in the
command line raises the level by one, so to get the verbosity level 3
you would type:

@example
$ wyslij-po -vvv @dots{}
@end example

  The bigger the level, the more information will be produced on the
output.

  Here is an example of the output produced in level 1:

@example
$ wyslij-po -v pl.po  
pl.po: cflow-1.2.pl.po

Message headers:
Content-transfer-encoding: base64
Content-Type: application/x-gzip; name="cflow-1.2.pl.po.gz"
MIME-Version: 1.0
From: trans@@gnu.org.ua
To: @value{TPROBOT}
Subject: TP-Robot cflow-1.2.pl.po
X-Mailer: wyslij-po @value{VERSION}

@end example

  Here, the first line shows the input file name and the corresponding
canonical @acronym{PO} name for it. The remaining lines show
@acronym{RFC} 2822 message headers.

  The verbosity level 2 shows additional information about the progress:

@example
$ wyslij-po -vv pl.po
Sourcing language table `./wyslij-po.lc'
Restoring canonical file name for `pl.po'
Verifying POT file version for `mailutils'
Verifying creation vs. revision date
pl.po: cflow-1.2.pl.po
executing gzip -c pl.po...

Message headers:
Content-transfer-encoding: base64
Content-Type: application/x-gzip; name="cflow-1.2.pl.po.gz"
MIME-Version: 1.0
From: trans@@gnu.org.ua
To: @value{TPROBOT}
Subject: TP-Robot cflow-1.2.pl.po
X-Mailer: wyslij-po @value{VERSION}

Submitting pl.po
@end example

  The levels 3 and 4 print lots of information concerning actual
@acronym{SMTP} transaction. These are mainly useful for debugging.  

@xopindex{dry-run, described}
  It is often desirable to know what @command{wyslij-po} would do,
without actually sending translations. The special command line option
@option{--dry-run} (@option{-n}) is designed for this purpose. When
this option is given, @command{wyslij-po} will do all its usual
processing, except for actually sending the result. This option
automatically sets verbose level to 1 (of course you can push it
higher by supplying additional @option{-v} options along with
@option{--dry-run}): 

@example
$ wyslij-po --dry-run pl.po  
pl.po: cflow-1.2.pl.po

Message headers:
Content-transfer-encoding: base64
Content-Type: application/x-gzip; name="cflow-1.2.pl.po.gz"
MIME-Version: 1.0
From: trans@@gnu.org.ua
To: @value{TPROBOT}
Subject: TP-Robot cflow-1.2.pl.po
X-Mailer: wyslij-po @value{VERSION}

NOT submitting
@end example
   
@node Config, Langtab, Dry-run, Top
@chapter Configuration Files.
@cindex configuration file
  If you have a set of commonly used @command{wyslij-po} options, it
is convenient to keep them in a configuration file, instead of typing
them again each time you invoke the program. @command{Wyslij-po} uses
the Mailutils concept of configuration files, which is described in
detail in @ref{configuration, Mailutils Configuration File, ,
mailutils, GNU Mailutils Manual}. 

  There are two possible locations for the @command{wyslij-po}
configuration. System-wide configuration is kept in the main
configuration file (@pxref{configuration, Main site-wide configuration
file,, mailutils, GNU Mailutils Manual}), in section @code{program
wyslij-po}, or in the file named @file{wyslij-po} in the configuration
include directory, if the @code{include} statement is used
(@pxref{Include, Include Statement,, mailutils, GNU Mailutils
Manual}). Per-user configuration is kept in file @file{~/.wyslij-po}.

  To set default mailer (similar to @option{--mailer} option,
@pxref{Sending, mailer}), use @code{mailer} statement, @xref{Mailer Statement,
Mailer Statement,, mailutils, GNU Mailutils Manual}.

@deffn {Configuration} compress @var{command}
Set command line of the utility used for file compression. For
example:

@example
compress "/usr/bin/bzip2 -c";
@end example

@xref{gzip}, for a detailed discussion of file compression.

See also @ref{Invoke, --compress}, for another way to set this value.
@end deffn

@deffn {Configuration} langtab @var{file}
Set the name of the language table file. @xref{Langtab}.
@end deffn

@deffn {Configuration} to @var{email}
Set @acronym{TP} robot (recipient) email address. @xref{Sending}.
@end deffn

@deffn {Configuration} cc @var{email}
Set emails of carbon copy recipients. @var{Email} may contain multiple
email addresses, separated by commas:

@example
cc "<tp@@localhost>,<bitbucket@@remote.tld>";
@end example

@noindent
Notice the use of quote characters.

See also @ref{Invoke, --cc}, for another way to set this value.
@end deffn

@deffn {Configuration} bcc @var{email}
Set emails of carbon copy recipients.

See also @ref{Invoke, --bcc}, for another way to set this value.
@end deffn

@deffn {Configuration} fcc @var{folder}
Store a copy of the sent message in the specified mail
folder. @var{Folder} can be any valid mailbox @acronym{URL}
(@pxref{URL, URL,, mailutils, GNU Mailutils Manual}). The following
example instructs @command{wyslij-po} to keep copies of the messages
it sends in a @acronym{MH} folder @samp{+po-out}:

@example
fcc "mh:~/Mail/po-out";
@end example
@end deffn

@deffn {Configuration} from @var{email}
Set sender e-mail address. @xref{Message}, for a detailed description.
See also @ref{Invoke, --from}, for another way to set this value.
@end deffn

@deffn {Configuration} from-po @var{bool}
Read sender e-mail address from the value of @code{Last-Translator}
@acronym{PO} header. It is equivalent to specifying the
@option{--from} (@option{-F}) command line option without argument.
@end deffn

@deffn {Configuration} verify-po-time @var{bool}
Controls whether to verify @acronym{PO} modification time before
sending the message.

@xref{Verification, revision date}, for a description of this test.
@end deffn

@deffn {Configuration} verify-version @var{string}
Controls whether to verify package version before
sending the message.

@xref{Verification, Package version}, for a description of this test.
@end deffn

@deffn {Configuration} tp-url @var{template}
Sets template for the textual domain
@acronym{URL}. @xref{Verification, textual domain url}, for a
description of its purpose.

@var{Template} must be a valid @acronym{HTTP} @acronym{URL}.
It must contain at least one occurrence of @value{DOMAINVAR}, which
will be replaced by the actual name of the textual domain. 
@end deffn

@deffn {Configuration} pot-regex @var{regex}
Set the regular expression matching the name of the last POT file for
the textual domain. @xref{Verification, regular expression}, for a
detailed description of its purposes.

@var{Regex} must be an @dfn{extended regular expression} (@pxref{Extended
regexps, Extended regular expressions, Extended regular expressions,
sed, GNU sed}) with exactly one parenthesized group.
@end deffn

@node Langtab, Reporting Bugs, Config, Top
@chapter Language Tables.
@cindex language code
  To recreate the canonical @acronym{PO} name (@pxref{canonical-name})
for a given translation, @command{wyslij-po} needs to know the
@dfn{language code} associated with this language. This information cannot
be obtained from @acronym{PO} file directly. Instead,
@command{wyslij-po} obtains the full language name 
from the @code{Language-Team} @acronym{PO} header, and then uses this
value as a look-up key in a set of @dfn{language tables}. If the key is
found, its value gives the language code.

@cindex language tables, format
  The language tables are stored in plain text files. Their format is
as follows:

@itemize @bullet
@item Empty lines are ignored.
@item Any lines whose first non-whitespace character is @samp{#} are
comments and are ignored as well.
@item Unless ignored by the above reasons, any line is split at the
whitespace. The first word in line gives the language code (usually
corresponding to @acronym{ISO} 639). The rest of words are re-composed
into a string, using a single horizontal space as a delimiter. This
string is then used as the full language name (the look-up key).
@end itemize

  For example, the following entry: 

@example
pt_BR Brazilian Portuguese
@end example

@noindent
means that when the string @samp{Brazilian Portuguese} is encountered
at the beginning of the @code{Language-Team} @acronym{PO} header, the
language code @samp{pt_BR} will be used.

@cindex language tables, files
  There are two language table files: a @dfn{system-wide} and a
@dfn{per-user} one.

  The system-wide language table is stored in file @file{wyslij-po.lc}
in your system configuration directory (by default it is
@file{/usr/local/etc}, but can be changed at compile time).

@xopindex{langtab, described}
  The per-user language table is read after the system-wide one. It is
located in the user's home directory and is named
@file{.wyslij-po.lc}. You can also supply another file name, using the
@option{--langtab} command line option, e.g. @option{--langtab=mytab.lc}.

  The contents of both files are concatenated and stored in a single
table.

  Notice that it is not an error if a language table file does not
exist. @command{Wyslij-po} will silently ignore non-existing
files. Therefore, if you get the similar error:

@example
wyslij-po: Unknown language: Bulgarian
@end example

you should make sure the right tables are read, by running
@command{wyslij-po} with the @option{-vv} (or, better yet,
@option{--dry-run --verbose}) command line option. In normal case, it
will at least read the site-wide language table, which will be reflected in
its output:

@example
$ wyslij-po --dry-run -v bg.po
Sourcing language table `/usr/local/etc/wyslij-po.lc'
Restoring canonical file name for `bg.po'
@end example

If it does not, make sure you install the table or supply its
alternate name using @option{--langtab}. Otherwise, inspect the table
and add an entry for the language in question.

  The package is shipped with a system wide configuration file built
using the data from @uref{@value{TPTEAMS}}, so most
of the time you won't have to edit it (unless, of course, new language
teams are added to the @acronym{TP})
  
@node Reporting Bugs, Build, Langtab, Top
@chapter How to Report a Bug

Email bug reports to @email{bug-wyslij-po@@gnu.org.ua}.

As the purpose of bug reporting is to improve software, please be sure
to include maximum information when reporting a bug. The information
needed is:

@itemize
@item Version of the package you are using.
@item Compilation options used when configuring the package.
@item Conditions under which the bug appears.
@end itemize

@node Build, Invoke, Reporting Bugs, Top
@appendix How to Build the Package
@cindex building @command{wyslij-po}
@cindex @command{wyslij-po}, building
  Building @command{wyslij-po} is quite straightforward:  

@enumerate 1
@item

Make sure you have installed the GNU Mailutils, version 2.0 or later.

@item

Run @code{./configure}

@item

Run @code{make}

@item

Run @code{make install}
@end enumerate

@node Invoke, Copying This Manual, Build, Top
@appendix Invocation Summary.
@cindex Command line options
@cindex Options, command line
  This appendix lists all @command{wyslij-po} command line options.
For each option are given a short description and a reference to the
part of this manual that fully describes it.

@table @option
@item --bcc=@var{email-list}
Set blind carbon-copy recipients (@pxref{Message}).

@item --cc=@var{email-list}
Set carbon-copy recipients (@pxref{Message}).

@item  --compress=@var{command}
@itemx --gzip=@var{command}
@opsummary{compress}
@opsummary{gzip}
Use this @var{command} for compression (@pxref{Message}).

@item --dry-run
@itemx -n
@opsummary{dry-run}
Do nothing, print what would have been done (@pxref{Dry-run}).

@item --fcc=@var{folder}
@opsummary{fcc}
Store copy of each message sent in the given folder.

@item --from[=@var{email}]         
@itemx -F@var{email}
@opsummary{from}
Set sender address (@pxref{Message}).

@item --help               
@itemx -?
@opsummary{help}
Give a short help summary

@item --langtab=@var{file}
@opsummary{langtab}
Set the name of the per-user language t