1[comment {-*- tcl -*- doctools}]
2[manpage_begin random n 2.2]
3[moddesc   {Memory channels}]
4[titledesc {Create and manipulate randomizer channels}]
5[copyright {2004 Pat Thoyts <patthoyts@users.sourceforge.net>}]
6[require Tcl]
7[require memchan]
8[description]
9
10[list_begin definitions]
11
12[call [cmd random]]
13
14creates a random channel which absorbs everything written into it and
15uses it as a seed for a random number generator. This generator is
16used to create a random sequence of bytes when reading from the
17channel. It is not possible to seek the channel.
18
19[list_end]
20
21[section OPTIONS]
22
23Memory channels created by [cmd random] provide one additional option to
24set or query.
25
26[list_begin definitions]
27
28    [lst_item [arg "-delay [opt milliseconds]"]]
29
30    A [cmd random] channel is always writable and readable. This means
31    that all [cmd fileevent]-handlers will fire continuously.  To
32    avoid starvation of other event sources the events raised by this
33    channel type have a configurable delay. This option is set in
34    milliseconds and defaults to 5.
35
36[list_end]
37
38[see_also memchan fifo fifo2 null zero]
39[keywords random {in-memory channel} channel i/o]
40[manpage_end]
41