New upstream release.
[debian/cpulimit.git] / README
diff --git a/README b/README
index 447e099..9c512eb 100644 (file)
--- a/README
+++ b/README
@@ -21,6 +21,9 @@ LimitCPU is licensed under the GNU General Public License (version 2).
 A copy of the license should be included with this program in a
 file named LICENSE.
 
+Copyright 2005, Angelo Marletta <marlonx80@hotmail.com>
+Copyright 2011-2012, Jesse Smith <jessefrgsmith@yahoo.ca>
+
 
 
 
@@ -39,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-1.3.tar.gz
+tar zxf cpulimit-1.5.tar.gz
 
 Then we run the makefile.
 
-cd cpulimit-1.3
+cd cpulimit-1.5
 make
 
 This should produce the executable file "cpulimit". If you would like
@@ -90,6 +93,14 @@ cpulimit --exec /usr/bin/bigexe --limit 50 -z
 The "-z" flag tells LimitCPU to stop running once its target is
 no longer running itself.
 
+The following example is useful for scripts where we want
+to launch a program and then immediately throttle it
+without knowing its process ID. The "$!" symbol refers to
+the last program run and the -b flag tells cpulimit to
+run in the background, returning control to the shell.
+
+/usr/bin/someapp &
+cpulimit -p $! -l 25 -b