]> Cypherpunks.ru repositories - nncp.git/commitdiff
Various documentation fixes
authorSergey Matveev <stargrave@stargrave.org>
Wed, 6 Jan 2021 19:53:04 +0000 (22:53 +0300)
committerSergey Matveev <stargrave@stargrave.org>
Wed, 6 Jan 2021 19:53:04 +0000 (22:53 +0300)
doc/cfg.texi
doc/cmds.texi
doc/log.texi
doc/thanks.texi

index 1acfc33377dc06d6f257dd0b30785a0a65957f44..7ff63f30fd6e845367b24ae035a263918475fae0 100644 (file)
@@ -203,18 +203,18 @@ omitted at all -- no rate limits.
 
 @anchor{CfgOnlineDeadline}
 @item 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
-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
 
 @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
 
 @anchor{CfgCalls}
 @item calls
index abaa60afe89aea83934a1808a1c82ab3cad314dc..2fb0374cbf235eb3ceb04febf7d162834f6f50c3 100644 (file)
@@ -152,14 +152,14 @@ Optional number of @option{NODE}s tells to ignore other ones.
 Otherwise all nodes with specified @emph{calls} configuration
 field will be called.
 
 Otherwise all nodes with specified @emph{calls} configuration
 field will be called.
 
-Look @ref{nncp-call} for more information.
+Look at @ref{nncp-call} for more information.
 
 @node nncp-cfgenc
 @section nncp-cfgenc
 
 @example
 
 @node nncp-cfgenc
 @section nncp-cfgenc
 
 @example
-$ nncp-cfgmin [options] [-s INT] [-t INT] [-p INT] cfg.hjson > cfg.hjson.eblob
-$ nncp-cfgmin [options] -d cfg.hjson.eblob > cfg.hjson
+$ nncp-cfgenc [options] [-s INT] [-t INT] [-p INT] cfg.hjson > cfg.hjson.eblob
+$ nncp-cfgenc [options] -d cfg.hjson.eblob > cfg.hjson
 @end example
 
 This command allows you to encrypt provided @file{cfg.hjson} file with
 @end example
 
 This command allows you to encrypt provided @file{cfg.hjson} file with
@@ -295,6 +295,9 @@ If @ref{CfgNotify, notification} is enabled on the remote side for exec
 handles, then it will sent simple letter after successful command
 execution with its output in message body.
 
 handles, then it will sent simple letter after successful command
 execution with its output in message body.
 
+@strong{Pay attention} that packet generated with this command can not
+be chunked.
+
 @node nncp-file
 @section nncp-file
 
 @node nncp-file
 @section nncp-file
 
index 1b0f43e72541ac21d8258467d611c669b869d281..9bcff527b69f3a25612fed12449cd5332283b72f 100644 (file)
@@ -26,9 +26,10 @@ I 2017-01-09T08:48:59.264847401Z [call-finish duration="10" node="BYRRQUULEHINPK
     Is single character log level. As a rule is is either @verb{|I|}
     (informational message), or @verb{|E|} (error message).
 @item DATETIME
     Is single character log level. As a rule is is either @verb{|I|}
     (informational message), or @verb{|E|} (error message).
 @item DATETIME
-    UTC datetime in RFC 3339 @verb{|2006-01-02T15:04:05.999999999Z|} format.
+    UTC datetime in @url{https://tools.ietf.org/html/rfc339, RFC 3339}
+    @verb{|2006-01-02T15:04:05.999999999Z|} format.
 @item SD
 @item SD
-    Structured data as in RFC 5424.
+    Structured data as in @url{https://tools.ietf.org/html/rfc5424, RFC 5424}.
 @item MSG
     Arbitrary UTF-8 encoded text data.
 @end table
 @item MSG
     Arbitrary UTF-8 encoded text data.
 @end table
index c0cb8082b15935d844055b6a06293a5a5f5ef658..f4cee431d509945bff909cc6190bc89a63b83c4e 100644 (file)
@@ -12,6 +12,6 @@ NNCP under Ubuntu GNU/Linux distributions and bug reports.
 feedback and NixOS package maintenance.
 
 @item @url{mailto:jgoerzen@@complete.org, John Goerzen} for his feature
 feedback and NixOS package maintenance.
 
 @item @url{mailto:jgoerzen@@complete.org, John Goerzen} for his feature
-suggestions and Debian package maintenance.
+suggestions, bugreports and Debian package maintenance.
 
 @end itemize
 
 @end itemize