~ubuntu-branches/ubuntu/utopic/critcl/utopic

« back to all changes in this revision

Viewing changes to doc/include/api_bmgmt.inc

• browse files at revision 1
• compare with another revision
• download diff
• download tarball
• view history from revision 1

Show diffs side-by-side

added

removed

doc/include/api_bmgmt.inc

 

1

 

 

2

The package provides a single command for the management of global

 

3

settings, i.e. configuration options which are independent of any

 

4

[file .critcl] file. 

 

5

 

 

6

[para] It is expected that this command is irrelevant to anybody just

 

7

wishing to write a [file .critcl] file. It is a management command

 

8

which is only useful to the [manpage {CriTcl Application}] or similar

 

9

tools.

 

10

 

 

11

[list_begin definitions]

 

12

 

 

13

[call [cmd ::critcl::config] [arg option] [opt [arg val]]]

 

14

 

 

15

This command sets and returns critcl's global configuration options. These are

 

16

 

 

17

[list_begin options]

 

18

[opt_def force bool]

 

19

 

 

20

This flag tells the package whether it should force the building of C

 

21

files despite having a cached shared library (when [const true], or

 

22

not. The default is [const off].

 

23

 

 

24

[opt_def lines bool]

 

25

 

 

26

This flag tells the package whether to embed #line directives into the

 

27

generated C code (when [const true]) or not. By default this is [const on].

 

28

 

 

29

[include rq_cline.inc]

 

30

 

 

31

[para] Developers of higher-level packages generating their own C

 

32

code, either directly, or indirectly, by using critcl commands, should

 

33

also read section [sectref {Advanced: Location management}] to see how

 

34

critcl helps them in generating their directives.

 

35

 

 

36

Examples of such packages come with critcl itself, see the packages

 

37

[package critcl::iassoc] and [package critcl::class].

 

38

 

 

39

[opt_def I path]

 

40

 

 

41

A single global include path to use for all files. Not set by default.

 

42

 

 

43

[opt_def combine enum]

 

44

[list_begin definitions]

 

45

[def [const dynamic]]

 

46

 

 

47

Object files have the suffix [const _pic].

 

48

 

 

49

[def [const static]]

 

50

 

 

51

Object files have the suffix [const _stub].

 

52

 

 

53

[def [const standalone]]

 

54

 

 

55

Object files have no suffix, and the generated C files are compiled

 

56

without using Tcl/Tk stubs. The result are object files usable for

 

57

static linking into a [term {big shell}].

 

58

 

 

59

[list_end]

 

60

 

 

61

The default is [const dynamic].

 

62

 

 

63

 

 

64

[opt_def language string]

 

65

[opt_def keepsrc bool]

 

66

 

 

67

This flag tells the package whether to keep the generated [file .c]

 

68

files after it has build their [file .o] files (when [const true]), or

 

69

not. The default is [const off].

 

70

 

 

71

[opt_def outdir path]

 

72

 

 

73

The path where to place a generated shared library. Not set by

 

74

default, causing placement into the [sectref {Result Cache}].

 

75

 

 

76

[list_end]

 

77

[list_end]

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1