Skip to content

Commit 2e83f9a

Browse files
committed
docs: document aio gets -eof and -keep
Signed-off-by: Steve Bennett <[email protected]>
1 parent 109c33c commit 2e83f9a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

jim_tcl.txt

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Changes since 0.83
6767
#. New `info usage` to return the usage for a proc or native command
6868
#. New `info aliases` to list all aliases
6969
#. `expr` supports new +'=*'+ and +'=~'+ matching operators (see <<_expressions,EXPRESSIONS>>)
70+
#. `aio gets` supports +*-eol*+ and +*-keep*+
7071

7172
Changes between 0.82 and 0.83
7273
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -5163,9 +5164,9 @@ aio
51635164
to flush the remaining data. As long as the eventloop runs (`vwait`, `update`), the write
51645165
data will be automatically flushed.
51655166

5166-
+$handle *gets* '?varName?'+::
5167-
Read one line from the cannel and return it or store it in the
5168-
var A terminating newline character is discarded. If +'varName'+
5167+
+$handle *gets* ?*-eol* 'str'? ?*-keep 0|1*? '?varName?'+::
5168+
Read one line from the channel and return it or store it in the
5169+
variable. A terminating newline character is discarded. If +'varName'+
51695170
is specified, then the line is placed in the variable by that name
51705171
and the return value is a count of the number of characters read
51715172
(not including the newline). If the end of the file is reached
@@ -5179,6 +5180,14 @@ aio
51795180
the file is not a newline character, then `gets` behaves as if there
51805181
were an additional newline character at the end of the file.
51815182

5183+
::
5184+
If +*-eol*+ is given, the end of line is considered to be the
5185+
given string instead of the newline character. If +*-keep 1*+
5186+
is given, the end-of-line string is not discarded and instead
5187+
is returned as part of the result (and if the return value is the
5188+
character count, it includes the end-of-line string).
5189+
The default is +*-keep 0*+.
5190+
51825191
+$handle *getfd*+::
51835192
Returns the underlying file descriptor. On Unix platforms this is a small integer.
51845193

0 commit comments

Comments
 (0)