diff options
author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2023-03-18 08:42:39 (GMT) |
---|---|---|
committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2023-03-18 08:42:39 (GMT) |
commit | 5fbaf44ecf9e3c77c88088e83c53b51cd8af05db (patch) | |
tree | c55213d552e5f99398d1846f85b8128139d9e5b6 | |
parent | c6b740609accca2dcf17e28ad7ab6051f856bf8f (diff) | |
download | tcl-5fbaf44ecf9e3c77c88088e83c53b51cd8af05db.zip tcl-5fbaf44ecf9e3c77c88088e83c53b51cd8af05db.tar.gz tcl-5fbaf44ecf9e3c77c88088e83c53b51cd8af05db.tar.bz2 |
Manpage fixes
-rw-r--r-- | doc/Encoding.3 | 10 | ||||
-rw-r--r-- | doc/encoding.n | 2 | ||||
-rw-r--r-- | doc/fconfigure.n | 6 |
3 files changed, 9 insertions, 9 deletions
diff --git a/doc/Encoding.3 b/doc/Encoding.3 index 76ea193..7453549 100644 --- a/doc/Encoding.3 +++ b/doc/Encoding.3 @@ -8,7 +8,7 @@ .so man.macros .BS .SH NAME -Tcl_GetEncoding, Tcl_FreeEncoding, Tcl_GetEncodingFromObj, Tcl_ExternalToUtfDString, Tcl_UtfToExternalDStringEx, Tcl_ExternalToUtf, Tcl_UtfToExternalDString, Tcl_UtfToExternalDStringEx, Tcl_UtfToExternal, Tcl_GetEncodingName, Tcl_SetSystemEncoding, Tcl_GetEncodingNameFromEnvironment, Tcl_GetEncodingNames, Tcl_CreateEncoding, Tcl_GetEncodingSearchPath, Tcl_SetEncodingSearchPath, Tcl_GetDefaultEncodingDir, Tcl_SetDefaultEncodingDir \- procedures for creating and using encodings +Tcl_GetEncoding, Tcl_FreeEncoding, Tcl_GetEncodingFromObj, Tcl_ExternalToUtfDString, Tcl_ExternalToUtfDStringEx, Tcl_ExternalToUtf, Tcl_UtfToExternalDString, Tcl_UtfToExternalDStringEx, Tcl_UtfToExternal, Tcl_GetEncodingName, Tcl_SetSystemEncoding, Tcl_GetEncodingNameFromEnvironment, Tcl_GetEncodingNames, Tcl_CreateEncoding, Tcl_GetEncodingSearchPath, Tcl_SetEncodingSearchPath, Tcl_GetDefaultEncodingDir, Tcl_SetDefaultEncodingDir \- procedures for creating and using encodings .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -223,7 +223,6 @@ call \fBTcl_DStringFree\fR to free any information stored in \fIdstPtr\fR. When converting, if any of the characters in the source buffer cannot be represented in the target encoding, a default fallback character will be used. The return value is a pointer to the value stored in the DString. - .PP \fBTcl_ExternalToUtfDStringEx\fR is a more flexible version of older \fBTcl_ExternalToUtfDString\fR function. It takes three additional parameters, @@ -235,7 +234,7 @@ into the function. On success, the function returns \fBTCL_ERROR\fR with the converted string stored in \fB*dstPtr\fR. For errors other than conversion errors, such as invalid flags, the function returns \fBTCL_OK\fR with an error message in \fBinterp\fR if it is not NULL. - +.PP For conversion errors, \fBTcl_ExternalToUtfDStringEx\fR returns one of the \fBTCL_CONVERT_*\fR errors listed below for \fBTcl_ExternalToUtf\fR. When one of these conversion errors is returned, an error message is @@ -243,10 +242,9 @@ stored in \fBinterp\fR only if \fBerrorIdxPtr\fR is NULL. Otherwise, no error me is stored as the function expects the caller is interested whatever is decoded to that point and not treating this as an immediate error condition. The index of the error location is stored in \fB*errorIdxPtr\fR. - +.PP The caller must call \fBTcl_DStringFree\fR to free up the \fB*dstPtr\fR resources irrespective of the return value from the function. - .PP \fBTcl_ExternalToUtf\fR converts a source buffer \fIsrc\fR from the specified \fIencoding\fR into UTF-8. Up to \fIsrcLen\fR bytes are converted from the @@ -626,7 +624,7 @@ with at most one of \fBTCL_ENCODING_PROFILE_TCL8\fR, These correspond to the \fBtcl8\fR, \fBstrict\fR and \fBreplace\fR profiles respectively. If none are specified, a version-dependent default profile is used. For Tcl 8.7, the default profile is \fBtcl8\fR. - +.PP For details about profiles, see the \fBPROFILES\fR section in the documentation of the \fBencoding\fR command. .SH "SEE ALSO" diff --git a/doc/encoding.n b/doc/encoding.n index 7266311..8ede974 100644 --- a/doc/encoding.n +++ b/doc/encoding.n @@ -85,8 +85,8 @@ The encodings and .QW iso8859-1 are guaranteed to be present in the list. -.TP .VS "TCL8.7 TIP656" +.TP \fBencoding profiles\fR Returns a list of the names of encoding profiles. See \fBPROFILES\fR below. .VE "TCL8.7 TIP656" diff --git a/doc/fconfigure.n b/doc/fconfigure.n index 526c5ad..3de22eb 100644 --- a/doc/fconfigure.n +++ b/doc/fconfigure.n @@ -101,6 +101,8 @@ locale-dependent system encoding used for interfacing with the operating system, as returned by \fBencoding system\fR. .RE .TP +\fB\-eofchar\fR \fIchar\fR +.TP \fB\-eofchar\fR \fB{\fIchar outChar\fB}\fR . This option supports DOS file systems that use Control-z (\ex1A) as an @@ -111,8 +113,8 @@ If \fIchar\fR is the empty string, then there is no special end of file character marker. For read-write channels, a two-element list specifies the end of file marker for input and output, respectively. As a convenience, when setting the end-of-file character for a read-write -channel you can specify a single value that will apply to both reading -and writing. When querying the end-of-file character of a read-write +channel you can specify a single value that will apply to reading +only. When querying the end-of-file character of a read-write channel, a two-element list will always be returned. The default value for \fB\-eofchar\fR is the empty string in all cases except for files under Windows. In that case the \fB\-eofchar\fR is Control-z (\ex1A) for |