taskpolicy.tproj/taskpolicy.8

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