doc/cmd/nncp-ack.texi

   1 @node nncp-ack
   2 @cindex packet acknowledgement
   3 @pindex nncp-ack
   4 @section nncp-ack
   5
   6 @example
   7 $ nncp-ack [options] -all
   8 $ nncp-ack [options] -node NODE[,@dots{}]
   9 $ nncp-ack [options] -node NODE -pkt PKT
  10 @end example
  11
  12 Send acknowledgement of successful @option{PKT} (Base32-encoded hash)
  13 packet receipt from @option{NODE} node. If no @option{-pkt} is
  14 specified, then acknowledge all packet in node's @code{rx} outbound
  15 spool. If @option{-all} is specified, then do that for all nodes.
  16
  17 General workflow with acknowledgement is following, assuming that
  18 Alice has some outbound packets for Bob:
  19
  20 @itemize
  21
  22 @item Transfer encrypted packets, without deleting them locally:
  23
  24 @example
  25 alice$ nncp-xfer -keep -tx -node bob /mnt/shared
  26 @end example
  27
  28 @item On Bob's side retrieve those packets:
  29
  30 @example
  31 bob$ nncp-xfer -rx /mnt/shared
  32 @end example
  33
  34 That will also check if copied packets checksum is not mismatched.
  35
  36 @item Create ACK packets of received ones:
  37
  38 @example
  39 bob$ nncp-ack -node alice
  40 @end example
  41
  42 @item Send those newly created packets back to Alice:
  43
  44 @example
  45 bob$ nncp-xfer -tx /mnt/shared
  46 @end example
  47
  48 @item Get those acknowledgement packets and @ref{nncp-toss, toss} them:
  49
  50 @example
  51 alice$ nncp-xfer -rx /mnt/shared
  52 alice$ nncp-toss
  53 @end example
  54
  55 Each ACK packet will remove kept corresponding outbound packets, because
  56 Bob explicitly confirmed their receipt.
  57
  58 @end itemize
  59
  60 Similarly you can use it with @command{@ref{nncp-bundle}}, but do not
  61 forget that by default it does not do checksumming of the packets, so
  62 you should either use its @option{-check} option, or run
  63 @command{@ref{nncp-check}} after.