krino: 0.0.5 — keyword cache, t and d in reviewv0.0.5

1 files changed, 22 insertions, 0 deletions

diff --git a/man/krino.conf.5 b/man/krino.conf.5
index 769bd51..c89fbd9 100644
--- a/man/krino.conf.5
+++ b/man/krino.conf.5
@@ -521,6 +521,28 @@ Matching is substring:
 matches
 .Ql \&"acmeco\&" .
 Words hyphenated across lines in a PDF are not rejoined.
+.Ss Keyword cache
+For each file it extracts,
+.Nm krino
+records in
+.Pa $XDG_CACHE_HOME/krino/ Ns Ar name Ns Pa .cache
+which of the directory's content keywords the text contains, and answers
+later content tests from it while the file is unchanged.
+No text and no file names are stored; a file is known by device, inode,
+size and modification time, which a move or rename within one filesystem
+keeps.
+The keywords are stored as written in the configuration.
+.Pp
+A file is extracted again when it changes, or when a test asks about a
+keyword its entry was never checked against.
+Failures are never cached, and a file above
+.Ic max-read
+is refused before the cache is read.
+The whole cache is discarded when an extraction tool is installed, removed
+or replaced.
+Each run keeps entries only for files still in the directory.
+A file edited in place with its size and modification time preserved keeps
+its old answers; deleting the cache resets everything.
 .Sh ACTIONS
 .Ss Chains
 A file's chain is the actions of every matching rule, in rule order, and