xref: /freebsd/share/man/man5/sysctl.conf.5 (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1.\" Copyright (c) 1999 Chris Costello <chris@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd June 30, 2022
28.Dt SYSCTL.CONF 5
29.Os
30.Sh NAME
31.Nm sysctl.conf
32.Nd kernel state defaults
33.Sh DESCRIPTION
34The
35.Pa /etc/sysctl.conf
36file is read in when the system goes into multi-user mode to set default
37settings for the kernel.
38The
39.Pa /etc/sysctl.conf
40file is in the format of the
41.Xr sysctl 8
42command, i.e.,
43.Bd -literal -offset indent
44sysctl_mib=value
45.Ed
46.Pp
47Comments are denoted by a
48.Dq #
49at the beginning of a line.
50Comments can also exist at the end of a line,
51as seen in the
52.Sx EXAMPLES
53section, below.
54.Pp
55For kernel modules loaded via
56.Xr rc.subr 8
57system,
58additional module-specific settings can be applied
59by adding a file in the same format named
60.Pf /etc/sysctl.kld.d/<module name>.conf .
61.Sh FILES
62.Bl -tag -width /etc/rc.d/sysctl_lastload -compact
63.It Pa /etc/rc.d/sysctl
64.Xr rc 8
65script which processes
66.Nm
67early on in the process of transitioning to multi-user mode.
68.It Pa /etc/rc.d/sysctl_lastload
69.Xr rc 8
70script which processes
71.Nm
72shortly before the system reaches the multi-user mode.
73.It Pa /etc/sysctl.conf
74Initial settings for
75.Xr sysctl 8 .
76.It Pa /etc/sysctl.conf.local
77Machine-specific settings for sites with a common
78.Pa /etc/sysctl.conf .
79.It Pa /etc/sysctl.kld.d
80Module specific settings for kernel modules loaded via
81.Xr rc.subr 8 .
82.El
83.Sh EXAMPLES
84To turn off logging of programs that exit due to fatal signals you may use
85a configuration like
86.Bd -literal -offset indent
87# Configure logging.
88kern.logsigexit=0	# Do not log fatal signal exits (e.g., sig 11)
89.Ed
90.Sh SEE ALSO
91.Xr rc.conf 5 ,
92.Xr rc 8 ,
93.Xr sysctl 8
94.Sh HISTORY
95The
96.Nm
97file appeared in
98.Fx 4.0 .
99.Sh BUGS
100If loadable kernel modules are used to introduce additional kernel
101functionality and sysctls to manage that functionality,
102.Nm
103may be processed too early in the boot process to set those sysctls.
104Please consult
105.Xr rcorder 8
106to learn more about the ordering of
107.Xr rc 8
108scripts.
109