plan 10: docs (-n, README version and scope, trash identity, --json U+FFFD, limitations, changelog)

2 files changed, 35 insertions, 1 deletions

diff --git a/man/krino.1 b/man/krino.1
index e9d41da..ecbadc2 100644
--- a/man/krino.1
+++ b/man/krino.1
@@ -85,7 +85,8 @@ Cannot be combined with
 .Fl n .
 .It Fl n
 Dry run: print the plan and exit without changing any file.
-It may refresh the keyword cache, which only makes the next run faster.
+It may create krino's empty state directory, and refresh the keyword cache,
+which only makes the next run faster.
 .It Fl v
 Also list files that were skipped as unmatched, ignored or busy, and show
 the full reason a test matched or not.
@@ -460,6 +461,15 @@ and a copy in progress can leave a temporary
 .Pa .krino-*
 file and an empty directory behind.
 .Pp
+An undo recreates the directories it needs to move a file back, and removes
+them again only when that file's reversal completes; one interrupted or
+failed after recreating a directory, and never finished for that file,
+leaves the directory behind, empty.
+.Pp
+.Fl -json
+prints invalid UTF-8 in a file name as U+FFFD, so two such names can look
+the same in the JSON plan.
+.Pp
 Undo identifies a file by its directory and its path within it.
 A file one directory's rules move into another included directory, which
 sorts it again in the same run, is two files to undo; the first may then be
diff --git a/man/krino.conf.5 b/man/krino.conf.5
index 1fc113d..d86267d 100644
--- a/man/krino.conf.5
+++ b/man/krino.conf.5
@@ -658,6 +658,15 @@ or
 .Ql } .
 .El
 .Pp
+With
+.Ic fold
+on, the default, a
+.Ic name
+test matches the folded name and its captures come from that text, so
+.Ic {1}
+loses diacritics
+.Pq see Sx KNOWN LIMITATIONS .
+.Pp
 .Ar FMT
 is a strftime subset:
 .Ql %Y %m %d %H %M %S %j %% .
@@ -788,6 +797,21 @@ Duplicate conditions with different scopes do not share an original, so two
 such rules can between them move every copy of a group aside; nothing is
 deleted.
 .Sh KNOWN LIMITATIONS
+Captures
+.Ic {1} No ... Ic {9}
+come from the folded name when
+.Ic fold
+is on:
+.Ql (name \(dq^(.+)-faktura\(dq)
+on
+.Pa \[/L]\['o]d\[u017A]-faktura.pdf
+makes
+.Ic {1}
+.Ql Lodz .
+Set
+.Ql (fold no)
+in the rule to keep diacritics.
+.Pp
 A
 .Ar dest
 whose