]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/spool.texi
Merge branch 'develop'
[nncp.git] / doc / spool.texi
index 53ea301cdc0f9b3f782df70a4ad7f4b5c377d622..5e7812d50b6a0944356aed56ce12bcc488662b55 100644 (file)
@@ -5,30 +5,37 @@ Spool directory holds @ref{Encrypted, encrypted packets} received from
 remote nodes and queued for sending to them. It has the following
 example structure:
 
-@verbatim
+@example
 spool/tmp/
 spool/2WHB...OABQ/rx.lock
 spool/2WHB...OABQ/rx/5ZIB...UMKW.part
 spool/2WHB...OABQ/tx.lock
+spool/2WHB...OABQ/toss.lock
 spool/BYRR...CG6Q/rx.lock
 spool/BYRR...CG6Q/rx/
 spool/BYRR...CG6Q/tx.lock
+spool/BYRR...CG6Q/tx/AQUT...DGNT.seen
 spool/BYRR...CG6Q/tx/NSYY...ZUU6
+spool/BYRR...CG6Q/tx/VCSR...3VXX.seen
 spool/BYRR...CG6Q/tx/ZI5U...5RRQ
-@end verbatim
+@end example
 
 Except for @file{tmp}, all other directories are Base32-encoded node
 identifiers (@file{2WHB...OABQ}, @file{BYRR...CG6Q} in our example).
-Each node subdirectory has @file{rx} (received, partly received and
+Each node subdirectory has @file{rx} (received, partially received and
 currently unprocessed packets) and @file{tx} (for outbound packets)
 directories.
 
 Each @file{rx}/@file{tx} directory contains one file per encrypted
 packet. Its filename is Base32 encoded BLAKE2b hash of the contents. So
 it can be integrity checked at any time. @file{5ZIB...UMKW.part} is
-partly received file from @file{2WHB...OABQ} node. @file{tx} directory
-can not contain partly written files -- they are moved atomically from
-@file{tmp}.
+partially received file from @file{2WHB...OABQ} node. @file{tx}
+directory can not contain partially written files -- they are moved
+atomically from @file{tmp}.
+
+When @ref{nncp-toss} utility is called with @option{-seen} option, it
+will create empty @file{XXX.seen} files, telling that some kind of
+packet was already tossed sometime.
 
 Only one process can work with @file{rx}/@file{tx} directories at once,
 so there are corresponding lock files.