]> git.saurik.com Git - apple/system_cmds.git/blame - taskpolicy.tproj/taskpolicy.8
system_cmds-735.20.1.tar.gz
[apple/system_cmds.git] / taskpolicy.tproj / taskpolicy.8
CommitLineData
fc6d9e4b
A
1.Dd 2/21/13\r
2.Dt taskpolicy 8\r
3.Os Darwin\r
4.Sh NAME\r
5.Nm taskpolicy\r
1a7e3f61 6.Nd execute a program with an altered I/O or scheduling policy or change settings of already running process\r
fc6d9e4b
A
7.Sh SYNOPSIS\r
8.Nm\r
9.Op Fl d Ar policy\r
1a7e3f61
A
10.Op Fl g Ar policy\r
11.Op Fl c Ar clamp\r
fc6d9e4b 12.Op Fl b\r
1a7e3f61
A
13.Op Fl t Ar thruput_tier\r
14.Op Fl l Ar latency_tier\r
fc6d9e4b
A
15.Ar program\r
16.Oo\r
17.Ar arg1\r
18.Op Ar ...\r
19.Oc\r
1a7e3f61
A
20.Nm\r
21.Op Fl b|-B\r
22.Op Fl t Ar thruput_tier\r
23.Op Fl l Ar latency_tier\r
24.Op Fl p Ar pid\r
fc6d9e4b
A
25.Sh DESCRIPTION\r
26The\r
27.Nm\r
28program uses the\r
29.Xr setiopolicy_np 3\r
30and\r
31.Xr setpriority 2\r
32APIs to execute a program with altered I/O or scheduling policies. All\r
33children of the specified program also inherit these policies.\r
34.Pp\r
35.Nm\r
36accepts the following flags and arguments:\r
37.Bl -tag -width "d policy " -offset indent\r
38.It Fl d Ar policy\r
39Run the program after calling\r
40.Xr setiopolicy_np 3\r
41with an iotype of IOPOL_TYPE_DISK, a scope of IOPOL_SCOPE_PROCESS, and the\r
42specified policy. The argument can either be an integer, or a symbolic string\r
43like "default" or "throttle", which is interpreted case-insensitively.\r
44.It Fl g Ar policy\r
45Run the program after calling\r
46.Xr setiopolicy_np 3\r
47with an iotype of IOPOL_TYPE_DISK, a scope of IOPOL_SCOPE_DARWIN_BG, and the\r
cf37c299 48specified policy. The argument is interpreted in the same manner as\r
fc6d9e4b 49.Fl d .\r
1a7e3f61
A
50.It Fl c Ar clamp\r
51Run the program using the specified QoS clamp. The argument can be either\r
52"utility", "background", or "maintenance", which is interpreted case-insensitively.\r
53.It Fl p Ar pid\r
54Change settings for the process specified by\r
55.Ar pid .\r
fc6d9e4b
A
56.It Fl b\r
57Run the program after calling\r
58.Xr setpriority 2\r
59with a priority of PRIO_DARWIN_BG.\r
1a7e3f61
A
60.It Fl B\r
61Move target process out of PRIO_DARWIN_BG.\r
62.It Fl t\r
63Set throughput tier of the process to \r
64.Ar thruput_tier .\r
65.It Fl l \r
66Set latency tier of the process to \r
67.Ar latency_tier .\r
fc6d9e4b
A
68.El\r
69.Pp\r
70.Sh SEE ALSO \r
71.Xr setpriority 2 ,\r
72.Xr setiopolicy_np 3\r