diff options
Diffstat (limited to 'share/man/man5')
| -rw-r--r-- | share/man/man5/Makefile | 70 | ||||
| -rw-r--r-- | share/man/man5/pf.conf.5 | 2 | ||||
| -rw-r--r-- | share/man/man5/rc.conf.5 | 4 | ||||
| -rw-r--r-- | share/man/man5/src.conf.5 | 6 | ||||
| -rw-r--r-- | share/man/man5/style.Makefile.5 | 24 | ||||
| -rw-r--r-- | share/man/man5/style.mdoc.5 | 30 | 
6 files changed, 63 insertions, 73 deletions
| diff --git a/share/man/man5/Makefile b/share/man/man5/Makefile index c13a8b7afde2..abf4b59d184b 100644 --- a/share/man/man5/Makefile +++ b/share/man/man5/Makefile @@ -43,20 +43,6 @@ MAN=	a.out.5 \  	style.mdoc.5 \  	sysctl.conf.5 \ -.if ${MK_BLUETOOTH} != "no" -MAN+=	bluetooth.device.conf.5 \ -	bluetooth.hosts.5 \ -	bluetooth.protocols.5 -.endif - -.if ${MK_FREEBSD_UPDATE} != "no" -MAN+=	freebsd-update.conf.5 -.endif - -.if ${MK_HESIOD} != "no" -MAN+=	hesiod.conf.5 -.endif -  MLINKS=	dir.5 dirent.5  MLINKS+=fs.5 inode.5  MLINKS+=hosts.equiv.5 rhosts.5 @@ -69,37 +55,46 @@ MANGROUPS+=	ACCT  ACCT=		acct.5  ACCTPACKAGE=	acct -MANGROUPS+=	BOOTLOADER +MANGROUPS.${MK_BLUETOOTH}+=		BLUETOOTH +BLUETOOTHPACKAGE=			bluetooth +BLUETOOTH=	bluetooth.device.conf.5 \ +		bluetooth.hosts.5 \ +		bluetooth.protocols.5 + +MANGROUPS+=				BOOTLOADER +BOOTLOADERPACKAGE=			bootloader  BOOTLOADER=	device.hints.5 -BOOTLOADERPACKAGE=bootloader -.if ${MK_TOOLCHAIN} != "no" -MANGROUPS+=	TOOLCHAIN +MANGROUPS.${MK_FREEBSD_UPDATE}+=	FREEBSD_UPDATE +FREEBSD_UPDATE=	freebsd-update.conf.5 + +MANGROUPS.${MK_HESIOD}+=		HESIOD +HESIOD=		hesiod.conf.5 + +MANGROUPS.${MK_TOOLCHAIN}+=		TOOLCHAIN +TOOLCHAINPACKAGE=			toolchain  TOOLCHAIN=	ar.5 -TOOLCHAINPACKAGE=toolchain -.endif -MANGROUPS+=	LP +MANGROUPS+=				LP +LPPACKAGE=				lp  LP=		hosts.lpd.5 -LPPACKAGE=	lp -MANGROUPS+=	PERIODIC +MANGROUPS+=				PERIODIC +PERIODICPACKAGE=			periodic  PERIODIC=	periodic.conf.5 -PERIODICPACKAGE=periodic -.if ${MK_PF} != "no" -MANGROUPS+=	PF +MANGROUPS.${MK_PF}+=			PF +PFPACKAGE=				pf  PF=		pf.conf.5 \  		pf.os.5 -PFPACKAGE=	pf -.endif -MANGROUPS+=	RC +MANGROUPS+=				RC +RCPACKAGE=				rc  RC=		rc.conf.5  RCLINKS=	rc.conf.5 rc.conf.local.5 -RCPACKAGE=	rc -MANGROUPS+=	RUNTIME +MANGROUPS+=				RUNTIME +RUNTIMEPACKAGE=				runtime  RUNTIME=	devfs.conf.5 \  		devfs.rules.5 \  		fstab.5 \ @@ -107,19 +102,18 @@ RUNTIME=	devfs.conf.5 \  RUNTIMELINKS=	passwd.5 master.passwd.5  RUNTIMELINKS+=	passwd.5 pwd.db.5  RUNTIMELINKS+=	passwd.5 spwd.db.5 -RUNTIMEPACKAGE=	runtime -MANGROUPS+=	SMB +MANGROUPS+=				SMB +SMBPACKAGE=				smbutils  SMB=		nsmb.conf.5 -SMBPACKAGE=	smbutils -MANGROUPS+=	SSH +MANGROUPS.${MK_OPENSSH}+=		SSH +SSHPACKAGE=				ssh  SSH=		moduli.5 -SSHPACKAGE=	ssh -MANGROUPS+=	UFS +MANGROUPS+=				UFS +UFSPACKAGE=				ufs  UFS=		fs.5 -UFSPACKAGE=	ufs  # This makes more sense for amd64 and i386 but  # we decide to install all manpages in all architectures diff --git a/share/man/man5/pf.conf.5 b/share/man/man5/pf.conf.5 index 41410d6bc0fa..be46b1a47291 100644 --- a/share/man/man5/pf.conf.5 +++ b/share/man/man5/pf.conf.5 @@ -1490,7 +1490,7 @@ options and both implicitly and explicitly in the case of  ones.  A  .Ar rdr-to -opion may cause the source port to be modified if doing so avoids a conflict +option may cause the source port to be modified if doing so avoids a conflict  with an existing connection.  A random source port in the range 50001-65535 is chosen in this case.  Port numbers are never translated with a diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index edbfa937f8df..6274c1ee5b94 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -4950,7 +4950,7 @@ can be used in jails) depending on the content of the  .Ao Ar name Ac Ns Va _svcj_options  variable.  Typically this variable is set inside rc scripts, but it can be -overriden in the rc config. +overridden in the rc config.  Valid options for  .Ao Ar name Ac Ns Va _svcj_options  are: @@ -5041,7 +5041,7 @@ service at all, or may set it to  if it is not set in the  rc config, to exclude it from  .Va svcj_all_enable -but allow to explicitely enable it. +but allow to explicitly enable it.  The sshd service for example would not see other jails, if  it would run as a service jail.  This may or may not be what is needed, and as such it is diff --git a/share/man/man5/src.conf.5 b/share/man/man5/src.conf.5 index 1bb609336532..bab2c3d84abf 100644 --- a/share/man/man5/src.conf.5 +++ b/share/man/man5/src.conf.5 @@ -1,5 +1,5 @@  .\" DO NOT EDIT-- this file is @generated by tools/build/options/makeman. -.Dd October 1, 2025 +.Dd October 22, 2025  .Dt SRC.CONF 5  .Os  .Sh NAME @@ -956,12 +956,12 @@ Do not build LLVM's lld linker.  Do not build the LLDB debugger.  .Pp  This is a default setting on -arm/armv7 and riscv/riscv64. +riscv/riscv64.  .It Va WITH_LLDB  Build the LLDB debugger.  .Pp  This is a default setting on -amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64 and powerpc/powerpc64le. +amd64/amd64, arm/armv7, arm64/aarch64, i386/i386, powerpc/powerpc64 and powerpc/powerpc64le.  .It Va WITHOUT_LLD_BOOTSTRAP  Do not build the LLD linker during the bootstrap phase of  the build. diff --git a/share/man/man5/style.Makefile.5 b/share/man/man5/style.Makefile.5 index fe8754924575..9a2f1b069d99 100644 --- a/share/man/man5/style.Makefile.5 +++ b/share/man/man5/style.Makefile.5 @@ -1,7 +1,7 @@  .\"  .\" SPDX-License-Identifier: BSD-3-Clause  .\" -.\" Copyright (c) 2002-2003, 2023 David O'Brien <obrien@FreeBSD.org> +.\" Copyright (c) 2002-2003, 2023, 2025 David O'Brien <deo@NUXI.org>  .\" All rights reserved.  .\"  .\" Redistribution and use in source and binary forms, with or without @@ -28,7 +28,7 @@  .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF  .\" SUCH DAMAGE.  .\" -.Dd July 17, 2023 +.Dd October 29, 2025  .Dt STYLE.MAKEFILE 5  .Os  .Sh NAME @@ -179,6 +179,21 @@ settings between the  and  .Fl I Ns 's.  .It +Lists that span more than one line should be formatted as follows: +.Bd -literal -offset indent +SRCS+=<SP>\\ +<TAB>main.c<SP>\\ +<TAB>trace.c<SP>\\ +<TAB>zoo.c \\ +\& +.Ed +Specifically, the last item in the list should have a trailing '\\'. +This is to avoid causing a "false diff" or "false blame" when +a new item is appended at the end. +In general the list should be English language alphabetized. +A list of libraries or header inclusion paths are notable exceptions +if needed for proper building. +.It  Do not use GCCisms (such as  .Fl g  and @@ -233,9 +248,6 @@ For variables that are only checked with  .Fn defined ,  do not provide any fake value.  .El -.Pp -The desire to express a logical grouping often means not obeying some of the -above.  .Sh EXAMPLES  The simplest program  .Pa Makefile @@ -270,5 +282,7 @@ manual page and first appeared in  .An David O'Brien Aq deo@NUXI.org  .Sh BUGS  There are few hard and fast style rules here. +The desire to express a logical grouping sometimes means not obeying some of the +above.  The style of many things is too dependent on the context of the whole makefile,  or the lines surrounding it. diff --git a/share/man/man5/style.mdoc.5 b/share/man/man5/style.mdoc.5 index 1c3ec2012118..2f8ea90ae21f 100644 --- a/share/man/man5/style.mdoc.5 +++ b/share/man/man5/style.mdoc.5 @@ -1,30 +1,9 @@  .\" -.\" SPDX-License-Identifier: BSD-2-Clause -.\" -.\" Copyright (c) 2018-2022 Mateusz Piotrowski <0mp@FreeBSD.org> +.\" Copyright (c) 2018-2025 Mateusz Piotrowski <0mp@FreeBSD.org>  .\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\"    notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\"    notice, this list of conditions and the following disclaimer in the -.\"    documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" 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 -.\" SUCH DAMAGE. +.\" SPDX-License-Identifier: BSD-2-Clause  .\" -.Dd December 21, 2024 +.Dd October 24, 2025  .Dt STYLE.MDOC 5  .Os  .Sh NAME @@ -71,6 +50,9 @@ Historically,  was the preferred way before the deprecation of  .Sy \&Li .  .El +.Ss Copyright Header +Refer to +.Xr style 9 .  .Ss HARDWARE Section  Driver manuals in section four should have a  .Sx HARDWARE | 
