Add various documentation indices

[nncp.git] / doc / call.texi

diff --git a/doc/call.texi b/doc/call.texi
index fe55de5456d2b9f82c4aa83b428f6c13155d4c0b..388f041a553fd483da7111a8350d221bcbf10e8f 100644 (file)
--- a/doc/call.texi
+++ b/doc/call.texi
@@ -1,7 +1,9 @@
 @node Call
+@cindex call
+@vindex calls
 @unnumbered Call configuration
 
-Call is a rule when and how node can be called.
+Call is a rule when and how node can be called by @ref{nncp-caller}.
 
 Example list of call structures:
 
@@ -14,7 +16,7 @@ calls: [
 
         autotoss: true
         autotoss-doseen: true
-    },
+    }
     {
         cron: "30 * * * SAT,SUN"
         onlinedeadline: 1800
@@ -22,17 +24,18 @@ calls: [
         nice: NORMAL
         rxrate: 10
         txrate: 20
-    },
+    }
     {
         cron: "0 * * * SAT,SUN"
         xx: rx
         addr: lan
-    },
+    }
     {
         cron: "*/5 * * * * * *"
         when-tx-exists: true
         nock: true
-    },
+        mcd-ignore: true
+    }
 ]
 @end verbatim
 
@@ -50,17 +53,23 @@ It contains the following fields (only @emph{cron} is required):
 
 @table @emph
 
+@vindex cron
 @item cron
 @include cronexpr.texi
 
+@vindex nice
 @item nice
 Optional. Use that @ref{Niceness, niceness} during the call (255 is used
 otherwise).
 
+@vindex xx
+@vindex rx
+@vindex tx
 @item xx
 Optional. Either @verb{|rx|} or @verb{|tx|}. Tells only to either to
 receive or to transmit data during that call.
 
+@vindex addr
 @item addr
 Optional. Call only that address, instead of trying all from
 @ref{CfgAddrs, @emph{addrs}} configuration option. It can be either key
@@ -78,14 +87,21 @@ configuration option when calling.
 Optional. Override @ref{CfgMaxOnlineTime, @emph{maxonlinetime}}
 configuration option when calling.
 
+@vindex autotoss
 @item autotoss, -doseen, -nofile, -nofreq, -noexec, -notrns
 Optionally enable auto tossing: run tosser on node's spool every second
-during the call. You can control either are @file{.seen} files must be
+during the call. You can control either are @file{seen/} files must be
 created, or skip any kind of packet processing.
 
+@vindex when-tx-exists
 @item when-tx-exists
-Call only if packets for sending exists.
+Call only if packets for sending exists. The check of outbound packets
+existence is performed @strong{every} time we are going to make a call,
+but @emph{when-tx-exists} does not influence @emph{cron}. When
+@emph{cron} configuration decides that it is time to make a call, with
+@emph{when-tx-exists} option it checks packets existence first.
 
+@vindex nock
 @anchor{CfgNoCK}
 @item nock
 NoCK (no-checksumming) tells not to do checksumming of received files,
@@ -96,4 +112,10 @@ received one, but just sequential writing of the file. Pay attention
 that you have to make a call to remote node after checksumming is done,
 to send notification about successful packet reception.
 
+@vindex mcd-ignore
+@anchor{CfgMCDIgnore}
+@item mcd-ignore
+Ignore @ref{MCD} announcements: do not add MCD addresses for possible
+connection attempts.
+
 @end table