d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rc.conf.5: Improve documentation of <name>_oomprotect

Browse Source 
Apart from improving readability, this commit mentions that
<name>_oomprotect is ignored in a jail environment. Also, replace
${name}_cmd with the correct ${argument}_cmd and point the reader to
rc.subr(8).

MFC after:	1 week
This commit is contained in:
Mateusz Piotrowski 2022-07-07 20:01:57 +02:00
parent cb56f86025
commit df1817a81e
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
share/man/man5/rc.conf.5
View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd June 28, 2022
.Dd July 7, 2022
.Dt RC.CONF 5
.Os
.Sh NAME
@ -221,6 +221,7 @@ The
.Xr nice 1
value to run the service under.
.It Ao Ar name Ac Ns Va _oomprotect
.Pq Vt str
Use
.Xr protect 1
to prevent the service from being killed when swap space
@ -229,13 +230,15 @@ Use
.Dq Li YES
to protect only the service itself, and
.Dq Li ALL
to protect the service and all child processes.
to protect the service and all its child processes.
.Pp
Please note rc scripts that redefine
.Bd -literal
${name}_cmd
.Ed
Please note that rc scripts which redefine
.Dl ${argument}_cmd
.Pq see Xr rc.subr 8
such as PostgreSQL will not inherit the OOM killer protection.
.Pp
This variable has no effect on services running within a
.Xr jail 8 .
.It Ao Ar name Ac Ns Va _user
.Pq Vt str
Run the service under this user account.