diff --git a/lib/libc/gen/makecontext.3 b/lib/libc/gen/makecontext.3 index bcf836979962..198c541d40a6 100644 --- a/lib/libc/gen/makecontext.3 +++ b/lib/libc/gen/makecontext.3 @@ -1,161 +1,162 @@ .\" Copyright (c) 2002 Packet Design, LLC. .\" All rights reserved. .\" .\" Subject to the following obligations and disclaimer of warranty, .\" use and redistribution of this software, in source or object code .\" forms, with or without modifications are expressly permitted by .\" Packet Design; provided, however, that: .\" .\" (i) Any and all reproductions of the source or object code .\" must include the copyright notice above and the following .\" disclaimer of warranties; and .\" (ii) No rights are granted, in any manner or form, to use .\" Packet Design trademarks, including the mark "PACKET DESIGN" .\" on advertising, endorsements, or otherwise except as such .\" appears in the above copyright notice or in the software. .\" .\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING .\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED .\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, .\" OR NON-INFRINGEMENT. PACKET DESIGN DOES NOT WARRANT, GUARANTEE, .\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS .\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, .\" RELIABILITY OR OTHERWISE. IN NO EVENT SHALL PACKET DESIGN BE .\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE .\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT, .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL .\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF .\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER 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 PACKET DESIGN IS ADVISED OF .\" THE POSSIBILITY OF SUCH DAMAGE. .\" .Dd March 23, 2020 .Dt MAKECONTEXT 3 .Os .Sh NAME .Nm makecontext , swapcontext .Nd modify and exchange user thread contexts .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In ucontext.h .Ft void .Fo makecontext .Fa "ucontext_t *ucp" .Fa "void \*[lp]*func\*[rp]\*[lp]void\*[rp]" .Fa "int argc" ... .Fc .Ft int .Fn swapcontext "ucontext_t *oucp" "const ucontext_t *ucp" .Sh DESCRIPTION The .Fn makecontext function modifies the user thread context pointed to by .Fa ucp , which must have previously been initialized by a call to .Xr getcontext 3 and had a stack allocated for it. The context is modified so that it will continue execution by invoking .Fn func with the arguments provided. The .Fa argc argument must be equal to the number of additional arguments of type .Vt int provided to .Fn makecontext and also equal to the number of arguments of type .Vt int to .Fn func ; otherwise , the behavior is undefined. .Pp The .Fa "ucp->uc_link" argument must be initialized before calling .Fn makecontext and determines the action to take when .Fn func returns: if equal to .Dv NULL , the process exits; otherwise, .Fn setcontext "ucp->uc_link" is implicitly invoked. .Pp The .Fn swapcontext function saves the current thread context in .Fa "*oucp" and makes .Fa "*ucp" the currently active context. .Sh RETURN VALUES If successful, .Fn swapcontext returns zero; otherwise \-1 is returned and the global variable .Va errno is set appropriately. .Sh ERRORS The .Fn swapcontext function will fail if: .Bl -tag -width Er .It Bq Er ENOMEM There is not enough stack space in .Fa ucp to complete the operation. .El .Sh SEE ALSO .Xr setcontext 3 , .Xr ucontext 3 .Sh STANDARDS The .Fn makecontext and .Fn swapcontext functions conform to .St -xsh5 and .St -p1003.1-2001 . .Pp The .St -p1003.1-2004 revision marked the functions .Fn makecontext and .Fn swapcontext as obsolete, citing portability issues and recommending the use of .Tn POSIX threads instead. The .St -p1003.1-2008 revision removed the functions from the specification. .Pp .Bf -symbolic The standard does not clearly define the type of integer arguments passed to .Fa func via .Fn makecontext ; portable applications should not rely on the implementation detail that it may be possible to pass pointer arguments to functions. +.Ef .Sh HISTORY The .Fn makecontext and .Fn swapcontext functions first appeared in .At V.4 . diff --git a/lib/libc/posix1e/acl_cmp_np.3 b/lib/libc/posix1e/acl_cmp_np.3 index a8dca4959d2e..5e47df833d0d 100644 --- a/lib/libc/posix1e/acl_cmp_np.3 +++ b/lib/libc/posix1e/acl_cmp_np.3 @@ -1,83 +1,84 @@ .\"- .\" Copyright (c) 2021 Gleb Popov .\" All rights reserved. .\" .\" 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. .\" .Dd January 20, 2021 .Dt ACL_CMP_NP 3 .Os .Sh NAME .Nm acl_cmp .Nd compare between two ACLs .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/types.h .In sys/acl.h .Ft int .Fn acl_cmp_np "acl_t acl1" "acl_t acl2" .Sh DESCRIPTION The .Fn acl_cmp_np function is a non-portable call that checks if ACLs pointed to by .Va acl1 and .Va acl2 are equivalent. The two ACLs are considered equal when they contain the same entries with matching tag types, qualifiers and permissions. .Sh RETURN VALUES Upon successful completion, this function returns 0 if the given ACLs are equivalent and 1 if they differ. Otherwise, the value -1 is returned, and .Va errno indicates the error. .Sh ERRORS If any of the following conditions occur, the .Fn acl_cmp_np function shall return a value of .Va -1 and set .Va errno to the corresponding value: .Bl -tag -width Er .It Bq Er EINVAL Either first or second argument does not point to a valid ACL. +.El .Sh SEE ALSO .Xr acl 3 , .Xr posix1e 3 .Sh STANDARDS POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion of the draft continues on the cross-platform POSIX.1e implementation mailing list. To join this list, see the .Fx POSIX.1e implementation page for more information. .Sh HISTORY POSIX.1e support was introduced in .Fx 4.0 , and development continues. .Sh AUTHORS .An Gleb Popov diff --git a/lib/libc/posix1e/acl_extended_file_np.3 b/lib/libc/posix1e/acl_extended_file_np.3 index 26572be9d2b3..4673e9c3e417 100644 --- a/lib/libc/posix1e/acl_extended_file_np.3 +++ b/lib/libc/posix1e/acl_extended_file_np.3 @@ -1,95 +1,96 @@ .\"- .\" Copyright (c) 2021 Gleb Popov .\" All rights reserved. .\" .\" 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. .\" .Dd February 26, 2021 .Dt ACL_EXTENDED_FILE_NP 3 .Os .Sh NAME .Nm acl_extended_file_np , .Nm acl_extended_file_nofollow_np , .Nm acl_extended_link_np .Nd checks if the file has extended ACLs set .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/types.h .In sys/acl.h .Ft int .Fn acl_extended_file_np "const char* path_p" .Ft int .Fn acl_extended_file_nofollow_np "const char* path_p" .Ft int .Fn acl_extended_link_np "const char* path_p" .Sh DESCRIPTION The .Fn acl_extended_file_np function is a non-portable call that checks if the file or directory referred to by the argument .Va path_p contains extended access ACLs. The .Fn acl_extended_file_nofollow_np function works the same way, except it does not follow symlinks. The .Fn acl_extended_link_np function is a synonim to .Fn acl_extended_file_nofollow_np named in FreeBSD style. An ACL is considered to be extended access one if it contains entries other than the three required entries of tag types ACL_USER_OBJ, ACL_GROUP_OBJ and ACL_OTHER. .Sh RETURN VALUES Upon successful completion, this function returns 0 if the file object does not contain extended access ACLs and 1 in the other case. Otherwise, the value -1 is returned, and .Va errno indicates the error. .Sh ERRORS If any of the following conditions occur, the .Fn acl_extended_file_np function shall return a value of .Va -1 and set .Va errno to the corresponding value: .Bl -tag -width Er .It Bq Er EACCES Search permission is denied for a component of the path prefix. +.El .Sh SEE ALSO .Xr extattr_get_file 2 , .Xr posix1e 3 .Sh STANDARDS POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion of the draft continues on the cross-platform POSIX.1e implementation mailing list. To join this list, see the .Fx POSIX.1e implementation page for more information. .Sh HISTORY POSIX.1e support was introduced in .Fx 4.0 , and development continues. .Sh AUTHORS .An Gleb Popov diff --git a/lib/libpathconv/abs2rel.3 b/lib/libpathconv/abs2rel.3 index 634f294800e4..9240ef1662e2 100644 --- a/lib/libpathconv/abs2rel.3 +++ b/lib/libpathconv/abs2rel.3 @@ -1,134 +1,135 @@ .\" .\" Copyright (c) 1997 Shigio Yamaguchi. All rights reserved. .\" Copyright (c) 1999 Tama Communications Corporation. All rights reserved. .\" .\" 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. .\" .Dd August 7, 2022 .Dt ABS2REL 3 .Os .Sh NAME .Nm abs2rel .Nd make a relative path name from an absolute path name .Sh SYNOPSIS .Ft "char *" .Fn abs2rel "const char *path" "const char *base" "char *result" "size_t size" .Sh DESCRIPTION The .Fn abs2rel function makes a relative path name from an absolute path name .Fa path based on a directory .Fa base and copies the resulting path name into the memory referenced by .Fa result . The .Fa result argument must refer to a buffer capable of storing at least .Fa size characters. The resulting path name may include symbolic links. The .Fn abs2rel function doesn't check whether or not any path exists. .Sh "RETURN VALUES" The .Fn abs2rel function returns relative path name on success. If an error occurs, it returns .Dv NULL . .Sh EXAMPLES char result[MAXPATHLEN]; char *path = abs2rel("/usr/src/sys", "/usr/local/lib", result, MAXPATHLEN); yields: path == "../../src/sys" Similarly, path1 = abs2rel("/usr/src/sys", "/usr", result, MAXPATHLEN); path2 = abs2rel("/usr/src/sys", "/usr/src/sys", result, MAXPATHLEN); yields: path1 == "src/sys" path2 == "." .Sh ERRORS The .Fn abs2rel function may fail and set the external variable .Va errno to indicate the error. .Bl -tag -width Er .It Bq Er EINVAL The .Fa base directory isn't an absolute path name or the .Fa size argument is zero. .It Bq Er ERANGE The .Fa size argument is greater than zero but smaller than the length of the pathname plus 1. +.El .Sh SEE ALSO .Xr rel2abs 3 .Sh AUTHORS .An Shigio Yamaguchi (shigio@tamacom.com) .Sh BUGS If the .Fa base directory includes symbolic links, the .Fn abs2rel function produces the wrong path. For example, if '/sys' is a symbolic link to '/usr/src/sys', char *path = abs2rel("/usr/local/lib", "/sys", result, MAXPATHLEN); yields: path == "../usr/local/lib" /* It's wrong!! */ You should convert the base directory into a real path in advance. .Pp path = abs2rel("/sys/kern", realpath("/sys", resolvedname), result, MAXPATHLEN); yields: path == "../../../sys/kern" /* It's correct but ... */ That is correct, but a little redundant. If you wish get the simple answer 'kern', do the following. path = abs2rel(realpath("/sys/kern", r1), realpath("/sys", r2), result, MAXPATHLEN); The .Fn realpath function assures correct result, but don't forget that .Fn realpath requires that all but the last component of the path exist. diff --git a/lib/libpathconv/rel2abs.3 b/lib/libpathconv/rel2abs.3 index f889f427450d..1f607fd739e1 100644 --- a/lib/libpathconv/rel2abs.3 +++ b/lib/libpathconv/rel2abs.3 @@ -1,96 +1,97 @@ .\" .\" Copyright (c) 1997 Shigio Yamaguchi. All rights reserved. .\" Copyright (c) 1999 Tama Communications Corporation. All rights reserved. .\" .\" 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. .\" .Dd August 7, 2022 .Dt REL2ABS 3 .Os .Sh NAME .Nm rel2abs .Nd make an absolute path name from a relative path name .Sh SYNOPSIS .Ft "char *" .Fn rel2abs "const char *path" "const char *base" "char *result" "size_t size" .Sh DESCRIPTION The .Fn rel2abs function makes an absolute path name from a relative path name .Fa path based on a directory .Fa base and copies the resulting path name into the memory referenced by .Fa result . The .Fa result argument must refer to a buffer capable of storing at least .Fa size character The resulting path name may include symbolic links. .Fn abs2rel doesn't check whether or not any path exists. .Sh "RETURN VALUES" The .Fn rel2abs function returns absolute path name on success. If an error occurs, it returns .Dv NULL . .Sh EXAMPLES char result[MAXPATHLEN]; char *path = rel2abs("../../src/sys", "/usr/local/lib", result, MAXPATHLEN); yields: path == "/usr/src/sys" Similarly, path1 = rel2abs("src/sys", "/usr", result, MAXPATHLEN); path2 = rel2abs(".", "/usr/src/sys", result, MAXPATHLEN); yields: path1 == "/usr/src/sys" path2 == "/usr/src/sys" .Sh ERRORS The .Fn rel2abs function may fail and set the external variable .Va errno to indicate the error. .Bl -tag -width Er .It Bq Er EINVAL The .Fa base directory isn't an absolute path name or the .Fa size argument is zero. .It Bq Er ERANGE The .Fa size argument is greater than zero but smaller than the length of the pathname plus 1 +.El .Sh SEE ALSO .Xr abs2rel 3 .Sh AUTHORS .An Shigio Yamaguchi (shigio@tamacom.com) diff --git a/sbin/init/init.8 b/sbin/init/init.8 index 88d663a1afe8..b20860d59e35 100644 --- a/sbin/init/init.8 +++ b/sbin/init/init.8 @@ -1,468 +1,469 @@ .\" Copyright (c) 1980, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" Donn Seeley at Berkeley Software Design, Inc. .\" .\" 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. .\" 3. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" @(#)init.8 8.3 (Berkeley) 4/18/94 .\" .Dd July 22, 2021 .Dt INIT 8 .Os .Sh NAME .Nm init .Nd process control initialization .Sh SYNOPSIS .Nm .Nm .Oo .Cm 0 | 1 | 6 | .Cm c | q .Oc .Sh DESCRIPTION The .Nm utility is the last stage of the boot process. It normally runs the automatic reboot sequence as described in .Xr rc 8 , and if this succeeds, begins multi-user operation. If the reboot scripts fail, .Nm commences single-user operation by giving the super-user a shell on the console. The .Nm utility may be passed parameters from the boot program to prevent the system from going multi-user and to instead execute a single-user shell without starting the normal daemons. The system is then quiescent for maintenance work and may later be made to go to multi-user by exiting the single-user shell (with ^D). This causes .Nm to run the .Pa /etc/rc start up command file in fastboot mode (skipping disk checks). .Pp If the .Em console entry in the .Xr ttys 5 file is marked .Dq insecure , then .Nm will require that the super-user password be entered before the system will start a single-user shell. The password check is skipped if the .Em console is marked as .Dq secure . Note that the password check does not protect from variables such as .Va init_script being set from the .Xr loader 8 command line; see the .Sx SECURITY section of .Xr loader 8 . .Pp If the system security level (see .Xr security 7 ) is initially nonzero, then .Nm leaves it unchanged. Otherwise, .Nm raises the level to 1 before going multi-user for the first time. Since the level cannot be reduced, it will be at least 1 for subsequent operation, even on return to single-user. If a level higher than 1 is desired while running multi-user, it can be set before going multi-user, e.g., by the startup script .Xr rc 8 , using .Xr sysctl 8 to set the .Va kern.securelevel variable to the required security level. .Pp If .Nm is run in a jail, the security level of the .Dq host system will not be affected. Part of the information set up in the kernel to support a jail is a per-jail security level. This allows running a higher security level inside of a jail than that of the host system. See .Xr jail 8 for more information about jails. .Pp In multi-user operation, .Nm maintains processes for the terminal ports found in the file .Xr ttys 5 . The .Nm utility reads this file and executes the command found in the second field, unless the first field refers to a device in .Pa /dev which is not configured. The first field is supplied as the final argument to the command. This command is usually .Xr getty 8 ; .Nm getty opens and initializes the tty line and executes the .Xr login 1 program. The .Nm login program, when a valid user logs in, executes a shell for that user. When this shell dies, either because the user logged out or an abnormal termination occurred (a signal), the cycle is restarted by executing a new .Nm getty for the line. .Pp The .Nm utility can also be used to keep arbitrary daemons running, automatically restarting them if they die. In this case, the first field in the .Xr ttys 5 file must not reference the path to a configured device node and will be passed to the daemon as the final argument on its command line. This is similar to the facility offered in the .At V .Pa /etc/inittab . .Pp Line status (on, off, secure, getty, or window information) may be changed in the .Xr ttys 5 file without a reboot by sending the signal .Dv SIGHUP to .Nm with the command .Dq Li "kill -HUP 1" . On receipt of this signal, .Nm re-reads the .Xr ttys 5 file. When a line is turned off in .Xr ttys 5 , .Nm will send a SIGHUP signal to the controlling process for the session associated with the line. For any lines that were previously turned off in the .Xr ttys 5 file and are now on, .Nm executes the command specified in the second field. If the command or window field for a line is changed, the change takes effect at the end of the current login session (e.g., the next time .Nm starts a process on the line). If a line is commented out or deleted from .Xr ttys 5 , .Nm will not do anything at all to that line. .Pp The .Nm utility will terminate multi-user operations and resume single-user mode if sent a terminate .Pq Dv TERM signal, for example, .Dq Li "kill \-TERM 1" . If there are processes outstanding that are deadlocked (because of hardware or software failure), .Nm will not wait for them all to die (which might take forever), but will time out after 30 seconds and print a warning message. .Pp The .Nm utility will cease creating new processes and allow the system to slowly die away, if it is sent a terminal stop .Pq Dv TSTP signal, i.e.\& .Dq Li "kill \-TSTP 1" . A later hangup will resume full multi-user operations, or a terminate will start a single-user shell. This hook is used by .Xr reboot 8 and .Xr halt 8 . .Pp The .Nm utility will terminate all possible processes (again, it will not wait for deadlocked processes) and reboot the machine if sent the interrupt .Pq Dv INT signal, i.e.\& .Dq Li "kill \-INT 1". This is useful for shutting the machine down cleanly from inside the kernel or from X when the machine appears to be hung. .Pp The .Nm utility will do the same, except it will halt the machine if sent the user defined signal 1 .Pq Dv USR1 , or will halt and turn the power off (if hardware permits) if sent the user defined signal 2 .Pq Dv USR2 . .Pp When shutting down the machine, .Nm will try to run the .Pa /etc/rc.shutdown script. This script can be used to cleanly terminate specific programs such as .Nm innd (the InterNetNews server). If this script does not terminate within 120 seconds, .Nm will terminate it. The timeout can be configured via the .Xr sysctl 8 variable .Va kern.init_shutdown_timeout . .Pp .Nm init passes .Dq Li single as the argument to the shutdown script if return to single-user mode is requested. Otherwise, .Dq Li reboot argument is used. .Pp After all user processes have been terminated, .Nm will try to run the .Pa /etc/rc.final script. This script can be used to finally prepare and unmount filesystems that may have been needed during shutdown, for instance. .Pp The role of .Nm is so critical that if it dies, the system will reboot itself automatically. If, at bootstrap time, the .Nm process cannot be located, the system will panic with the message .Dq "panic: init died (signal %d, exit %d)" . .Pp If run as a user process as shown in the second synopsis line, .Nm will emulate .At V behavior, i.e., super-user can specify the desired .Em run-level on a command line, and .Nm will signal the original (PID 1) .Nm as follows: .Bl -column Run-level SIGTERM .It Sy "Run-level Signal Action" .It Cm 0 Ta Dv SIGUSR1 Ta "Halt" .It Cm 0 Ta Dv SIGUSR2 Ta "Halt and turn the power off" .It Cm 0 Ta Dv SIGWINCH Ta "Halt and turn the power off and then back on" .It Cm 1 Ta Dv SIGTERM Ta "Go to single-user mode" .It Cm 6 Ta Dv SIGINT Ta "Reboot the machine" .It Cm c Ta Dv SIGTSTP Ta "Block further logins" .It Cm q Ta Dv SIGHUP Ta Rescan the .Xr ttys 5 file .El .Sh KERNEL ENVIRONMENT VARIABLES The following .Xr kenv 2 variables are available as .Xr loader 8 tunables: .Bl -tag -width indent .It Va init_chroot If set to a valid directory in the root file system, it causes .Nm to perform a .Xr chroot 2 operation on that directory, making it the new root directory. That happens before entering single-user mode or multi-user mode (but after executing the .Va init_script if enabled). This functionality has generally been eclipsed by rerooting. See .Xr reboot 8 .Fl r for details. .It Va init_exec If set to a valid file name in the root file system, instructs .Nm to directly execute that file as the very first action, replacing .Nm as PID 1. .It Va init_script If set to a valid file name in the root file system, instructs .Nm to run that script as the very first action, before doing anything else. Signal handling and exit code interpretation is similar to running the .Pa /etc/rc script. In particular, single-user operation is enforced if the script terminates with a non-zero exit code, or if a SIGTERM is delivered to the .Nm process (PID 1). This functionality has generally been eclipsed by rerooting. See .Xr reboot 8 .Fl r for details. .It Va init_shell Defines the shell binary to be used for executing the various shell scripts. The default is .Dq Li /bin/sh . It is used for running the .Va init_exec or .Va init_script if set, as well as for the .Pa /etc/rc , .Pa /etc/rc.shutdown , and .Pa /etc/rc.final scripts. The value of the corresponding .Xr kenv 2 variable is evaluated every time .Nm calls a shell script, so it can be changed later on using the .Xr kenv 1 utility. In particular, if a non-default shell is used for running an .Va init_script , it might be desirable to have that script reset the value of .Va init_shell back to the default, so that the .Pa /etc/rc script is executed with the standard shell .Pa /bin/sh . +.El .Sh FILES .Bl -tag -width /var/log/init.log -compact .It Pa /dev/console system console device .It Pa /dev/tty* terminal ports found in .Xr ttys 5 .It Pa /etc/ttys the terminal initialization information file .It Pa /etc/rc system startup commands .It Pa /etc/rc.shutdown system shutdown commands .It Pa /etc/rc.final system shutdown commands (after process termination) .It Pa /var/log/init.log log of .Xr rc 8 output if the system console device is not available .El .Sh DIAGNOSTICS .Bl -diag .It "getty repeating too quickly on port %s, sleeping." A process being started to service a line is exiting quickly each time it is started. This is often caused by a ringing or noisy terminal line. .Bf -emphasis Init will sleep for 30 seconds, then continue trying to start the process. .Ef .It "some processes would not die; ps axl advised." A process is hung and could not be killed when the system was shutting down. This condition is usually caused by a process that is stuck in a device driver because of a persistent device error condition. .El .Sh SEE ALSO .Xr kill 1 , .Xr login 1 , .Xr sh 1 , .Xr ttys 5 , .Xr security 7 , .Xr getty 8 , .Xr halt 8 , .Xr jail 8 , .Xr rc 8 , .Xr reboot 8 , .Xr shutdown 8 , .Xr sysctl 8 .Sh HISTORY An .Nm utility appeared in .At v1 . .Sh CAVEATS Systems without .Xr sysctl 8 behave as though they have security level \-1. .Pp Setting the security level above 1 too early in the boot sequence can prevent .Xr fsck 8 from repairing inconsistent file systems. The preferred location to set the security level is at the end of .Pa /etc/rc after all multi-user startup actions are complete. diff --git a/share/man/man4/splash.4 b/share/man/man4/splash.4 index af2ae2e4369a..d7123bf6efd9 100644 --- a/share/man/man4/splash.4 +++ b/share/man/man4/splash.4 @@ -1,313 +1,314 @@ .\" .\" Copyright (c) 1999 .\" Kazutaka YOKOTA .\" All rights reserved. .\" .\" 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 as .\" the first lines of this file unmodified. .\" 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 ``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 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. .\" .Dd July 09, 2024 .Dt SPLASH 4 .Os .Sh NAME .Nm splash .Nd splash screen / screen saver interface .Sh SYNOPSIS .Cd "device splash" .Sh DESCRIPTION The .Nm pseudo device driver adds support for the splash screen and screen savers to the kernel. This driver is required if the splash bitmap image is to be loaded or any screen saver is to be used. .Ss Splash screen You can load and display an arbitrary bitmap image file as a welcome banner on the screen when the system is about to start. This image will remain on the screen during kernel initialization process until the login prompt appears on the screen or until a screen saver is loaded and initialized. The image will also disappear if you hit any key, although this may not work immediately if the kernel is still probing devices. .Pp If you specify the .Fl c or .Fl v boot option when loading the kernel, the splash image will not appear. However, it is still loaded and can be used as a screen saver later: see below. .Pp In order to display the bitmap, the bitmap file itself and the matching splash image decoder module must be loaded by the boot loader. Currently the following decoder modules are available: .Pp .Bl -tag -width splash_decoder -compact .It Pa splash_bmp.ko Windows BMP file decoder. While the BMP file format allows images of various color depths, this decoder currently only handles 256 color bitmaps. Bitmaps of other color depths will not be displayed. .It Pa splash_pcx.ko ZSoft PCX decoder. This decoder currently only supports version 5 8-bpp single-plane images. .It Pa splash_txt.ko TheDraw binary ASCII drawing file decoder. Displays a text-mode 80x25 ASCII drawing, such as that produced by the Binary save format in TheDraw. This format consists of a sequence of two byte pairs representing the 80x25 display, where the first byte is the ASCII character to draw and the second byte indicates the colors/attributes to use when drawing the character. .El .Pp The .Sx EXAMPLES section illustrates how to set up the splash screen. .Pp If the standard VGA video mode is used, the size of the bitmap must be 320x200 or less. If you enable the VESA mode support in the kernel, either by statically linking the VESA module or by loading the VESA module (see .Xr vga 4 ) , you can load bitmaps up to a resolution of 1024x768, depending on the VESA BIOS and the amount of video memory on the video card. .Ss Screen saver The screen saver will activate when the system is considered idle: i.e.\& when the user has not typed a key or moved the mouse for a specified period of time. As the screen saver is an optional module, it must be explicitly loaded into memory. Currently the following screen saver modules are available: .Pp .Bl -tag -width splash_module.ko -compact .It Pa blank_saver.ko This screen saver simply blanks the screen. .It Pa beastie_saver.ko Animated graphical .Bx Daemon. .It Pa daemon_saver.ko Animated .Bx Daemon screen saver. .It Pa dragon_saver.ko Draws a random dragon curve. .It Pa fade_saver.ko The screen will gradually fade away. .It Pa fire_saver.ko A fire which becomes higher as load increases. .It Pa green_saver.ko The screen will be blanked, similar to .Pa blank_saver.ko . If the monitor and the video card's BIOS support it the screen will also be powered off. .It Pa logo_saver.ko Animated graphical .Fx logo. .It Pa plasma_saver.ko Draws an animated interference pattern. .It Pa rain_saver.ko Draws a shower on the screen. .It Pa snake_saver.ko Draws a snake of string. .It Pa star_saver.ko Twinkling stars. .It Pa warp_saver.ko Streaking stars. .El .Pp Screen saver modules can be loaded using .Xr kldload 8 : .Pp .Dl kldload logo_saver .Pp The timeout value in seconds can be specified as follows: .Pp .Dl vidcontrol -t N .Pp Alternatively, you can set the .Ar saver variable in the .Pa /etc/rc.conf to the screen saver of your choice and the timeout value to the .Ar blanktime variable so that the screen saver is automatically loaded and the timeout value is set when the system starts. .Pp The screen saver may be instantly activated by hitting the .Ar saver key: the defaults are .Em Shift-Pause on the AT enhanced keyboard and .Em Shift-Ctrl-NumLock/Pause on the AT 84 keyboard. You can change the .Ar saver key by modifying the keymap (see .Xr kbdcontrol 1 , .Xr keymap 5 ) , and assign the .Ar saver function to a key of your preference. .Pp The screen saver will not run if the screen is not in text mode. .Ss Splash screen as a screen saver If you load a splash image but do not load a screen saver, you can continue using the splash module as a screen saver. The screen blanking interval can be specified as described in the .Sx Screen saver section above. .\".Sh DRIVER CONFIGURATION .Sh FILES .Bl -tag -width /boot/kernel/splash_xxxx.ko -compact .It Pa /boot/defaults/loader.conf boot loader configuration defaults .It Pa /etc/rc.conf system configuration information .It Pa /boot/kernel/splash_*.ko splash image decoder modules .It Pa /boot/kernel/*_saver.ko screen saver modules .It Pa /boot/kernel/vesa.ko the VESA support module .El .Sh EXAMPLES In order to load the splash screen or the screen saver, you must have the following line in the kernel configuration file. .Pp .Dl device splash .Pp Next for .Xr syscons 4 , edit .Pa /boot/loader.conf (see .Xr loader.conf 5 ) and include the following lines: .Bd -literal -offset indent splash_bmp_load="YES" bitmap_load="YES" bitmap_name="/boot/chuck.bmp" .Ed .Pp In the above example, the file .Pa /boot/chuck.bmp is loaded. In the following example, the VESA module is loaded so that a bitmap file which cannot be displayed in standard VGA modes may be shown using one of the VESA video modes. .Bd -literal -offset indent splash_pcx_load="YES" vesa_load="YES" bitmap_load="YES" bitmap_name="/boot/chuck.pcx" .Ed .Pp If the VESA support is statically linked to the kernel, it is not necessary to load the VESA module. Just load the bitmap file and the splash decoder module as in the first example above. .Pp To load a binary ASCII drawing and display this while booting, include the following into your .Pa /boot/loader.conf : .Bd -literal -offset indent splash_txt_load="YES" bitmap_load="YES" bitmap_name="/boot/splash.bin" .Ed .Pp For .Xr vt 4 , edit .Pa /boot/loader.conf (see .Xr loader.conf 5 ) and include the following lines: .Bd -literal -offset indent splash="/boot/images/freebsd-logo-rev.png" boot_mute="YES" +.Ed .\".Sh DIAGNOSTICS .Sh SEE ALSO .Xr vidcontrol 1 , .Xr syscons 4 , .Xr vga 4 , .Xr loader.conf 5 , .Xr rc.conf 5 , .Xr kldload 8 , .Xr kldunload 8 .Sh HISTORY The .Nm driver first appeared in .Fx 3.1 . .Sh AUTHORS .An -nosplit The .Nm driver and this manual page were written by .An Kazutaka Yokota Aq Mt yokota@FreeBSD.org . The .Pa splash_bmp module was written by .An Michael Smith Aq Mt msmith@FreeBSD.org and .An Kazutaka Yokota . The .Pa splash_pcx module was written by .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org based on the .Pa splash_bmp code. The .Pa splash_txt module was written by .An Antony Mawer Aq Mt antony@mawer.org based on the .Pa splash_bmp code, with some additional inspiration from the .Pa daemon_saver code. The .Pa logo_saver , .Pa plasma_saver , .Pa rain_saver and .Pa warp_saver modules were written by .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org . .Sh CAVEATS The screen saver work with .Xr syscons 4 only. .Sh BUGS If you load a screen saver while another screen saver has already been loaded, the first screen saver will not be automatically unloaded and will remain in memory, wasting kernel memory space.