You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/getting-started.rst
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,7 @@ Installation
37
37
38
38
If you prefer to build ActivityWatch from source, check out :doc:`this guide <installing-from-source>` instead.
39
39
40
+
40
41
Usage
41
42
=====
42
43
@@ -51,6 +52,9 @@ If you want more advanced ways to run ActivityWatch (including running it withou
51
52
.. note::
52
53
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`.
53
54
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
+
54
58
.. note::
55
59
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.
Copy file name to clipboardExpand all lines: src/installing-from-source.rst
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,9 @@ If you want to ensure you have the latest version of all submodules, preserving
28
28
29
29
git submodule foreach --recursive git pull
30
30
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.
Copy file name to clipboardExpand all lines: src/watchers.rst
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,24 +3,27 @@ Watchers
3
3
4
4
Watchers are the parts of ActivityWatch that do all the data collecting.
5
5
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):
7
7
8
8
- :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).
9
9
- :gh-aw:`aw-watcher-window` - Watches the active window, its title, and it's url (on Chrome-based browsers & Safari).
10
10
11
11
These default watchers are collecting some of the most important data.
12
12
But there is more to collect, so here are some other watchers that let you do so.
13
13
14
-
.. _window-watchers:
14
+
.. note::
15
+
For Wayland, see :ref:`wayland-watchers`.
15
16
16
-
Window watchers
17
-
---------------
17
+
.. _wayland-watchers:
18
+
19
+
Window and idle watchers for Wayland
20
+
-------------------------------------------
18
21
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`.
20
23
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.
0 commit comments