README.rst
1Caffeine-ng
2===========
3
4.. image:: https://travis-ci.com/caffeine-ng/caffeine-ng.svg?branch=master
5 :target: https://travis-ci.com/caffeine-ng/caffeine-ng
6 :alt: build status
7
8.. image:: https://img.shields.io/pypi/v/caffeine-ng.svg
9 :target: https://pypi.python.org/pypi/caffeine-ng
10 :alt: version on pypi
11
12.. image:: https://img.shields.io/pypi/l/caffeine-ng.svg
13 :target: https://github.com/caffeine-ng/caffeine-ng/blob/master/LICENCE
14 :alt: licence
15
16Caffeine is a little daemon that sits in your systray, and prevents the
17screensaver from showing up, or the system from going to sleep.
18It does so when an application is fullscreened (eg: youtube), or when you click
19on the systray icon (which you can do, when, eg: reading).
20
21This is a fork of `Caffeine 2.4`_, since later
22versions dropped support for the systray icon in favour of only automatic
23detection of fullscreen apps only, which resulted rather
24`controversial`_.
25
26The intention of this fork is to also evolve on its own, not only fixing
27issues, but also implemented missing features, when relevant.
28
29Caffeine-ng was shortly know as Taurine, a play on its successor's name, since
30taurine is a known stimulant, commonly found in energy drinks. However, this
31name did not last, since the artwork would not match adequately, and changing
32it was undesirable.
33
34.. _Caffeine 2.4: http://launchpad.net/caffeine/
35.. _controversial: https://bugs.launchpad.net/caffeine/+bug/1321750
36
37System requirements
38-------------------
39
40* Python 3.6 to 3.9 is required.
41
42* ``caffeine-ng`` works with the following screensavers / screenlockers:
43
44 * Anything that implements the ``org.freedesktop.ScreenSaver`` API (this
45 includes KDE, amongst others)
46 * gnome-screensaver
47 * XSS
48 * Xorg + DPMS
49 * xautolock
50 * xidlehook.
51
52See ``setup.py`` for required python packages
53
54Installation
55------------
56
57To install Caffeine-ng please follow steps from appropriate chapter below
58
59Generic installation
60--------------------
61
62To manually install caffeine-ng, run::
63
64 python setup.py build
65 sudo python setup.py install
66 sudo glib-compile-schemas /usr/share/glib-2.0/schemas
67
68Debian and derivatives
69----------------------
70
71First install all the required packages::
72
73 apt install python-docopt python-ewmh python-setproctitle python-wheel python-xdg
74
75And mark them auto if you wish::
76
77 apt-mark auto python-docopt python-ewmh python-setproctitle python-wheel python-xdg
78
79Then you need to build sources with::
80
81 make clean
82 make build
83
84Create a package for your distribution::
85
86 checkinstall --pkgname=caffeine-ng --pkgversion=3.4 --requires="python-docopt \(\>=0.6.2\),python-ewmh \(\>=0.1.4\),python-setproctitle \(\>=1.1.10\),python-wheel \(\>=0.29.0\),python-xdg \(\>=0.25\)" --conflicts="caffeine" --nodoc python ./setup.py install --install-layout=deb
87
88Replace version string with correct version and append this command with ``--install=no``
89should you wish to inspect created package before installing it
90Replace ``python`` with ``python3`` in package names above if you wish to build caffeine-ng with python 3
91
92Replace ``python`` with ``python3`` or ``python27`` in ``checkinstall`` invocation to use specific python version to build caffeine-ng with
93
94``checkinstall`` is available for various distributions, so you may follow these steps adapting them to your distribution
95
96ArchLinux
97------------
98
99On ArchLinux, caffeine-ng is available at the `AUR`_.
100
101To have Caffeine-ng run on startup, add it to your System Settings => Startup
102Programs list.
103
104.. _AUR: https://aur.archlinux.org/packages/caffeine-ng/
105
106License
107-------
108
109Copyright (C) 2009 The Caffeine Developers
110Copyright (C) 2014-2018 Hugo Osvaldo Barrera <hugo@barrera.io>
111
112Caffeine-ng is distributed under the GNU General Public License, either version
1133, or (at your option) any later version. See LICENCE for details.
114
115The Caffeine-ng status icons are Copyright (C) 2014 mildmojo
116(http://github.com/mildmojo), and distributed under the terms of the GNU Lesser
117General Public License, either version 3, or (at your option) any later
118version. See LGPL.
119
120The Caffeien-ng SVG shortcut icons are Copyright (C) 2009 Tommy Brunn
121(http://www.blastfromthepast.se/blabbermouth), and distributed under the
122terms of the GNU Lesser General Public License, either version 3, or (at
123your option) any later version. See LGPL.
124
125Hacking
126-------
127
128* To run: ``./bin/caffeine``
129* To compile translations: ``./update_translations``
130
131If you want to test out a translation without changing the language for the
132whole session: "LANG=ru_RU.UTF-8 ./bin/caffeine" (Replace ru_RU.UTF-8
133with whatever language you want to use. You will need to a language pack
134for the specific language) Be aware that some stock items
135will not be translated unless you log in with a given language.
136
