NotZed's Source Code Repository - busymon/blob - README

   1
   2 INTRODUCTION
   3 ------------
   4
   5 This is an absolute barebones 'get off the computer' montior.
   6
   7 It consists of two parts, a small C application which monitors
   8 computer use and an optional JavaFX application which displays a
   9 full-screen graphical alert.
  10
  11 COMPILING
  12 ---------
  13
  14 Java 11+ and an OpenJFX SDK are required for a full build.
  15
  16 See the top of the makefile for some options, it wan't written to be
  17 particularly portable or flexible.  See src/busymon.c and
  18 java/*/*.java for run-time parameters.
  19
  20 $ make
  21
  22 Compiles everything.
  23
  24 $ make install
  25
  26 Installs everything.  By default to /usr/local.  The prefix can be changed by
  27 adding prefix=/blah.  DESTDIR is supported.
  28
  29 $ make bin/busymon
  30
  31 Compiles just the C monitor.
  32
  33 USAGE
  34 -----
  35
  36 Run manually or from ~/.xinitrc or equivalent.
  37
  38 $ busymon /usr/local/share/notzed.busymon/busyalert
  39
  40 Runs the monitor with the bundled alert program.
  41
  42 By default the monitor will run the alert if you've been busy for 55
  43 minutes straight.  The default alert will display a countdown of 5
  44 minutes that covers the entire screen (of the primary monitor).  If
  45 you're busy for more than 2 minutes you're assumed to be AFK and it
  46 will reset the busy counter when you return.  It should work correctly
  47 if you suspend the computer.
  48
  49 The various times are hardcoded at the top of the .c and .java files
  50 (in seconds).  The heuristics (particularly for AFK) might need
  51 tuning.
  52
  53 Note that the fullscreen window can be reduced to a normal window if
  54 you press ESCAPE and it can then be closed.  But if you close it
  55 before the busymonitor has detected an AFK period it will simply be
  56 restarted.
  57
  58 LICENSE
  59 -------
  60
  61 The XScreenSaver query code is from a perl module by Adam Wendt,
  62 although it isn't really recognisable anymore.  That is licensed "same
  63 as perl" and from what I can tell the perl license is either Artistic
  64 or GNU GPL.
  65
  66 See COPYING.
  67
  68 Copyright (C) 2003-2008 Adam Wendt
  69 Copyright (C) 2019 Michael Zucchi
  70
  71 This program is free software: you can redistribute it and/or modify
  72 it under the terms of the GNU General Public License as published by
  73 the Free Software Foundation, either version 3 of the License, or (at
  74 your option) any later version.
  75
  76 This program is distributed in the hope that it will be useful, but
  77 WITHOUT ANY WARRANTY; without even the implied warranty of
  78 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  79 General Public License for more details.
  80
  81 You should have received a copy of the GNU General Public License
  82 along with this program.  If not, see <http://www.gnu.org/licenses/>.