doc/storage.texi

   1 @node Storage
   2 @unnumbered Storage
   3
   4 Each feed is kept in separate subdirectory in the @file{feeds/}. Its
   5 name is not important, but human readable is preferable choice. It
   6 contains:
   7
   8 @table @file
   9
  10 @item url
  11 File with the URL of the feed. This is the only file you have to
  12 manually deal with.
  13
  14 @item max
  15 If may contain maximal number of messages per current feed to keep and
  16 process.
  17
  18 @item etag, hdr, out
  19 Those files are used by @command{curl} to keep the content, its proper
  20 @code{mtime} (for @code{If-Modified-Since} header generation),
  21 @code{ETag} and response headers for debugging.
  22
  23 @item feed.zst
  24 It contains the content itself. Compressed with
  25 @url{https://facebook.github.io/zstd/, Zstandard}.
  26
  27 @item download.hash, parse.hash
  28 SHA-512 hash of the @file{feed.zst}, used to determine if feed was
  29 updated and parser has to do the job.
  30
  31 @item title
  32 Automatically generated file with the title of the feed.
  33
  34 @item cur/, new/, tmp/
  35 Directories necessary for making the directory Maildir mailbox. They
  36 contain parsed news posts.
  37
  38 @item encs/, warcs/
  39 Optionally created directories for storing of downloaded
  40 @ref{Enclosures, enclosures} and @ref{WARCs}.
  41
  42 @end table