From: Sergey Matveev <stargrave@stargrave.org>
Date: Wed, 6 Jan 2021 19:53:04 +0000 (+0300)
Subject: Various documentation fixes
X-Git-Tag: v5.5.0^2~4
X-Git-Url: http://www.git.cypherpunks.ru/?p=nncp.git;a=commitdiff_plain;h=57ad1181a80e569791e2e495f5765f3762fd024d

Various documentation fixes
---

diff --git a/doc/cfg.texi b/doc/cfg.texi
index 1acfc33..7ff63f3 100644
--- a/doc/cfg.texi
+++ b/doc/cfg.texi
@@ -203,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
diff --git a/doc/cmds.texi b/doc/cmds.texi
index abaa60a..2fb0374 100644
--- a/doc/cmds.texi
+++ b/doc/cmds.texi
@@ -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.
 
-Look @ref{nncp-call} for more information.
+Look at @ref{nncp-call} for more information.
 
 @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
@@ -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.
 
+@strong{Pay attention} that packet generated with this command can not
+be chunked.
+
 @node nncp-file
 @section nncp-file
 
diff --git a/doc/log.texi b/doc/log.texi
index 1b0f43e..9bcff52 100644
--- a/doc/log.texi
+++ b/doc/log.texi
@@ -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
-    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
-    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
diff --git a/doc/thanks.texi b/doc/thanks.texi
index c0cb808..f4cee43 100644
--- a/doc/thanks.texi
+++ b/doc/thanks.texi
@@ -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
-suggestions and Debian package maintenance.
+suggestions, bugreports and Debian package maintenance.
 
 @end itemize