From ed8816500efafbfe088d86c9fe5fe97862ac77c0 Mon Sep 17 00:00:00 2001 From: dkf Date: Fri, 19 May 2023 14:15:18 +0000 Subject: Improve the synopsis of the transchan manpage so it helps users a bit --- doc/transchan.n | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) 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 -- cgit v0.12