summaryrefslogtreecommitdiffstats
path: root/doc/gets.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/gets.n')
-rw-r--r--doc/gets.n15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/gets.n b/doc/gets.n
index f884d11..8631e4b 100644
--- a/doc/gets.n
+++ b/doc/gets.n
@@ -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: gets.n,v 1.4 2001/09/14 19:20:40 andreas_kupries Exp $
+'\" RCS: @(#) $Id: gets.n,v 1.5 2004/04/16 10:28:55 dkf Exp $
'\"
.so man.macros
.TH gets n 7.5 Tcl "Tcl Built-In Commands"
@@ -52,6 +52,19 @@ only of the end-of-line character(s).
The \fBeof\fR and \fBfblocked\fR commands can be used to distinguish
these three cases.
+.SH "EXAMPLE"
+This example reads a file one line at a time and prints it out with
+the current line number attached to the start of each line.
+
+.CS
+set chan [open "some.file.txt"]
+set lineNumber 0
+while {[gets $chan line] >= 0} {
+ puts "[incr lineNumber]: $line"
+}
+close $chan
+.CE
+
.SH "SEE ALSO"
file(n), eof(n), fblocked(n), Tcl_StandardChannels(3)