aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..3bd076c
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,16 @@
+Lock
+====
+
+This program creates a lock directory to ensure two programs do no simulaneously execute
+
+example:
+
+ calvin@barnabas:~/lock$ lock p
+ calvin@barnabas:~/lock$ lock p && echo 'UNLOCKED' &
+ [2] 22844
+ calvin@barnabas:~/lock$ rmdir p
+ * two seconds later *
+ calvin@barnabas:~/lock$
+ UNLOCKED
+ [2]- Done lock p && echo -e '\nUNLOCKED\n'
+ calvin@barnabas:~/lock$