summaryrefslogtreecommitdiffstats
path: root/doc/binary.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2005-12-16 11:12:31 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2005-12-16 11:12:31 (GMT)
commit6649ff8b06beb9b70bad5025f41bbfaf9f14c8c4 (patch)
tree10bfe33d01782f0200f31c950a43320326a210ec /doc/binary.n
parenteee69256b669d580123dbc86d580da7c89fbdcf0 (diff)
downloadtcl-6649ff8b06beb9b70bad5025f41bbfaf9f14c8c4.zip
tcl-6649ff8b06beb9b70bad5025f41bbfaf9f14c8c4.tar.gz
tcl-6649ff8b06beb9b70bad5025f41bbfaf9f14c8c4.tar.bz2
Minor clarification
Diffstat (limited to 'doc/binary.n')
-rw-r--r--doc/binary.n6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/binary.n b/doc/binary.n
index 3caf872..1944749 100644
--- a/doc/binary.n
+++ b/doc/binary.n
@@ -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: binary.n,v 1.27 2005/10/21 10:27:03 dkf Exp $
+'\" RCS: @(#) $Id: binary.n,v 1.28 2005/12/16 11:12:31 dkf Exp $
'\"
.so man.macros
.TH binary n 8.0 Tcl "Tcl Built-In Commands"
@@ -370,7 +370,9 @@ will return \fBabfdeghi\\000\\000j\fR.
.PP
The \fBbinary scan\fR command parses fields from a binary string,
returning the number of conversions performed. \fIString\fR gives the
-input to be parsed and \fIformatString\fR indicates how to parse it.
+input bytes to be parsed (one byte per character, and characters not
+representable as a byte have their high bits chopped)
+and \fIformatString\fR indicates how to parse it.
Each \fIvarName\fR gives the name of a variable; when a field is
scanned from \fIstring\fR the result is assigned to the corresponding
variable.