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