aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--man/krino.conf.525
1 files changed, 16 insertions, 9 deletions
diff --git a/man/krino.conf.5 b/man/krino.conf.5
index 8f3668b..a9b3ea8 100644
--- a/man/krino.conf.5
+++ b/man/krino.conf.5
@@ -78,11 +78,13 @@ or with
.Sy yes
also those in subdirectories down to
.Ic max-depth .
-Symbolic links are never followed, and a symbolic link or anything else
-that is not a regular file is counted and listed as
+Symbolic links are never followed: among the entries the walk looks at, a
+symbolic link, or anything else that is neither a regular file nor a
+directory, is counted and listed as
.Dq symlink
or
.Dq not a regular file .
+A subdirectory the walk does not enter is not counted.
The walk does not enter a copy or move destination that lies inside the
directory
.Pq Sx Unscanned destinations ,
@@ -318,8 +320,11 @@ Every form is checked when a file is read, by
.Ic krino check
and by every run, and nothing is scanned while a file that run reads has a
mistake.
-Several mistakes in one file are reported together, but only the first in
-each rule: fix it and check again.
+The mistakes found in one pass are reported together.
+A rule's placeholders, capture groups and
+.Ic (duplicate)
+with a delete are checked only once its condition has no mistake, and only
+its first bad action is reported: fix what is shown and check again.
Some of the messages, as printed
.Pq the path shortened, long ones wrapped here :
.Bd -literal -offset indent
@@ -688,9 +693,10 @@ keeps the files it matches from every later rule; so does a rule with
.Ic (stop)
whose condition cannot be decided
.Pq Sx Operators .
-A file left with no steps is counted and listed as excluded, with the rule
-that stopped it; but a stop rule does not undo what earlier rules planned,
-while an
+A file a stop rule matched without any action from earlier rules is counted
+and listed as excluded, with that rule; one stopped by an undecided rule is
+listed as not matched, with the warning.
+A stop rule does not undo what earlier rules planned, while an
.Ic exclude
sets a file aside before any rule.
.Pp
@@ -991,8 +997,9 @@ Groups overlap; a file can belong to several.
.It Sy text
txt md log csv tsv json yaml yml toml ini conf cfg rtf tex go c h cpp hpp
py sh js ts rs java rb pl lua css sql: read as text.
-A file that is not valid UTF-8 as a whole is read as Latin-1, one character
-per byte, so a single stray byte makes its UTF-8 letters no longer match.
+A file starting with a UTF-16 byte-order mark is read as UTF-16; otherwise a
+file that is not valid UTF-8 as a whole is read as Latin-1, one character per
+byte, so a single stray byte makes its UTF-8 letters no longer match.
.It Sy pdf
.Ic pdftotext
.Pq 30 second timeout .