X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=doc%2Fcfg.texi;h=3e0b882b0582f7c16792b9ed057e18d1b4c46d07;hb=4c17993ce76c6f1883e6854d826eafd4c33c1594;hp=46fa5f30ca50aefe1d8b09efccd167f352986f33;hpb=2ac16acad8de20005793cbadd61068d38dc3b0ca;p=nncp.git diff --git a/doc/cfg.texi b/doc/cfg.texi index 46fa5f3..3e0b882 100644 --- a/doc/cfg.texi +++ b/doc/cfg.texi @@ -8,6 +8,7 @@ Example @url{https://hjson.org/, Hjson} configuration file: spool: /var/spool/nncp log: /var/spool/nncp/log umask: "022" + noprogress: true notify: { file: { @@ -98,6 +99,10 @@ Non-empty optional @strong{umask} will force all invoked commands to override their umask to specified octal mask. Useful for using with @ref{Shared spool, shared spool directories}. +Enabled @strong{noprogress} option disabled progress showing for many +commands by default. You can always force its showing with +@option{-progress} command line option anyway. + @anchor{CfgNotify} @strong{notify} section contains notification settings for successfully tossed file, freq and exec packets. Corresponding @strong{from} and @@ -137,18 +142,18 @@ Dictionary consisting of handles and corresponding command line arguments. In example above there are @command{sendmail} handles, @command{warcer}, @command{wgeter} and @command{flag} one. Remote node can queue some handle execution with providing additional command line -arguments and the body fed to command's stdin. +arguments and the body fed to command's @code{stdin}. @verb{|sendmail: ["/usr/sbin/sendmail", "-t"]|} handle, when called by @verb{|echo hello world | nncp-exec OURNODE sendmail ARG0 ARG1 ARG2|} command, will execute: -@verbatim +@example NNCP_SELF=OURNODE \ NNCP_SENDER=REMOTE \ NNCP_NICE=64 \ /usr/sbin/sendmail -t ARG0 ARG1 ARG2 -@end verbatim +@end example feeding @verb{|hello world\n|} to that started @command{sendmail} process. @@ -185,9 +190,9 @@ human-readable name of the address. For direct TCP connections use @verb{|host:port|} format, pointing to @ref{nncp-daemon}'s listening instance. Also you can pipe connection through the external command using @verb{#|some command#} format. @code{/bin/sh -c "some command"} -will start and its stdin/stdout used as a connection. May be omitted if -either no direct connection exists, or @ref{nncp-call} is used with -forced address specifying. +will start and its @code{stdin}/@code{stdout} used as a connection. May +be omitted if either no direct connection exists, or @ref{nncp-call} is +used with forced address specifying. @anchor{CfgXxRate} @item rxrate/txrate @@ -198,18 +203,18 @@ omitted at all -- no rate limits. @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 -node must disconnect. By default it is set to 10 seconds -- that means -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. +Online connection deadline of nodes inactivity in seconds. It is the +time connection considered dead after not receiving/sending any packets +(except for PINGs) and connection must be terminated. By default it is +set to 10 seconds. 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. +If greater than zero, then it is maximal time of single connection. +Forcefully disconnect if it is exceeded. @anchor{CfgCalls} @item calls @@ -217,22 +222,3 @@ List of @ref{Call, call configuration}s. Can be omitted if @ref{nncp-caller} won't be used to call that node. @end table - -@menu -* Shared spool directory: Shared spool. -@end menu - -@node Shared spool -@section Shared spool directory - -If you want to share single spool directory with multiple grouped Unix -users, then you can @command{setgid} it and assure that umask is group -friendly. For convenience you can set @option{umask} globally for -invoked NNCP commands in the configuration file. For example: - -@verbatim -$ chgrp nncp /usr/local/etc/nncp.hjson /var/spool/nncp -$ chmod g+r /usr/local/etc/nncp.hjson -$ chmod g+rwxs /var/spool/nncp -$ echo 'umask: "007"' >> /usr/local/etc/nncp.hjson -@end verbatim