# HG changeset patch # User Paul Boddie # Date 1446498026 -3600 # Node ID 5c63dfef0f746622f30821e19b1dce3ab9b5605a # Parent a83aa13339c97b7641a54005b45504e86bc0f6ae Added notes on invoking the agent programs. diff -r a83aa13339c9 -r 5c63dfef0f74 docs/wiki/AgentPrograms --- a/docs/wiki/AgentPrograms Mon Nov 02 21:09:48 2015 +0100 +++ b/docs/wiki/AgentPrograms Mon Nov 02 22:00:26 2015 +0100 @@ -17,3 +17,25 @@ manual intervention - and to respond to event invitations or booking requests according to policies defined in the [[../Configuration|configuration]] of the system. + +== Program Invocation == + +Since imip-agent is concerned with the integration of calendaring with e-mail, +these programs are typically invoked by the [[../MailIntegration|mail system]], +although they may be invoked directly for [[../Testing|testing]] and other +purposes. Various options may be presented to the programs in order to modify +their behaviour, and these are summarised when the `--help` option is given. +For example: + +{{{ +imip_person.py --help +}}} + +The [[../MailIntegration|mail configuration guide]] references configuration +files that include example invocations of these programs. Generally, few +options need to be specified, and as a result the programs will acquire their +configuration from the installed [[../Configuration|configuration files]]. + +One exception is the `imip_person.py` program that needs to be told whether +it will deliver messages using [[../MailIntegration/LMTP|LMTP]] with the `-l` +option or using [[../MailIntegration/LocalSMTP|SMTP]] with the `-L` option.