]> git.ipfire.org Git - thirdparty/util-linux.git/blame - schedutils/chrt.1
docs: add a note about /proc/sys/kernel/random/uuid
[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
5ebbcdf9
LJ
33.RI [ options ]\ prio
34.IR command\ [ arg ]...
35.br
36.B chrt
37.RI [ options ]
38.B \-p
39.RI [ prio ]\ pid
48d7b13a
KZ
40.SH DESCRIPTION
41.PP
42.BR chrt (1)
43sets or retrieves the real-time scheduling attributes of an existing PID or
44runs COMMAND with the given attributes. Both policy (one of
df3773fb 45.BR SCHED_OTHER ,
48d7b13a
KZ
46.BR SCHED_FIFO ,
47.BR SCHED_RR ,
c779d6e9 48.BR SCHED_BATCH ,
48d7b13a 49or
c779d6e9 50.BR SCHED_IDLE )
48d7b13a 51and priority can be set and retrieved.
09dd84ca
KZ
52.PP
53The
54.BR SCHED_BATCH
c779d6e9
MS
55policy is supported since Linux 2.6.16. The
56.BR SCHED_IDLE
57policy is supported since Linux 2.6.23.
48d7b13a
KZ
58.SH OPTIONS
59.TP
60.B -p, --pid
61operate on an existing PID and do not launch a new task
df3773fb
KZ
62.TP
63.B -b, --batch
64set scheduling policy to
65.BR SCHED_BATCH
48d7b13a
KZ
66.TP
67.B -f, --fifo
68set scheduling policy to
69.BR SCHED_FIFO
70.TP
c779d6e9
MS
71.B -i, --idle
72set schedulng policy to
73.BR SCHED_IDLE
74.TP
48d7b13a
KZ
75.B -m, --max
76show minimum and maximum valid priorities, then exit
77.TP
78.B -o, --other
79set policy scheduling policy to
80.BR SCHED_OTHER
81.TP
82.B -r, --rr
83set scheduling policy to
84.BR SCHED_RR
85(the default)
86.TP
87.B -h, --help
88display usage information and exit
89.TP
90.B -v, --version
91output version information and exit
92.SH USAGE
93.TP
94The default behavior is to run a new command::
697d58e8 95chrt prio command [arguments]
48d7b13a
KZ
96.TP
97You can also retrieve the real-time attributes of an existing task:
697d58e8 98chrt -p pid
48d7b13a
KZ
99.TP
100Or set them:
697d58e8 101chrt -p prio pid
48d7b13a
KZ
102.SH PERMISSIONS
103A user must possess
104.BR CAP_SYS_NICE
105to change the scheduling attributes of a process. Any user can retrieve the
106scheduling information.
107.SH AUTHOR
108Written by Robert M. Love.
48d7b13a
KZ
109.SH COPYRIGHT
110Copyright \(co 2004 Robert M. Love
111.br
112This is free software; see the source for copying conditions. There is NO
113warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
114.SH "SEE ALSO"
115.BR taskset (1),
116.BR nice (1),
117.BR renice (1)
118.sp
119See
120.BR sched_setscheduler (2)
121for a description of the Linux scheduling scheme.
86d62711
KZ
122.SH AVAILABILITY
123The chrt command is part of the util-linux-ng package and is available from
124ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.