Add various documentation indices

[nncp.git] / doc / spool.texi

diff --git a/doc/spool.texi b/doc/spool.texi
index 61ec8c3513928fbb13eb33941382e5edab309c19..76c1f596b27205ace36ad503616d0da8f52db8db 100644 (file)
--- a/doc/spool.texi
+++ b/doc/spool.texi
@@ -1,4 +1,5 @@
 @node Spool
 @node Spool

+@cindex spool directory

 @unnumbered Spool directory
 
 Spool directory holds @ref{Encrypted, encrypted packets} received from
 @unnumbered Spool directory
 
 Spool directory holds @ref{Encrypted, encrypted packets} received from


@@ -18,6 +19,7 @@ spool/tmp
 
 @table @file
 
 
 @table @file
 

+@cindex tmp directory

 @item tmp
 directory contains various temporary files that under normal
 circumstances are renamed to necessary files inside other directories.
 @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.
 
 @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.
 
 @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.
 @item toss.lock, rx.lock, tx.lock
 Lock files. Only single process can work with @file{rx}/@file{tx}
 directories at once.


@@ -40,16 +45,19 @@ 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.
 
 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.
 
 @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.
 
 @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.
 

+@cindex seen files

 @item seen/LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ
 @ref{nncp-toss} utility can be invoked with @option{-seen} option,
 leading to creation of @file{seen/} files, telling that the file with
 @item seen/LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ
 @ref{nncp-toss} utility can be invoked with @option{-seen} option,
 leading to creation of @file{seen/} files, telling that the file with


@@ -59,6 +67,7 @@ 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).
 
 manually remove them, when you do not need them (probably because they
 are expired).
 

+@cindex hdr files

 @anchor{HdrFile}
 @item hdr/LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ
 If no @ref{CfgNoHdr, nohdr} option is enabled in configuration file,
 @anchor{HdrFile}
 @item hdr/LYT64MWSNDK34CVYOO7TA6ZCJ3NWI2OUDBBMX2A4QWF34FIRY4DQ
 If no @ref{CfgNoHdr, nohdr} option is enabled in configuration file,