aboutsummaryrefslogtreecommitdiff
path: root/man/krino-gui.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/krino-gui.1')
-rw-r--r--man/krino-gui.150
1 files changed, 40 insertions, 10 deletions
diff --git a/man/krino-gui.1 b/man/krino-gui.1
index 5f7b803..881637b 100644
--- a/man/krino-gui.1
+++ b/man/krino-gui.1
@@ -1,5 +1,5 @@
.\" SPDX-License-Identifier: GPL-3.0-or-later
-.Dd September 16, 2026
+.Dd September 17, 2026
.Dt KRINO-GUI 1
.Os
.Sh NAME
@@ -51,7 +51,9 @@ decide about - unreadable content, a failed duplicate check - is listed with
the reason and cannot be selected.
.Pp
Selecting a row explains it: every step with its rule and reason, and any
-warning. The right button offers
+warning, and shows the file itself underneath: a picture for an image, the
+first page for a PDF, the first lines for anything that is text. Nothing
+else is opened, and the file is only read. The right button offers
.Cm Trash instead
and
.Cm Delete permanently instead ,
@@ -77,11 +79,12 @@ as plain
.Cm krino undo
does.
.Ss Rules
-Only a directory's own file,
-.Pa dirs/NAME.conf ,
-is edited;
+This tab edits a directory's own file,
+.Pa dirs/NAME.conf ;
+the includes and excludes of
.Pa krino.conf
-is not.
+are edited by hand, and its defaults under
+.Cm Settings .
.Pp
.Cm Forms
lists the directory itself, its excludes and its rules. A rule's form holds
@@ -102,13 +105,20 @@ and
move a rule with the comment lines directly above it.
.Pp
.Cm Text
-is the whole file. Either way the configuration is checked as it is edited,
-about a second after typing stops: problems are listed with
+is the whole file, with line numbers and the forms coloured: comments,
+strings, the head of each form, and the actions that move or delete a file.
+.Pp
+Either way the configuration is checked as it is edited, about a second
+after typing stops, and
+.Cm Check
+asks for it at once. Problems are listed under both, with
.Ar file : Ns Ar line : Ns Ar column ,
and clicking one goes to that line.
.Cm Test on file
answers what the unsaved rules would do to one file, with the trace, the
-captures and the chain.
+captures and the chain;
+.Cm Test rule
+scans the directory and lists the files the selected rule would take.
.Pp
.Cm Save
is refused while the check reports anything, so a window cannot leave krino
@@ -116,6 +126,22 @@ unable to run. It writes atomically, keeps what was there as
.Pa NAME.conf.bak ,
and, if the file changed on disk since it was opened, offers to reload,
overwrite or cancel. Nothing on disk changes until Apply, Undo or Save.
+.Ss Settings
+.Cm Settings ,
+at the bottom of the window, holds two things. The first is krino's own
+defaults - case, fold, recursive, min-age, max-read, max-size, busy,
+on-conflict and the log path - which every directory inherits and its own
+file may override; they are written to
+.Pa krino.conf
+by the rules above: refused while the configuration would not load, the
+previous text kept as
+.Pa krino.conf.bak .
+The second is how this window behaves - the editor's font size, whether the
+configuration is coloured, whether the file behind a row is shown, and
+whether a scanned plan starts with every file checked. Those take effect as
+they are changed and are kept in
+.Pa gui.json ,
+which krino itself never reads.
.Sh FILES
.Bl -tag -width Ds
.It Pa ~/.config/krino/krino.conf
@@ -124,7 +150,11 @@ The main configuration, as for
.It Pa ~/.config/krino/dirs/NAME.conf
A directory's rules, and what the Rules tab edits.
.It Pa ~/.config/krino/dirs/NAME.conf.bak
-The text a save replaced.
+The text a save replaced;
+.Pa krino.conf.bak
+likewise for the main file.
+.It Pa ~/.config/krino/gui.json
+How this window behaves. Deleting it restores the defaults.
.El
.Sh EXIT STATUS
.Ex -std