Imported Upstream version 2.2
[debian/cpulimit.git] / README
diff --git a/README b/README
index 7aa2470..83b6902 100644 (file)
--- a/README
+++ b/README
@@ -42,11 +42,11 @@ How to compile and install
 Once you have downloaded a copy of LimitCPU building should be fairly
 straight forward. First we unpack the source code
 
-tar zxf cpulimit-2.0.tar.gz
+tar zxf cpulimit-2.2.tar.gz
 
 Then we run the makefile.
 
-cd cpulimit-2.0
+cd cpulimit-2.2
 make
 
 This should produce the executable file "cpulimit". If you would like
@@ -166,7 +166,32 @@ has been launched by cpulimit. For this reason it is necessary
 to specify the target program at the end of the command line
 as shown above.
 
+LimitCPU, by default, will tell a watched process to continue
+running when LimitCPU terminates. This is accomplished by
+sending the watched process the SIGCONT signal just before
+LimitCPU exits. The user can specify an alternative signal to
+send the watched process when LimitCPU terminates. This is
+accomplished using the -s or --signal command line flag. Here
+is an example of terminating a watched process
 
+cpulimit -l 25 -p 1234 -s SIGTERM
+
+And here we accomplish the same thing using a numeric value
+instead of the written form of the signal.
+
+cpulimit -l 25 -p 1234 --signal=15
+
+
+
+
+Accessing the latest code
+============================
+
+For developers who would like to test or modify the latest
+LimitCPU code, the code is available in a Subversion (svn)
+repository. The code can be checked out using the command
+
+svn checkout svn://svn.code.sf.net/p/limitcpu/code/ limitcpu-code