File: pt_tclparam_config_nx.man

package info (click to toggle)
tcllib 1.21%2Bdfsg-1
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 69,456 kB
  • sloc: tcl: 266,493; ansic: 14,259; sh: 2,936; xml: 1,766; yacc: 1,145; pascal: 881; makefile: 112; perl: 84; f90: 84; python: 33; ruby: 13; php: 11
file content (48 lines) | stat: -rw-r--r-- 1,548 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
[vset VERSION 1.0.1]
[comment {-*- text -*- doctools manpage}]
[manpage_begin pt::tclparam::configuration::nx n [vset VERSION]]
[include include/module.inc]
[titledesc {Tcl/PARAM, Canned configuration, NX}]
[require pt::tclparam::configuration::nx [opt [vset VERSION]]]
[description]
[include include/ref_intro.inc]

This package is an adjunct to [package pt::peg::to::tclparam], to make
the use of this highly configurable package easier by providing a
canned configuration. When applied this configuration causes the
package [package pt::peg::to::tclparam] to generate
[package NX]-based parser packages.

[para]

It is a supporting package in the Core Layer of Parser Tools.
[para][image arch_core_support][para]

[section API]

[list_begin definitions]

[call [cmd ::pt::tclparam::configuration::nx] [method def] \
	[arg name] [arg pkg] [arg version] [arg cmdprefix]]

The command applies the configuration provided by this package to the
[arg cmdprefix], causing the creation of [package NX]-based parsers
whose class is [arg name], in package [arg pkg] with [arg version].

[para]

The use of a command prefix as API allows application of the
configuration to not only [package pt::peg::to::tclparam]
([cmd {pt::peg::to::tclparam configure}]), but also export manager
instances and PEG containers ([cmd {$export configuration set}] and
[cmd {[$container exporter] configuration set}] respectively).

[para]

Or anything other command prefix accepting two arguments, option and
value.

[list_end]

[include include/feedback.inc]
[manpage_end]