NNCP_SENDER envvar while sendmail calling

[nncp.git] / doc / cfg.texi

diff --git a/doc/cfg.texi b/doc/cfg.texi
index acfdbf7a574bb7e2d067e0abfe2e69cfb6d470ad..0420d3959fec7352b25e7695cd1159fec9d3f12a 100644 (file)
--- a/doc/cfg.texi
+++ b/doc/cfg.texi
@@ -35,7 +35,8 @@ neigh:
     noisepub: UBM5K...VI42A
     sendmail: ["/bin/sh", "-c", "false"]
     incoming: /home/alice/incoming
-    onlinedeadline: 3600
+    onlinedeadline: 1800
+    maxonlinetime: 3600
     addrs:
       lan: "[fe80::1234%igb0]:5400"
       internet: alice.com:3389
@@ -48,6 +49,8 @@ neigh:
     signpub: GTGXG...IE3OA
     sendmail: [/usr/sbin/sendmail]
     freq: /home/bob/pub
+    freqchunked: 1024
+    freqminsize: 2048
     via: [alice]
 @end verbatim
 
@@ -58,7 +61,7 @@ log} file.
 @anchor{CfgNotify}
 @strong{notify} section contains notification settings for successfully
 tossed file and freq packets. Corresponding @strong{from} and
-@strong{to} fields will substituted in notification email message.
+@strong{to} fields will be substituted in notification email message.
 @emph{neigh/self/sendmail} will be used as a local mailer. You can omit
 either of those two @emph{from}/@emph{to} sections to omit corresponding
 notifications, or the whole section at once.
@@ -86,7 +89,9 @@ synchronization protocol}. Contains authentication public key.
 @item sendmail
 An array containing path to executable and its command line arguments
 that is called for mail sending. If it is empty, then no mail processing
-will be performed from that node.
+will be performed from that node. Sendmail command
+@command{["/bin/foo", "bar"]} called the following way:
+@command{NNCP_SENDER=NODEID /bin/foo bar RCPT1 RCPT2 ... < MSG}.
 
 @anchor{CfgIncoming}
 @item incoming
@@ -98,6 +103,14 @@ omitted to forbid file uploading on that node.
 Full path to directory from where file requests will queue files for
 transmission. May be omitted to forbid freqing from that node.
 
+@item freqchunked
+If set, then enable @ref{Chunked, chunked} file transmission during
+freqing. This is the desired chunk size in KiBs.
+
+@item freqminsize
+If set, then apply @ref{OptMinSize, -minsize} option during file
+transmission.
+
 @item via
 An array of node identifiers that will be used as a relay to that node.
 For example @verb{|[foo,bar]|} means that packet can reach current node
@@ -117,10 +130,15 @@ forced address specifying.
 Online connection deadline of node inactivity in seconds. It is the time
 connection considered dead after not receiving/sending any packets and
 node must disconnect. By default it is set to 10 seconds -- that means
-that disconnecting after 10 seconds when no packets received and
-transmitted. This can be set to rather high values to keep connection
-alive (to reduce handshake overhead and delays), wait for appearing
-packets ready to send and notifying remote side about their appearance.
+disconnecting after 10 seconds when no packets received and transmitted.
+This can be set to rather high values to keep connection alive (to
+reduce handshake overhead and delays), wait for appearing packets ready
+to send and notifying remote side about their appearance.
+
+@anchor{CfgMaxOnlineTime}
+@item maxonlinetime
+If greater than zero, then it is maximal amount of time connect could be
+alive. Forcefully disconnect if it is exceeded.
 
 @anchor{CfgCalls}
 @item calls