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

« back to all changes in this revision

Viewing changes to doc/include/api_rcache.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_rcache.inc

 

1

 

 

2

This package provides two commands for the management of the

 

3

[sectref {Result Cache}]. See that section for background information.

 

4

 

 

5

[para] [emph NOTE] that these commands are irrelevant to anybody just

 

6

wishing to write a package using critcl for the C parts. They are

 

7

management commands which are only useful to the

 

8

[manpage {CriTcl Application}] or similar tools.

 

9

 

 

10

 

 

11

[list_begin definitions]

 

12

[comment ---------------------------------------------------------------------]

 

13

[call [cmd ::critcl::cache] [opt path]]

 

14

 

 

15

This command sets and returns the path to the directory for the

 

16

package's result cache.

 

17

 

 

18

[para] The default location is

 

19

[file ~/.critcl/[lb]platform::generic[rb]] and usually does not

 

20

require any changes.

 

21

 

 

22

[comment ---------------------------------------------------------------------]

 

23

[call [cmd ::critcl::clean_cache] [opt [arg pattern]...]]

 

24

 

 

25

This command cleans the result cache, i.e. removes any and all files

 

26

and directories in it. If one or more patterns are specified then only

 

27

the files and directories matching them are removed.

 

28

 

 

29

[list_end]

• Older »

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