applications/slock
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

use markdown in readme

Browse Source
This commit is contained in:
Christopher Jeffrey 2014-09-25 14:45:17 -07:00
parent 6b7c9b3afc
commit 50d3be5296
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README
View File

@ -1,9 +1,9 @@
slock - simple screen locker # slock - a fork of the suckless screenlocker for the _extremely_ paranoid
============================
simple screen locker utility for X.
Changes by chjj This is my personal fork of slock. It is the only screenlocker secure enough
------------ for me to use.
## Changes from the original Slock
- Custom Password: You can provide a custom password so you don't have to enter - Custom Password: You can provide a custom password so you don't have to enter
your user password on the X server. Simply create a ~/.slock_passwd file with your user password on the X server. Simply create a ~/.slock_passwd file with
@ -47,22 +47,25 @@ Changes by chjj
You must change [username] and [hostname] to your username and the hostname You must change [username] and [hostname] to your username and the hostname
of the machine. of the machine.
Requirements ## Requirements
------------
In order to build slock you need the Xlib header files. In order to build slock you need the Xlib header files.
- Potential runtime deps: sudo, ffmpeg, setxkbmap, curl, aplay
- Other potential requirements: a twilio account, an imgur account
## Installation
Installation
------------
Edit config.mk to match your local setup (slock is installed into Edit config.mk to match your local setup (slock is installed into
the /usr/local namespace by default). the /usr/local namespace by default).
Afterwards enter the following command to build and install slock Afterwards enter the following command to build and install slock
(if necessary as root): (if necessary as root):
make clean install ``` bash
$ make clean install
```
## Running slock
Running slock
-------------
Simply invoke the 'slock' command. To get out of it, enter your password. Simply invoke the 'slock' command. To get out of it, enter your password.