1[include common/trf_version.inc]
2[manpage_begin rs_ecc n [vset trf_version]]
3[titledesc "Reed-Solomon error correcting code"]
4[include common/trf_header.inc]
5[description]
6
7The command [cmd rs_ecc] provides a reed-solomon error correcting
8coder. The coder operates on blocks of 248 bytes each, therefore
9buffering 247 bytes.
10
11[para]
12[list_begin definitions]
13
14[call [cmd rs_ecc] [opt [arg options...]] [opt [arg data]]]
15
16[list_begin definitions]
17
18[lst_item "[option -mode] [const encode]|[const decode]"]
19
20This option has to be present and is always understood.
21
22[nl]
23
24For [term immediate] mode the argument value specifies the operation
25to use.  For an [term attached] encoding it specifies the operation to
26use for [emph writing]. Reading will automatically use the reverse
27operation.
28
29See section [sectref {IMMEDIATE versus ATTACHED}] for explanations of
30these two terms.
31
32[nl]
33
34Beyond the argument values listed above all unique abbreviations are
35recognized too.
36
37[nl]
38
39[const Encode] converts from arbitrary (most likely binary) data into
40a representation containing additional error correcting information,
41[const decode] does the reverse, and performs the error correction if
42necessary.
43
44[include common/options.inc]
45[list_end]
46[list_end]
47
48[include common/sections.inc]
49
50[see_also  trf-intro]
51[keywords {error correction} reed-solomon]
52[manpage_end]
53