aboutsummaryrefslogtreecommitdiff
path: root/slocko/README
diff options
context:
space:
mode:
Diffstat (limited to 'slocko/README')
-rw-r--r--slocko/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/slocko/README b/slocko/README
new file mode 100644
index 0000000..3c225a6
--- /dev/null
+++ b/slocko/README
@@ -0,0 +1,25 @@
+slocko - simple screen locker for openbsd
+=========================================
+
+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.