fix mandoc(1) warnings in sbin/
[dragonfly.git] / sbin / usched / usched.8
CommitLineData
93675141
SW
1.\"
2.\" Copyright (c) 2012
3.\" The DragonFly Project. All rights reserved.
f6d52dfb
TN
4.\" This code is derived from software contributed to The DragonFly Project
5.\" by Matthew Dillon <dillon@backplane.com> and Thomas Nikolajsen
6.\" <thomas.nikolajsen@mail.dk>
93675141
SW
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\"
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in
16.\" the documentation and/or other materials provided with the
17.\" distribution.
18.\" 3. Neither the name of The DragonFly Project nor the names of its
19.\" contributors may be used to endorse or promote products derived
20.\" from this software without specific, prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
f6d52dfb 35.Dd October 21, 2012
93675141
SW
36.Dt USCHED 8
37.Os
38.Sh NAME
39.Nm usched
f6d52dfb 40.Nd run a program with a specified userland scheduler and cpumask
93675141
SW
41.Sh SYNOPSIS
42.Nm
f6d52dfb
TN
43.Op Fl d
44.Brq Ar scheduler Ns Oo Cm \&: Ns Ar cpumask Oc | Cm \&: Ns Ar cpumask
93675141 45.Ar program
f6d52dfb 46.Op Ar argument ...
93675141 47.Sh DESCRIPTION
f6d52dfb 48Run
93675141
SW
49.Ar program
50using the specified userland
f6d52dfb
TN
51.Ar scheduler
52on
53.Tn CPUs
54given in
55.Ar cpumask .
56The userland
57.Ar scheduler
58can have value
59.Sq bsd4
60or
61.Sq dfly .
62If
63.Ar scheduler
64is not specified,
65userland scheduler is inherited from parent process
66.Pq Nm .
67.Pp
68The following options are available:
69.Bl -tag -width indent
70.It Fl d
71Add debug output.
72.El
73.Pp
74.Nm
75is only usable for super user as other users cannot change
76userland scheduler or cpumask.
77.Pp
78System default userland scheduler can be changed in
79.Xr loader.conf 5 ,
80see
81.Xr loader 8 .
1f214455
FF
82.Sh EXIT STATUS
83.Ex -std usched
f6d52dfb
TN
84.Sh EXAMPLES
85Run
86.Xr sh 1
87using only first 3
88.Tn CPUs .
89.Pp
90.Dl usched :7 sh
91.Pp
92Run
93.Xr sh 1
94using userland scheduler
95.Sq bsd4
96using only first 4
97.Tn CPUs .
98.Pp
99.Dl usched bsd4:0xf sh
93675141 100.Sh SEE ALSO
f6d52dfb
TN
101.Xr usched_set 2 ,
102.Xr loader.conf 5 ,
103.Xr loader 8
93675141
SW
104.Sh HISTORY
105The
106.Nm
107utility first appeared in
108.Dx 3.1 .
f6d52dfb 109.Sh AUTHORS
1cb631f7
FF
110.An Matthew Dillon Aq Mt dillon@backplane.com
111.An Thomas Nikolajsen Aq Mt thomas.nikolajsen@mail.dk
f6d52dfb
TN
112.Sh BUGS
113Using system default userland scheduler by specifying
114.Ar scheduler
115as
116.Sq default
117is not implemented.