share/man/man4/rctl.4

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