Index: head/libexec/rtld-elf/rtld.1 =================================================================== --- head/libexec/rtld-elf/rtld.1 (revision 366574) +++ head/libexec/rtld-elf/rtld.1 (revision 366575) @@ -1,438 +1,438 @@ .\" Copyright (c) 1995 Paul Kranenburg .\" 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. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgment: .\" This product includes software developed by Paul Kranenburg. .\" 3. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission .\" .\" 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. .\" .\" $FreeBSD$ .\" .Dd June 1, 2020 .Dt RTLD 1 .Os .Sh NAME .Nm ld-elf.so.1 , .Nm ld.so , .Nm rtld .Nd run-time link-editor .Sh DESCRIPTION The .Nm utility is a self-contained shared object providing run-time support for loading and link-editing shared objects into a process' address space. It is also commonly known as the dynamic linker. It uses the data structures contained within dynamically linked programs to determine which shared libraries are needed and loads them using the .Xr mmap 2 system call. .Pp After all shared libraries have been successfully loaded, .Nm proceeds to resolve external references from both the main program and all objects loaded. A mechanism is provided for initialization routines to be called on a per-object basis, giving a shared object an opportunity to perform any extra set-up before execution of the program proper begins. This is useful for C++ libraries that contain static constructors. .Pp When resolving dependencies for the loaded objects, .Nm translates dynamic token strings in rpath and soname. If the .Fl "z origin" option of the static linker was set when linking the binary, the token expansion is performed at the object load time, see .Xr ld 1 . The following strings are recognized now: .Bl -tag -width ".Pa $PLATFORM" .It Pa $ORIGIN Translated to the full path of the loaded object. .It Pa $OSNAME Translated to the name of the operating system implementation. .It Pa $OSREL Translated to the release level of the operating system. .It Pa $PLATFORM Translated to the machine hardware platform. .El .Pp The .Nm utility itself is loaded by the kernel together with any dynamically-linked program that is to be executed. The kernel transfers control to the dynamic linker. After the dynamic linker has finished loading, relocating, and initializing the program and its required shared objects, it transfers control to the entry point of the program. The following search order is used to locate required shared objects: .Pp .Bl -enum -offset indent -compact .It .Dv DT_RPATH of the referencing object unless that object also contains a .Dv DT_RUNPATH tag .It .Dv DT_RPATH of the program unless the referencing object contains a .Dv DT_RUNPATH tag .It Path indicated by .Ev LD_LIBRARY_PATH environment variable .It .Dv DT_RUNPATH of the referencing object .It Hints file produced by the .Xr ldconfig 8 utility .It The .Pa /lib and .Pa /usr/lib directories, unless the referencing object was linked using the .Dq Fl z Ar nodefaultlib option .El .Pp The .Nm utility recognizes a number of environment variables that can be used to modify its behaviour. On 64-bit architectures, the linker for 32-bit objects recognizes all the environment variables listed below, but is being prefixed with .Ev LD_32_ , for example: .Ev LD_32_TRACE_LOADED_OBJECTS . .Bl -tag -width ".Ev LD_LIBMAP_DISABLE" .It Ev LD_DUMP_REL_POST If set, .Nm will print a table containing all relocations after symbol binding and relocation. .It Ev LD_DUMP_REL_PRE If set, .Nm will print a table containing all relocations before symbol binding and relocation. .It Ev LD_LIBMAP A library replacement list in the same format as .Xr libmap.conf 5 . For convenience, the characters .Ql = and .Ql \&, can be used instead of a space and a newline. This variable is parsed after .Xr libmap.conf 5 , and will override its entries. This variable is unset for set-user-ID and set-group-ID programs. .It Ev LD_LIBMAP_DISABLE If set, disables the use of .Xr libmap.conf 5 and .Ev LD_LIBMAP . This variable is unset for set-user-ID and set-group-ID programs. .It Ev LD_ELF_HINTS_PATH This variable will override the default location of .Dq hints file. This variable is unset for set-user-ID and set-group-ID programs. .It Ev LD_LIBRARY_PATH A colon separated list of directories, overriding the default search path for shared libraries. This variable is unset for set-user-ID and set-group-ID programs. .It Ev LD_LIBRARY_PATH_RPATH If the variable is specified and has a value starting with any of \'y\', \'Y\' or \'1\' symbols, the path specified by .Ev LD_LIBRARY_PATH variable is allowed to override the path from .Dv DT_RPATH for binaries which does not contain .Dv DT_RUNPATH tag. For such binaries, when the variable .Ev LD_LIBRARY_PATH_RPATH is set, .Dq Fl z Ar nodefaultlib link-time option is ignored as well. .It Ev LD_PRELOAD A list of shared libraries, separated by colons and/or white space, to be linked in before any other shared libraries. If the directory is not specified then the directories specified by .Ev LD_LIBRARY_PATH will be searched first followed by the set of built-in standard directories. This variable is unset for set-user-ID and set-group-ID programs. .It Ev LD_LIBRARY_PATH_FDS A colon separated list of file descriptor numbers for library directories. This is intended for use within .Xr capsicum 4 sandboxes, when global namespaces such as the filesystem are unavailable. It is consulted just after LD_LIBRARY_PATH. This variable is unset for set-user-ID and set-group-ID programs. .It Ev LD_BIND_NOT When set to a nonempty string, prevents modifications of the PLT slots when doing bindings. As result, each call of the PLT-resolved function is resolved. In combination with debug output, this provides complete account of all bind actions at runtime. This variable is unset for set-user-ID and set-group-ID programs. .It Ev LD_BIND_NOW When set to a nonempty string, causes .Nm to relocate all external function calls before starting execution of the program. Normally, function calls are bound lazily, at the first call of each function. .Ev LD_BIND_NOW increases the start-up time of a program, but it avoids run-time surprises caused by unexpectedly undefined functions. .It Ev LD_TRACE_LOADED_OBJECTS When set to a nonempty string, causes .Nm to exit after loading the shared objects and printing a summary which includes the absolute pathnames of all objects, to standard output. .It Ev LD_TRACE_LOADED_OBJECTS_ALL When set to a nonempty string, causes .Nm to expand the summary to indicate which objects caused each object to be loaded. .It Ev LD_TRACE_LOADED_OBJECTS_FMT1 .It Ev LD_TRACE_LOADED_OBJECTS_FMT2 When set, these variables are interpreted as format strings a la .Xr printf 3 to customize the trace output and are used by .Xr ldd 1 Ns 's .Fl f option and allows .Xr ldd 1 to be operated as a filter more conveniently. If the dependency name starts with string .Pa lib , .Ev LD_TRACE_LOADED_OBJECTS_FMT1 is used, otherwise .Ev LD_TRACE_LOADED_OBJECTS_FMT2 is used. The following conversions can be used: .Bl -tag -width 4n .It Li %a The main program's name (also known as .Dq __progname ) . .It Li \&%A The value of the environment variable .Ev LD_TRACE_LOADED_OBJECTS_PROGNAME . Typically used to print both the names of programs and shared libraries being inspected using .Xr ldd 1 . .It Li %o The library name. .It Li %p The full pathname as determined by .Nm rtld Ns 's library search rules. .It Li %x The library's load address. .El .Pp Additionally, .Ql \en and .Ql \et are recognized and have their usual meaning. .It Ev LD_UTRACE If set, .Nm will log events such as the loading and unloading of shared objects via .Xr utrace 2 . .It Ev LD_LOADFLTR If set, .Nm will process the filtee dependencies of the loaded objects immediately, instead of postponing it until required. Normally, the filtees are opened at the time of the first symbol resolution from the filter object. .El .Sh DIRECT EXECUTION MODE .Nm is typically used implicitly, loaded by the kernel as requested by the .Dv PT_INTERP program header of the executed binary. .Fx also supports a direct execution mode for the dynamic linker. In this mode, the user explicitly executes .Nm and provides the path of the program to be linked and executed as an argument. This mode allows use of a non-standard dynamic linker for a program activation without changing the binary or without changing the installed dynamic linker. Execution options may be specified. .Pp The syntax of the direct invocation is .Bd -ragged -offset indent .Pa /libexec/ld-elf.so.1 .Op Fl b Ar exe .Op Fl f Ar fd .Op Fl p .Op Fl - .Pa image_path .Op Ar image arguments .Ed .Pp The options are: .Bl -tag -width indent .It Fl b Ar exe Use the executable .Fa exe instead of .Fa image_path for activation. If this option is specified, .Ar image_path is only used to provide the .Va argv[0] value to the program. .It Fl f Ar fd File descriptor .Ar fd references the binary to be activated by .Nm . It must already be opened in the process when executing .Nm . If this option is specified, .Ar image_path is only used to provide the .Va argv[0] value to the program. .It Fl p If the .Pa image_path argument specifies a name which does not contain a slash .Dq Li / character, .Nm uses the search path provided by the environment variable .Dv PATH to find the binary to execute. .It Fl v Display information about this run-time linker binary, then exit. .It Fl - Ends the .Nm options. The argument following .Fl - is interpreted as the path of the binary to execute. .El .Pp In the direct execution mode, .Nm emulates verification of the binary execute permission for the current user. -This is done to avoid breaking user expectations in naively restricted +This is done to avoid breaking user expectations in naively restricted execution environments. The verification only uses Unix .Dv DACs , ignores .Dv ACLs , and is naturally prone to race conditions. Environments which rely on such restrictions are weak and breakable on their own. .Sh VERSIONING Newer .Nm might provide some features or changes in runtime behavior that cannot be easily detected at runtime by checking of the normal exported symbols. Note that it is almost always wrong to verify .Dv __FreeBSD_version in userspace to detect features, either at compile or at run time, because either kernel, or libc, or environment variables could not match the running .Nm . .Pp To solve the problem, .Nm exports some feature indicators in the .Fx private symbols namespace .Dv FBSDprivate_1.0 . Symbols start with the .Dv _rtld_version prefix. Current list of defined symbols and corresponding features is: .Bl -tag -width indent .It Dv _rtld_version__FreeBSD_version Symbol exports the value of the .Dv __FreeBSD_version definition as it was provided during the .Nm build. The symbol is always present since the .Dv _rtld_version facility was introduced. .It Dv _rtld_version_laddr_offset The .Va l_addr member of the .Vt link_map structure contains the load offset of the shared object. Before that, .Va l_addr contained the base address of the library. See .Xr dlinfo 3 . .Pp Also it indicates the presence of .Va l_refname member of the structure. .El .Sh FILES .Bl -tag -width ".Pa /var/run/ld-elf32.so.hints" -compact .It Pa /var/run/ld-elf.so.hints Hints file. .It Pa /var/run/ld-elf32.so.hints Hints file for 32-bit binaries on 64-bit system. .It Pa /etc/libmap.conf The libmap configuration file. .It Pa /etc/libmap32.conf The libmap configuration file for 32-bit binaries on 64-bit system. .El .Sh SEE ALSO .Xr ld 1 , .Xr ldd 1 , .Xr dlinfo 3 , .Xr capsicum 4 , .Xr elf 5 , .Xr libmap.conf 5 , .Xr ldconfig 8 Index: head/share/man/man4/acpi_ibm.4 =================================================================== --- head/share/man/man4/acpi_ibm.4 (revision 366574) +++ head/share/man/man4/acpi_ibm.4 (revision 366575) @@ -1,506 +1,506 @@ .\" Copyright (c) 2005 Christian Brueffer .\" Copyright (c) 2005 Markus Brueffer .\" 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. .\" .\" $FreeBSD$ .\" .Dd June 24, 2020 .Dt ACPI_IBM 4 .Os .Sh NAME .Nm acpi_ibm .Nd "ThinkPad ACPI extras driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device acpi_ibm" .Ed .Pp Alternatively, to load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent acpi_ibm_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for hotkeys and other components of ThinkPad laptops. The main purpose of this driver is to provide an interface, accessible via .Xr sysctl 8 and .Xr devd 8 , through which applications can determine the status of various laptop components. .Pp While the .Xr sysctl 8 interface is enabled automatically after loading the driver, the .Xr devd 8 interface has to be enabled explicitly, as it may alter the default action of certain keys. This is done by setting the .Va events sysctl as described below. Specifying which keys should generate events is done by setting a bitmask, whereas each bit represents one key or key combination. This bitmask, accessible via the .Va eventmask sysctl, is set to .Va availmask by default, a value representing all possible keypress events on the specific ThinkPad model. .Ss Xr devd 8 Events Hotkey events received by .Xr devd 8 provide the following information: .Pp .Bl -tag -width "subsystem" -offset indent -compact .It system .Qq Li ACPI .It subsystem .Qq Li IBM .It type The source of the event in the ACPI namespace. The value depends on the model. .It notify Event code (see below). .El .Pp Depending on the ThinkPad model, event codes may vary. On a ThinkPad T41p these are as follows: .Pp .Bl -tag -width "subsystem" -offset indent -compact .It Li 0x01 Fn + F1 .It Li 0x02 Fn + F2 .It Li 0x03 Fn + F3 (LCD backlight) .It Li 0x04 Fn + F4 (Suspend to RAM) .It Li 0x05 Fn + F5 (Bluetooth) .It Li 0x06 Fn + F6 .It Li 0x07 Fn + F7 (Screen expand) .It Li 0x08 Fn + F8 .It Li 0x09 Fn + F9 .It Li 0x0a Fn + F10 .It Li 0x0b Fn + F11 .It Li 0x0c Fn + F12 (Suspend to disk) .It Li 0x0d Fn + Backspace .It Li 0x0e Fn + Insert .It Li 0x0f Fn + Delete .It Li 0x10 Fn + Home (Brightness up) .It Li 0x11 Fn + End (Brightness down) .It Li 0x12 Fn + PageUp (ThinkLight) .It Li 0x13 Fn + PageDown .It Li 0x14 Fn + Space (Zoom) .It Li 0x15 Volume Up .It Li 0x16 Volume Down .It Li 0x17 Mute .It Li 0x18 Access IBM Button .El .Ss Xr led 4 Interface The .Nm driver provides a .Xr led 4 interface for the ThinkLight. The ThinkLight can be made to blink by writing .Tn ASCII strings to the .Pa /dev/led/thinklight device. .Sh SYSCTL VARIABLES The following sysctls are currently implemented: .Bl -tag -width indent .It Va dev.acpi_ibm.0.initialmask (read-only) Bitmask of ACPI events before the .Nm driver was loaded. .It Va dev.acpi_ibm.0.availmask (read-only) Bitmask of all supported ACPI events. .It Va dev.acpi_ibm.0.events Enable ACPI events and set the .Va eventmask to .Va availmask . Without the .Nm driver being loaded, only the Fn+F4 button generates an ACPI event. .It Va dev.acpi_ibm.0.eventmask Sets the ACPI events which are reported to .Xr devd 8 . Fn+F3, Fn+F4 and Fn+F12 always generate ACPI events, regardless which value .Va eventmask has. Depending on the ThinkPad model, the meaning of different bits in the .Va eventmask may vary. On a ThinkPad T41p this is a bitwise OR of the following: .Pp .Bl -tag -width indent-two -compact .It Li 1 Fn + F1 .It Li 2 Fn + F2 .It Li 4 Fn + F3 (LCD backlight) .It Li 8 Fn + F4 (Suspend to RAM) .It Li 16 Fn + F5 (Bluetooth) .It Li 32 Fn + F6 .It Li 64 Fn + F7 (Screen expand) .It Li 128 Fn + F8 .It Li 256 Fn + F9 .It Li 512 Fn + F10 .It Li 1024 Fn + F11 .It Li 2048 Fn + F12 (Suspend to disk) .It Li 4096 Fn + Backspace .It Li 8192 Fn + Insert .It Li 16384 Fn + Delete .It Li 32768 Fn + Home (Brightness up) .It Li 65536 Fn + End (Brightness down) .It Li 131072 Fn + PageUp (ThinkLight) .It Li 262144 Fn + PageDown .It Li 524288 Fn + Space (Zoom) .It Li 1048576 Volume Up .It Li 2097152 Volume Down .It Li 4194304 Mute .It Li 8388608 Access IBM Button .El .It Va dev.acpi_ibm.0.hotkey (read-only) Status of several buttons. Every time a button is pressed, the respecting bit is toggled. It is a bitwise OR of the following: .Pp .Bl -tag -width indent-two -compact .It Li 1 Home Button .It Li 2 Search Button .It Li 4 Mail Button .It Li 8 Access IBM Button .It Li 16 Zoom .It Li 32 Wireless LAN Button .It Li 64 Video Button .It Li 128 Hibernate Button .It Li 256 ThinkLight Button .It Li 512 Screen Expand .It Li 1024 Brightness Up/Down Button .It Li 2048 Volume Up/Down/Mute Button .El .It Va dev.acpi_ibm.0.lcd_brightness Current brightness level of the display. .It Va dev.acpi_ibm.0.volume Speaker volume. .It Va dev.acpi_ibm.0.mute Indicates, whether the speakers are muted or not. .It Va dev.acpi_ibm.0.mic_mute -Indicates, whether the microphone led (present on some model) is on or not. +Indicates, whether the microphone led (present on some model) is on or not. Note that this does not mean that the microphone input is muted. .It Va dev.acpi_ibm.0.thinklight Indicates, whether the ThinkLight keyboard light is activated or not. .It Va dev.acpi_ibm.0.bluetooth Toggle Bluetooth chip activity. .It Va dev.acpi_ibm.0.wlan (read-only) Indicates whether the WLAN chip is active or not. .It Va dev.acpi_ibm.0.fan Indicates whether the fan is in automatic (1) or manual (0) mode. Default is automatic mode. This sysctl should be used with extreme precaution, since disabling automatic fan control might overheat the ThinkPad and lead to permanent damage if the .Va fan_level is not set accordingly. .It Va dev.acpi_ibm.0.fan_level Indicates at what speed the fan should run when being in manual mode. Valid values range from 0 (off) to 7 (max) and 8. Level 8 is used by the driver to set the fan in unthrottled mode. In this mode, the fan is set to spin freely and will quickly reach a very high speed. Use this mode only if absolutely necessary, e.g., if the system has reached its critical temperature and it is about to shut down. The resulting speed differs from model to model. On a T41p this is as follows: .Pp .Bl -tag -width indent-two -compact .It Li 0 off .It Li 1, 2 ~3000 RPM .It Li 3, 4, 5 ~3600 RPM .It Li 6, 7 ~4300 RPM .It Li 8 ~6400 RPM (Full-speed, unthrottled) .El .It Va dev.acpi_ibm.0.fan_speed (read-only) Fan speed in rounds per minute. A few older ThinkPads report the fan speed in levels ranging from 0 (off) to 7 (max). .It Va dev.acpi_ibm.0.thermal (read-only) Shows the readings of up to eight different temperature sensors. Most ThinkPads include six or more temperature sensors but only expose the CPU temperature through .Xr acpi_thermal 4 . Some ThinkPads have the below sensor layout which might vary depending on the specific model: .Pp .Bl -enum -compact .It CPU .It Mini PCI Module .It HDD .It GPU .It Built-in battery .It UltraBay battery .It Built-in battery .It UltraBay battery .El .It Va dev.acpi_ibm.0.handlerevents .Xr devd 8 events handled by .Nm when .Va events is set to 1. Events are specified as a whitespace-separated list of event code in hexadecimal or decimal form. Note that the event maybe handled twice (e.g., Brightness up/down) if ACPI BIOS already handled the event. .El .Pp Defaults for these sysctls can be set in .Xr sysctl.conf 5 . .Sh FILES .Bl -tag -width ".Pa /dev/led/thinklight" .It Pa /dev/led/thinklight ThinkLight .Xr led 4 device node .El .Sh EXAMPLES The following can be added to .Xr devd.conf 5 in order to pass button events to a .Pa /usr/local/sbin/acpi_oem_exec.sh script: .Bd -literal -offset indent notify 10 { match "system" "ACPI"; match "subsystem" "IBM"; action "/usr/local/sbin/acpi_oem_exec.sh $notify ibm"; }; .Ed .Pp A possible .Pa /usr/local/sbin/acpi_oem_exec.sh script might look like: .Bd -literal -offset indent #!/bin/sh # if [ "$1" = "" -o "$2" = "" ] then echo "usage: $0 notify oem_name" exit 1 fi NOTIFY=`echo $1` LOGGER="logger" CALC="bc" BC_PRECOMMANDS="scale=2" ECHO="echo" CUT="cut" MAX_LCD_BRIGHTNESS=7 MAX_VOLUME=14 OEM=$2 DISPLAY_PIPE=/tmp/acpi_${OEM}_display case ${NOTIFY} in 0x05) LEVEL=`sysctl -n dev.acpi_${OEM}.0.bluetooth` if [ "$LEVEL" = "1" ] then sysctl dev.acpi_${OEM}.0.bluetooth=0 MESSAGE="bluetooth disabled" else sysctl dev.acpi_${OEM}.0.bluetooth=1 MESSAGE="bluetooth enabled" fi ;; 0x10|0x11) LEVEL=`sysctl -n dev.acpi_${OEM}.0.lcd_brightness` PERCENT=`${ECHO} "${BC_PRECOMMANDS} ; \\ ${LEVEL} / ${MAX_LCD_BRIGHTNESS} * 100" |\\ ${CALC} | ${CUT} -d . -f 1` MESSAGE="brightness level ${PERCENT}%" ;; 0x12) LEVEL=`sysctl -n dev.acpi_${OEM}.0.thinklight` if [ "$LEVEL" = "1" ] then MESSAGE="thinklight enabled" else MESSAGE="thinklight disabled" fi ;; 0x15|0x16) LEVEL=`sysctl -n dev.acpi_${OEM}.0.volume` PERCENT=`${ECHO} "${BC_PRECOMMANDS} ; \\ ${LEVEL} / ${MAX_VOLUME} * 100" | \\ ${CALC} | ${CUT} -d . -f 1` MESSAGE="volume level ${PERCENT}%" ;; 0x17) LEVEL=`sysctl -n dev.acpi_${OEM}.0.mute` if [ "$LEVEL" = "1" ] then MESSAGE="volume muted" else MESSAGE="volume unmuted" fi ;; 0x1b) LEVEL=`sysctl -n dev.acpi_ibm.0.mic_led` if [ $LEVEL -eq 0 ]; then sysctl dev.acpi_ibm.0.mic_led=1 mixer rec 0 - fi - if [ $LEVEL -eq 1 ]; then + fi + if [ $LEVEL -eq 1 ]; then sysctl dev.acpi_ibm.0.mic_led=0 mixer rec 30 fi ;; *) ;; esac ${LOGGER} ${MESSAGE} if [ -p ${DISPLAY_PIPE} ] then ${ECHO} ${MESSAGE} >> ${DISPLAY_PIPE} & fi exit 0 .Ed .Pp The following example specify that event code 0x04 (Suspend to RAM), 0x10 (Brightness up) and 0x11 (Brightness down) are handled by .Nm . .Bd -literal -offset indent sysctl dev.acpi_ibm.0.handlerevents='0x04 0x10 0x11' .Ed .Pp in .Xr sysctl.conf 5 : .Bd -literal -offset indent dev.acpi_ibm.0.handlerevents=0x04\\ 0x10\\ 0x11 .Ed .Sh SEE ALSO .Xr acpi 4 , .Xr led 4 , .Xr sysctl.conf 5 , .Xr devd 8 , .Xr sysctl 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 6.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Takanori Watanabe Aq Mt takawata@FreeBSD.org and later mostly rewritten by .An Markus Brueffer Aq Mt markus@FreeBSD.org . This manual page was written by .An Christian Brueffer Aq Mt brueffer@FreeBSD.org and .An Markus Brueffer Aq Mt markus@FreeBSD.org . Index: head/share/man/man4/man4.i386/glxiic.4 =================================================================== --- head/share/man/man4/man4.i386/glxiic.4 (revision 366574) +++ head/share/man/man4/man4.i386/glxiic.4 (revision 366575) @@ -1,106 +1,107 @@ .\" Copyright (c) 2011 Henrik Brix Andersen .\" 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 ``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. .\" .\" $FreeBSD$ .\" .Dd May 15, 2011 .Dt GLXIIC 4 i386 .Os .Sh NAME .Nm glxiic .Nd Geode LX CS5536 I2C controller driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device pci" .Cd "device isa" .Cd "device glxiic" .Cd "device iicbus" .Ed .Pp Alternatively, to load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent glxiic_load="YES" .Ed .Sh DESCRIPTION The .Nm driver supports the System Management Bus controller of the Geode LX -series CS5536 Companion Device. The Geode LX is a member of the AMD -Geode family of integrated x86 system chips. +series CS5536 Companion Device. +The Geode LX is a member of the AMD Geode family of integrated x86 system chips. .Pp Although AMD refers to this device as a System Management Bus (SMBus) controller, it is really an I2C controller (it lacks SMBus ALERT# and Alert Response support). .Pp The .Nm driver supports both I2C master and slave mode. .Sh SYSCTL VARIABLE The .Nm driver supports the following variable as both .Xr sysctl 8 and .Xr loader 8 tunable: .Bl -tag -width indent .It Va dev.glxiic.0.timeout -This variable controls the I2C bus timeout in milliseconds. The -default timeout is 35 milliseconds. A value of zero disables the -timeout. +This variable controls the I2C bus timeout in milliseconds. +The default timeout is 35 milliseconds. +A value of zero disables the timeout. .El .Sh CAVEAT The .Nm driver uses the interrupt line number configured by the board firmware -by default. If no interrupt line number has been configured by the -board firmware (or to override the interrupt line number configured by -board firmware), place the following line in +by default. +If no interrupt line number has been configured by the board firmware +(or to override the interrupt line number configured by board firmware), +place the following line in .Xr device.hints 5 : .Bd -ragged -offset indent hint.glxiic.0.irq="10" .Ed .Pp The interrupt line number must be between 1 and 15. .Sh SEE ALSO .Xr iicbus 4 , .Xr device.hints 5 , .Xr loader.conf 5 , .Xr loader 8 , .Xr sysctl 8 .Sh HISTORY The .Nm device driver and manual page first appeared in .Fx 9.0 . .Sh AUTHORS .An -nosplit The .Nm device driver and manual page were written by .An Henrik Brix Andersen Aq Mt brix@FreeBSD.org . Index: head/share/man/man4/man4.powerpc/smu.4 =================================================================== --- head/share/man/man4/man4.powerpc/smu.4 (revision 366574) +++ head/share/man/man4/man4.powerpc/smu.4 (revision 366575) @@ -1,124 +1,126 @@ .\"- .\" Copyright (c) 2010 Nathan Whitehorn .\" 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 ``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. .\" .\" $FreeBSD$ .\" .Dd February 22, 2010 .Dt SMU 4 .Os .Sh NAME .Nm smu .Nd Apple System Management Unit Driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device smu" .Ed .Sh DESCRIPTION The .Nm driver provides support for the System Management Unit (SMU) found in many Apple G5 systems. This includes most Power Macintosh G5 and all iMac G5 systems. .Pp The Apple SMU controller provides software power management and thermal control functionality, and is responsible for managing system cooling devices. .Sh HARDWARE Chips supported by the .Nm driver include: .Pp .Bl -bullet -compact .It Apple System Management Unit .El .Sh THERMAL MANAGEMENT The .Nm -driver provides basic automatic thermal management. Without a userspace -daemon providing more advanced control, the driver will attempt to maintain -system temperatures in a conservative range through coarse-grained control of -system cooling devices (see below). Automatic kernel-level thermal control -will take over if more than 3 seconds elapses between userspace cooling -setting adjustments. +driver provides basic automatic thermal management. +Without a userspace daemon providing more advanced control, the driver will +attempt to maintain system temperatures in a conservative range through +coarse-grained control of system cooling devices (see below). +Automatic kernel-level thermal control will take over if more than 3 +seconds elapses between userspace cooling setting adjustments. .Sh SYSCTL VARIABLES The .Nm driver provides power management services and thermal readout through a sysctl interface. -The following sysctls can be used to control the -power management behavior and to examine current system power and -thermal conditions. +The following sysctls can be used to control the power management behavior +and to examine current system power and thermal conditions. .Bl -tag -width indent .It Va dev.smu.%d.server_mode Restart after power failure behavior (1 causes system to reboot after power cut, 0 causes system to remain off). .It Va dev.smu.%d.target_temp -Target system temperature, in degrees Celsius. The +Target system temperature, in degrees Celsius. +The .Nm driver will attempt to adjust fans to maintain the temperature of the warmest component in the system at or below this level. .It Va dev.smu.%d.critical_temp -System critical temperature, in degrees Celsius. If any component in -the system exceeds this temperature, the machine will be shut down within -500 ms. +System critical temperature, in degrees Celsius. +If any component in the system exceeds this temperature, the machine +will be shut down within 500 ms. .It Va dev.smu.%d.fans.%s.minrpm Minimum allowed speed for this fan. .It Va dev.smu.%d.fans.%s.maxrpm Maximum allowed speed for this fan. .It Va dev.smu.%d.fans.%s.rpm -Current speed for this fan. The fan speed can be adjusted by changing this -sysctl. If more than 3 seconds elapses between fan speed adjustments, the -kernel will resume automatic control of the fan. +Current speed for this fan. +The fan speed can be adjusted by changing this sysctl. +If more than 3 seconds elapses between fan speed adjustments, the kernel will +resume automatic control of the fan. .It Va dev.smu.%d.sensors.%s -Current reading from this sensor. Four sensor types are supported. Temperature -sensors are in units of degrees Celsius, current sensors in milliamps, voltage -sensors in millivolts, and power sensors in milliwatts. +Current reading from this sensor. +Four sensor types are supported. +Temperature sensors are in units of degrees Celsius, current sensors in +milliamps, voltage sensors in millivolts, and power sensors in milliwatts. .El .Sh LED INTERFACE The .Nm driver provides an .Xr led 4 annunciator interface at .Pa /dev/led/sleepled . .Sh SEE ALSO .Xr acpi 4 , .Xr led 4 , .Xr pmu 4 .Sh HISTORY The .Nm device driver appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org . Index: head/share/man/man4/ng_checksum.4 =================================================================== --- head/share/man/man4/ng_checksum.4 (revision 366574) +++ head/share/man/man4/ng_checksum.4 (revision 366575) @@ -1,143 +1,147 @@ .\" Copyright (c) 2015 Dmitry Vagin .\" 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. .\" .\" $FreeBSD$ .\" .Dd October 29, 2015 .Dt NG_CHECKSUM 4 .Os .Sh NAME .Nm ng_checksum .Nd reconstructing IP checksums node type .Sh SYNOPSIS .In netgraph/ng_checksum.h .Sh DESCRIPTION The .Nm checksum node can calculate, or prepare for calculation in hardware, IPv4 header, TCP and UDP checksums. .Sh HOOKS This node type has two hooks: .Bl -tag -width ".Va out" .It Va in Packets received on this hook are processed according to settings specified in config and then forwarded to the .Ar out -hook, if it exists and is connected. Otherwise they are reflected back to the +hook, if it exists and is connected. +Otherwise they are reflected back to the .Ar in hook. .It Va out Packets received on this hook are forwarded to the .Ar in hook without any changes. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: .Bl -tag -width foo .It Dv NGM_CHECKSUM_SETDLT Pq Ic setdlt Sets the data link type on the .Va in -hook. Currently, supported types are +hook. +Currently, supported types are .Cm DLT_RAW (raw IP datagrams) and .Cm DLT_EN10MB (Ethernet). DLT_ definitions can be found in the .In net/bpf.h -header. Currently used values are +header. +Currently used values are .Cm DLT_EN10MB = 1 and .Cm DLT_RAW = 12. .It Dv NGM_CHECKSUM_GETDLT Pq Ic getdlt This control message obtains the data link type on the .Va in hook. .It Dv NGM_CHECKSUM_SETCONFIG Pq Ic setconfig -Sets the node configuration. The following +Sets the node configuration. +The following .Vt "struct ng_checksum_config" must be supplied as an argument: .Bd -literal -offset 4n struct ng_checksum_config { uint64_t csum_flags; uint64_t csum_offload; }; .Ed .Pp The .Va csum_flags can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6 (other values are ignored) for instructing the node to calculate the corresponding checksum. .Pp The .Va csum_offload value can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6 (other values are ignored) for instructing the node what checksums should be requested from the hardware. .Pp The node also takes into account any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6 already flagged on the mbuf. .It Dv NGM_CHECKSUM_GETCONFIG Pq Ic getconfig This control message obtains the current node configuration returned as a .Vt "struct ng_checksum_config" . .It Dv NGM_CHECKSUM_GET_STATS Pq Ic getstats Returns node statistics as a .Vt "struct ng_checksum_stats" . .It Dv NGM_CHECKSUM_CLR_STATS Pq Ic clrstats Clear the node statistics. .It Dv NGM_CHECKSUM_GETCLR_STATS Pq Ic getclrstats This command is identical to .Dv NGM_CHECKSUM_GET_STATS , except that the statistics are also atomically cleared. .El .Sh SHUTDOWN This node shuts down upon receipt of a .Dv NGM_SHUTDOWN control message, or when all hooks have been disconnected. .Sh EXAMPLES .Xr ngctl 8 script: .Bd -literal -offset 4n /usr/sbin/ngctl -f- <<-SEQ msg checksum-1: setdlt 1 msg checksum-1: setconfig { csum_flags=0 csum_offload=6 } SEQ .Ed .Pp Set the data link type to .Cm DLT_EN10MB (Ethernet), do not set additional checksum flags and request that the hardware calculate CSUM_IP_UDP|CSUM_IP_TCP. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_patch 4 , .Xr ngctl 8 .Sh HISTORY The .Nm node type was implemented in .Fx 10.2 and first submitted in .Fx 12.0 . .Sh AUTHORS .An "Dmitry Vagin" Aq daemon.hammer@ya.ru . Index: head/stand/defaults/loader.conf.5 =================================================================== --- head/stand/defaults/loader.conf.5 (revision 366574) +++ head/stand/defaults/loader.conf.5 (revision 366575) @@ -1,378 +1,377 @@ .\" Copyright (c) 1999 Daniel C. Sobral .\" 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. .\" .\" $FreeBSD$ .Dd April 29, 2020 .Dt LOADER.CONF 5 .Os .Sh NAME .Nm loader.conf .Nd "system bootstrap configuration information" .Sh DESCRIPTION The file .Nm contains descriptive information on bootstrapping the system. Through it you can specify the kernel to be booted, parameters to be passed to it, and additional modules to be loaded; and generally set all variables described in .Xr loader 8 . -.Pp .Sh SYNTAX Though .Nm Ns 's format was defined explicitly to resemble .Xr rc.conf 5 , and can be sourced by .Xr sh 1 , some settings are treated in a special fashion. Also, the behavior of some settings is defined by the setting's suffix; the prefix identifies which module the setting controls. .Pp The general parsing rules are: .Bl -bullet .It Spaces and empty lines are ignored. .It A # sign will mark the remainder of the line as a comment. .It Only one setting can be present on each line. .El .Pp All settings have the following format: .Pp .Dl variable="value" .Pp Unless it belongs to one of the classes of settings that receive special treatment, a setting will set the value of a .Xr loader 8 environment variable. The settings that receive special treatment are listed below. Settings beginning with .Qq * below define the modules to be loaded and may have any prefix; the prefix identifies a module. All such settings sharing a common prefix refer to the same module. .Bl -tag -width Ar .It Ar exec Immediately executes a .Xr loader 8 command. This type of setting cannot be processed by programs other than .Xr loader 8 , so its use should be avoided. Multiple instances of it will be processed independently. .It Ar loader_conf_files Defines additional configuration files to be processed right after the present file. .Ar loader_conf_files should be treated as write-only. One cannot depend on any value remaining in the loader environment or carried over into the kernel environment. .It Ar kernel Name of the kernel to be loaded. If no kernel name is set, no additional modules will be loaded. The name must be a subdirectory of .Pa /boot that contains a kernel. .It Ar kernel_options Flags to be passed to the kernel. .It Ar vfs.root.mountfrom Specify the root partition to mount. For example: .Pp .Dl vfs.root.mountfrom="ufs:/dev/da0s1a" .Pp .Xr loader 8 automatically calculates the value of this tunable from .Pa /etc/fstab from the partition the kernel was loaded from. The calculated value might be calculated incorrectly when .Pa /etc/fstab is not available during .Xr loader 8 startup (as during diskless booting from NFS), or if a different device is desired by the user. The preferred value can be set in .Pa /loader.conf . .Pp The value can also be overridden from the .Xr loader 8 command line. This is useful for system recovery when .Pa /etc/fstab is damaged, lost, or read from the wrong partition. .It Ar password Protect boot menu with a password without interrupting .Ic autoboot process. The password should be in clear text format. If a password is set, boot menu will not appear until any key is pressed during countdown period specified by .Va autoboot_delay variable or .Ic autoboot process fails. In both cases user should provide specified password to be able to access boot menu. .It Ar bootlock_password Provides a password to be required by check-password before execution is allowed to continue. The password should be in clear text format. If a password is set, the user must provide specified password to boot. .It Ar verbose_loading If set to .Dq YES , module names will be displayed as they are loaded. .It Ar module_blacklist Blacklist of modules. Modules specified in the blacklist may not be loaded automatically with a .Ar *_load directive, but they may be loaded directly at the .Xr loader 8 prompt. Blacklisted modules may still be loaded indirectly as dependencies of other modules. .It Ar *_load If set to .Dq YES , that module will be loaded. If no name is defined (see below), the module's name is taken to be the same as the prefix. .It Ar *_name Defines the name of the module. .It Ar *_type Defines the module's type. If none is given, it defaults to a kld module. .It Ar *_flags Flags and parameters to be passed to the module. .It Ar *_before Commands to be executed before the module is loaded. Use of this setting should be avoided. .It Ar *_after Commands to be executed after the module is loaded. Use of this setting should be avoided. .It Ar *_error Commands to be executed if the loading of a module fails. Except for the special value .Dq abort , which aborts the bootstrap process, use of this setting should be avoided. .El .Pp .Em WARNING: developers should never use these suffixes for any kernel environment variables (tunables) or conflicts will result. .Sh DEFAULT SETTINGS Most of .Nm Ns 's default settings can be ignored. The few of them which are important or useful are: .Bl -tag -width bootfile -offset indent .It Va bitmap_load .Pq Dq NO If set to .Dq YES , a bitmap will be loaded to be displayed on screen while booting. .It Va bitmap_name .Pq Dq Pa /boot/splash.bmp Name of the bitmap to be loaded. Any other name can be used. .It Va comconsole_speed .Dq ( 9600 or the value of the .Va BOOT_COMCONSOLE_SPEED variable when .Xr loader 8 was compiled). Sets the speed of the serial console. If the previous boot loader stage specified that a serial console is in use then the default speed is determined from the current serial port speed setting. .It Va console .Pq Dq vidconsole .Dq comconsole selects serial console, .Dq vidconsole selects the video console, .Dq nullconsole selects a mute console (useful for systems with neither a video console nor a serial port), and .Dq spinconsole selects the video console which prevents any input and hides all output replacing it with .Dq spinning character (useful for embedded products and such). .It Va efi_max_resolution Specify the maximum desired resolution for the EFI console. The following values are accepted: .Bl -column "WidthxHeight" .It Sy Value Ta Sy Resolution .It 480p Ta 640x480 .It 720p Ta 1280x720 .It 1080p Ta 1920x1080 .It 2160p Ta 3840x2160 .It 4k Ta 3840x2160 .It 5k Ta 5120x2880 .It Va Width Ns x Ns Va Height Ta Va Width Ns x Ns Va Height .El .It Va kernel .Pq Dq kernel .It Va kernels .Pq Dq kernel kernel.old Space or comma separated list of kernels to present in the boot menu. .It Va loader_conf_files .Pq Dq Pa /boot/loader.conf /boot/loader.conf.local .It Va splash_bmp_load .Pq Dq NO If set to .Dq YES , will load the splash screen module, making it possible to display a bmp image on the screen while booting. .It Va splash_pcx_load .Pq Dq NO If set to .Dq YES , will load the splash screen module, making it possible to display a pcx image on the screen while booting. .It Va vesa_load .Pq Dq NO If set to .Dq YES , the vesa module will be loaded, enabling bitmaps above VGA resolution to be displayed. .It Va beastie_disable If set to .Dq YES , the beastie boot menu will be skipped. .It Va loader_logo Pq Dq Li orbbw Selects a desired logo in the beastie boot menu. Possible values are: .Dq Li orbbw , .Dq Li orb , .Dq Li fbsdbw , .Dq Li beastiebw , .Dq Li beastie , and .Dq Li none . .It Va loader_color If set to .Dq NO , the beastie boot menu will be displayed without ANSI coloring. .It Va entropy_cache_load .Pq Dq YES If set to .Dq NO , the very early boot-time entropy file will not be loaded. See the entropy entries in .Xr rc.conf 5 . .It Va entropy_cache_name .Pq Dq /boot/entropy The name of the very early boot-time entropy cache file. .It Va cpu_microcode_load .Pq Dq NO If set to .Dq YES , the microcode update file specified by .Va cpu_microcode_name will be loaded and applied very early during boot. This provides functionality similar to .Xr cpucontrol 8 but ensures that CPU features enabled by microcode updates can be used by the kernel. The update will be re-applied automatically when resuming from an ACPI sleep state. If the update file contains updates for multiple processor models, the kernel will search for and extract a matching update. Currently this setting is supported only on Intel .Dv i386 and .Dv amd64 processors. It has no effect on other processor types. .It Va cpu_microcode_name A path to a microcode update file. .El .Sh OTHER SETTINGS Other settings that may be used in .Nm that have no default value: .Bl -tag -width bootfile -offset indent .It Va fdt_overlays Specifies a comma-delimited list of FDT overlays to apply. .Pa /boot/dtb/overlays is created by default for overlays to be placed in. .It Va kernels_autodetect If set to .Dq YES , attempt to auto-detect kernels installed in .Pa /boot . This is an option specific to the Lua-based loader. It is not available in the default Forth-based loader. .El .Sh FILES .Bl -tag -width /boot/defaults/loader.conf -compact .It Pa /boot/defaults/loader.conf default settings -- do not change this file. .It Pa /boot/loader.conf user defined settings. .It Pa /boot/loader.conf.local machine-specific settings for sites with a common loader.conf. .El .Sh SEE ALSO .Xr rc.conf 5 , .Xr boot 8 , .Xr cpucontrol 8 , .Xr loader 8 , .Xr loader.4th 8 .Sh HISTORY The file .Nm first appeared in .Fx 3.2 . .Sh AUTHORS This manual page was written by .An Daniel C. Sobral Aq dcs@FreeBSD.org . .Sh BUGS The .Xr loader 8 stops reading .Nm when it encounters a syntax error, so any options which are vital for booting a particular system (i.e.\& .Dq Va hw.ata.ata_dma Ns "=0" ) should precede any experimental additions to .Nm . Index: head/stand/forth/beastie.4th.8 =================================================================== --- head/stand/forth/beastie.4th.8 (revision 366574) +++ head/stand/forth/beastie.4th.8 (revision 366575) @@ -1,173 +1,177 @@ .\" Copyright (c) 2011-2012 Devin Teske .\" 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. .\" .\" $FreeBSD$ .\" .Dd January 6, 2016 .Dt BEASTIE.4TH 8 .Os .Sh NAME .Nm beastie.4th .Nd FreeBSD ASCII art boot module .Sh DESCRIPTION The file that goes by the name of .Nm is a set of commands designed to draw the ASCII art FreeBSD mascot \(en known simply as .Em beastie \(en to the right of the boot loader menu. The commands of .Nm by themselves are not enough for most uses. Please refer to the examples below for the most common situations, and to .Xr loader 8 for additional commands. .Pp Before using any of the commands provided in .Nm , it must be included through the command: .Pp .Dl include beastie.4th .Pp This line is present in the default .Pa /boot/loader.rc file, so it is not needed (and should not be re-issued) in a normal setup. .Pp The commands provided by it are: .Pp .Bl -tag -width disable-module_module -compact -offset indent .It Ic draw-beastie Draws the FreeBSD logo. .Pp The logo that is drawn is configured by setting the .Ic loader_logo variable in .Xr loader.conf 5 to one of .Dq Li beastie , .Dq Li beastiebw , .Dq Li fbsdbw , .Dq Li orb , and .Dq Li orbbw (the default). .Pp The position of the logo can be configured by setting the .Ic loader_logo_x and .Ic loader_logo_y variables in .Xr loader.conf 5 . The default values are 46 (x) and 4 (y). .Pp .It Ic clear-beastie Clears the screen of beastie. .Pp .It Ic beastie-start Initializes the interactive boot loader menu. .Pp The .Ic loader_delay variable can be configured in .Xr loader.conf 5 to the number of seconds you would like to delay loading the boot menu. During the delay the user can press Ctrl-C to fall back to .Ic autoboot or ENTER to proceed. The default behavior is to not delay. .El .Pp The environment variables that effect its behavior are: .Bl -tag -width bootfile -offset indent .It Va loader_logo -Selects the desired logo in the beastie boot menu. Possible values are: +Selects the desired logo in the beastie boot menu. +Possible values are: .Dq Li fbsdbw , .Dq Li beastie , .Dq Li beastiebw , .Dq Li orb , .Dq Li orbbw (default), and .Dq Li none . .It Va loader_logo_x -Sets the desired column position of the logo. Default is 46. +Sets the desired column position of the logo. +Default is 46. .It Va loader_logo_y -Sets the desired row position of the logo. Default is 4. +Sets the desired row position of the logo. +Default is 4. .It Va beastie_disable If set to .Dq YES , the beastie boot menu will be skipped. The beastie boot menu is always skipped if running non-x86 hardware. .It Va loader_delay If set to a number higher than zero, introduces a delay before starting the -beastie boot menu. During the delay the user can press either Ctrl-C to skip -the menu or ENTER to proceed to the menu. The default is to not delay when -loading the menu. +beastie boot menu. +During the delay the user can press either Ctrl-C to skip the menu or ENTER +to proceed to the menu. +The default is to not delay when loading the menu. .El .Sh FILES .Bl -tag -width /boot/loader.4th -compact .It Pa /boot/loader The .Xr loader 8 . .It Pa /boot/beastie.4th .Nm itself. .It Pa /boot/loader.rc .Xr loader 8 bootstrapping script. .El .Sh EXAMPLES Standard i386 .Pa /boot/loader.rc : .Pp .Bd -literal -offset indent -compact include /boot/beastie.4th beastie-start .Ed .Pp Set a different logo in .Xr loader.conf 5 : .Pp .Bd -literal -offset indent -compact loader_logo="beastie" .Ed .Sh SEE ALSO .Xr loader.conf 5 , .Xr loader 8 , .Xr loader.4th 8 .Sh HISTORY The .Nm set of commands first appeared in .Fx 5.1 . .Sh AUTHORS The .Nm set of commands was written by .An -nosplit .An Scott Long Aq scottl@FreeBSD.org , .An Aleksander Fafula Aq alex@fafula.com and .An Devin Teske Aq dteske@FreeBSD.org . Index: head/stand/forth/brand.4th.8 =================================================================== --- head/stand/forth/brand.4th.8 (revision 366574) +++ head/stand/forth/brand.4th.8 (revision 366575) @@ -1,125 +1,128 @@ .\" Copyright (c) 2011 Devin Teske .\" 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. .\" .\" $FreeBSD$ .\" .Dd May 18, 2011 .Dt BRAND.4TH 8 .Os .Sh NAME .Nm brand.4th .Nd FreeBSD ASCII art boot module .Sh DESCRIPTION The file that goes by the name of .Nm is a set of commands designed to draw the ASCII art BSD brand above the boot loader menu. The commands of .Nm by themselves are not enough for most uses. Please refer to the examples below for the most common situations, and to .Xr loader 8 for additional commands. .Pp Before using any of the commands provided in .Nm , it must be included through the command: .Pp .Dl include brand.4th .Pp This line is present in the default .Pa /boot/menu.rc file, so it is not needed (and should not be re-issued) in a normal setup. .Pp The commands provided by it are: .Pp .Bl -tag -width disable-module_module -compact -offset indent .It Ic draw-brand Draws the BSD brand. .Pp The brand that is drawn is configured by setting the .Ic loader_brand variable in .Xr loader.conf 5 to one of .Dq Li fbsd (the default) or .Dq Li none . .Pp The position of the logo can be configured by setting the .Ic loader_brand_x and .Ic loader_brand_y variables in .Xr loader.conf 5 . The default values are 2 (x) and 1 (y). .El .Pp The environment variables that effect its behavior are: .Bl -tag -width bootfile -offset indent .It Va loader_brand -Selects the desired brand in the beastie boot menu. Possible values are: +Selects the desired brand in the beastie boot menu. +Possible values are: .Dq Li fbsd (default) or .Dq Li none . .It Va loader_brand_x -Sets the desired column position of the brand. Default is 2. +Sets the desired column position of the brand. +Default is 2. .It Va loader_brand_y -Sets the desired row position of the brand. Default is 1. +Sets the desired row position of the brand. +Default is 1. .El .Sh FILES .Bl -tag -width /boot/loader.4th -compact .It Pa /boot/loader The .Xr loader 8 . .It Pa /boot/brand.4th .Nm itself. .It Pa /boot/loader.rc .Xr loader 8 bootstrapping script. .El .Sh EXAMPLES Set FreeBSD brand in .Xr loader.conf 5 : .Pp .Bd -literal -offset indent -compact loader_brand="fbsd" .Ed .Sh SEE ALSO .Xr loader.conf 5 , .Xr loader 8 .Sh HISTORY The .Nm set of commands first appeared in .Fx 9.0 . .Sh AUTHORS The .Nm set of commands was written by .An -nosplit .An Devin Teske Aq dteske@FreeBSD.org . Index: head/tools/tools/ether_reflect/ether_reflect.1 =================================================================== --- head/tools/tools/ether_reflect/ether_reflect.1 (revision 366574) +++ head/tools/tools/ether_reflect/ether_reflect.1 (revision 366575) @@ -1,109 +1,113 @@ .\" Copyright (c) 2008 George V. Neville-Neil .\" 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. .\" .\" $FreeBSD$ .\" .Dd December 23, 2008 .Dt ETHER_REFLECT 1 .Os .Sh NAME .Nm ether_reflect .Nd "reflect ethernet packets" .Sh SYNOPSIS .Nm .Op Fl a Ar ethernet address .Op Fl e Ar ethertype .Op Fl i Ar interface .Op Fl t Ar timeout .Op Fl p .Op Fl d .Sh DESCRIPTION The .Nm command implements a simple ethernet packet reflector using the .Xr PCAP 3 library and .Xr bpf 4 , -the Berkeley Packet Filter. The program is useful primarily to test -the low level round trip time of packets through an Ethernet interface -and/or a switch. Network protocols, such as IP, and the network stack -in general are never invoked, only the device driver that implements -the particular interface is executed. As the +the Berkeley Packet Filter. +The program is useful primarily to test the low level round trip time +of packets through an Ethernet interface and/or a switch. +Network protocols, such as IP, and the network stack in general are never +invoked, only the device driver that implements the particular interface +is executed. +As the .Nm command uses the .Xr bpf 4 device the user must have root privileges to execute this program. .Pp The options are as follows: .Bl -tag -width ".Fl d Ar argument" .It Fl a Ar address Instead of reversing the ethernet destination and source addresses supply a different destination ethernet address for each packet received. .It Fl e Ar ether type Use a different ethertype than the default, 0x8822, which is the IEEE ether type for driver testing. .It Fl i Ar interface Network interface, which can be found with ifconfig(1). .It Fl t Ar timeout -The time, in milliseconds, to wait for a packet. Lower times decrease -latency at the cost of CPU. +The time, in milliseconds, to wait for a packet. +Lower times decrease latency at the cost of CPU. .It Fl p -Set the device into promiscuous mode before testing. This is not -usually necessary. +Set the device into promiscuous mode before testing. +This is not usually necessary. .It Fl d -Debug output. Print various small pieces of debug information. +Debug output. +Print various small pieces of debug information. .El .Sh EXAMPLES The following is an example of a typical usage of the .Nm command: .Pp .Dl "ether_reflect -i em0 -t 1" .Pp Reflect all test packets, those with an ether type of 0x8822, which -are seen on ineterface em0. The timeout is 1 millisecond. +are seen on ineterface em0. +The timeout is 1 millisecond. .Pp .Dl "ether_reflect -i em0 -a 00:00:00:aa:bb:cc -t 1" .Pp Rewrite the destination address in each packet to 00:00:00:aa:bb:cc before reflecting the packet. .Sh SEE ALSO .Xr tcpdump 1 , .Xr bpf 2 , .Xr pcap 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm program first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An George V. Neville-Neil Aq Mt gnn@FreeBSD.org . .Sh BUGS Should be reported to the author or to .Aq Mt net@FreeBSD.org . Index: head/tools/tools/vimage/vimage.8 =================================================================== --- head/tools/tools/vimage/vimage.8 (revision 366574) +++ head/tools/tools/vimage/vimage.8 (revision 366575) @@ -1,195 +1,194 @@ .\" Copyright (c) 2002, 2003 Marko Zec .\" Copyright (c) 2009 University of Zagreb .\" Copyright (c) 2009 FreeBSD Foundation .\" .\" 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. .\" .\" $FreeBSD$ .\" .Dd August 25, 2009 .Dt VIMAGE 8 .Os .Sh NAME .Nm vimage .Nd manage virtual network stacks .Sh SYNOPSIS .Nm .Op Fl c | m .Ar vname .Op Ar param=value ... .Nm .Fl d .Ar vname .Nm .Fl l .Op Fl rvj .Op Ar vname .Nm .Fl i .Ar vname ifname .Op Ar newifname .Nm .Ar vi_name .Op command ... .Sh DESCRIPTION The .Nm utility is an alternative user interface for controlling virtual network stacks in FreeBSD, aimed primarily at supporting legacy applications which are not yet converted to using .Xr jail 8 , .Xr jexec 8 , and .Xr jls 8 . . .Ss Overview A virtual image or vimage is a jail with its own independent network -stack instance. Every process, socket and network interface present -in the system is always attached to one, and only one, virtual network -stack instance (vnet). -During system bootup sequence a default vnet -is created to which all the configured interfaces and user processes -are initially attached. -Assuming that enough system resources are -are available, a user with sufficient privileges can create and manage -a hierarchy of subordinated virtual images. +stack instance. +Every process, socket and network interface present in the system is always +attached to one, and only one, virtual network stack instance (vnet). +During system bootup sequence a default vnet is created to which all the configured +interfaces and user processes are initially attached. +Assuming that enough system resources are are available, a user with sufficient +privileges can create and manage a hierarchy of subordinated virtual images. The .Nm command allows for creation, deletion and monitoring of virtual images, -as well as for execution of arbitrary processes in a targeted virtual -image. +as well as for execution of arbitrary processes in a targeted virtual image. .Ss Invocation If invoked with no modifiers, the .Nm command spawns a new interactive shell in virtual image .Ar vname . If optional additional arguments following .Ar vname are provided, the first of those will be executed in place of the interactive shell, and the rest of the arguments will be passed as arguments to the executed command. .Pp The following modifiers are available: .Bl -tag -width indent .It Fl c Create a new virtual image named .Ar vname . Additional arguments, if provided, may be used to specify operating parameters different from defaults, in format .Ar param=value . See .Xr jail 8 for an extensive list of available parameters. .It Fl m Modify the parameters of a virtual image named .Ar vname , using the same syntax as with the -c form of the command. .It Fl d Delete the virtual image .Ar vname . No processes and/or sockets should exist in the target virtual image -in order for the delete request to succeed. Non-loopback interfaces -residing in the target virtual image will be reassigned to the virtual -image's parent. +in order for the delete request to succeed. +Non-loopback interfaces residing in the target virtual image +will be reassigned to the virtual image's parent. .It Fl l -List the properties and statistics for virtual images one level -below the current one in the hierarchy. If an optional argument +List the properties and statistics for virtual images one level below +the current one in the hierarchy. +If an optional argument .Ar vname is provided, only the information regarding the target virtual image .Ar vname is displayed. With the optional .Op Ar -r switch enabled the list will include all virtual images below the current level in the vimage hierarchy. Enabling the optional .Op Ar -v or .Op Ar -j switches results in a more detailed output. .It Fl i Move interface .Ar ifname to the target virtual image .Ar vname . Interfaces will be automatically renamed to .So ethXX .Sc , unless an optional argument specifying the desired interface name .Op Ar newifname is provided. .El .Sh EXAMPLES Create a new virtual image named .So v1 .Sc , which is allowed to create and manage an own subhierarchy of vimages: .Pp .Dl vimage -c v1 children.max=100 .Pp Execute the .So ifconfig .Sc command in the virtual image .So v1 .Sc : .Pp .Dl vimage v1 ifconfig .Pp Move the interface .So vlan0 .Sc to the virtual image .So v1 .Sc while renaming the interface as .So ve0 .Sc : .Pp .Dl vimage -i v1 vlan0 ve0 .Pp Show the status information for virtual image .So v1 .Sc : .Pp .Dl vimage -lv v1 .Sh DIAGNOSTICS The .Nm command exits 0 on success, and >0 if an error occurs. .Sh SEE ALSO .Xr jail 8 , .Xr jexec 8 , .Xr jls 8 .Sh HISTORY Network stack virtualization framework first appeared as a patchset -against the FreeBSD 4.7 kernel in 2002, and was maintained outside -of the main FreeBSD tree. +against the +.Fx 4.7 +kernel in 2002, and was maintained outside of the main FreeBSD tree. As a result of a project sponsored by the FreeBSD Foundation and -Stiching NLNet, integrated virtualized network stack first appeared -in FreeBSD 8.0. +Stiching NLNet, integrated virtualized network stack first appeared in +.Fx 8.0 . .Sh AUTHORS .An Marko Zec Aq Mt zec@fer.hr .Sh BUGS Deletion of vimages / vnets is known to leak kernel memory and fail at stopping various timers, hence may lead to system crashes.