{"id":22021868,"url":"https://github.com/mezantrop/sclocka","last_synced_at":"2025-05-07T06:42:24.288Z","repository":{"id":154756821,"uuid":"631918125","full_name":"mezantrop/sclocka","owner":"mezantrop","description":"The real screensaver/lock for terminals","archived":false,"fork":false,"pushed_at":"2024-11-30T12:08:09.000Z","size":6004,"stargazers_count":23,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T07:22:13.347Z","etag":null,"topics":["c","pty","screenlock","screenlocker","screensaver","security","terminal","terminal-based"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mezantrop.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-24T10:35:38.000Z","updated_at":"2025-02-16T17:13:05.000Z","dependencies_parsed_at":"2024-01-07T21:22:15.553Z","dependency_job_id":"e94ef927-cf0a-4c88-8572-fa9e444e3fc9","html_url":"https://github.com/mezantrop/sclocka","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezantrop%2Fsclocka","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezantrop%2Fsclocka/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezantrop%2Fsclocka/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezantrop%2Fsclocka/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mezantrop","download_url":"https://codeload.github.com/mezantrop/sclocka/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252831095,"owners_count":21810776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","pty","screenlock","screenlocker","screensaver","security","terminal","terminal-based"],"created_at":"2024-11-30T06:15:42.209Z","updated_at":"2025-05-07T06:42:24.280Z","avatar_url":"https://github.com/mezantrop.png","language":"C","funding_links":["https://www.buymeacoffee.com/mezantrop"],"categories":["\u003ca name=\"screensaver\"\u003e\u003c/a\u003eScreen savers"],"sub_categories":[],"readme":"# Sclocka\n\n## Screen saver/lock for terminals\n\n\u003ca href=\"https://www.buymeacoffee.com/mezantrop\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"\u003e\u003c/a\u003e\n\nProtect your terminal with a screensaver and lock it with a password. `Sclocka` runs on *BSD, macOS and Linux\n\n[![Sclocka](media/sclocka.gif)](https://youtu.be/i5aE6_wzTlk)\n\u003cbr\u003e\n*Click to see video*\n\nRun external screensavers at your own risk, probably not all of them will work as expected,\nalso they may crash and overall consequences (including security) may be unexpected or potentially dangerous.\n\n### Sclocka on real hardware\n\nDEC TV220, thanks [@TheWanderer1983](https://github.com/TheWanderer1983)\u003cbr\u003e\n\u003cimg src=\"media/sclocka-DEC-VT220-start.jpg\" width=\"40%\"\u003e\n\u003cimg src=\"media/sclocka-DEC-VT220-cmatrix.jpg\" width=\"40%\"\u003e\n\n### Features and TODO list\n\n- [x] Plain screensaver mode *(no password)*\n- [x] Password protection via PAM (Pluggable Authentication Modules)\n- Supported platforms:\n  - [x] Linux\n  - [x] macOS\n  - [x] FreeBSD, NetBSD, OpenBSD\n  - [ ] Others to be done\n- [ ] Sclocka as login shell\n- [ ] Packages/ports\n- [ ] Documentation\n\n**[Changelog](CHANGELOG.md) | [Issues](https://github.com/mezantrop/sclocka/issues) | [Contributors](CONTRIBUTORS.md)**\n\n### Build and install\n\nBuild Requirements\n\n- CLANG or GCC\n- make\n- PAM development libraries\n\n#### FreeBSD\n\n`# make install clean`\n\nNote, the default `login` PAM service on FreeBSD doesn't check a user's password for the same login. To allow `sclocka`\nperform password authentication via PAM, install [unix-selfauth-helper](https://github.com/Zirias/unix-selfauth-helper):\n\n```sh\n# pkg install unix-selfauth-helper\n```\n\nCreate and configure a special PAM service e.g. /etc/pam.d/sclocka:\n\n```\nauth            sufficient      pam_exec.so             return_prog_exit_status expose_authtok /usr/local/libexec/unix-selfauth-helper\nauth            include         system\naccount         include         system\n```\n\nStart `sclocka` with `-P sclocka` option:\n\n```sh\n$ sclocka -P sclocka\n```\n\n#### NetBSD\n\n`# make install clean`\n\nSee notes about PAM helper from FreeBSD section\n\n#### OpenBSD\n\nNo PAM supported\n\n`# make without_pam install clean`\n\n#### macOS\n\n`# make install clean`\n\nNote, you may be prompted to install command line developer tools\n\n#### Debian flavor Linux\n\nMake sure you have everything to compile sources:\n\n```sh\n$ sudo apt-get install build-essential\n$ sudo apt-get install libpam0g-dev\n\n$ sudo make install clean\n```\n\n#### Red Hat based Linux\n\nMake sure you have everything to compile sources:\n\n```sh\n$ sudo dnf groupinstall \"Development Tools\"\n$ sudo dnf install pam-devel\n\n$ sudo make install clean\n```\n\n### Run\n\n`# sclocka`\n\nWait for a screensaver to appear\n\n#### Options\n\n`Sclocka` can be envoked with several options:\n\n```sh\n$ sclocka -h\n\nSclocka - screen saver/lock for terminals, v1.1.2.2\n\nUsage:\n        sclocka [-b n|b|c|f] [-c] [-i n] [-s n] [-r]\n                [-p] [-P service]\n        sclocka [-B] [-b n|b|c|f] [-c] [-i n] [-r]\n                [-p] [-P service]\n        sclocka [-E \"/path/to/saver arg1 .. argn\"] [-b n|b|c|f] [-c] [-i n]\n                [-r] [-p] [-P service]\n        sclocka [-h]\n\n[-B]            Black-only, no screensaver animation\n[-E \"/path/to/saver arg1 .. argn\"]\n                Execute an external screensaver program with arguments\n\n[-b f]          Screen restore: (n)one, (b)uffer, (c)apabilities, (f)ormfeed\n[-c]            Do not clear the window\n[-i 5]          Wait n minutes before launching the screensaver\n[-s 64]         Screensaver speed n in milliseconds\n\n[-p]            Disable PAM password check\n[-P login]      Use custom PAM service\n\n[-r]            Do not enable raw terminal mode\n\n[-h]            This message\n```\n\n### Contacts\n\nNot so early stage of development, yet don't expect everything to work properly. If you have an idea, a question,\nor have found a problem, do not hesitate to open an issue or mail me: Mikhail Zakharov \u003czmey20000@yahoo.com\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmezantrop%2Fsclocka","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmezantrop%2Fsclocka","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmezantrop%2Fsclocka/lists"}