diff options
author | William Joye <wjoye@cfa.harvard.edu> | 2016-10-27 19:39:39 (GMT) |
---|---|---|
committer | William Joye <wjoye@cfa.harvard.edu> | 2016-10-27 19:39:39 (GMT) |
commit | ea28451286d3ea4a772fa174483f9a7a66bb1ab3 (patch) | |
tree | 6ee9d8a7848333a7ceeee3b13d492e40225f8b86 /tcllib/modules/virtchannel_base/nullzero.man | |
parent | b5ca09bae0d6a1edce939eea03594dd56383f2c8 (diff) | |
parent | 7c621da28f07e449ad90c387344f07a453927569 (diff) | |
download | blt-ea28451286d3ea4a772fa174483f9a7a66bb1ab3.zip blt-ea28451286d3ea4a772fa174483f9a7a66bb1ab3.tar.gz blt-ea28451286d3ea4a772fa174483f9a7a66bb1ab3.tar.bz2 |
Merge commit '7c621da28f07e449ad90c387344f07a453927569' as 'tcllib'
Diffstat (limited to 'tcllib/modules/virtchannel_base/nullzero.man')
-rw-r--r-- | tcllib/modules/virtchannel_base/nullzero.man | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/tcllib/modules/virtchannel_base/nullzero.man b/tcllib/modules/virtchannel_base/nullzero.man new file mode 100644 index 0000000..8eff277 --- /dev/null +++ b/tcllib/modules/virtchannel_base/nullzero.man @@ -0,0 +1,44 @@ +[comment {-*- tcl -*- doctools manpage}] +[manpage_begin tcl::chan::nullzero n 1] +[keywords /dev/null] +[keywords /dev/zero] +[keywords null] +[keywords {reflected channel}] +[keywords {tip 219}] +[keywords {virtual channel}] +[keywords zero] +[copyright {2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>}] +[moddesc {Reflected/virtual channel support}] +[category Channels] +[titledesc {Null/Zero channel combination}] +[require Tcl 8.5] +[require TclOO] +[require tcl::chan::events [opt 1]] +[require tcl::chan::nullzero [opt 1]] +[description] +[para] + +The [package tcl::chan::nullzero] package provides a command creating channels, +which are a combination of null and zero devices. They immediately forget +whatever is written to them, and on reading return an infinite stream of null +characters. + +[para] Packages related to this are [package tcl::chan::null] and +[package tcl::chan::zero]. + +[para] The internal [package TclOO] class implementing the channel handler +is a sub-class of the [package tcl::chan::events] framework. + +[section API] + +[list_begin definitions] + +[call [cmd ::tcl::chan::nullzero]] + +This command creates a new nullzero channel and returns its handle. + +[list_end] + +[vset CATEGORY virtchannel] +[include ../doctools2base/include/feedback.inc] +[manpage_end] |