]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/cfg/general.texi
Add various documentation indices
[nncp.git] / doc / cfg / general.texi
index 69551a280e85521acb0a16979d14db16c2e5554a..a2aed512538a7c1a765def996092b41edd6e76aa 100644 (file)
@@ -1,4 +1,5 @@
 @node CfgGeneral
+@cindex general configuration options
 @section Configuration general options
 
 Those options are in the root of configuration dictionary.
@@ -13,8 +14,8 @@ noprogress: true
 nohdr: true
 
 # MultiCast Discovery
-mcd-listen: ["em0", "igb1"]
-mcd-send: {em0: 60, igb1: 5}
+mcd-listen: ["em[0-3]", "igb_.*"]
+mcd-send: {"em[0-3]": 60, igb_.*: 5}
 
 # Yggdrasil aliases
 yggdrasil-aliases: {
@@ -26,8 +27,13 @@ yggdrasil-aliases: {
 @end verbatim
 
 @table @code
+
+@vindex spool
 @item spool
 Absolute path to the @ref{Spool, spool} directory.
+
+@vindex log
+@vindex FD log file descriptor
 @item log
 Either:
     @itemize
@@ -35,31 +41,43 @@ Either:
     @item @code{FD:XXX}, where @code{XXX} is a decimal file descriptor
         to write records too
     @end itemize
+
+@vindex umask
 @item umask
 Will force all invoked commands to override their umask to specified
 octal mask. Useful for using with @ref{Shared spool, shared spool directories}.
+
+@vindex noprogress
 @item noprogress
 When enabled, disables progress showing for many commands by default.
 You can always force its showing with @option{-progress} command line
 option anyway.
+
+@vindex nohdr
 @anchor{CfgNoHdr}
 @item nohdr
 @strong{nohdr} option disables @ref{HdrFile, @file{hdr/}} files usage.
+
 @end table
 
 And optional @ref{MCD, MultiCast Discovery} options:
 
 @table @code
+
+@vindex mcd-listen
 @anchor{CfgMCDListen}
 @item mcd-listen
-Specifies list of network interfaces @ref{nncp-caller} will listen for
-incoming @ref{MCD} announcements.
+Specifies list of network interfaces regular expression
+@ref{nncp-caller} will listen for incoming @ref{MCD} announcements.
+
+@vindex mcd-send
 @anchor{CfgMCDSend}
 @item mcd-send
-Specifies list of network interfaces, and intervals in seconds, where
-@ref{nncp-daemon} will send @ref{MCD} announcements.
+Specifies list of network interfaces regular expressions, and intervals
+in seconds, where @ref{nncp-daemon} will send @ref{MCD} announcements.
 @end table
 
+@cindex yggdrasil aliases
 @anchor{CfgYggdrasilAliases}
 Optional @ref{Yggdrasil}-related aliases are used for convenience and
 keeping private keys away being used directly in command line. Each