summaryrefslogtreecommitdiffstats
path: root/doc/refchan.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2023-05-19 13:35:19 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2023-05-19 13:35:19 (GMT)
commit5ef48eba53cf49267f12579de32cce1a74d85311 (patch)
tree9a2002f3e25c602875afd5744b98360208268e51 /doc/refchan.n
parentd6a3425ec6628898597b1e19cc23cd6899746fcf (diff)
downloadtcl-5ef48eba53cf49267f12579de32cce1a74d85311.zip
tcl-5ef48eba53cf49267f12579de32cce1a74d85311.tar.gz
tcl-5ef48eba53cf49267f12579de32cce1a74d85311.tar.bz2
Improve the synopsis of the refchan manpage so it helps users a bit
Diffstat (limited to 'doc/refchan.n')
-rw-r--r--doc/refchan.n15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/refchan.n b/doc/refchan.n
index ae900c5..94823c5 100644
--- a/doc/refchan.n
+++ b/doc/refchan.n
@@ -11,7 +11,20 @@
.SH NAME
refchan \- command handler API of reflected channels
.SH SYNOPSIS
-\fBcmdPrefix \fIoption\fR ?\fIarg arg ...\fR?
+.nf
+\fBchan create \fImode cmdPrefix\fR
+
+\fIcmdPrefix \fBblocking\fR \fIchannelId mode\fR
+\fIcmdPrefix \fBcget\fR \fIchannelId option\fR
+\fIcmdPrefix \fBcgetall\fR \fIchannelId\fR
+\fIcmdPrefix \fBconfigure\fR \fIchannelId option value\fR
+\fIcmdPrefix \fBfinalize\fR \fIchannelId\fR
+\fIcmdPrefix \fBinitialize\fR \fIchannelId mode\fR
+\fIcmdPrefix \fBread\fR \fIchannelId count\fR
+\fIcmdPrefix \fBseek\fR \fIchannelId offset base\fR
+\fIcmdPrefix \fBwatch\fR \fIchannelId eventspec\fR
+\fIcmdPrefix \fBwrite\fR \fIchannelId data\fR
+.fi
.BE
.SH DESCRIPTION
.PP