diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2023-05-19 14:15:18 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2023-05-19 14:15:18 (GMT) |
| commit | ed8816500efafbfe088d86c9fe5fe97862ac77c0 (patch) | |
| tree | 34c03669dc4850c7dd6871fb4e978011fc910df6 /doc/transchan.n | |
| parent | 5ef48eba53cf49267f12579de32cce1a74d85311 (diff) | |
| download | tcl-ed8816500efafbfe088d86c9fe5fe97862ac77c0.zip tcl-ed8816500efafbfe088d86c9fe5fe97862ac77c0.tar.gz tcl-ed8816500efafbfe088d86c9fe5fe97862ac77c0.tar.bz2 | |
Improve the synopsis of the transchan manpage so it helps users a bit
Diffstat (limited to 'doc/transchan.n')
| -rw-r--r-- | doc/transchan.n | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/transchan.n b/doc/transchan.n index 4da74f2..b9a0f21 100644 --- a/doc/transchan.n +++ b/doc/transchan.n @@ -11,7 +11,18 @@ .SH NAME transchan \- command handler API of channel transforms .SH SYNOPSIS -\fBcmdPrefix \fIoption\fR ?\fIarg arg ...\fR? +.nf +\fBchan push \fIchannelName cmdPrefix\fR + +\fIcmdPrefix \fBclear \fIhandle\fR +\fIcmdPrefix \fBdrain \fIhandle\fR +\fIcmdPrefix \fBfinalize \fIhandle\fR +\fIcmdPrefix \fBflush \fIhandle\fR +\fIcmdPrefix \fBinitialize \fIhandle mode\fR +\fIcmdPrefix \fBlimit? \fIhandle\fR +\fIcmdPrefix \fBread \fIhandle buffer\fR +\fIcmdPrefix \fBwrite \fIhandle buffer\fR +.fi .BE .SH DESCRIPTION .PP |