summaryrefslogtreecommitdiffstats
path: root/doc/RegConfig.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-09-06 09:44:56 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-09-06 09:44:56 (GMT)
commit0e5952c887bd1c44ce8a13516659d6e763a2d381 (patch)
treef3df18b7b55fef1a57dbdfd4b3b9d48ee8923f16 /doc/RegConfig.3
parente61f35c191941709a727ae6128a43b24a0ee5bff (diff)
downloadtcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.zip
tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.tar.gz
tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.tar.bz2
More documentation fixes from Mikhail Kolesnitchenko. [Patch 1022527]
Diffstat (limited to 'doc/RegConfig.3')
-rw-r--r--doc/RegConfig.323
1 files changed, 8 insertions, 15 deletions
diff --git a/doc/RegConfig.3 b/doc/RegConfig.3
index 9816573..f9d200a 100644
--- a/doc/RegConfig.3
+++ b/doc/RegConfig.3
@@ -4,45 +4,38 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: RegConfig.3,v 1.3 2004/09/01 09:50:45 dkf Exp $
+'\" RCS: @(#) $Id: RegConfig.3,v 1.4 2004/09/06 09:44:57 dkf Exp $
.so man.macros
.TH Tcl_RegisterConfig 3 8.4 Tcl "Tcl Library Procedures"
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
-Tcl_RegisterConfig \- procedures to register embedded configuration information.
+Tcl_RegisterConfig \- procedures to register embedded configuration information
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
.sp
void
-\fBTcl_RegisterConfig\fR(\fIinterp,pkgName,configuration,valEncoding\fR)
+\fBTcl_RegisterConfig\fR(\fIinterp, pkgName, configuration, valEncoding\fR)
.sp
.SH ARGUMENTS
+.AS Tcl_Interp *interp
.AP Tcl_Interp *interp in
-
Refers to the interpreter the embedded configuration information is
registered for. Must not be NULL.
-
.AP "CONST char" *pkgName in
-
Contains the name of the package registering the embedded
configuration as ASCII string. This means that this information is in
UTF-8 too. Must not be NULL.
-
.AP Tcl_Config *configuration in
-
Refers to an array of Tcl_Config entries containing the information
embedded in the binary library. Must not be NULL. The end of the array
-is signaled by either a key identical to NULL, or a key refering to
+is signaled by either a key identical to NULL, or a key referring to
the empty string.
-
.AP "CONST char" *valEncoding in
-
Contains the name of the encoding used to store the configuration
values as ASCII string. This means that this information is in UTF-8
too. Must not be NULL.
-
.BE
.SH DESCRIPTION
@@ -50,7 +43,7 @@ too. Must not be NULL.
The function described here has its base in TIP 59 and provides
extensions with support for the embedding of configuration
information into their binary library and the generation of a
-tcl-level interface for querying this information.
+Tcl-level interface for querying this information.
.PP
To embed configuration information into their binary library an
extension has to define a non-volatile array of Tcl_Config entries in
@@ -65,8 +58,8 @@ encoding used by the configuration values.
.PP
The string \fIvalEncoding\fR contains the name of an encoding known to
Tcl. All these names are use only characters in the ASCII subset of
-UTF-8 and are thus implicity in the UTF-8 encoding. It is expected
-that keys are legible english text and therefore using the ASCII
+UTF-8 and are thus implicitly in the UTF-8 encoding. It is expected
+that keys are legible English text and therefore using the ASCII
subset of UTF-8. In other words, they are expected to be in UTF-8
too. The values associated with the keys can be any string
however. For these the contents of \fIvalEncoding\fR define which