diff options
Diffstat (limited to 'share/man/man8')
-rw-r--r-- | share/man/man8/Makefile | 1 | ||||
-rw-r--r-- | share/man/man8/debug.sh.8 | 13 | ||||
-rw-r--r-- | share/man/man8/diskless.8 | 7 | ||||
-rw-r--r-- | share/man/man8/nanobsd.8 | 20 | ||||
-rw-r--r-- | share/man/man8/rc.8 | 14 | ||||
-rw-r--r-- | share/man/man8/rc.subr.8 | 86 | ||||
-rw-r--r-- | share/man/man8/uefi.8 | 6 |
7 files changed, 75 insertions, 72 deletions
diff --git a/share/man/man8/Makefile b/share/man/man8/Makefile index 1e2c22e97d8e..bd6bdfe4ba05 100644 --- a/share/man/man8/Makefile +++ b/share/man/man8/Makefile @@ -1,4 +1,3 @@ - .include <src.opts.mk> MAN= \ diff --git a/share/man/man8/debug.sh.8 b/share/man/man8/debug.sh.8 index 2c137ff3fd42..bf0fdbd6bcf5 100644 --- a/share/man/man8/debug.sh.8 +++ b/share/man/man8/debug.sh.8 @@ -12,7 +12,7 @@ .\" Please send copies of changes and bug-fixes to: .\" sjg@crufty.net .\" -.Dd January 31, 2024 +.Dd October 22, 2024 .Dt DEBUG.SH 8 .Os .Sh NAME @@ -30,6 +30,8 @@ .It .Ic Debugging .It +.Ic DebugAdd Ar tag +.It .Ic DebugEcho Op Ar message .It .Ic DebugLog Op Ar message @@ -99,7 +101,7 @@ are ignored, they just allow for symmetry with calls to The optional .Ar rc value will be returned rather than the default of 0. -Thus if +Thus if .Fn DebugOff is the last operation in a function, .Ar rc @@ -110,6 +112,13 @@ It is useful for bounding complex debug actions, rather than using lots of .Ic $DEBUG_DO lines. +.It Ic DebugAdd Ar tag +Add +.Ar tag +to +.Va DEBUG_SH +to influence later output, +possibly in a child process. .It Ic DebugEcho is just shorthand for: .Bd -literal -offset indent diff --git a/share/man/man8/diskless.8 b/share/man/man8/diskless.8 index 8839e27e11ba..cc49854ae850 100644 --- a/share/man/man8/diskless.8 +++ b/share/man/man8/diskless.8 @@ -1,3 +1,6 @@ +.\"- +.\" SPDX-License-Identifier: BSD-3-Clause +.\" .\" Copyright (c) 1994 Gordon W. Ross, Theo de Raadt .\" Updated by Luigi Rizzo, Robert Watson .\" All rights reserved. @@ -24,12 +27,12 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd May 3, 2020 +.Dd August 11, 2024 .Dt DISKLESS 8 .Os .Sh NAME .Nm diskless -.Nd booting a system over the network +.Nd booting a system over the network with PXE .Sh DESCRIPTION The ability to boot a machine over the network is useful for .Em diskless diff --git a/share/man/man8/nanobsd.8 b/share/man/man8/nanobsd.8 index 140a63b3d2f3..838f9ddc9afa 100644 --- a/share/man/man8/nanobsd.8 +++ b/share/man/man8/nanobsd.8 @@ -1,3 +1,6 @@ +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" .\" Copyright (c) 2006 Daniel Gerzo <danger@FreeBSD.org> .\" All rights reserved. .\" @@ -22,16 +25,15 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd May 19, 2016 +.Dd July 14, 2025 .Dt NANOBSD 8 .Os .Sh NAME .Nm nanobsd.sh -.Nd utility used to create a FreeBSD system image suitable for embedded -applications +.Nd create an embedded FreeBSD system image .Sh SYNOPSIS .Nm -.Op Fl bfhiKknqvwX +.Op Fl BbfhIiKknqvWwX .Op Fl c Ar config-file .Sh DESCRIPTION The @@ -47,6 +49,8 @@ installation and maintenance. .Pp The following options are available: .Bl -tag -width ".Fl c Ar config-file" -offset indent +.It Fl B +Skip the install stages (both for kernel and world). .It Fl b Skip the build stages (both for kernel and world). .It Fl c Ar config-file @@ -55,6 +59,8 @@ Specify the configuration file to use. Skip the code slice extraction. .It Fl h Display usage information. +.It Fl I +Build the disk image from an existing build/install. .It Fl i Skip the disk image build stage. .It Fl K @@ -75,13 +81,17 @@ used for each build stage (world and kernel). Make output more quiet. .It Fl v Make output more verbose. +.It Fl W +Skip the +.Cm installworld +stage of the build. .It Fl w Skip the .Cm buildworld stage of the build. .It Fl X Make -.Cm native-xtools. +.Cm native-xtools . .El .Pp The features of diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8 index fda04bceaf4c..b7bd7b2de1f0 100644 --- a/share/man/man8/rc.8 +++ b/share/man/man8/rc.8 @@ -28,7 +28,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 31, 2024 +.Dd September 20, 2024 .Dt RC 8 .Os .Sh NAME @@ -451,18 +451,6 @@ is not set, when going from single-user to multi-user mode for example, the script does not do anything. .Pp The -.Pa /etc/rc.d/local -script can execute scripts from multiple -.Nm rc.d/ -directories. -The default location includes -.Pa /usr/local/etc/rc.d/ , -but these may be overridden with the -.Va local_startup -.Xr rc.conf 5 -variable. -.Pp -The .Pa /etc/rc.d/serial script is used to set any special configurations for serial devices. .Pp diff --git a/share/man/man8/rc.subr.8 b/share/man/man8/rc.subr.8 index 0906ecb2e787..1fd5041cecd8 100644 --- a/share/man/man8/rc.subr.8 +++ b/share/man/man8/rc.subr.8 @@ -27,7 +27,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd February 10, 2024 +.Dd October 23, 2024 .Dt RC.SUBR 8 .Os .Sh NAME @@ -73,7 +73,7 @@ .It .Ic rc_log Ar message .It -.It rc_trace Ar level Ar message +.Ic rc_trace Ar level Ar message .It .Ic rc_usage Ar command ... .It @@ -134,7 +134,7 @@ The .Ar action argument may be one of the following: -.Bl -tag -width ".Cm remove" +.Bl -tag -width "remove" .It Cm add .Ar file is now being backed up by or possibly re-entered into this backup mechanism. @@ -487,7 +487,7 @@ scripts to be implemented in a small amount of shell code. .Ar argument is searched for in the list of supported commands, which may be one of: -.Bl -tag -width ".Cm restart" -offset indent +.Bl -tag -width "restart" -offset indent .It Cm start Start the service. This should check that the service is to be started as specified by @@ -523,7 +523,7 @@ If or .Va procname is set, also support: -.Bl -tag -width ".Cm restart" -offset indent +.Bl -tag -width "status" -offset indent .It Cm poll Wait for the command to exit. .It Cm status @@ -535,7 +535,7 @@ Other supported commands are listed in the optional variable .Pp .Ar argument may have one of the following prefixes which alters its operation: -.Bl -tag -width ".Li force" -offset indent +.Bl -tag -width "force" -offset indent .It Li fast Skip the check for an existing running process, and sets @@ -579,7 +579,7 @@ but only certain small classes of them. .Ic run_rc_command uses the following shell variables to control its behaviour. Unless otherwise stated, these are optional. -.Bl -tag -width ".Va procname" -offset indent +.Bl -tag -width "procname" -offset indent .It Va name The name of this script. This is not optional. @@ -773,6 +773,8 @@ Login class to use with .Va ${name}_limits . Defaults to .Dq Li daemon . +.It Va ${name}_offcmd +Shell commands to run during start if a service is not enabled. .It Va ${name}_oomprotect .Xr protect 1 .Va command @@ -826,8 +828,15 @@ This is a generic version of or .Va ${name}_nice . .It Va ${name}_setup -Command to be run prior to -.Va command . +Optional command to be run during +.Cm start , +.Cm restart , +and +.Cm reload +prior to the respective +.Ar argument Ns Va _precmd . +If the command fails for any reason it will output a warning, +but execution will continue. .It Ar argument Ns Va _cmd Shell commands which override the default method for .Ar argument . @@ -867,17 +876,16 @@ if .Ar argument Ns Va _cmd is not defined, then a default method is provided by .Ic run_rc_command : -.Bl -tag -width ".Sy Argument" -offset indent -.It Sy Argument -.Sy Default method -.It Cm start +.Bl -column "Argument" "Default Method" -offset indent +.It Sy Argument Ta Sy Default method +.It Cm start Ta If .Va command is not running and .Ic checkyesno Va rcvar succeeds, start .Va command . -.It Cm stop +.It Cm stop Ta Determine the PIDs of .Va command with @@ -889,7 +897,7 @@ or those PIDs, and run .Ic wait_for_pids on those PIDs. -.It Cm reload +.It Cm reload Ta Similar to .Cm stop , except that it uses @@ -906,21 +914,21 @@ It can be enabled via if appropriate: .Pp .Dl "extra_commands=reload" -.It Cm restart +.It Cm restart Ta Runs the .Cm stop method, then the .Cm start method. -.It Cm status +.It Cm status Ta Show the PID of .Va command , or some other script specific status operation. -.It Cm poll +.It Cm poll Ta Wait for .Va command to exit. -.It Cm rcvar +.It Cm rcvar Ta Display which .Xr rc.conf 5 variable is used (if any). @@ -936,7 +944,7 @@ The following variables are available to the methods as well as after .Ic run_rc_command has completed: -.Bl -tag -width ".Va rc_service" -offset indent +.Bl -tag -width "rc_service" -offset indent .It Va rc_arg Argument provided to .Ic run_rc_command , @@ -1009,41 +1017,27 @@ and to enable tracing if any of those tags appear in .Va DEBUG_SH . .Pp -The startup behaviour of +.Ic run_rc_script +executes .Ar file -depends upon the following checks: +unless: .Bl -enum .It -If .Ar file ends in -.Pa .sh , -it is sourced into the current shell. +.Pa .sh +and lives in +.Pa /etc/rc.d . .It -If .Ar file appears to be a backup or scratch file -(e.g., with a suffix of -.Pa ~ , # , .OLD , +.Po e.g., with a suffix of +.Pa ~ , # , .OLD , ,v , or -.Pa .orig ) , -ignore it. +.Pa .orig Pc . .It -If .Ar file -is not executable, ignore it. -.It -If the -.Xr rc.conf 5 -variable -.Va rc_fast_and_loose -is empty, -source -.Ar file -in a sub shell, -otherwise source -.Ar file -into the current shell. +is not executable. .El .It Ic run_rc_scripts Oo options Oc file ... Call @@ -1164,7 +1158,7 @@ and then .Ar message . .El .Sh FILES -.Bl -tag -width ".Pa /etc/rc.subr" -compact +.Bl -tag -width "/etc/rc.subr" -compact .It Pa /etc/rc.subr The .Nm @@ -1172,8 +1166,8 @@ file resides in .Pa /etc . .El .Sh SEE ALSO -.Xr debug.sh 8 , .Xr rc.conf 5 , +.Xr debug.sh 8 , .Xr rc 8 .Sh HISTORY The diff --git a/share/man/man8/uefi.8 b/share/man/man8/uefi.8 index 42642bb48260..e29bed134850 100644 --- a/share/man/man8/uefi.8 +++ b/share/man/man8/uefi.8 @@ -45,7 +45,7 @@ The boot process loads system bootstrap code located in an EFI System Partition (ESP). The ESP is a GPT or MBR partition with a specific identifier that contains an -.Xr msdosfs 5 +.Xr msdosfs 4 FAT file system with a specified file hierarchy. .Bl -column -offset indent "Partition Scheme" "ESP Identifier" .It Sy "Partition Scheme" Ta Sy "ESP Identifier" @@ -108,9 +108,9 @@ Default kernel Typical non-default kernel (optional) .El .Sh SEE ALSO +.Xr msdosfs 4 , .Xr vt 4 , .Xr boot.config 5 , -.Xr msdosfs 5 , .Xr boot 8 , .Xr efibootmgr 8 , .Xr efidp 8 , @@ -126,7 +126,7 @@ boot support for amd64 first appeared in .Fx 10.1 ; for arm64 in .Fx 11.0 ; -for armv6 and armv7 in +for armv7 in .Fx 12.0 ; and for riscv in .Fx 13.0 . |