summaryrefslogtreecommitdiffstats
path: root/doc/RegConfig.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2007-10-28 14:17:38 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2007-10-28 14:17:38 (GMT)
commitccacc920f9cd610a9a9d8e800f623c20bf43a702 (patch)
treedaec40c266097bb1d38f10254010691b0131d4cc /doc/RegConfig.3
parent8ffb8fa76d0d34283e491044dd28385674ba113e (diff)
downloadtcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.zip
tcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.tar.gz
tcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.tar.bz2
First stage of doing GOOBE improvements to documentation now that the html generation works
Diffstat (limited to 'doc/RegConfig.3')
-rw-r--r--doc/RegConfig.321
1 files changed, 9 insertions, 12 deletions
diff --git a/doc/RegConfig.3 b/doc/RegConfig.3
index 908c2ec..2e01a58 100644
--- a/doc/RegConfig.3
+++ b/doc/RegConfig.3
@@ -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: RegConfig.3,v 1.6 2004/10/07 15:15:47 dkf Exp $
+'\" RCS: @(#) $Id: RegConfig.3,v 1.7 2007/10/28 14:17:39 dkf Exp $
.so man.macros
.TH Tcl_RegisterConfig 3 8.4 Tcl "Tcl Library Procedures"
.BS
@@ -72,9 +72,9 @@ NULL. The function makes \fBno\fR copy of the \fIconfiguration\fR
array. This means that the caller has to make sure that the memory
holding this array is never released. This is the meaning behind the
word \fBnon-volatile\fR used earlier. The easiest way to accomplish
-this is to define a global static array of Tcl_Config entries. See the
-file "generic/tclPkgConfig.c" in the sources of the Tcl core for an
-example.
+this is to define a global static array of Tcl_Config entries. See the file
+.QW generic/tclPkgConfig.c
+in the sources of the Tcl core for an example.
.PP
When called \fBTcl_RegisterConfig\fR will
.IP (1)
@@ -97,20 +97,17 @@ Returns a list containing the names of all defined keys.
Returns the configuration value associated with the specified
\fIkey\fR.
.RE
-
.SH TCL_CONFIG
-
+.PP
The \fBTcl_Config\fR structure contains the following fields:
.PP
.CS
typedef struct Tcl_Config {
- const char* key;
- const char* value;
+ const char* key;
+ const char* value;
} Tcl_Config;
.CE
-
-'\" No cross references yet.
-'\" .SH "SEE ALSO"
-
+.\" No cross references yet.
+.\" .SH "SEE ALSO"
.SH KEYWORDS
embedding, configuration, bianry library