xref: /freebsd-src/share/man/man4/rctl.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1*f2e34224SEdward Tomasz Napierala.\" Copyright (c) 2017 Edward Tomasz Napierala
2*f2e34224SEdward Tomasz Napierala.\"
3*f2e34224SEdward Tomasz Napierala.\" Redistribution and use in source and binary forms, with or without
4*f2e34224SEdward Tomasz Napierala.\" modification, are permitted provided that the following conditions
5*f2e34224SEdward Tomasz Napierala.\" are met:
6*f2e34224SEdward Tomasz Napierala.\" 1. Redistributions of source code must retain the above copyright
7*f2e34224SEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer.
8*f2e34224SEdward Tomasz Napierala.\" 2. Redistributions in binary form must reproduce the above copyright
9*f2e34224SEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer in the
10*f2e34224SEdward Tomasz Napierala.\"    documentation and/or other materials provided with the distribution.
11*f2e34224SEdward Tomasz Napierala.\"
12*f2e34224SEdward Tomasz Napierala.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13*f2e34224SEdward Tomasz Napierala.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14*f2e34224SEdward Tomasz Napierala.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15*f2e34224SEdward Tomasz Napierala.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16*f2e34224SEdward Tomasz Napierala.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17*f2e34224SEdward Tomasz Napierala.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18*f2e34224SEdward Tomasz Napierala.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19*f2e34224SEdward Tomasz Napierala.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20*f2e34224SEdward Tomasz Napierala.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21*f2e34224SEdward Tomasz Napierala.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22*f2e34224SEdward Tomasz Napierala.\" SUCH DAMAGE.
23*f2e34224SEdward Tomasz Napierala.Dd May 28, 2017
24*f2e34224SEdward Tomasz Napierala.Dt RCTL 4
25*f2e34224SEdward Tomasz Napierala.Os
26*f2e34224SEdward Tomasz Napierala.Sh NAME
27*f2e34224SEdward Tomasz Napierala.Nm rctl
28*f2e34224SEdward Tomasz Napierala.Nd resource limits
29*f2e34224SEdward Tomasz Napierala.Sh SYNOPSIS
30*f2e34224SEdward Tomasz NapieralaTo compile this driver into the kernel,
31*f2e34224SEdward Tomasz Napieralaplace the following line in the
32*f2e34224SEdward Tomasz Napieralakernel configuration file:
33*f2e34224SEdward Tomasz Napierala.Bd -ragged -offset indent
34*f2e34224SEdward Tomasz Napierala.Cd "options RACCT"
35*f2e34224SEdward Tomasz Napierala.Cd "options RCTL"
36*f2e34224SEdward Tomasz Napierala.Ed
37*f2e34224SEdward Tomasz Napierala.Sh DESCRIPTION
38*f2e34224SEdward Tomasz NapieralaThe
39*f2e34224SEdward Tomasz Napierala.Nm
40*f2e34224SEdward Tomasz Napieralasubsystem provides a flexible resource limits mechanism,
41*f2e34224SEdward Tomasz Napieralacontrolled by a set of rules that can be added or removed at runtime
42*f2e34224SEdward Tomasz Napieralausing the
43*f2e34224SEdward Tomasz Napierala.Xr rctl 8
44*f2e34224SEdward Tomasz Napieralamanagement utility.
45*f2e34224SEdward Tomasz Napierala.Sh LOADER TUNABLES
46*f2e34224SEdward Tomasz NapieralaTunables can be set at the
47*f2e34224SEdward Tomasz Napierala.Xr loader 8
48*f2e34224SEdward Tomasz Napieralaprompt, or
49*f2e34224SEdward Tomasz Napierala.Xr loader.conf 5 .
50*f2e34224SEdward Tomasz Napierala.Bl -tag -width indent
51*f2e34224SEdward Tomasz Napierala.It Va kern.racct.enable: No 1
52*f2e34224SEdward Tomasz NapieralaEnable
53*f2e34224SEdward Tomasz Napierala.Nm .
54*f2e34224SEdward Tomasz NapieralaThis defaults to 1, unless
55*f2e34224SEdward Tomasz Napierala.Cd "options RACCT_DEFAULT_TO_DISABLED"
56*f2e34224SEdward Tomasz Napieralais set in the kernel configuration file.
57*f2e34224SEdward Tomasz Napierala.El
58*f2e34224SEdward Tomasz Napierala.Sh SEE ALSO
59*f2e34224SEdward Tomasz Napierala.Xr rctl.conf 5 ,
60*f2e34224SEdward Tomasz Napierala.Xr rctl 8
61*f2e34224SEdward Tomasz Napierala.Sh HISTORY
62*f2e34224SEdward Tomasz NapieralaThe
63*f2e34224SEdward Tomasz Napierala.Nm
64*f2e34224SEdward Tomasz Napieralasubsystem first appeared in
65*f2e34224SEdward Tomasz Napierala.Fx 9.0 .
66*f2e34224SEdward Tomasz Napierala.Sh AUTHORS
67*f2e34224SEdward Tomasz NapieralaThe
68*f2e34224SEdward Tomasz Napierala.Nm
69*f2e34224SEdward Tomasz Napieralasubsystem was developed by
70*f2e34224SEdward Tomasz Napierala.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
71*f2e34224SEdward Tomasz Napieralaunder sponsorship from the FreeBSD Foundation.
72