5b3f8775de16a52e268d5acdee7c81e5f98cd2a6
[dragonfly.git] / usr.sbin / dschedctl / dschedctl.8
1 .\"
2 .\" Copyright (c) 2010
3 .\"     The DragonFly Project.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\"    contributors may be used to endorse or promote products derived
17 .\"    from this software without specific, prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .Dd April 20, 2010
33 .Os
34 .Dt DSCHEDCTL 8
35 .Sh NAME
36 .Nm dschedctl
37 .Nd manipulate disk policies
38 .Sh SYNOPSIS
39 .Nm
40 .Fl l
41 .Op Ar disk
42 .Nm
43 .Fl p
44 .Nm
45 .Op Fl v
46 .Fl s Ar policy
47 .Op Ar disk
48 .Nm
49 .Fl h
50 .Sh DESCRIPTION
51 The
52 .Nm
53 provides an interface to manipulate the in-kernel
54 disk scheduler framework.
55 .Pp
56 The options are as follows:
57 .Bl -tag -width indent
58 .It Fl h
59 Shows a usage message with a short description of
60 .Nm Ap s
61 options.
62 .It Fl l Op Ar disk
63 If
64 .Ar disk
65 is specified, the policy currently assigned to
66 .Ar disk
67 is shown.
68 Otherwise all disks and their respective policies are shown.
69 .It Fl p
70 List all available dsched policies.
71 Any of these policies can be set on any disk.
72 .It Fl s Ar policy Op Ar disk
73 Sets the dsched policy of
74 .Ar disk
75 if specified, or all disks if not, to
76 .Ar policy .
77 If the verbose mode is enabled, a message will be printed for each successful
78 policy change.
79 .It Fl v
80 Enables verbose mode.
81 .El
82 .Sh HISTORY
83 The
84 .Nm
85 utility appeared in
86 .Dx 2.7 .
87 .Sh AUTHORS
88 .An Alex Hornung