File: options.inc

package info (click to toggle)
tcltrf 2.1.4-dfsg3-8
  • links: PTS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,656 kB
  • sloc: ansic: 73,139; sh: 3,155; tcl: 1,343; makefile: 182; exp: 22
file content (26 lines) | stat: -rw-r--r-- 734 bytes parent folder | download | duplicates (7)
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
[comment {-*- tcl -*- doctools = encoding_options.inc}]

[lst_item "[option -mode] [const encode]|[const decode]"]

This option has to be present and is always understood by the
encoding.

[nl]

For [term immediate] mode the argument value specifies the operation
to use.  For an [term attached] encoding it specifies the operation to
use for [emph writing]. Reading will automatically use the reverse
operation.

See section [sectref {IMMEDIATE versus ATTACHED}] for explanations of
these two terms.

[nl]

Beyond the argument values listed above all unique abbreviations are
recognized too.

[nl]

[const Encode] converts from arbitrary (most likely binary) data into
the described representation, [const decode] does the reverse .