]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/cmds.texi
nncp-rm command
[nncp.git] / doc / cmds.texi
index 9097044773b37c88ff414284f7ca60856fdd3870..4fa10456e5430e39b0b7b42a0434bdee076c40c5 100644 (file)
@@ -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
@@ -62,8 +60,8 @@ overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
 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,
@@ -75,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
@@ -91,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
@@ -167,15 +166,28 @@ side will execute specified @ref{CfgSendmail, sendmail} command with
 @option{USER}s appended as a command line argument and feed decompressed
 mail body to that command's stdin.
 
-@node nncp-newnode
-@section nncp-newnode
+@node nncp-mincfg
+@section nncp-mincfg
 
 @verbatim
-% nncp-newnode [options] > mynewnode.yaml
+% nncp-mincfg [options] > stripped.yaml
 @end verbatim
 
-Generate new node: private keys, example configuration file and print it
-to stdout. You must use this command when you setup the new node.
+Print out stripped configuration version: only path to @ref{Spool,
+spool}, path to log file, neighbours public keys are stayed. This is
+useful mainly for usage with @ref{nncp-xfer} that has to know only
+neighbours, without private keys involving.
+
+@node nncp-newcfg
+@section nncp-newcfg
+
+@verbatim
+% nncp-newcfg [options] > new.yaml
+@end verbatim
+
+Generate new node configuration: private keys, example configuration
+file and print it to stdout. You must use this command when you setup
+the new node.
 
 Pay attention that private keys generation consumes an entropy from your
 operating system.
@@ -196,7 +208,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,
@@ -272,6 +283,20 @@ remove them.
 @option{-rx} option tells only to move inbound packets addressed to us.
 @option{-tx} option tells exactly the opposite: move only outbound packets.
 
+@ref{nncp-mincfg} could be useful for creating stripped minimalistic
+configuration file version without any private keys.
+
 @file{DIR} directory has the following structure:
 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
 destination node, @file{SENDER} is Base32 encoded sender node.
+
+@node nncp-rm
+@section nncp-rm
+
+@verbatim
+% nncp-rm [options] NODE PKT
+@end verbatim
+
+Remove specified packet (Base32 name) in @option{NODE}'s queues. This
+command is useful when you want to remove the packet that is failing to
+be processed.