Imported Upstream version 2.2
[debian/cpulimit.git] / cpulimit.1
1 .TH CPULIMIT "1" "June 2012" "cpulimit" "User commands"
2 .SH NAME
3 cpulimit -- limits the CPU usage of a process
4 .SH SYNOPSIS
5 .B cpulimit
6 \fI[TARGET\fR] \fR[\fIOPTIONS\fR...] \fR[ -- \fIPROGRAM\fR]
7 .SH DESCRIPTION
8 .P
9 \fITARGET \fRmust be exactly one of these:
10 .TP
11 \fB\-p\fR, \fB\-\-pid\fR=\fIN\fR
12 pid of the process
13 .TP
14 \fB\-e\fR, \fB\-\-exe\fR=\fIFILE\fR
15 name of the executable program file
16 .TP
17 \fB\-P\fR, \fB\-\-path\fR=\fIPATH\fR
18 absolute path name of the executable program file
19 .P
20 \fIOPTIONS\fR
21 .TP
22 \fB\-b\fR, \fB\-\-background\fR
23 run cpulimit in the background, freeing up the terminal
24 .TP
25 \fB\-c\fR, \fB\-\-cpu\fR
26 specify the number of CPU cores available. Usually this is detected for us.
27 .TP
28 \fB\-l\fR, \fB\-\-limit\fR=\fIN\fR
29 percentage of CPU allowed from 1 up. Usually 1 - 100, but can be higher on multi-core CPUs. (mandatory)
30 .TP
31 \fB\-q\fR, \fB\-\-quiet\fR
32 Runs in quiet mode, avoids writing update messages to console.
33 .TP
34 \fB\-k\fR, \fB\-\-kill\fR
35 kill target process instead of throttling its CPU usage
36 .TP
37 \fB\-r\fR, \fB\-\-restore\fR
38 restore a process killed using the \-k flag.
39 .TP
40 \fB\-s\fR, \fB\-\-signal\fR
41 send an alternative signal to the watched process when we exit. Default is SIGCONT.
42 .TP
43 \fB\-v\fR, \fB\-\-verbose\fR
44 show control statistics
45 .TP
46 \fB\-z\fR, \fB\-\-lazy\fR
47 exit if there is no suitable target process, or if it dies
48 .TP
49 \fB\--\fR 
50 This is the final CPUlimit option. All following 
51 options are for another program we will launch.
52 .TP
53 \fB\-h\fR, \fB\-\-help\fR
54 display this help and exit
55 .SH EXAMPLES
56 Assuming you have started \fB`foo \-\-bar`\fR and you find out with \fItop\fR(1) or
57 \fIps\fR(1) that this process uses all your CPU time you can either
58 .TP
59 \[sh] \fBcpulimit \-e foo \-l 50\fR
60 limits the CPU usage of the process by acting on the executable program file
61 (note: the argument "\-\-bar" is omitted)
62 .TP
63 \[sh] \fBcpulimit \-p 1234 \-l 50\fR
64 limits the CPU usage of the process by acting on its PID, as shown by
65 \fIps\fR(1)
66 .TP
67 \[sh] \fBcpulimit \-P /usr/bin/foo \-l 50\fR
68 same as \fI\-e\fR but uses the absolute path name
69 .TP
70 \[sh] \fB/usr/bin/someapp \&
71 .TP
72 \[sh] \fBcpulimit \-p $! \-l 25 \-b\fR
73 Useful for scripts where you want to throttle
74 the last command run.
75 .TP
76 \[sh] \fBcpulimit \-l 20 firefox\fR
77 Launch Firefox web browser and limit its CPU usage to
78 20%
79 .TP
80 \[sh] \fBcpulimit \-l 25 \-\- firefox \-private\fR
81 Launch Firefox web browser in private mode and limit its CPU usage to
82 25%
83 .TP
84 \[sh] \fBcpulimit \-c 2 \-p 12345 \-l 25\fR
85 The \fB\-c\fR flag sets the number of CPU cores the
86 program thinks are available. Usually this is detected
87 for us, but can be over-ridden.
88 .TP
89 \[sh] \fBcpulimit \-l 20 \-k firefox\fr
90 Launch the Firefox program and kill it if the process goes
91 over 20% CPU usage.
92 .TP
93 \[sh] \fBcpulimit \-l 20 \-p 1234 -s SIGTERM
94 Throttle process 1234 at 20% CPU usage. If cpulimit is forced to exit, 
95 it sends the watched process the SIGTERM signal.
96 .SH NOTES
97 .IP \(bu 4
98 cpulimit always sends the SIGSTOP and SIGCONT signals to a process, 
99 both to verify
100 that it can control it and 
101 to limit the average amount of CPU it consumes.  This can result in
102 misleading (annoying) job control messages that indicate that the job 
103 has been stopped (when actually it was, but immediately restarted).  
104 This can also cause issues with interactive shells that detect or otherwise
105 depend on SIGSTOP/SIGCONT.   For example,
106 you may place a job in the foreground, only to see it immediately stopped
107 and restarted in the background.  (See also <http://bugs.debian.org/558763>.)
108 .IP \(bu 4
109 When invoked with the \fI\-e\fR or \fI\-P\fR options, cpulimit looks for 
110 any process under /proc with a name that matches the process name argument 
111 given.  Furthermore, it uses the first instance of the process found.  
112 To control a specific instance of a process, use the \fI\-p\fR option 
113 and provide a PID.
114 .IP \(bu 4
115 The current version of cpulimit assumes the kernel HZ value 100.
116
117 .SH AUTHOR
118 This manpage was written for the Debian project by gregor herrmann 
119 <gregoa@debian.org> but may be used by others.