frzysk/mycaffeine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add README.md and docs in the script

Browse source
This commit is contained in:
mcolonna 2025-07-30 20:28:32 +02:00
parent 6526939890
commit 2b107aa851
2 changed files with 58 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md Normal file
View file

@ -0,0 +1,33 @@
# mycaffeine
a little linux tools that moves your pointer regularly to avoid the automatic screen lock on a computer you can't configure. it doesn't need root.
# how to install
you may want to copy the file /mycaffeine in the $PATH or somewhere you can run it quickly. you don't need to, it's just a standalone script.
# how to use
these commands assume you copied ./mycaffeine
## how to start it
```sh
$ mycaffeine start
```
## how to stop it
```sh
$ mycaffeine stop
```
## how to check if it's currently running
there is no command to do that, but you can just start it or stop it again to be sure it's running.
## how to specify the interval
change the value of the variable $DELAY in the script.
## how to check if it works
change the delay to 1 seconds and see if your pointer moves lol
## what if it doesn't work
i have no idea

37
mycaffeine
View file

@ -1,23 +1,32 @@
#!/bin/bash #!/bin/bash
# Made by zy (https://github.com/frzysk) # script made by zy (https://gitea.zaclys.com/frzysk)
# #
# This scripts makes your pointer automatically move at a specific interval
# to avoid automatic lock of the computer.
# Doesn't need root.
# #
# How to start it: # a little linux tools that moves your pointer regularly to avoid the automatic screen lock on a computer you can't configure. it doesn't need root.
#
#
# HOW TO INSTALL
#
# you may want to copy this script in the $PATH or somewhere you can run it quickly. you don't need to, it's just a standalone script.
#
#
# HOW TO USE
#
# these commands assume you copied ./mycaffeine
#
# how to start it
# $ mycaffeine start # $ mycaffeine start
# How to stop it: # how to stop it
# $ mycaffeine stop # $ mycaffeine stop
# How to check if it's currently running: # how to check if it's currently running
# don't # there is no command to do that, but you can just start it or stop it again to be sure it's running.
# How to specify the interval: # how to specify the interval
# Change the value of the variable $DELAY in the script. # change the value of the variable $DELAY below (in seconds).
# How to check if it works: # how to check if it works
# Change the delay to 1 seconds and see if your pointer moves # change the delay to 1 seconds and see if your pointer moves lol
# What if it doesn't work: # what if it doesn't work
# That would be sad # i have no idea
DELAY=300 # in seconds DELAY=300 # in seconds