{"id":18600459,"url":"https://github.com/jorsn/blackknight","last_synced_at":"2025-08-28T23:33:00.987Z","repository":{"id":16199057,"uuid":"18945792","full_name":"jorsn/blackknight","owner":"jorsn","description":"A terminal screen locker.","archived":false,"fork":false,"pushed_at":"2014-11-25T19:27:15.000Z","size":188,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-26T22:27:41.638Z","etag":null,"topics":["haskell","pam","screen-locker","tmux"],"latest_commit_sha":null,"homepage":null,"language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jorsn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-04-19T16:49:24.000Z","updated_at":"2021-11-11T20:27:48.000Z","dependencies_parsed_at":"2022-09-12T16:50:52.925Z","dependency_job_id":null,"html_url":"https://github.com/jorsn/blackknight","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/jorsn%2Fblackknight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jorsn%2Fblackknight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jorsn%2Fblackknight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jorsn%2Fblackknight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jorsn","download_url":"https://codeload.github.com/jorsn/blackknight/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239389578,"owners_count":19630310,"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":["haskell","pam","screen-locker","tmux"],"created_at":"2024-11-07T02:04:05.934Z","updated_at":"2025-02-18T00:54:25.880Z","avatar_url":"https://github.com/jorsn.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"blackknight\n============\n\n**blackknight** is a screen locker for text terminals using [PAM] for password checking.\nIt locks single terminals and can be used as lock-command for [TMux].\n\n[PAM]:  https://en.wikipedia.org/wiki/Pluggable_Authentication_Modules\n[TMux]: https://en.wikipedia.org/wiki/Tmux\n\n\nInvocation\n------------\n\nTo run **blackknight** after installing it simply type\n\n```\n$ blackknight\n```\n\nPossible cmdline options are:\n\n| Option                     | Description\n| -------------------------- | ---------------------\n| `-h`/`--help`\u003cbr\u003e          | Display a help message.\n| `-nc`/`--noclear`\u003cbr\u003e      | Do not clear the screen before locking.\n| `-nm`/`--nomsg`\u003cbr\u003e        | Do not display a message.\n| `\u003calternate lock message\u003e` | Display the given message instead of the default one.\n\n\n**Warning: `blackknight` clears the screen *and the scrollback buffer* when locking.\nOnly the schreen *without the scrollback buffer* is restored when unlocking.**\n\n\nUsage as TMux lock-command\n---------------------------\n\nPlace the following line in `/etc/tmux.conf` or `~/.tmux.conf`:\n\n```\nset-option -g lock-command 'blackknight'\n```\n\n\nBuild/Installation\n---------------------\n\nSince **blackknight** uses [cabal] you only have to type\n\n```\n$ cabal install\n```\n\nto install or\n\n```\n$ cabal build\n```\n\nto build without installation.\n\n_To be able to run **blackknight** you have to install it as root (`sudo cabal install --global`)\nor copy `pam.d/blackknight` to `/etc/pam.d/` with permissions set to `0644`._\n\n[cabal]:  http://www.haskell.org/cabal\n\n\nCopyright\n-----------\n\nCopyright (c) 2014 Johannes Rosenberger \u003cjo.rosenberger at gmx-topmail.de\u003e\n\nThis code is released under a BSD Style License.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY\nEXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\nOF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT\nSHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\nINCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR\nBUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\nCONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\nANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH\nDAMAGE.\n\nFor more details please read the '[LICENSE]' file.\n\n[LICENSE]: https://github.com/jorsn/blackknight/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjorsn%2Fblackknight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjorsn%2Fblackknight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjorsn%2Fblackknight/lists"}