debian/watch: use sourceforge URL directly instead of the redirector at
[debian/cpulimit.git] / debian / cpulimit.1
1 .TH CPULIMIT "1" "November 2006" "cpulimit" "User commands"
2 .SH NAME
3 cpulimit -- limits the CPU usage of a process
4 .SH SYNOPSIS
5 .B cpulimit
6 \fITARGET \fR[\fIOPTIONS\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\-l\fR, \fB\-\-limit\fR=\fIN\fR
23 percentage of CPU allowed from 0 to 100 (mandatory)
24 .TP
25 \fB\-v\fR, \fB\-\-verbose\fR
26 show control statistics
27 .TP
28 \fB\-z\fR, \fB\-\-lazy\fR
29 exit if there is no suitable target process, or if it dies
30 .TP
31 \fB\-h\fR, \fB\-\-help\fR
32 display this help and exit
33 .SH EXAMPLES
34 Assuming you have started \fB`foo \-\-bar`\fR and you find out with \fItop\fR(1) or
35 \fIps\fR(1) that this process uses all your CPU time you can either
36 .TP
37 \[sh] \fBcpulimit \-e foo \-l 50\fR
38 limits the CPU usage of the process by acting on the executable program file
39 (note: the argument "\-\-bar" is omitted)
40 .TP
41 \[sh] \fBcpulimit \-p 1234 \-l 50\fR
42 limits the CPU usage of the process by acting on its PID, as shown by
43 \fIps\fR(1)
44 .TP
45 \[sh] \fBcpulimit \-P /usr/bin/foo \-l 50\fR
46 same as \fI\-e\fR but uses the absolute path name 
47 .SH AUTHOR
48 This manpage was written for the Debian project by gregor herrmann
49 <gregor+debian@comodo.priv.at> but may be used by others.