Differential D15953 Diff 44917 head/usr.sbin/config/config.5

Changeset View

Standalone View

head/usr.sbin/config/config.5

	Show All 17 Lines
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd June 26, 2018			.Dd July 5, 2018
	.Dt CONFIG 5			.Dt CONFIG 5
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm config			.Nm config
	.Nd kernel configuration file format			.Nd kernel configuration file format
	.Sh DESCRIPTION			.Sh DESCRIPTION
	A kernel configuration file specifies the configuration of a			A kernel configuration file specifies the configuration of a
	.Fx			.Fx
	▲ Show 20 Lines • Show All 74 Lines • ▼ Show 20 Lines
	Devices that are specific to architecture			Devices that are specific to architecture
	.Ar arch			.Ar arch
	are defined in the file			are defined in the file
	.Pa sys/conf/files. Ns Aq Ar arch .			.Pa sys/conf/files. Ns Aq Ar arch .
	.\" -------- ENV --------			.\" -------- ENV --------
	.Pp			.Pp
	.It Ic env Ar filename			.It Ic env Ar filename
	Specifies a filename containing a kernel environment definition.			Specifies a filename containing a kernel environment definition.
	The kernel normally uses an environment prepared for it at boot time			.Pp
	by			The kernel will augment this compiled-in environment with the environment
				prepared for it at boot time by
	.Xr loader 8 .			.Xr loader 8 .
	This directive makes the kernel ignore the boot environment and use			Environment variables specified in the
	the compiled-in environment instead, unless the boot environment contains			.Xr loader 8
	.Va static_env.disabled=1 .			environment will take precedence over environment variables specified in
				.Ar filename ,
				and environment variables specified in the dynamic environment take precedence
				over both of these.
	.Pp			.Pp
				.Va static_env.disabled=1
				may be specified in the
				.Xr loader 8
				environment to disable use of this compiled-in environment.
				This option has no effect if specified in any environment after the
				.Xr loader 8
				environment is processed.
				.Pp
	This directive is useful for setting kernel tunables in			This directive is useful for setting kernel tunables in
	embedded environments that do not start from			embedded environments that do not start from
	.Xr loader 8 .			.Xr loader 8 .
	.Pp			.Pp
	All			All
	.Ic env			.Ic env
	and			and
	.Ic envvar			.Ic envvar
	Show All 35 Lines
	from.			from.
	From			From
	.Fx 5.0			.Fx 5.0
	onwards, the kernel reads the system's device configuration at boot			onwards, the kernel reads the system's device configuration at boot
	time (see			time (see
	.Xr device.hints 5 ) .			.Xr device.hints 5 ) .
	This directive configures the kernel to use the static device configuration			This directive configures the kernel to use the static device configuration
	listed in			listed in
	.Ar filename ,			.Ar filename .
	unless the boot environment contains			.Pp
	.Va static_hints.disabled=1 .			Hints provided in this static device configuration will be overwritten in the
				order in which they're encountered.
				Hints in the compiled-in environment takes precedence over compiled-in hints,
				and hints in the environment prepared for the kernel by
				.Xr loader 8
				takes precedence over hints in the compiled-in environment.
				.Pp
				Once the dynamic environment becomes available, all compiled-in hints will be
				added to the dynamic environment if they do not already have an override in
				the dynamic environment.
				The dynamic environment will then be used for all searches of hints.
				.Pp
				.Va static_hints.disabled=1
				may be specified in either a compiled-in environment or the
				.Xr loader 8
				environment to disable use of these hints files.
				This option has no effect if specified in any environment after the
				.Xr loader 8
				environment is processed.
				.Pp
	The file			The file
	.Ar filename			.Ar filename
	must conform to the syntax specified by			must conform to the syntax specified by
	.Xr device.hints 5 .			.Xr device.hints 5 .
	Multiple hints lines are allowed.			Multiple hints lines are allowed.
	The resulting hints will be the files concatenated in reverse order of			The resulting hints will be the files concatenated in reverse order of
	appearance so that hints in later files properly override hints in earlier			appearance so that hints in later files properly override hints in earlier
	files.			files.
	▲ Show 20 Lines • Show All 248 Lines • Show Last 20 Lines