File: critcl_application_package.man

package info (click to toggle)
critcl 3.3.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,680 kB
  • sloc: ansic: 41,058; tcl: 12,090; sh: 7,230; pascal: 3,456; asm: 3,058; ada: 1,681; cpp: 1,001; cs: 879; makefile: 333; perl: 104; xml: 95; f90: 10
file content (62 lines) | stat: -rw-r--r-- 2,101 bytes parent folder | download
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
[comment {-*- mode: tcl ; fill-column: 90 -*- doctools manpage}]
[comment {quadrant: reference}]
[include pkg_version.inc]
[manpage_begin critcl_application_package 3tcl [vset VERSION]]
[include include/module.inc]
[titledesc {CriTcl Application Package Reference}]
[require Tcl 8.6]
[require critcl::app [opt [vset VERSION]]]
[require critcl [opt [vset VERSION]]]
[require platform [opt 1.0.2]]
[require cmdline]
[description]
[para]
[include include/welcome.inc]
[para]

This document is the reference manpage for the [package critcl::app]
package. Its intended audience are developers working on critcl's
internals.  [vset not_needed_for_critcl_script]

[vset see_overview]

[para]

This package resides in the Application Layer of CriTcl.
[para][image arch_application][para],

implementing the functionality of the [manpage {CriTcl Application}],
and through this, the mode [sectref {Modes Of Operation/Use} {generate package}].

The actual application is (only) a shim wrapping around this
package. It itself is build on top of the core package
[package critcl].

[comment {= = == === ===== ======== ============= =====================}]
[section API]

The package exports a single command

[list_begin definitions]
[call [cmd ::critcl::app::main] [arg commandline]]

The [arg commandline] is a list of zero or more options followed by zero or
more [vset critcl_script] files.  By default, the [vset critcl_script] files
are build and the results cached.   This cuts down on the time needed to
load the package.  The last occurrence of [option -pkg] and [option -tea], if
provided, selects the corresponding alternative mode of operations.

For a larger set of examples please see section "Building CriTcl Packages"
in the document about [manpage {Using CriTcl}].


[list_end]

The options are:
[section {Options}]			[include include/aoptions.inc]
[section {Modes Of Operation/Use}]	[include include/modes.inc]
[section {Package Structure}]		[include include/pstructure.inc]

[comment {= = == === ===== ======== ============= =====================}]
[include include/feedback.inc]
[manpage_end]