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
|
[comment {-*- tcl -*- doctools manpage}]
[manpage_begin tcl::transform::hex n 1.1]
[keywords {channel transformation}]
[keywords hexadecimal]
[keywords {reflected channel}]
[keywords {tip 230}]
[keywords transformation]
[keywords {virtual channel}]
[copyright {2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
[moddesc {Reflected/virtual channel support}]
[category Channels]
[titledesc {Hexadecimal encoding transformation}]
[require Tcl "8.6 9"]
[require tcl::transform::core [opt 1.1]]
[require tcl::transform::hex [opt 1.1]]
[description]
[para]
The [package tcl::transform::hex] package provides a command creating
a channel transformation which hex encodes data written to it, and
decodes the data read from it.
[para] A related transformations in this module is
[package tcl::transform::base64].
[para] The internal [package TclOO] class implementing the transform
handler is a sub-class of the [package tcl::transform::core]
framework.
[section API]
[list_begin definitions]
[call [cmd ::tcl::transform::hex] [arg chan]]
This command creates a hex transformation on top of the channel
[arg chan] and returns its handle.
[list_end]
[vset CATEGORY virtchannel]
[include ../common-text/feedback.inc]
[manpage_end]
|