]> git.ipfire.org Git - thirdparty/util-linux.git/blame - schedutils/chrt.1
check exit status of autotools
[thirdparty/util-linux.git] / schedutils / chrt.1
CommitLineData
48d7b13a
KZ
1.\" chrt(1) manpage
2.\"
3.\" Copyright (C) 2004 Robert Love
4.\"
5.\" This is free documentation; you can redistribute it and/or
6.\" modify it under the terms of the GNU General Public License as
7.\" published by the Free Software Foundation; either version 2 of
8.\" the License.
9.\"
10.\" The GNU General Public License's references to "object code"
11.\" and "executables" are to be interpreted as the output of any
12.\" document formatting or typesetting system, including
13.\" intermediate and printed output.
14.\"
15.\" This manual is distributed in the hope that it will be useful,
16.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
17.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18.\" GNU General Public License for more details.
19.\"
20.\" You should have received a copy of the GNU General Public
21.\" License along with this manual; if not, write to the Free
22.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
23.\" USA.
24.\"
25.\" 2002-05-11 Robert Love <rml@tech9.net>
26.\" Initial version
27.\"
28.TH CHRT "1" "Apr 2003" "schedutils" "Linux User's Manual"
29.SH NAME
30chrt \- manipulate real-time attributes of a process
31.SH SYNOPSIS
32.B chrt
33[\fIoptions\fR] [\fIprio\fR] [\fIpid\fR | \fIcommand\fR [\fIarg\fR]...]
34.SH DESCRIPTION
35.PP
36.BR chrt (1)
37sets or retrieves the real-time scheduling attributes of an existing PID or
38runs COMMAND with the given attributes. Both policy (one of
df3773fb 39.BR SCHED_OTHER ,
48d7b13a
KZ
40.BR SCHED_FIFO ,
41.BR SCHED_RR ,
42or
df3773fb 43.BR SCHED_BATCH )
48d7b13a
KZ
44and priority can be set and retrieved.
45.SH OPTIONS
46.TP
47.B -p, --pid
48operate on an existing PID and do not launch a new task
49.TP
50
df3773fb
KZ
51.TP
52.B -b, --batch
53set scheduling policy to
54.BR SCHED_BATCH
48d7b13a
KZ
55.TP
56.B -f, --fifo
57set scheduling policy to
58.BR SCHED_FIFO
59.TP
60.B -m, --max
61show minimum and maximum valid priorities, then exit
62.TP
63.B -o, --other
64set policy scheduling policy to
65.BR SCHED_OTHER
66.TP
67.B -r, --rr
68set scheduling policy to
69.BR SCHED_RR
70(the default)
71.TP
72.B -h, --help
73display usage information and exit
74.TP
75.B -v, --version
76output version information and exit
77.SH USAGE
78.TP
79The default behavior is to run a new command::
5ee00309 80chrt [prio] [command] [arguments]
48d7b13a
KZ
81.TP
82You can also retrieve the real-time attributes of an existing task:
83chrt -p [pid]
84.TP
85Or set them:
86chrt -p [prio] [pid]
87.SH PERMISSIONS
88A user must possess
89.BR CAP_SYS_NICE
90to change the scheduling attributes of a process. Any user can retrieve the
91scheduling information.
92.SH AUTHOR
93Written by Robert M. Love.
94.SH "REPORTING BUGS"
95Report bugs to <rml@tech9.net>.
96.SH COPYRIGHT
97Copyright \(co 2004 Robert M. Love
98.br
99This is free software; see the source for copying conditions. There is NO
100warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
101.SH "SEE ALSO"
102.BR taskset (1),
103.BR nice (1),
104.BR renice (1)
105.sp
106See
107.BR sched_setscheduler (2)
108for a description of the Linux scheduling scheme.