]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/spool.texi
Unify @ref and @command usage
[nncp.git] / doc / spool.texi
index 14f8ee2b6c4663a363ce20f23de1f0e024847414..c7ddb31a0e5910f31dddff247aa36bec3732d4e3 100644 (file)
@@ -1,4 +1,5 @@
 @node Spool
+@cindex spool directory
 @unnumbered Spool directory
 
 Spool directory holds @ref{Encrypted, encrypted packets} received from
@@ -18,6 +19,7 @@ spool/tmp
 
 @table @file
 
+@cindex tmp directory
 @item tmp
 directory contains various temporary files that under normal
 circumstances are renamed to necessary files inside other directories.
@@ -27,10 +29,13 @@ filesystem for working renaming.
 @item 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
 is an example Base32-encoded neighbour identifier.
 
+@cindex rx directory
+@cindex tx directory
 @item rx, tx
 directories are for incoming and outgoing encrypted packets. @file{rx}
 contains currently unfinished, non-checked, unprocessed, etc packets.
 
+@cindex lock files
 @item toss.lock, rx.lock, tx.lock
 Lock files. Only single process can work with @file{rx}/@file{tx}
 directories at once.
@@ -40,40 +45,44 @@ is an example @ref{Encrypted, encrypted packet}. Its filename is Base32
 encoded @ref{MTH} hash of the whole contents. It can be integrity checked
 anytime.
 
+@cindex part files
 @item LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ.part
 is an example @strong{partly} received file. It can appear only when
 online transfer is used. Its filename is sent by remote side and until
 file is fully downloaded -- it plays no role.
 
+@cindex nock files
 @item LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ.nock
 non-checksummed (NoCK) @strong{fully} received file. Its checksum is
-verified against its filename either by @ref{nncp-check}, or by working
-online daemons. If it is correct, then its extension is trimmed.
+verified against its filename either by @command{@ref{nncp-check}}, or
+by working online daemons. If it is correct, then its extension is trimmed.
 
-@item LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ.seen
-@ref{nncp-toss} utility can be invoked with @option{-seen} option,
-leading to creation of @file{.seen} files, telling that the file with
-specified hash has already been processed before. It could be useful
-when there are use-cases where multiple ways of packets transfer
+@cindex seen files
+@item seen/LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ
+@command{@ref{nncp-toss}} utility can be invoked with @option{-seen}
+option, leading to creation of @file{seen/} files, telling that the file
+with specified hash has already been processed before. It could be
+useful when there are use-cases where multiple ways of packets transfer
 available and there is possibility of duplicates reception. You have to
 manually remove them, when you do not need them (probably because they
 are expired).
 
+@cindex hdr files
 @anchor{HdrFile}
-@item LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ.hdr
+@item hdr/LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ
 If no @ref{CfgNoHdr, nohdr} option is enabled in configuration file,
-then @file{.hdr} files are automatically created for every ordinary
+then @file{hdr/} files are automatically created for every ordinary
 (fully received and checksummed) packet. It literally contains just the
 header of the corresponding packet. It will be automatically created
-even during simple @ref{nncp-stat} call. On filesystems with big
-blocksize (ZFS for example) it can greatly help listing the packets in
-directories, because it prevents unnecessary read-amplification. On
+even during simple @command{@ref{nncp-stat}} call. On filesystems with
+big blocksize (ZFS for example) it can greatly help listing the packets
+in directories, because it prevents unnecessary read-amplification. On
 other filesystems probably it won't help at all, or even harm
 performance.
 
-There is a hack: you can create more dense @file{.hdr} allocation by
-removing all @file{.hdr} files and then running @command{nncp-stat},
-that will recreate them. In many cases many @file{.hdr} files will be
+There is a hack: you can create more dense @file{hdr/} allocation by
+removing all @file{hdr/} files and then running @command{@ref{nncp-stat}},
+that will recreate them. In many cases many @file{hdr/} files will be
 allocated more or less linearly on the disk, decreasing listing time
 even more.