]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/cfg/general.texi
Multicast areas
[nncp.git] / doc / cfg / general.texi
diff --git a/doc/cfg/general.texi b/doc/cfg/general.texi
new file mode 100644 (file)
index 0000000..63d0757
--- /dev/null
@@ -0,0 +1,48 @@
+@node CfgGeneral
+@section Configuration general options
+
+Those options are in the root of configuration dictionary.
+
+@verbatim
+spool: /var/spool/nncp
+log: /var/spool/nncp/log
+
+# All of options below are optional
+umask: "022"
+noprogress: true
+nohdr: true
+
+# MultiCast Discovery
+mcd-listen: ["em0", "igb1"]
+mcd-send: {em0: 60, igb1: 5}
+@end verbatim
+
+@table @code
+@item spool
+Absolute path to the @ref{Spool, spool} directory.
+@item log
+Absolute path to the @ref{Log, log} file.
+@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}.
+@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.
+@anchor{CfgNoHdr}
+@item nohdr
+@strong{nohdr} option disables @ref{HdrFile, .hdr} files usage.
+@end table
+
+And optional @ref{MCD, MultiCast Discovery} options:
+
+@table @code
+@anchor{CfgMCDListen}
+@item mcd-listen
+Specifies list of network interfaces @ref{nncp-caller} will listen for
+incoming @ref{MCD} announcements.
+@anchor{CfgMCDSend}
+@item mcd-send
+Specifies list of network interfaces, and intervals in seconds, where
+@ref{nncp-daemon} will send @ref{MCD} announcements.
+@end table