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
|
<!-- Generated from file 'trf.man' by tcllib/doctools with format 'tmml' -->
<manpage id='trf' cat='cmd' title='trf-intro' version='2.1.3' package=''>
<head>
<info key='copyright' value='Copyright (c) 1996-2003, Andreas Kupries <andreas_kupries@users.sourceforge.net>'/>
</head>
<namesection>
<name>trf-intro</name>
<desc>Introduction to Trf</desc>
</namesection>
<synopsis>
<syntax>
package require <package>Tcl</package> <o>8.2</o>
package require <package>Trf</package> <o>2.1.3</o>
</syntax>
</synopsis>
<section id='section1'>
<title>DESCRIPTION</title>
The package <package>Trf</package> provides a number of commands which take
data and transform them in various ways.
</section>
<section id='section2'>
<title>BACKGROUND</title>
The implementation of Trf began as proof-of-concept of the validity
and usefulness of the "stacked channel" patches to the core. These
patches allow the writing of extensions to the generic I/O system of
the core which are able to intercept all read/write operations on
designated channels, thus giving it the ability to transform the data
flowing through these channels as desired.
<p>
This allows things like transparent encryption, compression, charset
recoding, etc.
</p>
<p>
Since version 8.2 of the tcl core the aforementioned patches are part
of the tcl core itself, changing the status of <package>trf</package> from
"extension requiring core patches" to "normal extension".
</p>
<p>
Other packages built upon either the stackd channels directly, or Trf
are:
</p>
<ol>
<li>
<package>TrfCrypt</package>, by myself, contains various encryption systems
</li>
<li>
<package>TLS</package>, an SSL/TLS implementation by Matt Newman.
</li>
<li>
<package>Tcl MIME</package> by Marshall Rose.
</li>
</ol>
</section>
<section id='section3'>
<title>API</title>
The commands provide by <package>trf</package> can be placed into the three
categories listed below. Note that all commands are added to the
global namespace.
<dl>
<dle>
<dt><term>Encodings</term></dt>
<dd>
The encoding commands either take some data and return the same data
in encoded form, or take encoded data and return a decoded result.
<ol>
<li>
<cmd>oct</cmd>
</li>
<li>
<cmd>hex</cmd>
</li>
<li>
<cmd>oct</cmd>
</li>
<li>
<cmd>base64</cmd>
</li>
<li>
<cmd>uuencode</cmd>
</li>
<li>
<cmd>ascii85</cmd>
</li>
<li>
<cmd>otp_words</cmd>
</li>
<li>
<cmd>quoted-printable</cmd>
</li>
</ol>
<br/>
</dd>
</dle>
<dle>
<dt><term>Message Digests</term></dt>
<dd>
The second category are message digests in general, simple ones like
<cmd>crc</cmd>, and cryptographically strong algorithms like <cmd>md5</cmd>.
<ol>
<li>
<cmd>crc-zlib</cmd>
</li>
<li>
<cmd>crc</cmd>
</li>
<li>
<cmd>adler</cmd>
</li>
<li>
<cmd>md2</cmd>
</li>
<li>
<cmd>md5</cmd>
</li>
<li>
<cmd>md5_otp</cmd>
</li>
<li>
<cmd>sha</cmd>
</li>
<li>
<cmd>sha1</cmd>
</li>
<li>
<cmd>sha1_otp</cmd>
</li>
<li>
<cmd>haval</cmd>
</li>
<li>
<cmd>ripemd-160</cmd>
</li>
<li>
<cmd>ripemd-128</cmd>
</li>
</ol>
<br/>
</dd>
</dle>
<dle>
<dt>Miscellaneous</dt>
<dd>
At last a number of commands not readily placed into categories
providing password crypting, general transformations, data
compression, error correction and others.
<ol>
<li>
<cmd>crypt</cmd>
</li>
<li>
<cmd>md5crypt</cmd>
</li>
<li>
<cmd>transform</cmd>
</li>
<li>
<cmd>rs_ecc</cmd>
</li>
<li>
<cmd>zip</cmd>
</li>
<li>
<cmd>bz2</cmd>
</li>
<li>
<cmd>unstack</cmd>
</li>
</ol>
</dd>
</dle>
</dl>
</section>
<seealso>
<ref>oct</ref>
<ref>hex</ref>
<ref>oct</ref>
<ref>base64</ref>
<ref>uuencode</ref>
<ref>ascii85</ref>
<ref>otp_words</ref>
<ref>quoted-printable</ref>
<ref>crc-zlib</ref>
<ref>crc</ref>
<ref>adler</ref>
<ref>md2</ref>
<ref>md5</ref>
<ref>md5_otp</ref>
<ref>sha</ref>
<ref>sha1</ref>
<ref>sha1_otp</ref>
<ref>haval</ref>
<ref>ripemd-160</ref>
<ref>ripemd-128</ref>
<ref>crypt</ref>
<ref>md5crypt</ref>
<ref>transform</ref>
<ref>rs_ecc</ref>
<ref>zip</ref>
<ref>bz2</ref>
</seealso>
<keywords>
<keyword>transformation</keyword>
<keyword>encoding</keyword>
<keyword>message digest</keyword>
<keyword>compression</keyword>
<keyword>error correction</keyword>
</keywords>
</manpage>
|
