-maxonlinetime option

[nncp.git] / doc / cfg.texi

diff --git a/doc/cfg.texi b/doc/cfg.texi
index 28b1e5d914cdc9483c88748e2e85986e51abd249..3160d73d96d8e51a23271f6f86342c9c4e9f9f73 100644 (file)
--- a/doc/cfg.texi
+++ b/doc/cfg.texi
@@ -35,10 +35,14 @@ 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
+    calls:
+      -
+        cron: "*/2 * * * *"
   bob:
     id: 2IZNP...UYGYA
     exchpub: WFLMZ...B7NHA
@@ -52,6 +56,7 @@ neigh:
 directory. @strong{log} field contains an absolute path to @ref{Log,
 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.
@@ -78,15 +83,18 @@ node has the following fields:
 If present, then node can be online called using @ref{Sync,
 synchronization protocol}. Contains authentication public key.
 
+@anchor{CfgSendmail}
 @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.
 
+@anchor{CfgIncoming}
 @item incoming
 Full path to directory where all file uploads will be saved. May be
 omitted to forbid file uploading on that node.
 
+@anchor{CfgFreq}
 @item freq
 Full path to directory from where file requests will queue files for
 transmission. May be omitted to forbid freqing from that node.
@@ -97,6 +105,7 @@ For example @verb{|[foo,bar]|} means that packet can reach current node
 by transitioning through @emph{foo} and then @emph{bar} nodes. May be
 omitted if direct connection exists and no relaying is required.
 
+@anchor{CfgAddrs}
 @item addrs
 Dictionary containing known network addresses of the node. Each key is
 human-readable name of the link/address. Values are @verb{|addr:port|}
@@ -104,7 +113,7 @@ pairs pointing to @ref{nncp-daemon}'s listening instance. May be omitted
 if either no direct connection exists, or @ref{nncp-call} is used with
 forced address specifying.
 
-@anchor{Onlinedeadline}
+@anchor{CfgOnlineDeadline}
 @item onlinedeadline
 Online connection deadline of node inactivity in seconds. It is the time
 connection considered dead after not receiving/sending any packets and
@@ -114,4 +123,14 @@ 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
+List of @ref{Call, call configuration}s. Can be omitted if
+@ref{nncp-caller} won't be used to call that node.
+
 @end table