Merge commit '7c621da28f07e449ad90c387344f07a453927569' as 'tcllib'

1 files changed, 80 insertions, 0 deletions

diff --git a/tcllib/modules/pt/include/export/config/cparam.inc b/tcllib/modules/pt/include/export/config/cparam.inc
new file mode 100644
index 0000000..afe817f
--- /dev/null
+++ b/tcllib/modules/pt/include/export/config/cparam.inc
@@ -0,0 +1,80 @@
+[section Configuration]
+
+The C/PARAM export plugin recognizes the following configuration
+variables and changes its behaviour as they specify.
+
+[list_begin arguments]
+
+[arg_def string template]
+
+If this configuration variable is set it is assumed to contain a
+string into which to put the generated code and other configuration
+data. The various locations are expected to be specified with the
+following placeholders:
+
+[list_begin definitions]
+
+[def [const @user@]]
+To be replaced with the value of the configuration variable [option user].
+
+[def [const @format@]]
+To be replaced with the the constant [const C/PARAM].
+
+[def [const @file@]]
+To be replaced with the value of the configuration variable [option file].
+
+[def [const @name@]]
+To be replaced with the value of the configuration variable [option name].
+
+[def [const @code@]]
+To be replaced with the generated C code.
+
+[list_end]
+
+The following configuration variables are special, in that they will
+occur within the generated code, and are replaced there as well.
+
+[list_begin definitions]
+
+[def [const @statedecl@]]
+To be replaced with the value of the configuration variable [option state-decl].
+
+[def [const @stateref@]]
+To be replaced with the value of the configuration variable [option state-ref].
+
+[def [const @strings@]]
+To be replaced with the value of the configuration variable [option string-varname].
+
+[def [const @self@]]
+To be replaced with the value of the configuration variable [option self-command].
+
+[def [const @def@]]
+To be replaced with the value of the configuration variable [option fun-qualifier].
+
+[def [const @ns@]]
+To be replaced with the value of the configuration variable [option namespace].
+
+[def [const @main@]]
+To be replaced with the value of the configuration variable [option main].
+
+[def [const @prelude@]]
+To be replaced with the value of the configuration variable [option prelude].
+
+[list_end]
+
+[para]
+
+If this configuration variable is not set, or empty, then the plugin
+falls back to a standard template, which is defined as "[const @code@]".
+
+[list_end]
+
+[emph Note] that this plugin may ignore the standard configuration
+variables [var user], [var format], [var file], and their values,
+depending on the chosen template.
+
+[para]
+
+The content of the standard configuration variable [var name], if set,
+is used as name of the grammar in the output. Otherwise the plugin
+falls back to the default name [const a_pe_grammar].