aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/entry-points.texi
blob: 4c4ec90f3788edb6274cd60c7d309544159290db (plain)
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
@node Entry Points
@chapter Entry Points

Calp has many different entry points. Each is implemented in a module
residing under @code{calp entry-points}. Each such module @emph{must}
export a @code{main} procedure, which should take a list of command
line arguments (as a single parameter).

When starting Calp from the command line, the @code{main} procedure
located in @code{(calp main)} is called. That procedure parse it's own
command line flags, up until the first non-flag argument. That word
will be used to chose the actual entry point, which is then
responsible for parsing the remaining command line flags.

Information about global command line arguments can be accessed by
running @command{calp --help}, and subcommands arguments through
@command{calp @var{<subcommand>} --help}.

@deftp {Entry Point} benchmark module
Run @code{(@ (calp benchmark @var{module}) run-benchmark)} with
profiling enabled, and prints the collected data.
@end deftp

@deftp {Entry Point} convert
Convert calendar files between filetypes.
@end deftp

@deftp {Entry Point} html
Generates static HTML files.
@end deftp

@deftp {Entry Point} ical
Generates static iCal files.
@end deftp

@deftp {Entry Point} import
Import entry into database.
@end deftp

@deftp {Entry Point} server
Start the web server.
@end deftp

@deftp {Entry Point} terminal
Start the terminal interface.
@end deftp

@deftp {Entry Point} text
Format text, completely ignoring calendars.
@end deftp

@deftp {Entry Point} tidsrapport
Generate an FDF (PDF Form submission file) for some very specific time
reporting sheets.

TODO this should be removed from this project, and moved to a
``private'' repo of hugo.
@end deftp

@deftp {Entry Point} update-zoneinfo
Downloads zoneinfo files and places them in the correct location.
@end deftp