Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicciniamh/ssaver
a "screensaver/locker" for Terminals using zsh
https://github.com/nicciniamh/ssaver
command-line-tool linux macos python terminal unix zsh
Last synced: 26 days ago
JSON representation
a "screensaver/locker" for Terminals using zsh
- Host: GitHub
- URL: https://github.com/nicciniamh/ssaver
- Owner: nicciniamh
- License: unlicense
- Created: 2023-11-22T20:06:12.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-11-24T03:13:01.000Z (12 months ago)
- Last Synced: 2024-01-26T01:47:37.668Z (10 months ago)
- Topics: command-line-tool, linux, macos, python, terminal, unix, zsh
- Language: Shell
- Homepage:
- Size: 192 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ssaver - a "screensaver/locker" for Terminals using zsh
ssaver is a pair of utilities. One is a script meant to be sourced into zsh. The other is a python curses
program that does the actual screensaver.
## screensaver.zsh
This script creates a screensaver function that is used like a shell command that allows changing of the
options used.
### Logo
The screensaver logo, centered on the screen by default, is two lines of user@hostname and the current time.
### Screensaver commands
Screenaver commands are invoked with ```screensaver ```.
|Command|Description |Parameters |
|----------|----------------------------------------------|--------------------------|
| activate | activates the screen saver | noine |
| blank | Displays screensaver settings | none |
| on | Enables the screensaver with default timeout | none |
| off | Disables the screensaver | none |
| save | Saves current options to ~/.ssaver.rc | none |
| set | Sets options (see below) | colors,lock,random, time |
#### Set commands
Set commands are invoked with ```set ```. Each time a set command is used the
screensaver options are saved to ```~/.ssaver.rc```.
|Command |Description |Parameters |
|--------|-----------------------------------------------------|--------------------------|
|colors |Turns on or off random coloring of the logo. |on, off |
|fullhost|Turns on or off full hostname in logo. |on, off |
| lock |Turns on or off screen locking when saver activated. |on, off |
|random |Turns on or off random placement of logo |on, off |
| time |Sets the number of idle seconds for acitvation | *seconds* |
### Screenlock
The screenlock pythong program assumes that USER is set to the logged in user name. The screensaver.sh script marks this variable as read-only. When locking is enabled, the screenlock program uses PAM to check the password entered and unlocks the screen if authenticated with PAM.
Screen lock arguments:
| Argument | Description |
|--------------|--------------------------------------------|
| -h, --help | Show help message and exit. |
| -c, --colors | Use random colors on display. |
| -n, --nolock | Disable requiring a password to deactivate.|
| -r, --random | Use random placement of logo. |
| -l, --long | Use long (full) histname |
screenlock can be invoked directly, but, it's really meant to be called by the shell when TMOUT idle seconds expire. All the options of screenlock can be set by the screensaver command using the above command set.
## Installation
I have tested this code on Debian Bookworm, Pi OS Buster, Ubuntu Server 18.04 and macOS Ventura.
### Prerequisites
* zsh
* python 3.9+
* the following python modules: curses, pam, random
1. copy screenlock to somehwere on your path
2. copy screensaver.zsh to a convenient place
3. add ```source path-to/screensaver.zsh```
4. run ```exec zsh```
## License
This program has no license. Use it, copy it, call it yours if you feel a great need. No warranty is expressed or implied. If it breaks something, you own all the pieces. Please see [LICENSE](LICENSE) for details.