diff options
Diffstat (limited to 'doc/wydawca.texi')
-rw-r--r-- | doc/wydawca.texi | 133 |
1 files changed, 130 insertions, 3 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi index b313e4f..1f7ad70 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi @@ -1121,7 +1121,7 @@ attempts, or any bad signature was uploaded: mail-admin-stat stat-msg errors access-violations bad-signatures @end smallexample -@kwindex +@kwindex admin-address The recipient address for these notifications is set using @code{admin-address} statement. Its argument is either a single @acronym{RFC} 822 email address, or a comma-separated list of such @@ -1192,8 +1192,8 @@ end @subsection User Notification @UNREVISED{} @cindex mail notification, project admin - Project administrators can be notified via email about any of the -following events: + Project administrators (@dfn{owners}) and/or users may recieve email +notifications about any of the following events: @table @code @kwindex success @@ -1215,6 +1215,133 @@ uploader. uploader. @end table +@kwindex notify-event + These notifications are configured using the following statement: + +@smallexample +notify-event @var{event} @var{who} @var{msg-id} +@end smallexample + +@noindent +where @var{event} is one of the events described above, @var{msg-id} +is the identifier of a previously defined message template +(@pxref{templates}), and @var{who} determines who should receive the +notification. The following values for @var{who} are allowed: + +@table @code +@kwindex admin +@item admin +The system administrator. + +@kwindex owner +@item owner +Administrators of the project for which the files where uploaded. + +@kwindex user +@item user +A user who uploaded files. +@end table + + For example, the following two statements instruct @command{wydawca} +to email notifications about @code{bad-directive-signature} event to +project administrators and to the user who did the upload, using two +different templates: + +@smallexample +notify-event bad-directive-signature user user-bad-directive-signature +notify-event bad-directive-signature owner owner-bad-directive-signature +@end smallexample + + The following macro-variables may be used in templates for these +notifications: + +@table @code +@kwindex project +@item project +Project system name. + +@kwindex url +@acronym{URL} of the distribution site. + +@kwindex dir +Directory (relative to the project distribution root) to where the +files where uploaded. + +@kwindex dest-dir +Value of the @code{destination} keyword. + +@kwindex source-dir +Value of the @code{source} keyword. + +@kwindex triplet:full +@item triplet:full +Full listing of the uploaded triplet. It is equivalent to: + +@smallexample +@group +%@{triplet:dist@} +%@{triplet:sig@} +%@{triplet:dir@} +@end group +@end smallexample + +For example: + +@FIXME{example} + +@kwindex triplet:upload +@item triplet:upload +Listing of the uploaded files. + +@FIXME{example} + +@kwindex triplet:dist +@item triplet:dist +Listing of the main distribution file. + +@kwindex triplet:sig +@item triplet:sig +Listing of the detached signature file. + +@kwindex triplet:dir +@item triplet:dir +Listing of the directive file. + +@kwindex user +@kwindex user:name +@item user +@itemx user:name +System name of the user who uploaded the triplet. + +@kwindex user:real-name +@item user:real-name +Real name of the user who uploaded the triplet. + +@kwindex user:email +@item user:email +Email of the user who uploaded the triplet. +@end table + + The following example shows how to configure success notification +for the user: + +@smallexample +define-message user-success +Subject: Upload of %@{project@} successful + +Upload of %@{project@} to %@{dir@} finished successfully. +Files uploaded: + +%@{triplet:upload@} + +Regards, +Wydawca +The Project Submission Robot +end + +notify-event success user user-success +@end smallexample + @node wydawca.rc, invocation, configuring, Top @chapter @command{Wydawca} configuration file. @cindex configuration statements, reference |