documentation fixes
[rrq/rrqforth.git] / adoc / p_read_stream_line.adoc
1 // stdio.asm:   WORD p_read_stream_line,'READ-STREAM-LINE'
2
3 anchor:p_read_stream_line[]
4
5 === Word: READ-STREAM-LINE
6
7 ....
8 Data stack: ( stream -- n )
9 ....
10
11 "READ-STREAM-LINE" is a function word that gets the next line from the
12 given stream buffer into PAD and returns number of characters. If the
13 stream is backed by a file descriptor, the stream buffer is refilled
14 from there as needed, by a SYS_READ call when more characters are
15 needed.