Prepare Tcl's docs for life as 8.6 (remove out of date change bars, fix

typedefs, add a few missing bits)

1 files changed, 2 insertions, 32 deletions

diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3
index 59dfeaf..e9d1137 100644
--- a/doc/OpenFileChnl.3
+++ b/doc/OpenFileChnl.3
@@ -4,7 +4,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\"
-'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.36 2007/12/13 15:22:31 dgp Exp $
+'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.37 2008/06/29 22:28:24 dkf Exp $
 .so man.macros
 .TH Tcl_OpenFileChannel 3 8.3 Tcl "Tcl Library Procedures"
 .BS
@@ -99,10 +99,8 @@ Tcl_WideInt
 Tcl_WideInt
 \fBTcl_Tell\fR(\fIchannel\fR)
 .sp
-.VS 8.5
 int
 \fBTcl_TruncateChannel\fR(\fIchannel, length\fR)
-.VE 8.5
 .sp
 int
 \fBTcl_GetChannelOption\fR(\fIinterp, channel, optionName, optionValue\fR)
@@ -212,7 +210,6 @@ values. Must have been initialized by the caller.
 .AP "const char" *newValue in
 New value for the option given by \fIoptionName\fR.
 .BE
-
 .SH DESCRIPTION
 .PP
 The Tcl channel mechanism provides a device-independent and
@@ -230,7 +227,6 @@ The procedures described in this manual entry comprise the C APIs of the
 generic layer of the channel architecture. For a description of the channel
 driver architecture and how to implement channel drivers for new types of
 channels, see the manual entry for \fBTcl_CreateChannel\fR.
-
 .SH TCL_OPENFILECHANNEL
 .PP
 \fBTcl_OpenFileChannel\fR opens a file specified by \fIfileName\fR and
@@ -252,7 +248,6 @@ register it, use \fBTcl_RegisterChannel\fR, described below.
 If one of the standard channels, \fBstdin, stdout\fR or \fBstderr\fR was
 previously closed, the act of creating the new channel also assigns it as a
 replacement for the standard channel.
-
 .SH TCL_OPENCOMMANDCHANNEL
 .PP
 \fBTcl_OpenCommandChannel\fR provides a C-level interface to the
@@ -290,7 +285,6 @@ register it, use \fBTcl_RegisterChannel\fR, described below.
 If one of the standard channels, \fBstdin, stdout\fR or \fBstderr\fR was
 previously closed, the act of creating the new channel also assigns it as a
 replacement for the standard channel.
-
 .SH TCL_MAKEFILECHANNEL
 .PP
 \fBTcl_MakeFileChannel\fR makes a \fBTcl_Channel\fR from an existing,
@@ -300,7 +294,6 @@ register it, use \fBTcl_RegisterChannel\fR, described below.
 If one of the standard channels, \fBstdin, stdout\fR or \fBstderr\fR was
 previously closed, the act of creating the new channel also assigns it as a
 replacement for the standard channel.
-
 .SH TCL_GETCHANNEL
 .PP
 \fBTcl_GetChannel\fR returns a channel given the \fIchannelName\fR used to
@@ -318,7 +311,6 @@ according to the \fIpattern\fR.  If \fIpattern\fR is NULL, then it
 will not do any filtering.  The return value is \fBTCL_OK\fR if no
 errors occurred writing to the result, otherwise it is \fBTCL_ERROR\fR,
 and the error message is left in the interpreter's result.
-
 .SH TCL_REGISTERCHANNEL
 .PP
 \fBTcl_RegisterChannel\fR adds a channel to the set of channels accessible
@@ -343,7 +335,6 @@ call to \fBTcl_RegisterChannel\fR, they will get initialized by that
 call. See \fBTcl_StandardChannels\fR for a general treatise about
 standard channels and the behaviour of the Tcl library with regard to
 them.
-
 .SH TCL_UNREGISTERCHANNEL
 .PP
 \fBTcl_UnregisterChannel\fR removes a channel from the set of channels
@@ -358,7 +349,6 @@ that it no longer holds a reference to that channel. If this is the last
 reference to the channel, it will now be closed.  \fBTcl_UnregisterChannel\fR
 is very similar to \fBTcl_DetachChannel\fR except that it will also
 close the channel if no further references to it exist.
-
 .SH TCL_DETACHCHANNEL
 .PP
 \fBTcl_DetachChannel\fR removes a channel from the set of channels
@@ -373,7 +363,6 @@ Code not associated with a Tcl interpreter can call
 that it no longer holds a reference to that channel. If this is the last
 reference to the channel, unlike \fBTcl_UnregisterChannel\fR, 
 it will not be closed.
-
 .SH TCL_ISSTANDARDCHANNEL
 .PP
 \fBTcl_IsStandardChannel\fR tests whether a channel is one of the
@@ -382,7 +371,6 @@ three standard channels, stdin, stdout or stderr.  If so, it returns
 .PP
 No attempt is made to check whether the given channel or the standard 
 channels are initialized or otherwise valid.
-
 .SH TCL_CLOSE
 .PP
 \fBTcl_Close\fR destroys the channel \fIchannel\fR, which must denote a
@@ -412,7 +400,6 @@ been given as the \fBchan\fR argument in a call to
 \fBTcl_UnregisterChannel\fR, which will internally call \fBTcl_Close\fR
 when all calls to \fBTcl_RegisterChannel\fR have been matched by
 corresponding calls to \fBTcl_UnregisterChannel\fR.
-
 .SH "TCL_READCHARS AND TCL_READ"
 .PP
 \fBTcl_ReadChars\fR consumes bytes from \fIchannel\fR, converting the bytes
