Skip to content

Commit

Permalink
rc.conf.5: Improve documentation of <name>_oomprotect
Browse files Browse the repository at this point in the history
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

(cherry picked from commit df1817a)
  • Loading branch information
0mp committed Jul 22, 2022
1 parent 5758cfb commit 7beb8ff
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions share/man/man5/rc.conf.5
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd June 28, 2022
.Dd July 7, 2022
.Dt RC.CONF 5
.Os
.Sh NAME
Expand Down Expand Up @@ -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
Expand All @@ -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
${name}_cmd
.Ed
such as PostgreSQL will not a inherit the OOM killer protection.
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.
Expand Down

0 comments on commit 7beb8ff

Please sign in to comment.