Skip to content

Commit 48dd40c

Browse files
committed
Warn about Wayland support
1 parent efcf1ae commit 48dd40c

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

src/getting-started.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Installation
3737

3838
If you prefer to build ActivityWatch from source, check out :doc:`this guide <installing-from-source>` instead.
3939

40+
4041
Usage
4142
=====
4243

@@ -51,6 +52,9 @@ If you want more advanced ways to run ActivityWatch (including running it withou
5152
.. note::
5253
If you are running GNOME 3 or another desktop environment that does not support system trays, or if for some reason Qt can't be used on your machine, read `Running on GNOME`.
5354

55+
.. note::
56+
If your Linux system is using Wayland rather than X11, the default watchers will not work. Read :ref:`window and idle watchers for Wayland<wayland-watchers>`.
57+
5458
.. note::
5559
If you are using a proxy ActivityWatch might not work out of the box. To fix this you can set the environment variable ``NO_PROXY`` to include ``127.0.0.1`` before starting aw-qt. How to set an environment variable depends on your operating system; use Google if you are unsure how to do this.
5660

src/installing-from-source.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ If you want to ensure you have the latest version of all submodules, preserving
2828
2929
git submodule foreach --recursive git pull
3030
31+
.. note::
32+
If your Linux system is using Wayland rather than X11, the default watchers will not work. Read :ref:`window and idle watchers for Wayland<wayland-watchers>` for replacement modules supporting Wayland.
33+
3134
Checking dependencies
3235
---------------------
3336

src/watchers.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,27 @@ Watchers
33

44
Watchers are the parts of ActivityWatch that do all the data collecting.
55

6-
ActivityWatch comes with two watchers enabled by default:
6+
ActivityWatch comes with two watchers enabled by default supporting Windows, macOS and Linux (X11 only):
77

88
- :gh-aw:`aw-watcher-afk` - Watches for mouse & keyboard activity to detect if the user is active (by default, an inactive period of at least 3 minutes is flagged as AFK: away from keyboard).
99
- :gh-aw:`aw-watcher-window` - Watches the active window, its title, and it's url (on Chrome-based browsers & Safari).
1010

1111
These default watchers are collecting some of the most important data.
1212
But there is more to collect, so here are some other watchers that let you do so.
1313

14-
.. _window-watchers:
14+
.. note::
15+
For Wayland, see :ref:`wayland-watchers`.
1516

16-
Window watchers
17-
---------------
17+
.. _wayland-watchers:
18+
19+
Window and idle watchers for Wayland
20+
-------------------------------------------
1821

19-
Watches the active window, its title, and application name.
22+
Replaces :gh-aw:`aw-watcher-window` and :gh-aw:`aw-watcher-afk` to support Wayland, see issue :issue:`92`.
2023

21-
- :gh-aw:`aw-watcher-window` - The official window watcher for Windows, macOS, and Linux (X11 only).
22-
- :gh-aw:`aw-watcher-window-wayland` - A window watcher for Wayland, by :gh-user:`johan-bjareholt`.
23-
- :gh:`2e3s/awatcher` - A compiled watcher for X11 and Wayland to replace default window and AFK watchers, by :gh-user:`2e3s`.
24+
- :gh-aw:`aw-watcher-window-wayland` - A window and idle watcher for Wayland, by :gh-user:`johan-bjareholt`, supports Posh, Sway.
25+
- :gh:`2e3s/awatcher` - A compiled window and idle watcher for X11 and Wayland to replace default window and AFK watchers,
26+
by :gh-user:`2e3s`, supports Sway, Hyprland, KDE, GNOME, and X11.
2427

2528
Browser watchers
2629
----------------

0 commit comments

Comments
 (0)