]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/cmd/nncp-ack.texi
Generate ACKs during tossing
[nncp.git] / doc / cmd / nncp-ack.texi
index 14feac3816abc0b46befa5e117655c3066dd5435..358822d089d8ce38181e5fbbe69d9088206ed0be 100644 (file)
@@ -1,60 +1,22 @@
 @node nncp-ack
-@cindex packet acknowledgement
 @pindex nncp-ack
 @section nncp-ack
 
 @example
-$ nncp-ack [options] NODE [PKT|rx]
-@end example
-
-Sent acknowledgement of successful @option{PKT} (Base32-encoded hash)
-packet receipt. If @option{rx} is specified instead, then all
-@option{NODE}'s existing @code{rx} packets will be acknowledged.
-
-General workflow with acknowledgement is following, assuming that
-Alice has some outbound packets for Bob:
-
-@itemize
-
-@item Transfer an encrypted packets, without deleting them locally:
-
-@example
-alice$ nncp-xfer -keep -tx -node bob /mnt/shared
-@end example
-
-@item On Bob's side retrieve those packets:
-
-@example
-bob$ nncp-xfer -rx /mnt/shared
-@end example
+$ nncp-ack [options] -all
+$ nncp-ack [options] -node NODE[,@dots{}]
+$ nncp-ack [options] -node NODE -pkt PKT
 
-That will also check if copied packets checksum is not mismatched.
-
-@item Create ACK packets of received ones:
-
-@example
-bob$ nncp-ack alice rx
-@end example
-
-@item Send those newly created packets back to Alice:
-
-@example
-bob$ nncp-xfer -tx /mnt/shared
-@end example
-
-@item Get those acknowledgement packets and @ref{nncp-toss, toss} them:
-
-@example
-alice$ nncp-xfer -rx /mnt/shared
-alice$ nncp-toss
+$ nncp-ack [@dots{}] 4>&1 >&2 | nncp-rm [@dots{}] -pkt
 @end example
 
-Each ACK packet will remove kept corresponding outbound packets, because
-Bob explicitly confirmed their receipt.
-
-@end itemize
+Send @ref{ACK, acknowledgement} of successful @option{PKT}
+(Base32-encoded hash) packet receipt from @option{NODE} node. If no
+@option{-pkt} is specified, then acknowledge all packet in node's
+@code{rx} spool. If @option{-all} is specified, then do that for all
+nodes.
 
-Similarly you can use it with @command{@ref{nncp-bundle}}, but do not
-forget that by default it does not do checksumming of the packets, so
-you should either use its @option{-check} option, or run
-@command{@ref{nncp-check}} after.
+That commands outputs list of created encrypted ACK packets
+(@code{NODE/PKT}) to @strong{4}th file descriptor. That output can be
+passed for example to @command{@ref{nncp-rm}} to remove them after
+transmission to not wait for acknowledgement and retransmission.