xref: /freebsd/share/man/man5/rctl.conf.5 (revision 3f0164abf32b9b761e0a2cb4bdca3a8b84f156d4)
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.\" $FreeBSD$
27.\"
28.Dd April 14, 2011
29.Dt RCTL.CONF 5
30.Os
31.Sh NAME
32.Nm rctl.conf
33.Nd resource limits database defaults
34.Sh DESCRIPTION
35The
36.Pa /etc/rctl.conf
37file is read in when the system goes into multi-user mode to set default
38contents of the RCTL database.
39The
40.Pa /etc/rctl.conf
41is in the format of the
42.Xr rctl 8
43command, i.e.\&
44.Bd -literal -offset indent
45subject:subject-id:resource:action=amount/per
46.Ed
47.Pp
48Comments are denoted by a
49.Dq #
50at the beginning of a line.
51Comments can also exist at the end of a line,
52as seen in the
53.Sx EXAMPLES
54section, below.
55.Sh FILES
56.Bl -tag -width /etc/rctl.conf -compact
57.It Pa /etc/rctl.conf
58Initial settings for
59.Xr rctl 8 .
60.El
61.Sh EXAMPLES
62To limit the number of processes for users in login class "testing",
63use a rule like
64.Bd -literal -offset indent
65# Resource limits for the "testing" class.
66loginclass:testing:nproc:deny=100/user # At most 100 processes per user
67.Ed
68.Sh SEE ALSO
69.Xr rctl 8
70.Sh HISTORY
71The
72.Nm
73file appeared in
74.Fx 9.0 .
75