summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-01-20 20:59:22 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-01-20 20:59:22 (GMT)
commit792c57a7fb9f7db346f92861d380a32d1c31ea8a (patch)
tree9f0061479fecbdd831316a1c6617be88197cca3c
parent073e6715d127e9c252cdc1c852445d0f983e8e27 (diff)
downloadtcl-792c57a7fb9f7db346f92861d380a32d1c31ea8a.zip
tcl-792c57a7fb9f7db346f92861d380a32d1c31ea8a.tar.gz
tcl-792c57a7fb9f7db346f92861d380a32d1c31ea8a.tar.bz2
Make documentation conform to implementation in this branch
-rw-r--r--doc/encoding.n12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/encoding.n b/doc/encoding.n
index 24ca1c7..9577da3 100644
--- a/doc/encoding.n
+++ b/doc/encoding.n
@@ -28,7 +28,8 @@ formats.
Performs one of several encoding related operations, depending on
\fIoption\fR. The legal \fIoption\fRs are:
.TP
-\fBencoding convertfrom\fR ?\fB-nocomplain\fR|\fB-strict\fR|\fB-failindex var\fR? ?\fIencoding\fR? \fIdata\fR
+\fBencoding convertfrom\fR ?\fB-strict\fR? ?\fB-failindex var\fR? ?\fIencoding\fR? \fIdata\fR
+\fBencoding convertfrom\fR \fB-nocomplain\fR ?\fIencoding\fR? \fIdata\fR
.
Convert \fIdata\fR to a Unicode string from the specified \fIencoding\fR. The
characters in \fIdata\fR are 8 bit binary data. The resulting
@@ -56,11 +57,13 @@ This switch restores the TCL8.7 behaviour.
.PP
The \fB-strict\fR option follows more strict rules in conversion. For the \fButf-8\fR
encoder, it disallows invalid byte sequences and surrogates (which -
-otherwise - are just passed through).
+otherwise - are just passed through). This option may not be used together
+with \fB-nocomplain\fR.
.VE "TCL8.7 TIP346, TIP607, TIP601"
.RE
.TP
-\fBencoding convertto\fR ?\fB-nocomplain\fR|\fB-strict\fR|\fB-failindex var\fR? ?\fIencoding\fR? \fIstring\fR
+\fBencoding convertto\fR ?\fB-strict\fR? ?\fB-failindex var\fR? ?\fIencoding\fR? \fIdata\fR
+\fBencoding convertto\fR \fB-nocomplain\fR ?\fIencoding\fR? \fIdata\fR
.
Convert \fIstring\fR from Unicode to the specified \fIencoding\fR.
The result is a sequence of bytes that represents the converted
@@ -88,7 +91,8 @@ TCL 9. In TCL 9, the encoding command fails with an error on any encoding issue.
This switch restores the TCL8.7 behaviour.
.PP
The \fB-strict\fR option follows more strict rules in conversion. For the \fButf-8\fR
-encoder, it disallows surrogates (which - otherwise - are just passed through).
+encoder, it disallows surrogates (which - otherwise - are just passed through). This
+option may not be used together with \fB-nocomplain\fR.
.VE "TCL8.7 TIP346, TIP607, TIP601"
.RE
.TP