Various documentation fixes

[nncp.git] / doc / cmds.texi

diff --git a/doc/cmds.texi b/doc/cmds.texi
index b71b202955cebf8bff2fec05760a732fac750513..4c1873f85d2fcd548a3b2b1d355f150e80959779 100644 (file)
--- a/doc/cmds.texi
+++ b/doc/cmds.texi
@@ -14,10 +14,8 @@ Nearly all commands have the following common options:
     KiB file and set @option{-minsize 4096}, then resulting packet will
     be 4 KiB (containing file itself and some junk).
 @item -nice
-    Set desired outgoing packet niceness level. 1-255 values are
-    allowed. Higher value means lower priority. In some commands that
-    means processing of packets that have equal or lower nice value.
-    That is used for controlling network QoS.
+    Set desired outgoing packet @ref{Niceness, niceness level}.
+    1-255 values are allowed.
 @item -node
     Process only single specified node.
 @item -quiet
@@ -34,7 +32,8 @@ Nearly all commands have the following common options:
 @section nncp-call
 
 @verbatim
-% nncp-call [options] [-onlinedeadline INT] [-rx|-tx] NODE[:ADDR] [FORCEADDR]
+% nncp-call [options] [-onlinedeadline INT] [-maxonlinetime INT] [-rx|-tx]
+                      NODE[:ADDR] [FORCEADDR]
 @end verbatim
 
 Call (connect to) specified @option{NODE} and run @ref{Sync,
@@ -44,9 +43,12 @@ either check for incoming packets, or to send out queued ones.
 Synchronization protocol allows resuming and bidirectional packets
 transfer.
 
-If @option{-rx} option is specified then only inbound packets transmission
-is performed. If @option{-tx} option is specified, then only outbound
-transmission is performed.
+If @option{-rx} option is specified then only inbound packets
+transmission is performed. If @option{-tx} option is specified, then
+only outbound transmission is performed. @option{-onlinedeadline}
+overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
+@option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
+@emph{maxonlinetime}}.
 
 @node nncp-caller
 @section nncp-caller
@@ -58,8 +60,8 @@ transmission is performed.
 Croned daemon that calls remote nodes from time to time, according to
 their @ref{CfgCalls, @emph{calls}} configuration field.
 
-Optional number of @option{NODE}s tells to call only them, ignoring the
-other. Otherwise all nodes with specified @emph{calls} configuration
+Optional number of @option{NODE}s tells to ignore other ones.
+Otherwise all nodes with specified @emph{calls} configuration
 field will be called.
 
 @option{-onlinedeadline} overrides @ref{CfgOnlineDeadline,
@@ -71,12 +73,13 @@ not specify the exact one, then all will be tried until the first
 success. Optionally you can force @option{FORCEADDR} address usage,
 instead of addresses taken from configuration file.
 
-Pay attention that this command run integrity check for each completely
-received packet in the background. This can be time consuming and
-connection could be lost during that check time and remote node won't be
+Pay attention that this command runs integrity check for each completely
+received packet in the background. This can be time consuming.
+Connection could be lost during that check and remote node won't be
 notified that file is done. But after successful integrity check that
-file will be renamed from @file{.part} one and when you rerun
-@command{nncp-call} again, remote node will receive completion at once.
+file is renamed from @file{.part} one and when you rerun
+@command{nncp-call} again, remote node will receive completion
+notification.
 
 @node nncp-check
 @section nncp-check
@@ -87,7 +90,7 @@ file will be renamed from @file{.part} one and when you rerun
 
 Perform @ref{Spool, spool} directory integrity check. Read all files
 that has Base32-encoded filenames and compare it with recalculated
-BLAKE2b hash output of their contents. This supplementary command are
+BLAKE2b hash output of their contents. This supplementary command is
 not used often in practice, if ever.
 
 @node nncp-daemon
@@ -181,7 +184,7 @@ operating system.
 
 @verbatim
 % nncp-pkt [options] < pkt
-% nncp-pkt [options] -dump < pkt > payload
+% nncp-pkt [options] [-decompress] -dump < pkt > payload
 @end verbatim
 
 Low level packet parser. Normally it should not be used, but can help in
@@ -192,7 +195,6 @@ By default it will print packet's type, for example:
 Packet type: encrypted
 Niceness: 64
 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
-Payload size: 4.0 MiB (4162852 bytes)
 @end verbatim
 
 If you specify @option{-dump} option and provide an @ref{Encrypted,
@@ -211,7 +213,9 @@ Path: stargrave@stargrave.org
 @end verbatim
 
 And with the @option{-dump} option it will give you the actual payload
-(the whole file, mail message, and so on).
+(the whole file, mail message, and so on). @option{-decompress} option
+tries to zlib-decompress the data from plain packet (useful for mail
+packets).
 
 @node nncp-stat
 @section nncp-stat
@@ -229,7 +233,7 @@ queues.
 @section nncp-toss
 
 @verbatim
-% nncp-toss [options] [-dryrun]
+% nncp-toss [options] [-dryrun] [-cycle INT]
 @end verbatim
 
 Perform "tossing" operation on all inbound packets. This is the tool
@@ -240,6 +244,10 @@ packets. It should be run after each online/offline exchange.
 @option{-dryrun} option does not perform any writing and sending, just
 tells what it will do.
 
+@option{-cycle} option tells not to quit, but to repeat tossing every
+@option{INT} seconds in an infinite loop. That can be useful when
+running this command as a daemon.
+
 @node nncp-xfer
 @section nncp-xfer