From bd41d7fa936dbdb8d567c0eb231b5b1dce345f5f Mon Sep 17 00:00:00 2001 From: Stephen L Johnson Date: Sun, 9 Jul 2000 08:04:12 +0000 Subject: [PATCH] updated documenation for message templates --- src/spong-message.pl | 57 ++++---------------------------------------- 1 file changed, 5 insertions(+), 52 deletions(-) diff --git a/src/spong-message.pl b/src/spong-message.pl index 2fd11ee..f08251f 100755 --- a/src/spong-message.pl +++ b/src/spong-message.pl @@ -961,58 +961,11 @@ formats.) =head2 Message Templates -Notification messages formats are determined by the templates in the -C<%TEMPLATES> variable in the F file. Templates are seached -according to the following order: 'contact:module', 'module', 'contact', -'DEFAULT'. - -Any text in a template string is added verbatim to the message. The list of -substituation variables can be added to the template strings. - -=over - -=item !!HOST!! - -Full domain of the system of the event message. - -=item !!SHORTHOST!! - -The short host name of the system of the event message. - -=item !!COLOR!! and !!STATUS!! - -The status color ('green', 'yellow', or 'red') of the status message. - -=item !!WWWSPONG!! - -The $WWWSPONG url variable from the F configuration variable. - -=item !!SUMMARY!! - -The summary message field in the status message. - -=item !!DETAILED!! - -The detailed message field of the status message. The value of this variable -can be very large and have multple lines of text. - -=item !!CURTIME!! - -The current system time formatted according to $DATETIMEFMT - -=item !!DATE!! - -The date of the event message formatted according to $DATEFMT - -=item !!TIME!! - -The date of the event message formmated according to $TIMEFMT - -=item !!DATETIME!! - -The date/time of the event message formateed according to $DATETIMEFMT - -=back +Notification messages are formatted by message templates in the %TEMPLATES +configuration variable in the F file. The 'DEFAULT' template +is use is no other tempate is found. Templates override can be defined for any +contact, message module, or a combination of the two. See +L for information on the file format. =head2 Messaging Modules -- 2.30.2