Timekpr-nExT, a fresh, simple and easy to use screen time managing application that helps optimizing time spent at computer for your subordinates, children or even for yourself.
The application is targeted at parents or supervisors to optimize / limit time spent at computer as they see fits their situation.
Timekpr-nExT is designed to keep control of computer usage, which implies forcibly terminating user sessions and / or other types of restrictions and limitations.
Please be responsible and inform your users that their time is accounted and their work might be terminated abruptly, although notifications can be configured to warn them. In fact, notifications are mostly in their own hands.
Supervisor, when setting up limitations, please read the description of options and explore application before you enforce some option on user. Combination of options will give very tailored experience, but remember - Timekpr-nExT is a restrictive application.
Note: information in this README is updated along with beta releases, if you do not find a particular option in stable series, please wait
until it's released or use beta.
This README is useful, but quite large, so I have prepared a guide for you.
-
About functionality:
-
a short description of applications with typical use case (this is the one you may be interested in the most)
-
to better understand functionality click on description of functionality
-
description for user's application client application
-
description of supervisor's application administration application
-
-
latest prominent features introduced are:
-
alternative restriction types suspend / lock / shutdown
-
a way to limit applications / games from being used PlayTime functionality
-
user can configure the notifications user configurable notifications
-
type of time interval where time is not accounted towards user's limit "freeride" time periods
-
-
there are CLI (console) use / file configuration possibilities additional configuration possibilities
-
-
Installation guide:
- installation / removal instructions for most popular Linux systems
-
Support the project:
- support by donating
-
Translations:
- translate it to your language
-
Disclaimer, questions, suggestions and bugs:
Timekpr-nExT has two user facing applications which governs its behaviour.
An application and indicator icon which takes care of showing the time, limits and notifications to the user.
Informational "padlock" icon in they system notification area which is what user is automatically seeing when logged in.
Client application itself is activated by clicking on the icon and choosing menu "Limits & configuration", it contains more detailed information and some useful configuration options.
Application shows detailed information about limits as well as allows to configure certain aspects of functionality. The application is designed for the user himself.
An administration application for supervisors or parents to configure time limits for any user in the system as well as configure technical aspects of Timekpr-nExT.
The application has several configuration options organized into tabs to customize the end-user experience and restrictions as needed.
The invisible part of the Timekpr-nExT is the background service, sometimes referred as daemon, not demon :), which takes care of monitoring the system and enforcing restrictions and limits.
There is no nice picture for it, but mark my word, it's there working for you ;)
This section describes what and how Timekpr-nExT does its thing rather than descriptive information about every configuration option.
Please note that to describe configuration options, Timekpr-nExT heavily relies on tool-tip / hint functionality, please navigate mouse over to any configuration option and read its description, it usually helps to understand it better.
Timekpr-nExT tries to be as precise as possible and as much nice to user as restrictive software can be.
One of the things that has to be in place to accomplish that, is predictable and precise time accounting. Timekpr-nExT accounts time every 3 seconds by default and gives clear time / limits information to user. If user wants to configure more or less notifications, it is in his own hands.
Another thing is that time must not be accounted when it doesn't have to, so it tries to avoid accounting inactive session time. By inactive I mean user that is not using computer either because another user is using the computer via user switching functionality or user's session is locked and / or screensaver is active.
Time is not accounted, obviously, when computer is put to sleep or shut down.
The rest is up to supervisor to decide. Read on to have complete understanding of all functionality Timekpr-nExT offers.
Administration application is used to configure time limits and restrictions for users as well as technical options for Timekpr-nExT itself.
To run administration application you either need to run it as superuser or you need to add yourself to timekpr system group to have password-less
access to configuration. Most people use to run in as superuser as it is the easiest, out of the box experience - nothing has to be configured to use it.
Running as superuser is straightforward, open your favourite dock / launcher / application list and choose "(SU) Timekpr-nExT Control Panel (superuser mode)".
If you have added yourself to timekpr system group you can run "Timekpr-nExT Control Panel" without entering the password. Please note that if you
have not added yourself to timekpr system group this mode will not work!
Note: "(SU)" was added in front of application names because some earlier Gnome3 versions simply truncated longer application names and it was indistinguishable between the modes.
Running as part of the group requires more involvement. Add yourself to timekpr group either by your favourite user administration
application which should be provided by your favourite desktop environment or simply run sudo gpasswd -a $USER timekpr (change $USER to proper
username for administration, if it differs from currently logged in one and do NOT put your subordinate's username there ;)). The user who was added to
timekpr group will need to log out and in for this to work.
Please note: certain configuration options are not accessible when running in password-less mode, they're not related to user configuration and should be used very seldom in very special cases, however running in superuser mode grants all access to all options.
To configure limits and restrictions for user, it has to be selected from the user list. User list is retrieved from your system and initial configuration is applied. User list is then stored in configuration directory and configuration is not deleted even when the user itself is deleted!
Yes, that means that OS user can be re-created without loosing its configuration in Timekpr-nExT.
Please note: when opening administration application no user is pre-selected, this is by design to force a supervisor to choose a correct user to configure and avoid unintentional misconfiguration.
As the title implies, this section shows information about how much time the user has spent and how much time they have left to spend.
Some information is only displayed when the user is logged in, while some information is retrieved from the saved state. Live information is more accurate and allows you to monitor the user in real time. It is not displayed when the user is not logged in, however, the saved state information is always displayed, but it is refreshed less frequently.
Time adjustment controls are used, for example, if a supervisor decides to reward user with greater time allowance just for this day. Of course reward is not always a choice to make, so it's possible to penalise user too.
Keep in mind that adding more time will not override allowed time periods and general time allowance per day, you'll read about them later in this README.
Pro tip: use tool-tips to find more information.
There's a special time value called "Continuous time available" which means exactly that - a time which is available to use continuously without being logged out (of course depending on time allowance and allowed time period setup), however it's not counted for more than this and the next day together.
Continuous time may span more than one day, which means that user will be able to use computer across midnight without being logged out at day change, however it's only possible when you have configured this day time period to end at 24:00 and next day time period start at 00:00, i.e. time intervals must be continuous throughout midnight.
This tab allows you to configure time limitations for users. Please combine options to have the setup tailored to your view of user's order of the day.
Before I explain how to configure them properly, I will provide the two most common options for setting restrictions:
-
set time allowance to whole day, but limit access to specific time periods, example: 24:00:00 of allowance which can be used only in specified time intervals, 9:00-12:00, 13:00-16:00 and 19:00-21:00
-
set time allowance to desired hours per day and set time periods when user can use computer, example: 08:00:00 of allowance and 9:00-21:00 period when to spend those 8hrs
Please note that time values follow ISO 8601 standard, in other words it means that first week day is Monday and hours are displayed in 24h format.
This section presents configuration for every week day. Namely one can select on which days user can use computer as well as adjust a time limit for every day.
Days have to be enabled / disabled for every day separately, but limits can be adjusted for multiple days at once. Just select multiple days by mouse or ctrl+A for all days, select what you would like to adjust - hours or minutes and press "+" or "-" button. Simple as that.
Another way of editing a single day limit is to to click on the limit inside the table and edit it by hand. This way one can edit seconds too, not that I recommend it, but the possibility is there. When defining a limit one can use shortcuts, namely - entering 7 will result in 07:00:00 (hours:minutes:seconds), entering 7:1:15 will result in 07:01:15.
By default every day is enabled and user have all the time available.
Hour intervals define time periods when user can use the computer. These can be configured on per day basis, however it's possible to configure them for multiple days at once, just select multiple days and configure time periods.
The configuration itself is simple too. To create an interval, press create button and specify start and end of the time period by clicking on created interval inside the table. Of course one can edit the interval as needed.
When defining the intervals one can use shortcuts, namely - entering 7 will result in 07:00 (hour:minute), entering 7:15 will result in 07:15.
There's a special setting for time interval indicated as "∞" (unaccounted time intervals). Basically this setting means that time spent in this time period will not be accounted towards user's daily allowance, i.e. it's free time for him. In addition to that, this allows the user to use computer even if he has no time left all, i.e. daily allowance is already spent. This setting can be useful in case user has a special arrangement, such as online courses at specific times, so he does not spend his personal limit on them.
Please keep in mind that intervals themselves cannot overlap in any way, however it's possible to have intervals ending and starting continuously, for example, intervals 7:00-13:00 and 13:00-14:30 can coexist, but don't be surprised when adjacent intervals are merged into one.
Be aware, that if there's a break in time periods, even just for one minute, user will face whatever restriction is set for him, for example, if user restriction is set to "terminate sessions", he will be logged out.
Be aware that there's is a specific design choice in place which governs that one hour can not contain more than one time period. Time period, however, can fully fit within an hour, start in it or end there, i.e. time periods 7:15-9:15 and 9:45-14:30 cannot be entered, but time periods 7:15-9:00 and 9:45-14:30 are allowed.
After entering intervals, one have to press "verify" button for application to know that one, you know, did not made a typo :) If intervals are ok, one can apply the configuration. When time periods are misconfigured, both conflicting intervals will be highlighted.
By default whole day is available.
This section allows to adjust weekly and monthly time allowances. Just select a period and a time unit of day, hour or minute and press "+" or "-" buttons to adjust the limits.
Another way of editing a limit is to to click on the limit inside the table and edit it by hand. This way one can edit seconds too, not that I recommend it, but the possibility is there. When defining a limit one can use shortcuts, namely - entering 7 will result in 07:00:00:00 (days:hours:minutes:seconds), entering 6:10:5:11 will result in 06:10:05:11.
These limits work together with daily limits and hour intervals, user's available time is the least of the all of the limits combined together. This means that Timekpr-nExT will account every second user used for week and month and if the limit is reached, he will not be able to use computer freely even he has not spent his daily limit yet.
By default whole week and month is allowed, which is the common use case, one does not have to modify these values when daily limits are in use.
PlayTime is screen time limiting mode for applications / processes in the system, which in context of PlayTime, are called "activities".
PlayTime extends time limit configuration and accounting by greater control over how long certain applications can run. In other words, this functionality works as a process monitor of sorts.
PlayTime allows users to use certain applications for the configured period of time. If time allowance is used up, applications are terminated. Running them again will result in immediate termination.
Please keep in mind that generally PlayTime is a special limit within a standard time limit, therefore all rules of standard time allowances and periods fully apply, except in "override" mode, which will be explained in the options section below.
PlayTime was designed for games, hence the name, but a supervisor can define any application to be monitored, for example Web browser or calculator.
Please note that PlayTime will still account user's PlayTime even in time periods which are marked as free ("∞") in standard time configuration! Except in "override" mode, that is
This section provides controls for PlayTime enablement and so called PlayTime override mode.
PlayTime has to be enabled for every user separately and if it's not enabled, obviously, PlayTime will not work for this user. Be sure to enable PlayTime master switch to enable PlayTime accounting in the system, otherwise it will not work even if it's enabled for the user.
By default, PlayTime is not enabled.
Before explaining how to configure PlayTime, here is the overview of PlayTime modes and behaviour.
The standard mode is a restrictive mode which means that certain activities are allowed to be used for some time, after time is spent, they are terminated. For example if Steam is configured as an activity and the limit for PlayTime is one hour, after one hour Steam will be terminated and user will not be able to use it until the next day.
In addition to standard mode, there's a special "override" mode for PlayTime already mentioned above. In this mode PlayTime allowance and limits are disabled and user's time spent at computer is only accounted when applications configured as activities are used. That means that unless user uses computer for configured activities, it's free time for him. With the same example of Steam, user can freely use computer however he wants unless he starts Steam, then the "clock starts ticking" and user can use Steam until the time limit is over, if user closes Steam just before time limit is spent, he can use computer freely according to the rest of the configuration.
Option "Allowed during "∞" intervals" controls whether PlayTime activities are allowed to run during unaccounted time intervals which are marked as "∞". If this option is disabled, user will not be able to run any of the configured activities regardless of whether "override" mode is enabled or not! With the example of Steam - user will not be able to run it.
However, if this option is enabled, user can use any of the activities configured for him even in unaccounted time intervals. So with the example of Steam, user will be able to use Steam as usual and the time he uses Steam is counted towards PlayTime allowance.
If "override" mode is enabled in unaccounted time intervals, it is all free for the user. So with the example of Steam, user will be able to use Steam with no restrictions, time spent using Steam will not be accounted towards any limit at all.
As an example, this option can come handy, if time intervals marked as "∞" are used to attend mandatory education classes and supervisor does not want to allow a subordinate to run any of the configured activities during unaccounted time intervals, disable "Allowed during "∞" intervals" and you are set.
"Override" mode is not really a straight-forward option, but once you get it, it might suite you if this kind of time accounting is needed.
By default the option is enabled.
PlayTime limits are similar to standard time limits and allowances, configuration is the same, but these only apply to PlayTime.
If certain day is disabled for PlayTime, user can not use any of configured activities - they will be terminated immediately.
Please note that PlayTime limits are not used when "override" mode is enabled.
This is the most important section for PlayTime. Here one configures what are the activities to be monitored, but please keep in mind that this list is not exactly as simple as an allowlist or denylist of applications.
PlayTime functionality requires the supervisor to set up process masks for each activity he wants to limit. This may involve running process monitor from your favourite desktop environment, console / terminal or even remotely via SSH.
The reason this is a bit complicated and requires process masks to be entered, is that Linux is user friendly and can run applications installed anywhere as any user. This in itself is great, but that means that any software can be installed anywhere even in multiple copies and even user itself can do it! Yes, games in Lutris, Herioc or Steam and so on are user installable and does not require any special permissions to do so.
Installed software / games does not scream out load "hey, I'm a game!" or "hey, I am something supervisor is not happy about!", so it is rather impossible task in general to list all games ever in existance or to guess individual preferences and keep up with the list all the time. Supervisor has to determine which games or software is used by his subordinates and set up limits for it, if needed.
So here's a generic guide how to determine processes or their masks which can be used in activity configuration.
At first, especially if you have not seen terminal, this may look scary, but you always can use graphical tools to achieve this. KDEs and Gnomes "System monitor" does this pretty well, look for process name or command or commandline columns, they are your best friends in this. You can always ask your favourite web search engine or community how to determine process executable name.
Since process mask for PlayTime activity is basically a name of executable or full command line in case "Enhanced activity monitor"
is enabled (case sensitive!), a simple top -c -d 1 in terminal usually will do the trick to find one.
Games, when running, usually use most resources compared to anything else, so they will be on top.
Watch for COMMAND column. If the process looks very much like activity you want to limit, take actual executable name, without path, and fill it in the process
mask field. Here's the example for Discord Canary, in the process list I see /opt/discord-canary/DiscordCanary --type=renderer ..., only
DiscordCanary is the part you need. It's located after last slash and before arguments.
Some games on Linux behaves badly when Alt-Tabbing them, so connect to computer via SSH and determine a process name from there.
You can enter the description of activity too, it will be shown to user instead of actual process mask. If description is not entered, the actual mask is shown to the user.
Please note that process masks can accept RegExp (not glob!) expressions, albeit with some restrictions, but keep in mind that this is an expert option!
Please do verify that your RegExp is correct and it actually works, misusing them may end up killing unwanted user processes or may not match anything at all!
If RegExp is not correct, it will be used as literal strings. For example, *wine* is not a correct RegExp, .*wine.* is. Failing to specify this
correctly will end up searching processes which are literary *wine*, which obviously does not exist usually.
Please note that RegExp will not work with any one of these symbols [] and one should not use one of these ^$ either.
Consider your RegExp will always match the whole executable name or executable name and parameters in case "Enhanced process monitor" is enabled.
The simple example is if one entered a process mask .*wine.* it will basically be converted to ^.*wine.*$ and /.*wine.*$ internally.
It's worth mentioning that PlayTime employs a smart caching algorithms and tries to get the process list in a very efficient way. Only processes that are run as particular user are monitored, accounted and terminated.
In addition to that PlayTime logic works only when there are users that have PlayTime enabled and there are at least some activities configured.
As the name suggests this section has additional per user configuration options.
By enabling track inactive sessions every user session will be accounted, even if they are locked or other user is currently using the computer. Enable with care.
Hide icon and notifications does exactly that, it hides Timekpr-nExT client icon and hides almost all notifications. Only critical notifications are shown. If you enable this to unrestricted user, he will not even notice Timekpr-nExT is there.
Restriction & lockout type governs what type of action will be executed when time for the user will run out.
Note: please be careful if choosing non-default option, think ahead and figure out whether other options are suited for your use case!
This is the default option and a restrictive one. It terminates user sessions, that is, user is forcibly logged out without asking any questions.
This is another restrictive option. It kills user sessions, that is, user is forcibly logged out without asking any questions. This option was added as an alternative to "terminate sessions", this option tries to soft-kill the sessions and the effect is largely the same as with "terminate sessions".
This is another restrictive option, when time runs out, the computer will be shut down. Please use with caution, especially in multi-user environments!
This is lockout option. That is when time runs out computer is suspended.
Option is more suited for self control rather than restrict computer usage, due to the fact that sessions aren't terminated.
When computer is woken up at the moment when there is no time left, but user does not unlock the computer, it stays that way. If computer is unlocked, then instead of suspend, the screen is locked. This behaviour was put in place to avoid excessive turn on / off of computer for regular user, however if user unlocked computer a lot of times ~ 20, then it will be suspended.
This is lockout option, very similar to plain suspend, but with a catch - computer will be woken up at next available time period for that day. It will be woken up only if Timekpr-nExT was the one who put it to sleep.
Additionally you need to specify hour interval when computer may be woken up automatically. If next available time period is outside of configured interval, computer will NOT be woken up!
Please note that wakeup time is dependent on BIOS / UEFI support for RTC wakeup. If there is no support for it or it is disabled, computer will NOT be woken up!
This is lockout option. When time runs out, computer screen is locked. If computer is unlocked when there is still no time left, it will be locked again shortly. Simple as that.
Option is more suited for self control rather than restrict computer usage.
This tab allows a supervisor to configure certain technical aspects how Timekpr-nExT behaves. These options usually doesn't have to be changed as they are tuned to their optimal values.
This section contains various knobs to finetune time accounting and enforce limits.
Notification configuration is now a users responsibility, so he may decide to remove all notifications altogether, which may not be the best way to be informed about imminent log out.
This option comes to rescue, it will force a one final notification on user (which can still be disabled by user) to inform about the imminent restriction enforcement.
This option specifies number of seconds left for user before enforcing the selected lockout / restriction on him. When this many seconds are left, user is added to the restriction list and will start to face them.
This can be prevented by adding more time allowance or when user becomes inactive, so the scenario when user locks computer to go to supervisor to ask for more time allowance is plausible.
This option specifies number of seconds left for user before a countdown for the selected lockout / restriction starts. Countdown is continuous notification stream about very last seconds left.
This option specifies the rate in seconds at which Timekpr-nExT processes users, their sessions and calculates time values for them. This option can somewhat be considered as resolution of time accounting too.
This option specifies the rate in seconds at which Timekpr-nExT saves calculated time values to disk. Theoretically this means that if computer crashes this should be the max time that can be lost / unaccounted.
This is the log level, high the level more information is written to log files. Level 1 is the minimal level which will save space but will not give me enough information in case you file a bug, level 2 is the standard level, it usually writes sufficient level of information for problem solving. Level 3 is the "crazy" value which prints way too much cryptic in memory structures which may be interesting to me, but not to non-developer.
If everything is working fine for you, set the level to 1, otherwise leave it at default value. Be assured that log files doesn't contain anything sensitive except usernames.
Log level changes are effective immediately.
Please note that log files are handled by logrotate and are compressed, so I wouldn't worry about space usage on a standard computer.
There are multiple session types on Linux systems. By default Timekpr-nExT tracks graphical sessions that are running on "x11" (xorg), "wayland" and "mir".
The two most common types used 99.99% of all desktop Linux installations are "x11" and "wayland", however "mir" is not, but support to detect these is still in place, so it's left there just in case.
Please keep in mind that there are no more session types than these and the ones mentioned in excluded sessions option, please do not modify this unless you know what you are doing.
By default Timekpr-nExT does not track sessions from "tty" (console logins that are accessible by pressing Ctrl+Alt+F[1-7]) and "unspecified" which are the rest. Please do not modify this unless you know what you are doing.
In case you really need to track console sessions too, please remove "tty" from this list and add it to the tracked sessions list.
This section allows supervisor to exclude certain system users from accounting. This section is meant to exclude users that do create sessions, but are not used to log in directly, e.g. login managers.
Please do not enter normal users here as that will not work and cause errors when client will try to obtain information from daemon!
Currently there are couple of options, all related to PlayTime.
"PlayTime enabled" controls master switch for PlayTime functionality. I has to be turned on to enable PlayTime globally, if it's switched off, none of the users will have their activities accounted regardless of individual PlayTime setting!
"Enhanced activity monitor" option controls whether PlayTime functionality will use first 512 characters of full process commandline, including process arguments, to match proccesses against registered activity / process masks for users. Without this setting process masks are checked against executable path and name only.
This allows a supervisor to use advanced RegExp patterns to find not just a process name, but a great deal of arguments too. This option may be useful for
situatuations when there are processes running interpreted language, such as python or java. The most common gaming example is Minecraft, which is a java
application started from jar file, a process mask for it would be .*java.*minecraft.*.
Note: after changing this option, enhanced monitoring is applied to newly started processes only!
Timekpr-nExT client application provides time metrics and configuration possibilities to user. Since the user is the one who actually face the restrictions, the configuration possibilities are limited.
User can use tool-tips / hints to get more information on every value of the application by navigating mouse over the displayed information.
Please look at the information representation differences which may affect the way application looks to user.
Daily limits shows daily time allowance, time period restrictions and time spent / left set by supervisor. Most important metrics are continuous time left and time periods when user can use the computer.
Timekpr-nExT will change icon color depending on how much time is left for user, however this configuration is in user's own hands.
If time period has "∞" sign besides it, the time for this period will not be counted towards the user's limit, i.e. free time for the user. Additionally, when user has unaccounted time intervals and that time has come, icon color will change from whatever color it was to gray indicating that this time is not accounted in any way. When unaccounted time interval ends, the color of the icon will change according to user notification configuration.
Additional limits show weekly and monthly limits set by supervisor as well as time spent so far during this week and month.
This tab shows time allowance and activity list for PlayTime. Description of PlayTime can be found in PlayTime administration part of this guide. User is able to see what type of PlayTime mode is enabled and what are the limits for this day.
Tab shows active PlayTime activity count too as well as description of activities that are being monitored / restricted.
Please note that this tab is not available to user if supervisor has not enabled PlayTime for the user.
This is the first tab where user can make adjustments to tailor Timekpr-nExT behaviour to his needs. User can define a time left threshold when he'll be notified about how much time is left. He can assign a priority of notification as well.
There is a separate section for standard time left and PlayTime left notification configuration. Please note that PlayTime notification configuration is not shown to user if supervisor has not enabled PlayTime for the user.
More information can be found by viewing tool-tips of the configuration table.
This tab allows user to configure additional options to tailor Timekpr-nExT to his needs.
User is able to control whether seconds are shown besides the icon, whether all and limit change notifications are shown. It's possible to set up sound
notification too, by installing python3-espeak or python3-espeak-ng or similar package (please consult you distribution for proper name).
There are configuration options for normal and critical notifications, sound "bell" when notifications are shown and technical log level too.
More information on every option can be found in tool-tips.
Please note that there seems to be a bug in sound notifications.
Let's imagine a situation that Liane had to limit computer time for Cartman because he uses computer way too much to talk to Kyle and Stan (but not Kenny, because he doesn't have a computer ;-)) about messing up a day for Mr. Garrison or something along these lines. Due to his behaviour he has to attend online anger management classes to improve his behaviour in general.
So, Liane is thinking to introduce rather flexible time limit within strict time window for working days and holidays, in addition to that she reserves 2 hours from 15:00 - 17:00 on Monday for mandatory anger management classes.
Timekpr-nExT comes handy, Liane opens Timekpr-nExT Administration application makes configuration as follows:
-
choose username "cartman" and switch to "Limit configuration" tab
-
select Monday:
-
set time limit to 6 hours
-
add interval from 7:30 - 15:00
-
add interval from 15:00 - 17:00, check the "∞" checkbox
-
add interval from 17:00 - 21:00
-
-
select days from Tuesday through Friday:
-
set time limit to 6 hours
-
add interval from 7:30 - 21:00
-
-
select last two days - holidays:
-
set time limit to 8 hours
-
add interval from 9:00 - 22:30
-
-
press "Apply daily limits" and restrictions are set
By this she achieves flexibility of:
-
allowing 6 hours of computer time to be used from 7:30 to 21:00 from Monday to Friday
- allowing the use of computer from 15:00 - 17:00 without the need of spending his limit on mandatory anger management classes
-
allowing 8 hours of computer time from 9:00 - 22:30 during holidays
-
Cartman can not use his computer before outside of defined time periods and over the specified time allowance
Typical setup is rather simple and easy, there are (of course) more to it, please read on Detailed information, if you're interested.
First step to start using Timekpr-nExT is to install it, right? :-)
Basically there are two versions - beta and stable, usually they are not that different, but beta comes out earlier, especially when changes in upcoming version are larger.
The installation instructions are easy as well (I know that one can do that in GUI, but terminal is just simply faster :-)), just paste these lines in terminal and you're set.
Note: it's highly advised to log in and out after installation of new version.
Timekpr-nExT is available in:
-
my PPA (Personal Package Archive) for Ubuntu and compatible distributions
-
Timekpr-nExT is available in AUR (ArchLinux User Repository) for ArchLinux and Manjaro
-
packages for Debian and its derivatives are available natively (and usually outdated)
-
packages for Fedora are available in johanh's copr repository
-
packages for openSuse are available natively (starting from year 2025)
-
packages for manual installation for Fedora 32+ and openSUSE Leap 15.2+ are provided as is
| Distribution | Stable install | Stable remove |
|---|---|---|
| Ubuntu & co (via PPA) | sudo add-apt-repository ppa:mjasnik/ppasudo apt-get updatesudo apt-get install timekpr-next |
sudo apt-get remove --purge timekpr-next |
| ArchLinux & Manjaro (via AUR) | yay -S timekpr-next |
sudo pacman -Rdd timekpr-next |
| Fedora | copr repo (preferred) or manual installation (README and packages) |
copr repo (preferred) or manual uninstallation (README) |
| openSUSE | manual installation (README and packages) |
manual uninstallation (README) |
| Distribution | Beta install | Beta remove |
|---|---|---|
| Ubuntu & co (via PPA) | sudo add-apt-repository ppa:mjasnik/ppasudo apt-get updatesudo apt-get install timekpr-next-beta |
sudo apt-get remove --purge timekpr-next-beta |
| ArchLinux & Manjaro (via AUR) | yay -S timekpr-next-git |
sudo pacman -Rdd timekpr-next-git |
| Fedora and openSUSE | manual installation (README and packages) |
manual uninstallation (README) |
Note: for ArchLinux and Manjaro, please choose your favourite AUR helper, if that differs from mine.
Note: special thanks goes to SanskritFritz from ArchLinux community who was not only one of the first beta testers and active users, but he maintains said packages too.
Note: thanks goes to johanh from Fedora community who provided a copr repo for Fedora.
Until recently there was no easy way of using Timekpr-nExT in Debian, but thanks to Sim (smntov) and Anthony Fok (foka), Timekpr-nExT is available in Debian as native installation.
The preferred method of installing Timekpr-nExT in Debian is the same as in Ubuntu:
| Stable install | Stable remove | Beta |
|---|---|---|
sudo apt-get updatesudo apt-get install timekpr-next |
sudo apt-get remove --purge timekpr-next |
Not available |
Note: it might be possible to use a package made for "sid" in other versions of Debian, if dependencies are satisfied. For example, a package for "sid" (unstable) works in "buster" (10.7) just fine.
Of course, you can use any graphical software installer that comes with Debian too, like "KDE Discover" or "GNOME Software".
Note: for Debian please use a package created for Debian.
I was developing Timekpr-nExT to be compatible with most Desktop Environments, I had somewhere around 20 VMs where I test bigger changes, but I can not and will not test everything in the open! Currenly (after many years, I am not testing it that widely).
I have tested KDE, Gnome, Cinnamon, MATE, XFCE on multile distributions like Ubuntu, Manjaro / ArchLinux (which are my distributions of choice), Debian, Fedora and openSUSE, however I am currently testing this on demand, mostly based on bug reports or at my own discretion.
Please read nuances section for more information.
If you have an issue with Timekpr-nExT, please read this and file a bug.
Not every desktop environment is made the same, there are differences how information is shown to user.
The icon in system notification area is the one that differs. Gnome3 / Unity / XFCE / etc. show icon as well as detailed label besides it, however KDE / Deepin show only the icon without label. However, hovering mouse over the icon, actual time left is revealed.
On some distributions which use Gnome3 or other desktop environment based on Gnome3, a specific extension has to be enabled for icon to be shown. Usually the extension is provided by distribution itself, but in case it's not, please install Appinicator Support extension manually.
Some desktop environments can and will override timeout settings specified in Timekpr-nExT configuration. Sometimes they are configurable, but sometimes they are not. KDE Plasma has the best respect regarding notifications I have found so far.
So unfortunately, unless you use desktop environment that respect custom values for notification timeouts, you will face the preconfigured ones.
There's a possible future issue that can surface when Gnome3 will remove status icon functionality. When the time comes if at all, I'll try to figure out what to do about it.
Warning: this section is very technical and has no information that regular users of Timekpr-nExT would (possibly) want to know, please skip the section if you are not interested in technical side of things.
Timekpr-nExT is built with technologies which heavily use DBUS for it's interaction with the system. Not only it uses interfaces provided by various solutions, it exposes own interfaces to DBUS too. It allows Timekpr-nExT to be integrated into any client application or control panel which supports DBUS interactions.
The main interface used is systemd's login1 session management interface, without it Timekpr-nExT will not work.
It tries to use FreeDesktops screensaver interfaces (better source needed) as well as notification interfaces too.
In case FreeDesktop screensaver interfaces are not available, it tries to use Gnome's.
Timekpr-nExT makes connections to DBUS objects, they are cached and during execution, it mostly just calls.
In addition to graphical applications, Timekpr-nExT can be configured using tools available in CLI (Command Line Interface) and config files (by hand).
Timekpr-nExT Administration application can be run in terminal to obtain information on users and configure limits at the same functional level as in graphical mode. Please note that at this time CLI interface is available for user configuration only.
For CLI usage, please open your terminal emulator of choice (i.e. Gnome Terminal / Konsole / XTerm) and type sudo timekpra --help, it will introduce you to
Timekpr-nExT CLI by printing usage notes and examples.
Please note that CLI usage follows the same security principles as graphical application - either you have to be in the timekpr group, execute it
as root or use sudo to access its functionality even in CLI mode.
Timekpr-nExT Administration application in both modes apply configuration in real-time, i.e. configuration is effective immediately.
It's possible to edit configuration files directly to achieve the same as with tools provided by Timekpr-nExT. In this case configuration will be read and applied at save intervals (by default, every 30 sec).
This method is NOT recommnended, do not edit files manually because you can, preferably use the GUI or CLI to adjust the configuration.
Note: please be aware that configuration files are structured in particular way, have internal representation of values and one can break the configuration if not being careful. You have been warned!
Note: if configuration files are borked, e.g. Timekpr-nExT can not interpret them properly, it will try to salvage options it can and it will recreate the config file with defaults for damaged options.
Configuration files (be careful editing them)
| The purpose of the file | File location |
|---|---|
| Timekpr-nExT main configuration file | /etc/timekpr/timekpr.conf |
| User configuration files (one per user) | /var/lib/timekpr/config/timekpr.*.conf |
| User control files (one per user) | /var/lib/timekpr/work/timekpr.*.conf |
| Client configuration file | $HOME/.config/timekpr/timekpr.conf |
Log files are the files where Timekpr-nExT writes it's messages about execution, including a performance counters. Files are not meant to be inspected by users on regular basis, there's nothing interesting nor understandable for non technical users, even tehcnical users have nothing to look at here on regular basis. As the name implies, this is just a record of timekpr's actions in case something goes south.
However it's possible to look at them to find technical details about state of Timekpr-nExT or investigate the problematic behaviour and errors. These are the files I'll be asking in case something does not work as expected.
By default Timekpr-nExT writes a sufficiently detailed log file for me to understand the problem area quite well, but that means that there are a lot of messages in log files. There's nothing sensitive except usernames, if this is a concern, please obfuscate them before sending the files to me or attaching them to bug reports.
Since the version 0.5.1, log level changes are effective immediately and there is no need to restart Timekpr-nExT or reboot the computer.
Note: if the log file size is the concern, it's possible to decrease log level in Timekpr-nExT administration application to save some space, however when the issue arises, most likely I'll need it to be set to level 2 (the default).
Log files
| Logging area | File location |
|---|---|
| Daemon log file | /var/log/timekpr.log |
| Client application log files | /tmp/timekprc.*.log |
| Administration application log files | /tmp/timekpra.*.log |
Linux distributions (i.e. Ubuntu, Fedora, Mint, ...) ecosystem is large, nice, diverse and all those good things, but not everything there adheres to the same standards, so naturally there are some unusual discrepancies here and there, which affects Timekpr-nExT looks and/or functionality.
When I started designing / developing Timekpr-nExT I was pretty much sure how to implement desired functionality as I have looked into standards and tested particular implementation in Ubuntu 16.04 (Unity) to verity it is working, i.e. standards are standards and every implementation which uses them, should be roughly the same.
As it turned out, it's not exactly the case. Most of the time, everything worked as it should, but for certain functionality every Desktop Environment has it's own quirks, maybe using just the select bits of the specifiction or maybe it's just buggy implementation.
This section will contain these oddities / differences in implementations as far as Timekpr-nExT development is concerned. If you find odd why things happen or not happen the way you expect, maybe here's an answer.
NOTE: the situation with quirks may change in the future, I have observed that with every new release of distributions / desktop environment software stack or frameworks, situation gets better, so this information may become stale at some point! I'll try to address it, but since Timekpr-nExT tries to support as much versions and distributions as possible, it may still apply to older version of the distributions or desktop environments...
Currently it's known that if user has enabled Use sound "bell" for notifications, then critical notifications might not show on Desktop, they
are registered and can be seen in notification register, though.
Timekpr-nExT is heavily using login1 DBUS interfaces to accomplish what it does. One of the things is user session termination.
Timekpr-nExT asks login1 to terminate user session(s), but sometimes that ends up in black screen and a blinking cursor or just the graphical cursor
which can be moved, but for unaware user this is the same as computer "totally freezed".
This might be the case on older installations when screen is not switched to login manager screen. So I have implemented a workaround that after user sessions are terminated, it tries to switch to login manager.
For this to work I have developed a logic that tries to detect where's the login manager and usually it's possible when computer boots up, so restarting or upgrading Timekpr-nExT without rebooting while you have this issue, might end up in blinking cursor.
Another case why this happens is unknown, but symptoms are the same. When timekpr asks to terminate sessions they are not fully terminated resulting in "black screen". So the option "kill sessions" was added to lockout and restriction types, please try using it, it should help.
Due to differences in using the standards not every Desktop Environment works equally well with time accounting for locked screen.
Some Linux distributions which are using Gnome3 and desktop environments based on it, require screen to be locked and switched off before session is considered locked.
KDE, XFCE and multiple other desktop environments require screen to be just locked for session to be considered inactive.
Deepin (for example) does not get along Timekpr-nExT with screen locking at all, because their implementation differs from major players and is not exactly compatible with the FreeDesktop / Gnome standards / patterns.
This section contains very technical description of the discrepancies, you may look into the issue descriptions and skip the technical part.
This may give an insight into the problem you may have, usually, if you have the issue, there is no fix for it, you may need to wait for next version of your favourite distribution or switch to another one.
There are multiple causes for this, one of them is when user quickly closes / opens laptops lid multiple times, org.freedesktop.login1 sometimes reports
session as inactive despite a user is happily using the computer.
So system reports that it is idle and time accounting stops, it can be mitigated by using "inactive session tracking" found in the options, but one has to evaluate whether this workaround suites you.
Another case when time accounting is broken is when some Desktop Environments have org.freedesktop.ScreenSaver exported to DBUS, but it's not fully
functional, i.e. GetActive always reports "not active" or there's an error about method not implemeted.
It turns out that not that many DEs actually implement the freedesktop interface itself. I have implemented a workaround to this to use DEs native screensaver interface, but sometimes it's just buggy implementation which kills idle time accounting. Unfortunately there is no workaround for this.
Another case when time accounting is broken is when some Desktop Environments do not implement or the implementation is buggy for IdleHint in
org.freedesktop.login1 object. Timekpr, which relies on such functionality, may get the wrong impression on the state of the system.
Sometimes the implementation differs, some set idle when screen is locked, some do the same but only when screen turns off and some do not that all. I tried to not rely on option alone, but if this does not work, you are out of luck.
The same thing applies to LockedHint too, some DEs set it only when screen is off and some do not use it at all. If this does not work, you are out of luck.
As previously mentioned after user sessions should be terminated sometimes the screen "goes black" and nothing else happens.
This is due to unknown issue in certain linux distributions and happens when timekpr asks systemd's org.freedesktop.login1.Manager to terminate user sessions,
certain Desktop Environments does not automatically switch to login screen or just does not finish the logout properly.
It can be mitigated by using "kill sessions" option, so far this workaround seems to work.
So, there are inconsistencies and at times it was quite tricky / required workarounds to get the solution to be compatible with most popular Desktop Environments at the same functionality level.
Quite a lot of time and effort went into making this a reality, so if you appreciate my work, would like to say thanks for making Timekpr-nExT or just want to contribute, please do so via PayPal (you do not need to have PayPal account) or BITCOIN:
-
The PayPal donations URL (shortened): https://tinyurl.com/yc9x85v2 .
-
BITCOIN address: bc1q57wapz6lxfyxex725x3gs7nntm3tazw2n96nk3
Alternatively, you can help to translate Timekpr-nExT in your language here too.
Timekpr-nExT development started because I was not happy with the "old" timekpr-revived I brought back from the old project (timekpr) to useful state. I had complaints from my kid about precision of accounting, session termination behaviour and some others I don't remember anymore :)
So, development was mainly driven by a technical challenge to use better available technologies and giving the best functionality to my kid, of course somewhat limiting the time spent on computer! However, it's not the case anymore for quite a long time (many years already). My kid has grown up and is rather responsible in his actions, he uses Windows, where all the games run just fine :)
That was a long way of saying that I'm not using nor plan to use Timekpr-nExT myself anymore!
What does that mean, you may ask? Honestly, it changes some things. One thing that changed for sure is that I'm not intentionally proactive in feature development. Do not expect new features out of the blue!
I think Timekpr-nExT is versatile enough to be configured as one pleases, it should be ok for most of you. If the needs are simple, it can be simple too, just do not check things left and right, do not surprise yourself.
Latest features I introduced were suggested, some even financially supported by users, big thanks to those who supported me!
Another thing is that I'm not giving it a long term testing as before when my kid used it, I am not searching and testing it on newer versions of your favourite distribution nor I am watching the latest supported packages needed for Timekpr. If there are no bugs filed / questions asked, I will never know whether Timekpr-nExT is even working properly.
So, if this application is sufficient for your needs, good, consider saying thanks, if not, suggest features or improvements and if they end up in Timekpr-nExT consider saying thanks afterwards or support your desired feature from the start.
Please register suggestions and bugs here. As for questions, please ask them here.
Please prefix a title of the bug with BETA if the bug was found in beta version.
Alternatively suggestions can be sent to me via e-mail edzis"replace this with at symbol"inbox"place a dot here"lv, I'll evaluate their usefulness and
who knows, they may see a light of the day.
As for bugs: please describe your issues as precisely as possible including a steps to fully reproduce the issue, if applicable, describe your setup too, i.e. which distribution, version of OS, Desktop Environment are you using, be prepared to send me config and log files (they do not contain anything sensitive, except usernames).
If you don't want to register a user in LP, you can send bug reports via e-mail too, but it's NOT the best way to handle them!
I'll do my best to address them as my free time allows.
Thanks for choosing Timekpr-nExT!