xref: /freebsd/share/man/man5/rctl.conf.5 (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1.\" Copyright (c) 2011 Edward Tomasz Napierala
2.\" Copyright (c) 1999 Chris Costello <chris@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd October 6, 2023
27.Dt RCTL.CONF 5
28.Os
29.Sh NAME
30.Nm rctl.conf
31.Nd resource limits database defaults
32.Sh DESCRIPTION
33The
34.Pa /etc/rctl.conf
35file is read in when the system goes into multi-user mode to set default
36contents of the RCTL database.
37The
38.Pa /etc/rctl.conf
39is in the format of the
40.Xr rctl 8
41command, i.e.\&
42.Bd -literal -offset indent
43subject:subject-id:resource:action=amount/per
44.Ed
45.Pp
46Comments are denoted by a
47.Dq #
48at the beginning of a line.
49Comments can also exist at the end of a line,
50as seen in the
51.Sx EXAMPLES
52section, below.
53.Sh FILES
54.Bl -tag -width /etc/rctl.conf -compact
55.It Pa /etc/rctl.conf
56Initial settings for
57.Xr rctl 8 .
58.El
59.Sh EXAMPLES
60To limit the number of processes for users in login class "testing",
61use a rule like
62.Bd -literal -offset indent
63# Resource limits for the "testing" class.
64loginclass:testing:maxproc:deny=100/user # At most 100 processes per user
65.Ed
66.Sh SEE ALSO
67.Xr rctl 8
68.Sh HISTORY
69The
70.Nm
71file appeared in
72.Fx 9.0 .
73