- remove all patches (applied upstream), remove quilt framework
[debian/cpulimit.git] / README
1 README for LimitCPU
2 ==========================
3
4 LimitCPU is a program to throttle the CPU cycles used by other applications.
5 LimitCPU will monitor a process and make sure its CPU usage stays at or
6 below a given percentage. This can be used to make sure your system
7 has plenty of CPU cycles available for other tasks. It can also be used
8 to keep laptops cool in the face of CPU-hungry processes and for limiting
9 virtual machines.
10
11 LimitCPU is the direct child of CPUlimit, a creation of Angelo Marletta,
12 which can be found at http://cpulimit.sourceforge.net.
13
14
15
16
17 Copying, License and Distribution
18 ===================================
19
20 LimitCPU is licensed under the GNU General Public License (version 2).
21 A copy of the license should be included with this program in a
22 file named LICENSE.
23
24
25
26
27
28 Where to get LimitCPU
29 ==========================
30
31 The LimitCPU program can be aquired from http://limitcpu.sourceforge.net
32
33
34
35
36 How to compile and install
37 ===========================
38
39 Once you have downloaded a copy of LimitCPU building should be fairly
40 straight forward. First we unpack the source code
41
42 tar zxf cpulimit-1.3.tar.gz
43
44 Then we run the makefile.
45
46 cd cpulimit-1.3
47 make
48
49 This should produce the executable file "cpulimit". If you would like
50 to install the program to make it available system-wide, run
51
52 make install
53
54
55 Later should you wish to remove the program from your system, run
56 the following command from the limitcpu directory
57
58 make deinstall
59
60
61
62 Common usage
63 ==========================
64
65 The LimitCPU program is generally used to throttle the CPU usage of
66 one process. This can be done with the following command where
67 12345 is the process ID number of a running program and 25 is the
68 maximum percentage of the CPU we are willing to give that program
69
70 cpulimit -p 12345 -l 25
71
72 The above example will cause LimitCPU to keep an eye on the process
73 with ID number 12345 until the program exits. Should we wish to
74 run LimitCPU in the background we can use
75
76 cpulimit -p 12345 -l 25 -b
77
78 We can also limit running processes based on their name instead of
79 their process ID, as in this example:
80
81 cpulimit --exe /usr/bin/bigexe --limit 50
82
83 The above example will keep an eye on "bigexe" and, if the application
84 quits and another program called "bigexe" is run, LimitCPU will
85 monitor the new process too. Should we wish to only track the first
86 program and then exit, we can use 
87
88 cpulimit --exec /usr/bin/bigexe --limit 50 -z
89
90 The "-z" flag tells LimitCPU to stop running once its target is
91 no longer running itself.
92
93
94
95
96 Bugs and Feedback
97 =============================
98
99 Should you have comments, questions, or bugs to report, please send
100 an e-mail to jessefrgsmith@yahoo.ca with the word "LimitCPU" in the
101 subject line.
102