Differential D28642 Diff 83916 share/man/man5/style.mdoc.5

Changeset View

Standalone View

share/man/man5/style.mdoc.5

	Show First 20 Lines • Show All 191 Lines • ▼ Show 20 Lines
	.Sy \&Sq			.Sy \&Sq
	.Pq So Sc			.Pq So Sc
	macro for quoting inside quotes.			macro for quoting inside quotes.
	The use of the			The use of the
	.Sy \&Qq			.Sy \&Qq
	.Pq Qo Qc			.Pq Qo Qc
	macro is usually not necessary.			macro is usually not necessary.
	.El			.El
	.Ss Variables			.Ss Loader tunables and sysctl variables
	.Bl -dash -width ""			Loader tunables and sysctl variables should be documented in
	.It			.Qq LOADER TUNABLES
	Use			and
				.Qq SYSCTL VARIABLES
				sections, respectively.
				Both sections should provide them inside an
				.Sy \&Bl
				list block using the
	.Sy \&Va			.Sy \&Va
	instead of			macro.
	.Sy \&Dv			Note that
	for			.Xr makewhatis 8
	.Xr sysctl 8			only special cases them if found after the
	variables like			.Sy \&It
	.Va kdb.enter.panic .			macro, and for
				.Xr man 1
				to be able to do tunable/sysctl search, the following format should be used:
				.Bd -literal -offset indent
				\&.Sh LOADER TUNABLES
				Tunables can be set at the
				\&.Xr loader 8
				prompt before booting the kernel or stored in
				\&.Xr loader.conf 5 .
				\&.Bl -tag -width indent
				\&.It Va some.loader.tunable
				Tunable description.
				\&.El
				\&.Sh SYSCTL VARIABLES
				The following variables are available as both
				\&.Xr sysctl 8
				variables and
				\&.Xr loader 8
				tunables:
				\&.Bl -tag -width indent
				\&.It Va some.sysctl.variable
				Variable description.
				\&.El
				.Ed
				.Ss Other variables
				.Bl -dash -width ""
	.It			.It
	Use the angle brackets			Use the angle brackets
	.Sy \&Aq			.Sy \&Aq
	.Pq Dq "<>"			.Pq Dq "<>"
	macro			macro
	for arguments			for arguments
	.Pq Sy \&Ar			.Pq Sy \&Ar
	when they are mixed with similarly stylized macros like			when they are mixed with similarly stylized macros like
	Show All 33 Lines