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