1        Commands available through the swiss army knife aka SAK:
2
3        help     - This help
4
5        /Configuration
6        /===========================================================
7
8        version  - Return the bundle's version number
9        major    - Return the bundle's major version number
10        minor    - Return the bundle's minor version number
11        name     - Return the bundle's package name
12
13        /Development
14        /===========================================================
15
16        modules          - Return list of modules.
17        contributors     - Print a list of contributors to the bundle.
18        lmodules         - See above, however one module per line
19        imodules         - Return list of modules known to the installer.
20        critcl-modules   - Return a list of modules with critcl enhancements.
21
22        packages         - Return indexed packages in the bundle, plus versions,
23                           one package per line. Extracted from the
24                           package indices found in the modules.
25        provided         - Return list and versions of provided packages
26                           (in contrast to indexed).
27        vcompare pkglist - Compare package list of previous 'packages'
28                           call with current packages. Marks all new
29                           and unchanged packages for higher attention.
30
31        critcl ?module?  - Build a critcl module [default is @@].
32
33        bench ?opt? ?module..?
34                         - Run benchmark scripts (*.bench).
35
36                Options: -throwerrors 0|1  Propagate errors if set.
37                         -match   pattern  Exclude benchmarks not matching the
38                                           glob pattern.
39                         -rmatch  pattern  S.a, but a regexp pattern.
40                         -iters   integer  Max #iterations for all benchmarks.
41                         -threads integer  #Threads to use for threaded shells.
42                         -o       path     File to write the results too.
43                         -format  text|csv|raw Format to use for the results.
44                         -norm    column   Normalize results using the specified
45                                           column as reference.
46                         -verbose          Informational output during the run.
47                         -debug            Internal output during the run.
48
49        bench/show ?-o path? ?-format f? ?-norm col? file...
50
51                         Reads the files, merges the data, then
52                         writes the result back in the specified
53                         format, to the specified file, possibly
54                         normalizing to a column. Without a file
55                         the result is written to stdout.
56
57        bench/edit ?-o path? ?-format f? file col newvalue
58
59                         Reads the file, changes the interpreter
60                         path in the column to a new value. For
61                         merging of data from the same interpreter,
62                         but possibly different versions of the
63                         benchmarked package, like Tcllib.
64
65        bench/del ?-o path? ?-format f? file col...
66
67                         Reads the file and removes the specified
68                         columns. To delete unnecessary data in merged
69                         results.
70
71        oldvalidate ?module..?     - Check listed modules for problems.
72                                  For all modules if none specified.
73
74        oldvalidate_v ?module..?   - Check listed modules for for version
75                                  problems. For all modules if none
76                                  specified.
77
78        test ?module...?        - Run testsuite for listed modules.
79                                  For all modules if none specified.
80
81        docstrip/users             - List modules using docstrip
82        docstrip/regen ?module...? - Regenerate the sources of all
83                                     or the listed modules from their
84                                     docstrip sources.
85
86        /Documentation
87        /===========================================================
88
89        desc  ?module...?    - Module/Package descriptions
90        desc/2 ?module...?   - Module/Package descriptions, alternate format.
91
92        /Release engineering
93        /===========================================================
94
95        gendist  - Generate distribution from CVS snapshot
96
97        rpmspec  - Generate a RPM spec file for the bundle.
98        gentip55 - Generate a TIP55-style DESCRIPTION.txt file.
99        yml      - Generate a YAML description file.
100
101        release name sf-user-id
102                 - Marks the current state of all files as a new
103                   release. This updates all ChangeLog's, and
104                   regenerates the contents of PACKAGES
105
106        rstatus  - Determines the status of the code base with regard
107                   to the last release.
108
109        approve pkg - Suppress named package in rstatus output.
110                      I.e. mark the packages which are done while going
111                      over all of them for a release.
112
113