aboutsummaryrefslogtreecommitdiff
path: root/slockf/README
diff options
context:
space:
mode:
authorBradley Taunt <bt@btxx.org>2024-01-17 19:44:16 -0500
committerBradley Taunt <bt@btxx.org>2024-01-17 19:44:16 -0500
commitc47aa4c4279beb700ec18c83fcf74aafc77d76a4 (patch)
tree76692ddf485c4453b366ce8df41e35c879cac9d3 /slockf/README
Initial commit to cgit and place all suckless programs within installer
Diffstat (limited to 'slockf/README')
-rwxr-xr-xslockf/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/slockf/README b/slockf/README
new file mode 100755
index 0000000..dcacd01
--- /dev/null
+++ b/slockf/README
@@ -0,0 +1,24 @@
+slock - simple screen locker
+============================
+simple screen locker utility for X.
+
+
+Requirements
+------------
+In order to build slock you need the Xlib header files.
+
+
+Installation
+------------
+Edit config.mk to match your local setup (slock is installed into
+the /usr/local namespace by default).
+
+Afterwards enter the following command to build and install slock
+(if necessary as root):
+
+ make clean install
+
+
+Running slock
+-------------
+Simply invoke the 'slock' command. To get out of it, enter your password.