diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-11 21:03:47 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-11 21:03:47 +0200 |
commit | 1d147d7420cc4c14326fa273e9163a7dc807f94a (patch) | |
tree | 53bdedacf73b52b1dd28859c265baa21277dc294 | |
parent | Document text modules. (diff) | |
download | calp-1d147d7420cc4c14326fa273e9163a7dc807f94a.tar.gz calp-1d147d7420cc4c14326fa273e9163a7dc807f94a.tar.xz |
Add basic documentation of entry points.
Diffstat (limited to '')
-rw-r--r-- | doc/ref/calp.texi | 1 | ||||
-rw-r--r-- | doc/ref/entry-points.texi | 62 |
2 files changed, 63 insertions, 0 deletions
diff --git a/doc/ref/calp.texi b/doc/ref/calp.texi index d9cad0af..a3ab4bf6 100644 --- a/doc/ref/calp.texi +++ b/doc/ref/calp.texi @@ -65,6 +65,7 @@ text @footnote{Improvements welcome} @c @end menu @include guile.texi +@include entry-points.texi @include text.texi @node Index diff --git a/doc/ref/entry-points.texi b/doc/ref/entry-points.texi new file mode 100644 index 00000000..4c4ec90f --- /dev/null +++ b/doc/ref/entry-points.texi @@ -0,0 +1,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 |