{"id":13440456,"url":"https://github.com/i3/i3lock","last_synced_at":"2025-05-15T20:05:43.526Z","repository":{"id":25098429,"uuid":"28519514","full_name":"i3/i3lock","owner":"i3","description":"improved screen locker","archived":false,"fork":false,"pushed_at":"2025-04-15T15:27:17.000Z","size":428,"stargazers_count":939,"open_issues_count":15,"forks_count":404,"subscribers_count":30,"default_branch":"main","last_synced_at":"2025-04-15T16:40:43.907Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://i3wm.org/i3lock","language":"C","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/i3.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":".github/CONTRIBUTING.md","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":"2014-12-26T19:41:34.000Z","updated_at":"2025-04-15T15:27:21.000Z","dependencies_parsed_at":"2024-01-16T20:29:06.033Z","dependency_job_id":"4b00b240-5e3b-4657-ae6c-591265af3df0","html_url":"https://github.com/i3/i3lock","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i3%2Fi3lock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i3%2Fi3lock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i3%2Fi3lock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i3%2Fi3lock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/i3","download_url":"https://codeload.github.com/i3/i3lock/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254414499,"owners_count":22067272,"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":[],"created_at":"2024-07-31T03:01:22.931Z","updated_at":"2025-05-15T20:05:38.460Z","avatar_url":"https://github.com/i3.png","language":"C","funding_links":[],"categories":["C","Screen Lock"],"sub_categories":["Utilities"],"readme":"i3lock - improved screen locker\n===============================\n[i3lock](https://i3wm.org/i3lock/) is a simple screen locker like slock.\nAfter starting it, you will see a white screen (you can configure the\ncolor/an image). You can return to your screen by entering your password.\n\nMany little improvements have been made to i3lock over time:\n\n- i3lock forks, so you can combine it with an alias to suspend to RAM\n  (run \"i3lock \u0026\u0026 echo mem \u003e /sys/power/state\" to get a locked screen\n   after waking up your computer from suspend to RAM)\n\n- You can specify either a background color or a PNG image which will be\n  displayed while your screen is locked. Note that i3lock is not an image\nmanipulation software. If you need to resize the image to fill the screen\nor similar, use existing tooling to do this before passing it to i3lock.\n\n- You can specify whether i3lock should bell upon a wrong password.\n\n- i3lock uses PAM and therefore is compatible with LDAP etc.\n  On OpenBSD i3lock uses the bsd_auth(3) framework.\n\nInstall\n-------\n\nSee [the i3lock home page](https://i3wm.org/i3lock/).\n\nRequirements\n------------\n- pkg-config\n- libxcb\n- libxcb-util\n- libpam-dev\n- libcairo-dev\n- libxcb-xinerama\n- libxcb-randr\n- libev\n- libx11-dev\n- libx11-xcb-dev\n- libxkbcommon \u003e= 0.5.0\n- libxkbcommon-x11 \u003e= 0.5.0\n- libxcb-image\n- libxcb-xrm\n\nRunning i3lock\n-------------\n\nTo test i3lock, you can directly run the `i3lock` command. To get out of it,\nenter your password and press enter.\n\nFor a more permanent setup, we strongly recommend using `xss-lock` so that the\nscreen is locked *before* your laptop suspends:\n\n```\nxss-lock --transfer-sleep-lock -- i3lock --nofork\n```\n\nOn OpenBSD the `i3lock` binary needs to be setgid `auth` to call the\nauthentication helpers, e.g. `/usr/libexec/auth/login_passwd`.\n\nBuilding i3lock\n---------------\nWe recommend you use the provided package from your distribution. Do not build\ni3lock unless you have a reason to do so.\n\nFirst install the dependencies listed in requirements section, then run these\ncommands (might need to be adapted to your OS):\n```\nrm -rf build/\nmkdir -p build \u0026\u0026 cd build/\n\nmeson setup -Dprefix=/usr\nninja\n```\n\nUpstream\n--------\nPlease submit pull requests to https://github.com/i3/i3lock\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fi3%2Fi3lock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fi3%2Fi3lock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fi3%2Fi3lock/lists"}