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