aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Ebdrup Jensen <debdrup@FreeBSD.org>2021-05-18 12:46:41 +0000
committerDaniel Ebdrup Jensen <debdrup@FreeBSD.org>2021-11-30 01:06:40 +0000
commitbd6dce978c1a4d4472c98ff5685de3c2f2bd0203 (patch)
treef874ad61128e1e04cf2f96918143e57a692736fc
parent0e765d9b08dcc2386b799815f2c835c97a93614c (diff)
downloadsrc-bd6dce978c1a4d4472c98ff5685de3c2f2bd0203.tar.gz
src-bd6dce978c1a4d4472c98ff5685de3c2f2bd0203.zip
rc.conf(5): Add _limits, _login_class, and _oomprotect
Add a few very useful variables that might easily be overlooked, since they're only documented in rc.subr(8) which might not be the first place that people look. At least _oomprotect has existed since 11.0-RELEASE, and doesn't appear to be very well-known. While the others aren't as new, in my estimation, a lot more people would use them if they knew about them. While here, also add a reference to rc.subr(8) and login.conf(5), and sort the variables alphabetically. Reported by: Daniel Dettlaff <dmilith at gmail.com> Reviewed by: ceri, gbe, 0mp, ygy, a.wolk, pauamma
-rw-r--r--share/man/man5/rc.conf.551
1 files changed, 42 insertions, 9 deletions
diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5
index a22f267c13b9..7a704242373b 100644
--- a/share/man/man5/rc.conf.5
+++ b/share/man/man5/rc.conf.5
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 21, 2021
+.Dd November 30, 2021
.Dt RC.CONF 5
.Os
.Sh NAME
@@ -192,24 +192,53 @@ services are enabled that utilize the force_depend check.
.Pq Vt str
.Xr chroot 8
to this directory before running the service.
-.It Ao Ar name Ac Ns Va _user
-.Pq Vt str
-Run the service under this user account.
-.It Ao Ar name Ac Ns Va _group
-.Pq Vt str
-Run the chrooted service under this system group.
-Unlike the _user
-setting, this setting has no effect if the service is not chrooted.
.It Ao Ar name Ac Ns Va _fib
.Pq Vt int
The
.Xr setfib 1
value to run the service under.
+.It Ao Ar name Ac Ns Va _group
+.Pq Vt str
+Run the chrooted service under this system group.
+Unlike the
+.Ao Ar name Ac Ns Va _user
+setting, this setting has no effect if the service is not chrooted.
+.It Ao Ar name Ac Ns Va _limits
+.Pq Vt str
+Resource limits to apply to the service using
+.Xr limits 1 .
+By default, resource limits are based on the login class defined in
+.Ao Ar name Ac Ns Va _login_class .
+.It Ao Ar name Ac Ns Va _login_class
+.Pq Vt str
+Login class to be used with
+.Ao Ar name Ac Ns Va _limits .
+Defaults to
+.Dq Li daemon .
.It Ao Ar name Ac Ns Va _nice
.Pq Vt int
The
.Xr nice 1
value to run the service under.
+.It Ao Ar name Ac Ns Va _oomprotect
+Use
+.Xr protect 1
+to prevent the service from being killed when swap space
+is exhausted.
+Use
+.Dq Li YES
+to protect only the service itself, and
+.Dq Li ALL
+to protect the service and all child processes.
+.Pp
+Please note rc scripts that redefine
+.Bd
+${name}_cmd
+.Ed
+such as PostgreSQL will not a inherit the OOM killer protection.
+.It Ao Ar name Ac Ns Va _user
+.Pq Vt str
+Run the service under this user account.
.It Va apm_enable
.Pq Vt bool
If set to
@@ -4625,6 +4654,8 @@ it will be made permanently active.
.Xr gdb 1 ,
.Xr info 1 ,
.Xr kbdcontrol 1 ,
+.Xr limits 1 ,
+.Xr protect 1 ,
.Xr sh 1 ,
.Xr vi 1 ,
.Xr vidcontrol 1 ,
@@ -4646,6 +4677,7 @@ it will be made permanently active.
.Xr ipnat 5 ,
.Xr jail.conf 5 ,
.Xr loader.conf 5 ,
+.Xr login.conf 5 ,
.Xr motd 5 ,
.Xr newsyslog.conf 5 ,
.Xr pf.conf 5 ,
@@ -4694,6 +4726,7 @@ it will be made permanently active.
.Xr quotaon 8 ,
.Xr rc 8 ,
.Xr rc.sendmail 8 ,
+.Xr rc.subr 8 ,
.Xr rcorder 8 ,
.Xr rfcomm_pppd 8 ,
.Xr route 8 ,