@@ -473,7 +460,6 @@ stack the supplied channel is part of, \fBTcl_ReadRaw\fR does
 not. Thus this function is \fBonly\fR usable for transformational
 channel drivers, i.e. drivers used in the middle of a stack of
 channels, to move data from the channel below into the transformation.
-
 .SH "TCL_GETSOBJ AND TCL_GETS"
 .PP
 \fBTcl_GetsObj\fR consumes bytes from \fIchannel\fR, converting the bytes to
@@ -500,7 +486,6 @@ of input unavailability.
 \fBTcl_Gets\fR is the same as \fBTcl_GetsObj\fR except the resulting
 characters are appended to the dynamic string given by
 \fIlineRead\fR rather than a Tcl object.
-
 .SH "TCL_UNGETS"
 .PP
 \fBTcl_Ungets\fR is used to add data to the input queue of a channel,
@@ -513,7 +498,6 @@ head of the queue.  If \fIchannel\fR has a
 EOF set, no data will be
 added to the input queue.  \fBTcl_Ungets\fR returns \fIinputLen\fR or
 \-1 if an error occurs.
-
 .SH "TCL_WRITECHARS, TCL_WRITEOBJ, AND TCL_WRITE"
 .PP
 \fBTcl_WriteChars\fR accepts \fIbytesToWrite\fR bytes of character data at
@@ -568,7 +552,6 @@ not. Thus this function is \fBonly\fR usable for transformational
 channel drivers, i.e. drivers used in the middle of a stack of
 channels, to move data from the transformation into the channel below
 it.
-
 .SH TCL_FLUSH
 .PP
 \fBTcl_Flush\fR causes all of the buffered output data for \fIchannel\fR
@@ -582,7 +565,6 @@ eventually, as fast as the channel is able to absorb it.
 The return value is normally \fBTCL_OK\fR.
 If an error occurs, \fBTcl_Flush\fR returns \fBTCL_ERROR\fR and
 records a POSIX error code that can be retrieved with \fBTcl_GetErrno\fR.
-
 .SH TCL_SEEK
 .PP
 \fBTcl_Seek\fR moves the access point in \fIchannel\fR where subsequent
@@ -593,20 +575,15 @@ buffered input is discarded, prior to the seek operation.
 If an error occurs, \fBTcl_Seek\fR returns \-1 and records a POSIX error
 code that can be retrieved with \fBTcl_GetErrno\fR.
 After an error, the access point may or may not have been moved.
-
 .SH TCL_TELL
 .PP
 \fBTcl_Tell\fR returns the current access point for a channel. The returned
 value is \-1 if the channel does not support seeking.
-
 .SH TCL_TRUNCATECHANNEL
 .PP
-.VS 8.5
 \fBTcl_TruncateChannel\fR truncates the file underlying \fIchannel\fR
 to a given \fIlength\fR of bytes. It returns \fBTCL_OK\fR if the
 operation succeeded, and \fBTCL_ERROR\fR otherwise.
-.VE 8.5
-
 .SH TCL_GETCHANNELOPTION
 .PP
 \fBTcl_GetChannelOption\fR retrieves, in \fIoptionValue\fR, the value of one of
@@ -628,7 +605,6 @@ for the Tcl \fBsocket\fR command.
 The procedure normally returns \fBTCL_OK\fR. If an error occurs, it returns
 \fBTCL_ERROR\fR and calls \fBTcl_SetErrno\fR to store an appropriate POSIX
 error code.
-
 .SH TCL_SETCHANNELOPTION
 .PP
 \fBTcl_SetChannelOption\fR sets a new value \fInewValue\fR
@@ -636,30 +612,26 @@ for an option \fIoptionName\fR on \fIchannel\fR.
 The procedure normally returns \fBTCL_OK\fR.  If an error occurs,
 it returns \fBTCL_ERROR\fR;  in addition, if \fIinterp\fR is non-NULL,
 \fBTcl_SetChannelOption\fR leaves an error message in the interpreter's result.
-
 .SH TCL_EOF
 .PP
 \fBTcl_Eof\fR returns a nonzero value if \fIchannel\fR encountered
 an end of file during the last input operation.
-
 .SH TCL_INPUTBLOCKED
 .PP
 \fBTcl_InputBlocked\fR returns a nonzero value if \fIchannel\fR is in
 nonblocking mode and the last input operation returned less data than
 requested because there was insufficient data available.
 The call always returns zero if the channel is in blocking mode.
-
 .SH TCL_INPUTBUFFERED
 .PP
 \fBTcl_InputBuffered\fR returns the number of bytes of input currently
 buffered in the internal buffers for a channel. If the channel is not open
 for reading, this function always returns zero.
-
 .SH TCL_OUTPUTBUFFERED
+.PP
 \fBTcl_OutputBuffered\fR returns the number of bytes of output
 currently buffered in the internal buffers for a channel. If the
 channel is not open for writing, this function always returns zero.
-
 .SH "PLATFORM ISSUES"
 .PP
 The handles returned from \fBTcl_GetChannelHandle\fR depend on the
@@ -670,10 +642,8 @@ the channel was created with \fBTcl_OpenFileChannel\fR,
 \fBTcl_OpenCommandChannel\fR, or \fBTcl_MakeFileChannel\fR.  Other
 channel types may return a different type of handle on Windows
 platforms.
-
 .SH "SEE ALSO"
 DString(3), fconfigure(n), filename(n), fopen(3), Tcl_CreateChannel(3)
-
 .SH KEYWORDS
 access point, blocking, buffered I/O, channel, channel driver, end of file,
 flush, input, nonblocking, output, read, seek, write