@@ -300,16 +300,17 @@ Otherwise, left from the first column unfolds the stash. Up/down walk the cards,
300
300
301
301
### Hint mode
302
302
303
-
`hint` labels the links, URLs and buttons visible on the focused screen, so you can click one from the keyboard. No bind is set by default; for example `bind.cmd+g = hint`.
303
+
`hint` labels the links, URLs and buttons visible on the focused screen, so you can click one from the keyboard. Targets come from the accessibility tree when the app exposes it, and from the pixels of the screen otherwise. No bind is set by default; for example `bind.cmd+g = hint`.
304
304
305
305
- Each target gets a label of lowercase letters. With up to 26 targets the labels are one letter, with more they are two.
306
306
- Type a label to click its target: the pointer moves to the center of the target and presses the left button. With two-letter labels, the labels that do not match what you typed disappear and the typed letters are dimmed.
307
307
-`BackSpace` removes the last typed letter. `Escape` cancels, and so does any other key, which no window receives.
308
308
- Only the visible area of windows is scanned: a target covered by another window or outside the screen has no label. Targets on other screens are not labeled.
309
+
- A window whose app exposes its accessibility tree gets exactly the links and controls the app reports; the other windows are scanned from pixels. NeferWL turns accessibility on when it starts. GTK apps and Firefox work once it is on. Chromium and Electron apps need `--force-renderer-accessibility` (some Electron apps need `ACCESSIBILITY_ENABLED=1` instead), and Qt apps need `QT_LINUX_ACCESSIBILITY_ALWAYS_ON=1`. Without the accessibility bus, every window is scanned from pixels.
309
310
-`hint.targets = links` labels links and URLs only, not buttons.
310
311
-`hint` does nothing while the session is locked, on a rotated or flipped screen, while the overview is open, while a pointer button, drag or pointer constraint is active, or while hint mode is already active. Hint mode ends when the workspace on that screen changes or the overview opens.
311
312
- No capture indicator appears: the scan happens inside NeferWL and no client receives the pixels. Screen captures do not contain the labels.
312
313
313
314
#### Debugging hint mode
314
315
315
-
With `NEFERWL_HINT_DEBUG=1` set when NeferWL starts (for example `NEFERWL_HINT_DEBUG=1 make tty`, or the variable in the launch environment), every successful scan writes three files to `$XDG_STATE_HOME/neferwl/hints/` (`~/.local/state/neferwl/hints/` when unset): `<time>-<output>.png`, the frame as scanned; `<time>-<output>.annotated.png`, the same with each target outlined (links green, buttons blue, text grey); and `<time>-<output>.json`, the targets and timings. NeferWL keeps the 50 most recent scans and logs a warning at startup. The files contain the screen in clear: delete them after use.
316
+
With `NEFERWL_HINT_DEBUG=1` set when NeferWL starts (for example `NEFERWL_HINT_DEBUG=1 make tty`, or the variable in the launch environment), every successful scan writes three files to `$XDG_STATE_HOME/neferwl/hints/` (`~/.local/state/neferwl/hints/` when unset): `<time>-<output>.png`, the frame as scanned; `<time>-<output>.annotated.png`, the same with each target outlined (links green, buttons blue, text grey, targets from the accessibility tree magenta); and `<time>-<output>.json`, the targets (with their `source`, `atspi` or `pixels`) and timings. NeferWL keeps the 50 most recent scans and logs a warning at startup. The files contain the screen in clear: delete them after use.
@@ -300,16 +300,17 @@ Otherwise, left from the first column unfolds the stash. Up/down walk the cards,
300
300
301
### Hint mode
301
### Hint mode
302
302
303
-
`hint` labels the links, URLs and buttons visible on the focused screen, so you can click one from the keyboard. No bind is set by default; for example `bind.cmd+g = hint`.
303
+
`hint` labels the links, URLs and buttons visible on the focused screen, so you can click one from the keyboard. Targets come from the accessibility tree when the app exposes it, and from the pixels of the screen otherwise. No bind is set by default; for example `bind.cmd+g = hint`.
304
304
305
- Each target gets a label of lowercase letters. With up to 26 targets the labels are one letter, with more they are two.
305
- Each target gets a label of lowercase letters. With up to 26 targets the labels are one letter, with more they are two.
306
- Type a label to click its target: the pointer moves to the center of the target and presses the left button. With two-letter labels, the labels that do not match what you typed disappear and the typed letters are dimmed.
306
- Type a label to click its target: the pointer moves to the center of the target and presses the left button. With two-letter labels, the labels that do not match what you typed disappear and the typed letters are dimmed.
307
-`BackSpace` removes the last typed letter. `Escape` cancels, and so does any other key, which no window receives.
307
-`BackSpace` removes the last typed letter. `Escape` cancels, and so does any other key, which no window receives.
308
- Only the visible area of windows is scanned: a target covered by another window or outside the screen has no label. Targets on other screens are not labeled.
308
- Only the visible area of windows is scanned: a target covered by another window or outside the screen has no label. Targets on other screens are not labeled.
309
+
- A window whose app exposes its accessibility tree gets exactly the links and controls the app reports; the other windows are scanned from pixels. NeferWL turns accessibility on when it starts. GTK apps and Firefox work once it is on. Chromium and Electron apps need `--force-renderer-accessibility` (some Electron apps need `ACCESSIBILITY_ENABLED=1` instead), and Qt apps need `QT_LINUX_ACCESSIBILITY_ALWAYS_ON=1`. Without the accessibility bus, every window is scanned from pixels.
309
-`hint.targets = links` labels links and URLs only, not buttons.
310
-`hint.targets = links` labels links and URLs only, not buttons.
310
-`hint` does nothing while the session is locked, on a rotated or flipped screen, while the overview is open, while a pointer button, drag or pointer constraint is active, or while hint mode is already active. Hint mode ends when the workspace on that screen changes or the overview opens.
311
-`hint` does nothing while the session is locked, on a rotated or flipped screen, while the overview is open, while a pointer button, drag or pointer constraint is active, or while hint mode is already active. Hint mode ends when the workspace on that screen changes or the overview opens.
311
- No capture indicator appears: the scan happens inside NeferWL and no client receives the pixels. Screen captures do not contain the labels.
312
- No capture indicator appears: the scan happens inside NeferWL and no client receives the pixels. Screen captures do not contain the labels.
312
313
313
#### Debugging hint mode
314
#### Debugging hint mode
314
315
315
-
With `NEFERWL_HINT_DEBUG=1` set when NeferWL starts (for example `NEFERWL_HINT_DEBUG=1 make tty`, or the variable in the launch environment), every successful scan writes three files to `$XDG_STATE_HOME/neferwl/hints/` (`~/.local/state/neferwl/hints/` when unset): `<time>-<output>.png`, the frame as scanned; `<time>-<output>.annotated.png`, the same with each target outlined (links green, buttons blue, text grey); and `<time>-<output>.json`, the targets and timings. NeferWL keeps the 50 most recent scans and logs a warning at startup. The files contain the screen in clear: delete them after use.
316
+
With `NEFERWL_HINT_DEBUG=1` set when NeferWL starts (for example `NEFERWL_HINT_DEBUG=1 make tty`, or the variable in the launch environment), every successful scan writes three files to `$XDG_STATE_HOME/neferwl/hints/` (`~/.local/state/neferwl/hints/` when unset): `<time>-<output>.png`, the frame as scanned; `<time>-<output>.annotated.png`, the same with each target outlined (links green, buttons blue, text grey, targets from the accessibility tree magenta); and `<time>-<output>.json`, the targets (with their `source`, `atspi` or `pixels`) and timings. NeferWL keeps the 50 most recent scans and logs a warning at startup. The files contain the screen in clear: delete them after use.