diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-28 14:17:38 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-28 14:17:38 (GMT) |
| commit | ccacc920f9cd610a9a9d8e800f623c20bf43a702 (patch) | |
| tree | daec40c266097bb1d38f10254010691b0131d4cc /doc/CrtChannel.3 | |
| parent | 8ffb8fa76d0d34283e491044dd28385674ba113e (diff) | |
| download | tcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.zip tcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.tar.gz tcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.tar.bz2 | |
First stage of doing GOOBE improvements to documentation now that the html generation works
Diffstat (limited to 'doc/CrtChannel.3')
| -rw-r--r-- | doc/CrtChannel.3 | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index e7fb800..42c2cbd 100644 --- a/doc/CrtChannel.3 +++ b/doc/CrtChannel.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtChannel.3,v 1.37 2007/10/26 20:11:51 dgp Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.38 2007/10/28 14:17:38 dkf Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.4 Tcl "Tcl Library Procedures" .BS @@ -155,7 +155,8 @@ Current interpreter. (can be NULL) .AP "const char" *optionName in Name of the invalid option. .AP "const char" *optionList in -Specific options list (space separated words, without "-") +Specific options list (space separated words, without +.QW \- ) to append to the standard generic options list. Can be NULL for generic options error message only. @@ -850,7 +851,9 @@ These values can be retrieved with \fBTcl_ChannelTruncateProc\fR, which returns a pointer to the function. .SH TCL_BADCHANNELOPTION .PP -This procedure generates a "bad option" error message in an +This procedure generates a +.QW "bad option" +error message in an (optional) interpreter. It is used by channel drivers when an invalid Set/Get option is requested. Its purpose is to concatenate the generic options list to the specific ones and factorize @@ -871,12 +874,17 @@ so you get for instance: -buffering, -buffersize, -eofchar, -translation, -peername, or -sockname .CE -when called with \fIoptionList\fR="peername sockname" +when called with \fIoptionList\fR equal to +.QW "peername sockname" .PP -``blah'' is the \fIoptionName\fR argument and ``<specific options>'' +.QW blah +is the \fIoptionName\fR argument and +.QW "<specific options>" is a space separated list of specific option words. The function takes good care of inserting minus signs before -each option, commas after, and an ``or'' before the last option. +each option, commas after, and an +.QW or +before the last option. .SH "OLD CHANNEL TYPES" The original (8.3.1 and below) \fBTcl_ChannelType\fR structure contains the following fields: |