]> Cypherpunks.ru repositories - nncp.git/blob - doc/cfg/notify.texi
Add various documentation indices
[nncp.git] / doc / cfg / notify.texi
1 @node CfgNotify
2 @cindex email notification
3 @cindex notification configuration options
4 @cindex logging handles
5 @section Configuration notification options
6
7 That section controls what notifications are enabled and how must be
8 sent through the email. Notifications are sent for successful tossing of
9 file, freq or exec packet.
10
11 @verbatim
12 notify: {
13   file: {
14     from: nncp@localhost
15     to: user+file@example.com
16   }
17   freq: {
18     from: nncp@localhost
19     to: user+freq@example.com
20   }
21   exec: {
22     bob.somehandle: {
23       from: nncp+bob@localhost
24       to: user+somehandle@example.com
25     }
26     *.anotherhandle: {
27       from: nncp@localhost
28       to: user+anotherhandle@example.com
29     }
30   }
31 }
32 @end verbatim
33
34 Corresponding @strong{from} and @strong{to} fields will be substituted
35 in notification email message. @code{neigh.self.exec.sendmail} will be
36 used as a local mailer (command called for sending email message).
37
38 You can omit either of those two @code{from}/@code{to} sections to omit
39 corresponding notifications, or the whole section at once.
40
41 @code{notify.exec} section is a mapping of exec handles and
42 corresponding @code{from}/@code{to} sections. Each handle has either
43 @code{NODE.HANDLE} or @code{*.HANDLE} syntax. You can override
44 notification options for some node with the first type of name. Handle
45 command's output will be included in notification messages.