aboutsummaryrefslogtreecommitdiff
path: root/module/scripts/README.md
blob: 37bee9893430169c63d7c1c57fbc1e9b030530ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Guile Script Format
===================

### `%summary`
String containing a summary of what the module does.
Should be a single line.

### `%include-in-guild-list`
Boolean, indicating if the script should be listed when running `guild help` or `guild list`.

### `%help`
Longer help for module. If this variable isn't set the procedure `module-commentary` is run

### `%synopsis`
Short help showing how to invoke the script. Should *not* include the guild command.

### `main`
Procedure which is primary entry point. Gets remaining command line as its arguments (meaning it takes multiple arguments).