xref: /freebsd/share/man/man4/rctl.4 (revision 43a5ec4eb41567cc92586503212743d89686d78f)
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.\"
24.\" $FreeBSD$
25.Dd May 28, 2017
26.Dt RCTL 4
27.Os
28.Sh NAME
29.Nm rctl
30.Nd resource limits
31.Sh SYNOPSIS
32To compile this driver into the kernel,
33place the following line in the
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "options RACCT"
37.Cd "options RCTL"
38.Ed
39.Sh DESCRIPTION
40The
41.Nm
42subsystem provides a flexible resource limits mechanism,
43controlled by a set of rules that can be added or removed at runtime
44using the
45.Xr rctl 8
46management utility.
47.Sh LOADER TUNABLES
48Tunables can be set at the
49.Xr loader 8
50prompt, or
51.Xr loader.conf 5 .
52.Bl -tag -width indent
53.It Va kern.racct.enable: No 1
54Enable
55.Nm .
56This defaults to 1, unless
57.Cd "options RACCT_DEFAULT_TO_DISABLED"
58is set in the kernel configuration file.
59.El
60.Sh SEE ALSO
61.Xr rctl.conf 5 ,
62.Xr rctl 8
63.Sh HISTORY
64The
65.Nm
66subsystem first appeared in
67.Fx 9.0 .
68.Sh AUTHORS
69The
70.Nm
71subsystem was developed by
72.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
73under sponsorship from the FreeBSD Foundation.
74