Merge commit '7c621da28f07e449ad90c387344f07a453927569' as 'tcllib'

1 files changed, 43 insertions, 0 deletions

diff --git a/tcllib/modules/virtchannel_base/tcllib_fifo.man b/tcllib/modules/virtchannel_base/tcllib_fifo.man
new file mode 100644
index 0000000..3b695bf
--- /dev/null
+++ b/tcllib/modules/virtchannel_base/tcllib_fifo.man
@@ -0,0 +1,43 @@
+[comment {-*- tcl -*- doctools manpage}]
+[manpage_begin tcl::chan::fifo n 1]
+[keywords fifo]
+[keywords {in-memory channel}]
+[keywords {reflected channel}]
+[keywords {tip 219}]
+[keywords {virtual channel}]
+[copyright {2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
+[moddesc   {Reflected/virtual channel support}]
+[category  Channels]
+[titledesc {In-memory fifo channel}]
+[require Tcl 8.5]
+[require TclOO]
+[require tcl::chan::events [opt 1]]
+[require tcl::chan::fifo [opt 1]]
+[description]
+[para]
+
+The [package tcl::chan::fifo] package provides a command creating
+channels which live purely in memory. Access is fifo-like, i.e. things
+are read out of the channel in the order they were written to it.
+
+This is equivalent to the fifo channels provided by the package
+[package Mmechan], except that this is written in pure Tcl, not C. On
+the other hand, [package Memchan] is usable with Tcl 8.4 and before,
+whereas this package requires Tcl 8.5 or higher, and [package TclOO].
+
+[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::fifo]]
+
+This command creates a new fifo channel and returns its handle.
+
+[list_end]
+
+[vset CATEGORY virtchannel]
+[include ../doctools2base/include/feedback.inc]
+[manpage_end]