diff --git a/share/man/man9/cdefs.9 b/share/man/man9/cdefs.9 index acfaf7b23991..d949c67b8f9a 100644 --- a/share/man/man9/cdefs.9 +++ b/share/man/man9/cdefs.9 @@ -1,447 +1,448 @@ .\"- .\" Copyright (c) 2024 M. Warner Losh .\" .\" SPDX-License-Identifier: BSD-2-Clause .\" .Dd July 20, 2024 .Dt CDEFS 9 .Os .Sh NAME .Nm cdefs .Nd compiler portability macro definitions .Sh DESCRIPTION .In sys/cdefs.h defines macros for compiler, C language standard portability, POSIX standards compliance and symbol visibility. It defines programming interfaces for the system header files to adopt to the many environments .Fx supports compilation for. It defines convenience macros for the .Fx sources, tailored to the base system's needs. .Pp Most of these macros are for use inside the .Fx sources only. They are not intended as a general portability layer. .Sh Supported Compilers .Bl -tag -offset 2n -width 0 .It Compilers supported for building programs on Fx : .Bl -column -offset 0n indent-two .It Sy Compiler Ta Sy Versions .It gcc Ta 9, 10, 11, 12, 13, 14 .It clang Ta 10, 11, 12, 13, 14, 15, 16, 17, 18 .It TinyC (tcc) Ta 0.9 .It pcc Ta 1.1 .El .Pp Due to testing constraints, tcc and pcc may not always work. .It Compilers supported for building Fx itself: .Bl -column -offset 0n indent-two .It Sy Compiler Ta Sy Major Versions Supported .It gcc Ta 12, 13, 14 .It clang Ta 16, 17, 18 .El .Pp Please note: Not every single minor versions of these compilers will work or are supported. .Sh Macros and Magic for Programming Environment .Nm defines (or refrains from defining) a number of macros to increase portability of compiled programs. These are to allow more advanced language features to appear in header files. The header files assume a compiler that accepts C prototype function declarations. They also assume that the compiler accepts ANSI C89 keywords for all language dialects. .Ss General Macros General macros that facilitate multiple language environments and language dialects. .Bl -column "---------------" .It Sy Macro Ta Sy Description .It Dv __volatile Ta expands to volatile in C++ and C89 and newer environments, __volatile in pre-ANSI environments that support this extension or nothing otherwise. .It Dv __inline Ta expands to inline in C++ and C89 and newer environments, __inline in pre-ANSI environments that support this extension or nothing otherwise. .It Dv __restrict Ta expands to restrict in C99 and newer environments, or __restrict otherwise. .It Dv __CONCAT Ta used to paste two pre-processor tokens. .It Dv __STRING Ta used to convert the argument to a string. .It Dv __BEGIN_DECLS Ta Start a group of functions. .It Dv __END_DECLS Ta End a group of functions. In a C environment, these are defined as nothing. In a C++ environment, these declare the functions to have .Dq C linkage. .El .Ss Function, Structure and Variable Modifiers .Bl -column "---------------" .It Sy Macro Ta Sy Description .It Sy __weak_symbol Ta Declare the symbol to be a weak symbol .It Sy __dead2 Ta Function will not return .It Sy __pure2 Ta Function has no side effects .It Sy __unused Ta To Variable may be unused (usually arguments), so do not warn about it .It Sy __used Ta Function really is used, so emit it even if it appears unused. .It Sy __packed Ta \&Do not have space between structure elements for natural alignment. Used when communicating with external protocols. .It Sy __aligned(x) Ta Specify in bytes the minimum alignment for the specified field, structure or variable .It Sy __section(x) Ta Place function or variable in section Fa x .It Sy __writeonly Ta Hint that the variable is only assigned to, but do not warn about it. Useful for macros and other places the eventual use of the result is unknown. .It Sy __alloc_size(x) Ta The function always returns at least the number of bytes determined by argument number Fa x .It Sy __alloc_size2(x,n) Ta The function always returns an array, whose size is at least the number of bytes determined by argument number Fa x times the number of elements specified by argument number Fa n .It Sy __alloc_align(x) Ta Function either returns a pointer aligned to Fa x bytes or Dv NULL. .It Sy __min_size Ta Declare the array to have a certain, minimum size .It Sy __malloc_like Ta Function behaves like the .Dq malloc family of functions. .It Sy __pure Ta Function has no side effects .It Sy __always_inline Ta Always inline this function when called .It Sy __fastcall Ta Use the .Dq fastcall ABI to call and name mangle this function. .It Sy __result_use_check Ta Warn if function caller does not use it's return value .It Sy __result_use_or_ignore_check Ta Warn if function caller does not use it's return value. Allows the value to be explicitly ignored with a (void) cast. .It Sy __returns_twice Ta Returns multiple times, like .Xr fork 2 .It Sy __unreachable Ta This code is not reachable at runtime .It Sy __predict_true(x) Ta Hint to the compiler that .Fa x is true most of the time. Should only be used when performance is improved for a frequently called bit of code. .It Sy __predict_false(x) Ta Hint to the compiler that .Fa x is false most of the time. Should only be used when performance is improved for a frequently called bit of code. .It Sy __null_sentinel Ta The varadic function contains a parameter that is a NULL sentinel to mark the end of its arguments. .It Sy __exported Ta .It Sy __hidden Ta .It Sy __printflike(fmtarg,firstvararg) Ta Function is similar to .Fn printf which specifies the format argument with .Fa fmtarg and where the arguments formatted by that format start with the .Fa firstvararg , with 0 meaning that .Dv va_arg is used and cannot be checked. .It Sy __scanflike(fmtarg,firstvararg) Ta Function is similar to .Fn scanf which specifies the format argument with .Fa fmtarg and where the arguments formatted by that format start with the .Fa firstvararg , with 0 meaning that .Dv va_arg is used and cannot be checked. .It Sy __format_arg(f) Ta Specifies that arg .Fa f contains a string that will be passed to a function like .Fn printf or .Fa scanf after being translated in some way. .It Sy __strfmonlike(fmtarg,firstvararg) Ta Function is similar to .Fn scanf which specifies the format argument with .Fa fmtarg and where the arguments formatted by that format start with the .Fa firstvararg , with 0 meaning that .Dv va_arg is used and cannot be checked. .It Sy __strtimelike(fmtarg,firstvararg) Ta Function is similar to .Fn scanf which specifies the format argument with .Fa fmtarg and where the arguments formatted by that format start with the .Fa firstvararg , with 0 meaning that .Dv va_arg is used and cannot be checked. .It Sy __printf0like(fmtarg,firstvararg) Ta Exactly the same as .Sy __printflike except .Fa fmtarg may be .Dv NULL. .It Sy __strong_reference(sym,aliassym) Ta .It Sy __weak_reference(sym,alias) Ta .It Sy __warn_references(sym,msg) Ta .It Sy __sym_compat(sym,impl,verid) Ta .It Sy __sym_default(sym,impl,verid) Ta .It Sy __GLOBAL(sym) Ta .It Sy __WEAK(sym) Ta .It Sy __DECONST(type,var) Ta .It Sy __DEVOLATILE(type,var) Ta .It Sy __DEQUALIFY(type,var) Ta .It Sy __RENAME(x) Ta .It Sy __arg_type_tag Ta .It Sy __datatype_type_tag Ta .It Sy __align_up(x,y) Ta .It Sy __align_down(x,y) Ta .It Sy __is_aligned(x,y) Ta .El .Ss Locking and Debugging Macros Macros for lock annotation and debugging, as well as some general debugging macros for address sanitizers. .Bl -column "---------------" .It Sy __lock_annotate(x) Ta .It Sy __lockable Ta .It Sy __locks_exclusive Ta .It Sy __locks_shared Ta .It Sy __trylocks_exclusive Ta .It Sy __trylocks_shared Ta .It Sy __unlocks Ta .It Sy __asserts_exclusive Ta .It Sy __asserts_shared Ta .It Sy __requires_exclusive Ta .It Sy __requires_shared Ta .It Sy __requires_unlocked Ta .It Sy __no_lock_analysis Ta .It Sy __nosanitizeaddress Ta .It Sy __nosanitizememory Ta .It Sy __nosanitizethread Ta .It Sy __nostackprotector Ta .It Sy __guarded_by(x) Ta .It Sy __pt_guarded_by(x) Ta .El .Ss Emulated Keywords As C evolves, many of the old macros we once used have been incorporated into the standard language. As this happens, we add support for these keywords as macros for older compilation environments. Sometimes this results in a nop in the older environment. .Bl -column "---------------" .It Sy Keyword Ta Sy Description .It Sy _Alignas(x) Ta .It Sy _Alignof(x) Ta .It Sy _Noreturn Ta Expands to .Dq [[noreturn]] in C++-11 and newer compilation environments, otherwise .Dq __dead2 .It Sy _Static_assert(x, y) Ta Compile time assertion that .Fa x is true, otherwise emit .Fa y as the error message. .It Sy _Thread_local Ta Designate variable as thread local storage .It Sy __generic Ta implement _Generic-like features which aren't entirely possible to emulate the _Generic keyword .It Sy __noexcept Ta to emulate the C++11 argument-less noexcept form .It Sy __noexcept_if Ta to emulate the C++11 conditional noexcept form .It Sy _Nonnull Ta .It Sy _Nullable Ta .It Sy _Null_unspecified Ta .El .Ss Support Macros The following macros are defined, or have specific values, to denote certain things about the build environment. .Bl -column "---------------" .It Sy Macro Ta Sy Description .It Sy __LONG_LONG_SUPPORTED Ta Variables may be declared .Dq long long . This is defined for C99 or newer and C++ environments. .It Sy __STDC_LIMIT_MACROS Ta .It Sy __STDC_CONSTANT_MACROS Ta .El .Ss Convenience Macros These macros make it easier to do a number of things, even though strictly speaking the standard places their normal form in another header. .Bl -column "---------------" .It Sy Macro Ta Sy Description .It Sy __offsetof(type,field) Ta .It Sy __rangeof(type,start,end) Ta .It Sy __containerof(x,s,m) Ta .El .Ss ID Strings This section is deprecated, but is kept around because too much contrib software still uses these. .Bl -column "---------------" .It Sy Macro Ta Sy Description .It Sy __IDSTRING(name,string) Ta .It Sy __FBSDID(s) Ta .It Sy __RCSID(s) Ta .It Sy __RCSID_SOURCE(s) Ta .It Sy __SCCSID(s) Ta .It Sy __COPYRIGHT(s) Ta .El .Sh Supported C Environments .Fx supports a number C standard environments. Selection of the language dialect is a compiler-dependent command line option, though it is usually .Fl std=XX where XX is the standard to set for compiling, such as c89 or c23. .Fx provides a number of selection macros to control visibility of symbols. Please see the section on Selection Macros for the specifics. .Pp .Bl -tag .It K \*(Am R Pre-ANSI Kernighan and Ritchie C. Sometimes called .Dq knr or .Dq C78 to distinguish it from newer standards. Support for this compilation environment is dependent on compilers supporting this configuration. Most of the old forms of C have been deprecated or removed in ISO/IEC 9899:2024 (“ISO C23”). Compilers make compiling in this mode increasingly difficult and support for it may ultimately be removed from the tree. .It St -ansiC .Dv __STDC__ is defined, however .Dv __STDC_VERSION__ is not. .Pp Strict environment selected with .Dv _ANSI_SOURCE . .It St -isoC-99 .Dv __STDC_VERSION__ = 199901L .Pp Strict environment selected with .Dv _C99_SOURCE . .It St -isoC-2011 .Dv __STDC_VERSION__ = 201112L .Pp Strict environment selected with .Dv _C11_SOURCE . .It ISO/IEC 9899:2018 (“ISO C17”) .Dv __STDC_VERSION__ = 201710L .Pp Strict environment selected with .Dv _C11_SOURCE since there are no new C17 only symbols or macros. .Pp This version of the standard did not introduce any new features, only made minor, technical corrections. .It ISO/IEC 9899:2024 (“ISO C23”) .Dv __STDC_VERSION__ = 202311L Strict environment selected with .Dv _C23_SOURCE though this is not yet implemented. .El .Pp For more information on C standards, see .Xr c 7 . .Ss Programming Environment Selection Macros Defining the macros outlined below requests that the system header files provide only the functions, structures and macros (symbols) defined by the appropriate standard, while suppressing all extensions. However, system headers not defined by that standard may define extensions. .Bl -column "---------------" .It Sy Macro Ta Sy Environment .It Dv _POSIX_SOURCE Ta St -p1003.1-88 including St -ansiC .It Dv _POSIX_C_SOURCE = 1 Ta St -p1003.1-88 including St -ansiC .It Dv _POSIX_C_SOURCE = 2 Ta St -p1003.1-90 including St -ansiC .It Dv _POSIX_C_SOURCE = 199309 Ta St -p1003.1b-93 including St -ansiC .It Dv _POSIX_C_SOURCE = 199506 Ta St -p1003.1c-95 including St -ansiC .It Dv _POSIX_C_SOURCE = 200112 Ta St -p1003.1-2001 including St -isoC-99 .It Dv _POSIX_C_SOURCE = 200809 Ta St -p1003.1-2008 including St -isoC-99 .It Dv _POSIX_C_SOURCE = 202405 Ta in the future IEEE Std 1003.1-2024 (“POSIX.1”) including ISO/IEC 9899:2024 (“ISO C23”) .It Dv _XOPEN_SOURCE = 500 Ta St -p1003.1c-95 and XPG extensions to St -susv2 including St -ansiC .It Dv _XOPEN_SOURCE = 600 Ta St -p1003.1-2001 and XPG extensions to St -susv3 including St -isoC-99 .It Dv _XOPEN_SOURCE = 700 Ta St -p1003.1-2008 and XPG extensions to St -susv4 including St -isoC-99 .It Dv _XOPEN_SOURCE = 800 Ta in the future IEEE Std 1003.1-2024 (“POSIX.1”) and XPG extensions to Version 5 of the Single UNIX Specification (“SUSv5”) including ISO/IEC 9899:2024 (“ISO C23”) .It Dv _ANSI_SOURCE Ta St -ansiC .It Dv _C99_SOURCE Ta St -isoC-99 .It Dv _C11_SOURCE Ta St -isoC-2011 .It Dv _C23_SOURCE Ta in the future ISO/IEC 9899:2024 (“ISO C23”) .It Dv _BSD_SOURCE Ta Everything, including Fx extensions .El .Pp When both POSIX and C environments are selected, the POSIX environment selects which C environment is used. However, when C11 dialect is selected with .St -p1003.1-2008 , definitions for .St -isoC-2011 are included. .Ss Header Visibility Macros These macros are set by .Nm to control the visibility of different standards. Users should not use these, but they are documented here for developers. .Bl -column "---------------" .It Dv __XSI_VISIBLE Ta Restricts the visibility of XOPEN Single Unix Standard version. Possible values are 500, 600, 700 or 800, corresponding to Issue 5, 6, 7, or 8 of the Single Unix Standard. These are extra functions in addition to the normal POSIX ones. .It Dv __POSIX_VISIBLE Ta Make symbols associated with certain standards versions visible. Set to the value assigned to .Dv _POSIX_C_SOURCE by convention with 199009 for .St -p1003.1-88 and 199209 .St -p1003.1-90 . .It Dv __ISO_C_VISIBLE Ta The C level that's visible. Possible values include 1990, 1999, and 2011 for .St -isoC-90 , .St -isoC-99 and .St -isoC-2011 respectively. In the future, 2023 will be used for ISO C2023. .It Dv __BSD_VISIBLE Ta 1 if the .Fx extensions are visible, 0 otherwise. .It Dv __EXT1_VISIBLE Ta 1 if the .St -isoC-2011 Appendix K 3.7.4.1 extensions are visible, 0 otherwise. +.El .Sh Supported C++ Environments .Fx supports C++11 and newer standards fully. .Bl -tag .It ISO/IEC 14882:1998 ("C++98") .Dv __cplusplus = 199711 .Pp The first standardized version of C++. Unlike K \*(Am R support in C, compilers dropped support for versions of the language prior to C++98. .It ISO/IEC 14882:2003 ("C++03") .Dv __cplusplus = 199711 .Pp Note, this is the same value as C++98. C++03 did not define a new value for .Dv __cplusplus . There is no way, at compile time, to detect the difference. The standard resolved a number of defect reports and slightly expanded value initialization. Most compilers support it the same as C++98. .It ISO/IEC 14882:2011 ("C++11") .Dv __cplusplus = 201103 .It ISO/IEC 14882:2014 ("C++14") .Dv __cplusplus = 201402 .It ISO/IEC 14882:2017 ("C++17") .Dv __cplusplus = 201703 .It ISO/IEC 14882:2020 ("C++20") .Dv __cplusplus = 202002 .It ISO/IEC 14882:2023 ("C++23") .Dv __cplusplus = 202302 .El .Pp .Fx uses llvm project's libc++. However, they are removing support for C++ prior to C++11. While programs can still build with earlier environments for now, these changes mean that .Fl pedantic-errors cannot be reliably enabled for standards older than C++11. .Sh HISTORY .In sys/cdefs.h first appeared in .Bx 4.3 NET/2 . diff --git a/stand/man/loader_lua.8 b/stand/man/loader_lua.8 index 1ba0939e60bd..0aa467237266 100644 --- a/stand/man/loader_lua.8 +++ b/stand/man/loader_lua.8 @@ -1,264 +1,265 @@ .\" 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. .\" .Dd September 29, 2021 .Dt LOADER_LUA 8 .Os .Sh NAME .Nm loader_lua .Nd kernel bootstrapping final stage .Sh DESCRIPTION The program called .Nm is the final stage of .Fx Ns 's kernel bootstrapping process. On IA32 (i386) architectures, it is a .Pa BTX client. It is linked statically to .Xr libsa 3 and usually located in the directory .Pa /boot . .Pp It provides a scripting language that can be used to automate tasks, do pre-configuration or assist in recovery procedures. This scripting language is roughly divided in two main components. The smaller one is a set of commands designed for direct use by the casual user, called "builtin commands" for historical reasons. The main drive behind these commands is user-friendliness. The bigger component is the Lua interpreter. .Pp During initialization, .Nm probes for a console and sets the .Va console variable, or sets it to serial console .Pq Dq Li comconsole if the previous boot stage used that. If multiple consoles are selected, they are listed separated by spaces. Then, devices are probed, .Va currdev and .Va loaddev are set, and .Va LINES is set to 24. Next, Lua is initialized, and .Pa /boot/lua/loader.lua is processed if it exists. After that, .Pa /boot/loader.conf is processed if available. .Pp At this point, if an .Ic autoboot has not been attempted, and if .Va autoboot_delay is not set to .Dq Li NO (case insensitive), then an .Ic autoboot is attempted. If the system gets past this point, .Va prompt is set and .Nm enters interactive mode. Please note that, historically, even when .Va autoboot_delay is set to .Dq Li 0 , the user can interrupt the autoboot process by pressing a key on the console while the kernel and modules are being loaded. To prevent this set .Va autoboot_delay to .Dq Li -1 . In this case .Nm enters interactive mode only if .Ic autoboot has failed. .Sh BUILTIN COMMANDS In .Nm , builtin commands take parameters from the command line. Presently, the only way to call them from a script is by using .Pa evaluate on a string. If an error condition occurs, an exception is generated, which can be intercepted using Lua exception handling. If not intercepted, an error message is displayed and the interpreter's state is reset, emptying the stack and restoring interpreting mode. .Pp The commands are described in the .Xr loader_simp 8 .Dq BUILTIN COMMANDS section. .Ss BUILTIN ENVIRONMENT VARIABLES The environment variables common to all interpreters are described in the .Xr loader_simp 8 .Dq BUILTIN ENVIRONMENT VARIABLES section. .Ss BUILTIN PARSER When a builtin command is executed, the rest of the line is taken as arguments, and it is processed by a special parser which is not used for regular Lua commands. .Sh SECURITY Access to the .Nm command line provides several ways of compromising system security, including, but not limited to: .Pp .Bl -bullet .It Booting from removable storage, by setting the .Va currdev or .Va loaddev variables .It Executing a binary of choice, by setting the .Va init_path or .Va init_script variables .It Overriding ACPI DSDT to inject arbitrary code into the ACPI subsystem .El .Pp One can prevent unauthorized access to the .Nm command line by setting the .Va password , or setting .Va autoboot_delay to -1. See .Xr loader.conf 5 for details. In order for this to be effective, one should also configure the firmware (BIOS or UEFI) to prevent booting from unauthorized devices. .Sh MD Memory disk (MD) can be used when the .Nm was compiled with .Va MD_IMAGE_SIZE . The size of the memory disk is determined by .Va MD_IMAGE_SIZE . If MD available, a file system can be embedded into the .Nm with .Pa /sys/tools/embed_mfs.sh . Then, MD is probed and set to .Va currdev during initialization. .Pp Currently, MD is only supported in .Xr loader.efi 8 . .Sh FILES .Bl -tag -width /usr/share/examples/bootforth/ -compact .It Pa /boot/loader .Nm itself. .It Pa /boot/defaults/loader.conf .It Pa /boot/lua/loader.lua Loader init .It Pa /boot/loader.conf .It Pa /boot/loader.conf.local .Nm configuration files, as described in .Xr loader.conf 5 . +.El .Sh EXAMPLES Boot in single user mode: .Pp .Dl boot -s .Pp Load the kernel, a splash screen, and then autoboot in five seconds. Notice that a kernel must be loaded before any other .Ic load command is attempted. .Bd -literal -offset indent load kernel load splash_bmp load -t splash_image_data /boot/chuckrulez.bmp autoboot 5 .Ed .Pp Set the disk unit of the root device to 2, and then boot. This would be needed in a system with two IDE disks, with the second IDE disk hardwired to ada2 instead of ada1. .Bd -literal -offset indent set root_disk_unit=2 boot /boot/kernel/kernel .Ed .Pp Set the default device used for loading a kernel from a ZFS filesystem: .Bd -literal -offset indent set currdev=zfs:tank/ROOT/knowngood: .Ed .Pp .Sh ERRORS The following values are thrown by .Nm : .Bl -tag -width XXXXX -offset indent .It 100 Any type of error in the processing of a builtin. .It -1 .Ic Abort executed. .It -2 .Ic Abort" executed. .It -56 .Ic Quit executed. .It -256 Out of interpreting text. .It -257 Need more text to succeed -- will finish on next run. .It -258 .Ic Bye executed. .It -259 Unspecified error. .El .Sh SEE ALSO .Xr libsa 3 , .Xr loader.conf 5 , .Xr tuning 7 , .Xr boot 8 , .Xr btxld 8 .Sh HISTORY The .Nm first appeared in .Fx 12.0 . diff --git a/stand/man/loader_simp.8 b/stand/man/loader_simp.8 index 6eac6bf6a102..49214e78b494 100644 --- a/stand/man/loader_simp.8 +++ b/stand/man/loader_simp.8 @@ -1,741 +1,743 @@ .\" 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. .\" .Dd September 29, 2021 .Dt LOADER_SIMP 8 .Os .Sh NAME .Nm loader_simp .Nd kernel bootstrapping final stage .Sh DESCRIPTION The program called .Nm is the final stage of .Fx Ns 's kernel bootstrapping process. On IA32 (i386) architectures, it is a .Pa BTX client. It is linked statically to .Xr libsa 3 and usually located in the directory .Pa /boot . .Pp It provides a scripting language that can be used to automate tasks, do pre-configuration or assist in recovery procedures. This scripting language is roughly divided in two main components. The smaller one is a set of commands designed for direct use by the casual user, called "builtin commands" for historical reasons. The main drive behind these commands is user-friendliness. .Pp During initialization, .Nm will probe for a console and set the .Va console variable, or set it to serial console .Pq Dq Li comconsole if the previous boot stage used that. If multiple consoles are selected, they will be listed separated by spaces. Then, devices are probed, .Va currdev and .Va loaddev are set, and .Va LINES is set to 24. After that, .Pa /boot/loader.rc is processed if available. These files are processed through the .Ic include command, which reads all of them into memory before processing them, making disk changes possible. .Pp At this point, if an .Ic autoboot has not been tried, and if .Va autoboot_delay is not set to .Dq Li NO (not case sensitive), then an .Ic autoboot will be tried. If the system gets past this point, .Va prompt will be set and .Nm will engage interactive mode. Please note that historically even when .Va autoboot_delay is set to .Dq Li 0 user will be able to interrupt autoboot process by pressing some key on the console while kernel and modules are being loaded. In some cases such behaviour may be undesirable, to prevent it set .Va autoboot_delay to .Dq Li -1 , in this case .Nm will engage interactive mode only if .Ic autoboot has failed. .Sh BUILTIN COMMANDS In .Nm , builtin commands take parameters from the command line. Presently, the only way to call them from a script is by using .Pa evaluate on a string. In the case of an error, an error message will be displayed and the interpreter's state will be reset, emptying the stack and restoring interpreting mode. .Pp The builtin commands available are: .Pp .Bl -tag -width Ds -compact .It Ic autoboot Op Ar seconds Op Ar prompt Proceeds to bootstrap the system after a number of seconds, if not interrupted by the user. Displays a countdown prompt warning the user the system is about to be booted, unless interrupted by a key press. The kernel will be loaded first if necessary. Defaults to 10 seconds. .Pp .It Ic bcachestat Displays statistics about disk cache usage. For debugging only. .Pp .It Ic boot .It Ic boot Ar kernelname Op Cm ... .It Ic boot Fl flag Cm ... Immediately proceeds to bootstrap the system, loading the kernel if necessary. Any flags or arguments are passed to the kernel, but they must precede the kernel name, if a kernel name is provided. .Pp .It Ic echo Xo .Op Fl n .Op Aq message .Xc Displays text on the screen. A new line will be printed unless .Fl n is specified. .Pp .It Ic heap Displays memory usage statistics. For debugging purposes only. .Pp .It Ic help Op topic Op subtopic Shows help messages read from .Pa /boot/loader.help . The special topic .Em index will list the topics available. .Pp .It Ic include Ar file Op Ar Process script files. Each file, in turn, is completely read into memory, and then each of its lines is passed to the command line interpreter. If any error is returned by the interpreter, the include command aborts immediately, without reading any other files, and returns an error itself (see .Sx ERRORS ) . .Pp .It Ic load Xo .Op Fl t Ar type .Ar file Cm ... .Xc Loads a kernel, kernel loadable module (kld), disk image, or file of opaque contents tagged as being of the type .Ar type . Kernel and modules can be either in a.out or ELF format. Any arguments passed after the name of the file to be loaded will be passed as arguments to that file. Use the .Li md_image type to make the kernel create a file-backed .Xr md 4 disk. This is useful for booting from a temporary rootfs. Currently, argument passing does not work for the kernel. .Pp .It Ic load_geli Xo .Op Fl n Ar keyno .Ar prov Ar file .Xc Loads a .Xr geli 8 encryption keyfile for the given provider name. The key index can be specified via .Ar keyno or will default to zero. .Pp .It Ic ls Xo .Op Fl l .Op Ar path .Xc Displays a listing of files in the directory .Ar path , or the root directory if .Ar path is not specified. If .Fl l is specified, file sizes will be shown too. .Pp .It Ic lsdev Op Fl v Lists all of the devices from which it may be possible to load modules, as well as ZFS pools. If .Fl v is specified, more details are printed, including ZFS pool information in a format that resembles .Nm zpool Cm status output. .Pp .It Ic lsmod Op Fl v Displays loaded modules. If .Fl v is specified, more details are shown. .Pp .It Ic lszfs Ar filesystem A ZFS extended command that can be used to explore the ZFS filesystem hierarchy in a pool. Lists the immediate children of the .Ar filesystem . The filesystem hierarchy is rooted at a filesystem with the same name as the pool. .Pp .It Ic more Ar file Op Ar Display the files specified, with a pause at each .Va LINES displayed. .Pp .It Ic pnpscan Op Fl v Scans for Plug-and-Play devices. This is not functional at present. .Pp .It Ic read Xo .Op Fl t Ar seconds .Op Fl p Ar prompt .Op Va variable .Xc Reads a line of input from the terminal, storing it in .Va variable if specified. A timeout can be specified with .Fl t , though it will be canceled at the first key pressed. A prompt may also be displayed through the .Fl p flag. .Pp .It Ic reboot Immediately reboots the system. .Pp .It Ic set Ar variable .It Ic set Ar variable Ns = Ns Ar value Set loader's environment variables. .Pp .It Ic show Op Va variable Displays the specified variable's value, or all variables and their values if .Va variable is not specified. .Pp .It Ic unload Remove all modules from memory. .Pp .It Ic unset Va variable Removes .Va variable from the environment. .Pp .It Ic \&? Lists available commands. .El .Ss BUILTIN ENVIRONMENT VARIABLES Environment variables can be set and unset through the .Ic set and .Ic unset builtins, and can have their values interactively examined through the use of the .Ic show builtin. Their values can also be accessed as described in .Sx BUILTIN PARSER . .Pp Notice that these environment variables are not inherited by any shell after the system has been booted. .Pp A few variables are set automatically by .Nm . Others can affect the behavior of either .Nm or the kernel at boot. Some options may require a value, while others define behavior just by being set. Both types of builtin variables are described below. .Bl -tag -width bootfile .It Va autoboot_delay Number of seconds .Ic autoboot will wait before booting. Configuration options are described in .Xr loader.conf 5 . .It Va boot_askname Instructs the kernel to prompt the user for the name of the root device when the kernel is booted. .It Va boot_cdrom Instructs the kernel to try to mount the root file system from CD-ROM. .It Va boot_ddb Instructs the kernel to start in the DDB debugger, rather than proceeding to initialize when booted. .It Va boot_dfltroot Instructs the kernel to mount the statically compiled-in root file system. .It Va boot_gdb Selects gdb-remote mode for the kernel debugger by default. .It Va boot_multicons Enables multiple console support in the kernel early on boot. In a running system, console configuration can be manipulated by the .Xr conscontrol 8 utility. .It Va boot_mute All kernel console output is suppressed when console is muted. In a running system, the state of console muting can be manipulated by the .Xr conscontrol 8 utility. .It Va boot_pause During the device probe, pause after each line is printed. .It Va boot_serial Force the use of a serial console even when an internal console is present. .It Va boot_single Prevents the kernel from initiating a multi-user startup; instead, a single-user mode will be entered when the kernel has finished device probing. .It Va boot_verbose Setting this variable causes extra debugging information to be printed by the kernel during the boot phase. .It Va bootfile List of semicolon-separated search path for bootable kernels. The default is .Dq Li kernel . .It Va comconsole_speed Defines the speed of the serial console (i386 and amd64 only). If the previous boot stage indicated that a serial console is in use then this variable is initialized to the current speed of the console serial port. Otherwise it is set to 115200 unless this was overridden using the .Va BOOT_COMCONSOLE_SPEED variable when .Nm was compiled. Changes to the .Va comconsole_speed variable take effect immediately. .It Va comconsole_port Defines the base i/o port used to access console UART (i386 and amd64 only). If the variable is not set, its assumed value is 0x3F8, which corresponds to PC port COM1, unless overridden by .Va BOOT_COMCONSOLE_PORT variable during the compilation of .Nm . Setting the .Va comconsole_port variable automatically set .Va hw.uart.console environment variable to provide a hint to kernel for location of the console. Loader console is changed immediately after variable .Va comconsole_port is set. .It Va comconsole_pcidev Defines the location of a PCI device of the 'simple communication' class to be used as the serial console UART (i386 and amd64 only). The syntax of the variable is .Li 'bus:device:function[:bar]' , where all members must be numeric, with possible .Li 0x prefix to indicate a hexadecimal value. The .Va bar member is optional and assumed to be 0x10 if omitted. The bar must decode i/o space. Setting the variable .Va comconsole_pcidev automatically sets the variable .Va comconsole_port to the base of the selected bar, and hint .Va hw.uart.console . Loader console is changed immediately after variable .Va comconsole_pcidev is set. .It Va console Defines the current console or consoles. Multiple consoles may be specified. In that case, the first listed console will become the default console for userland output (e.g.\& from .Xr init 8 ) . .It Va currdev Selects the default device to loader the kernel from. The syntax is: .Dl Ic loader_device: or .Dl Ic zfs:dataset: Examples: .Dl Ic disk0p2: .Dl Ic zfs:zroot/ROOT/default: .It Va dumpdev Sets the device for kernel dumps. This can be used to ensure that a device is configured before the corresponding .Va dumpdev directive from .Xr rc.conf 5 has been processed, allowing kernel panics that happen during the early stages of boot to be captured. .It Va init_chroot See .Xr init 8 . .It Va init_exec See .Xr init 8 . .It Va init_path Sets the list of binaries which the kernel will try to run as the initial process. The first matching binary is used. The default list is .Dq Li /sbin/init:/sbin/oinit:/sbin/init.bak:\:/rescue/init . .It Va init_script See .Xr init 8 . .It Va init_shell See .Xr init 8 . .It Va interpret Has the value .Dq Li OK if the Forth's current state is interpreting. .It Va LINES Define the number of lines on the screen, to be used by the pager. .It Va module_path Sets the list of directories which will be searched for modules named in a load command or implicitly required by a dependency. The default value for this variable is .Dq Li /boot/kernel;/boot/modules . .It Va num_ide_disks Sets the number of IDE disks as a workaround for some problems in finding the root disk at boot. This has been deprecated in favor of .Va root_disk_unit . .It Va prompt Value of .Nm Ns 's prompt. Defaults to .Dq Li "${interpret}" . If variable .Va prompt is unset, the default prompt is .Ql > . .It Va root_disk_unit If the code which detects the disk unit number for the root disk is confused, e.g.\& by a mix of SCSI and IDE disks, or IDE disks with gaps in the sequence (e.g.\& no primary slave), the unit number can be forced by setting this variable. .It Va rootdev By default the value of .Va currdev is used to set the root file system when the kernel is booted. This can be overridden by setting .Va rootdev explicitly. .El .Pp Other variables are used to override kernel tunable parameters. The following tunables are available: .Bl -tag -width Va .It Va efi.rt.disabled Disable UEFI runtime services in the kernel, if applicable. Runtime services are only available and used if the kernel is booted in a UEFI environment. .It Va hw.physmem Limit the amount of physical memory the system will use. By default the size is in bytes, but the .Cm k , K , m , M , g and .Cm G suffixes are also accepted and indicate kilobytes, megabytes and gigabytes respectively. An invalid suffix will result in the variable being ignored by the kernel. .It Va hw.pci.host_start_mem , hw.acpi.host_start_mem When not otherwise constrained, this limits the memory start address. The default is 0x80000000 and should be set to at least size of the memory and not conflict with other resources. Typically, only systems without PCI bridges need to set this variable since PCI bridges typically constrain the memory starting address (and the variable is only used when bridges do not constrain this address). .It Va hw.pci.enable_io_modes Enable PCI resources which are left off by some BIOSes or are not enabled correctly by the device driver. Tunable value set to ON (1) by default, but this may cause problems with some peripherals. .It Va kern.maxusers Set the size of a number of statically allocated system tables; see .Xr tuning 7 for a description of how to select an appropriate value for this tunable. When set, this tunable replaces the value declared in the kernel compile-time configuration file. .It Va kern.ipc.nmbclusters Set the number of mbuf clusters to be allocated. The value cannot be set below the default determined when the kernel was compiled. .It Va kern.ipc.nsfbufs Set the number of .Xr sendfile 2 buffers to be allocated. Overrides .Dv NSFBUFS . Not all architectures use such buffers; see .Xr sendfile 2 for details. .It Va kern.maxswzone Limits the amount of KVM to be used to hold swap metadata, which directly governs the maximum amount of swap the system can support, at the rate of approximately 200 MB of swap space per 1 MB of metadata. This value is specified in bytes of KVA space. If no value is provided, the system allocates enough memory to handle an amount of swap that corresponds to eight times the amount of physical memory present in the system. .Pp Note that swap metadata can be fragmented, which means that the system can run out of space before it reaches the theoretical limit. Therefore, care should be taken to not configure more swap than approximately half of the theoretical maximum. .Pp Running out of space for swap metadata can leave the system in an unrecoverable state. Therefore, you should only change this parameter if you need to greatly extend the KVM reservation for other resources such as the buffer cache or .Va kern.ipc.nmbclusters . Modifies kernel option .Dv VM_SWZONE_SIZE_MAX . .It Va kern.maxbcache Limits the amount of KVM reserved for use by the buffer cache, specified in bytes. The default maximum is 200MB on i386, and 400MB on amd64. This parameter is used to prevent the buffer cache from eating too much KVM in large-memory machine configurations. Only mess around with this parameter if you need to greatly extend the KVM reservation for other resources such as the swap zone or .Va kern.ipc.nmbclusters . Note that the NBUF parameter will override this limit. Modifies .Dv VM_BCACHE_SIZE_MAX . .It Va kern.msgbufsize Sets the size of the kernel message buffer. The default limit of 96KB is usually sufficient unless large amounts of trace data need to be collected between opportunities to examine the buffer or dump it to a file. Overrides kernel option .Dv MSGBUF_SIZE . .It Va machdep.disable_mtrrs Disable the use of i686 MTRRs (x86 only). .It Va net.inet.tcp.tcbhashsize Overrides the compile-time set value of .Dv TCBHASHSIZE or the preset default of 512. Must be a power of 2. .It Va twiddle_divisor Throttles the output of the .Sq twiddle I/O progress indicator displayed while loading the kernel and modules. This is useful on slow serial consoles where the time spent waiting for these characters to be written can add up to many seconds. The default is 16; a value of 32 spins half as fast, while a value of 8 spins twice as fast. .It Va vm.kmem_size Sets the size of kernel memory (bytes). This overrides the value determined when the kernel was compiled. Modifies .Dv VM_KMEM_SIZE . .It Va vm.kmem_size_min .It Va vm.kmem_size_max Sets the minimum and maximum (respectively) amount of kernel memory that will be automatically allocated by the kernel. These override the values determined when the kernel was compiled. Modifies .Dv VM_KMEM_SIZE_MIN and .Dv VM_KMEM_SIZE_MAX . .El .Ss ZFS FEATURES .Nm supports the following format for specifying ZFS filesystems which can be used wherever .Xr loader 8 refers to a device specification: .Pp .Ar zfs:pool/filesystem: .Pp where .Pa pool/filesystem is a ZFS filesystem name as described in .Xr zfs 8 . .Pp If .Pa /etc/fstab does not have an entry for the root filesystem and .Va vfs.root.mountfrom is not set, but .Va currdev refers to a ZFS filesystem, then .Nm will instruct kernel to use that filesystem as the root filesystem. .Sh SECURITY Access to the .Nm command line provides several ways of compromising system security, including, but not limited to: .Pp .Bl -bullet .It Booting from removable storage. .Pp One can prevent unauthorized access to the .Nm command line by booting unconditionally in .Pa loader.rc . In order for this to be effective, one should also configure the firmware (BIOS or UEFI) to prevent booting from unauthorized devices. +.El .Sh FILES .Bl -tag -width /boot/loader_simp -compact .It Pa /boot/loader_simp .Nm itself. .It Pa /boot/loader.rc The script run by .Nm on startup. +.El .Sh EXAMPLES Boot in single user mode: .Pp .Dl boot -s .Pp Load the kernel, a splash screen, and then autoboot in five seconds. Notice that a kernel must be loaded before any other .Ic load command is attempted. .Bd -literal -offset indent load kernel load splash_bmp load -t splash_image_data /boot/chuckrulez.bmp autoboot 5 .Ed .Pp Set the disk unit of the root device to 2, and then boot. This would be needed in a system with two IDE disks, with the second IDE disk hardwired to ada2 instead of ada1. .Bd -literal -offset indent set root_disk_unit=2 boot /boot/kernel/kernel .Ed .Pp Set the default device used for loading a kernel from a ZFS filesystem: .Bd -literal -offset indent set currdev=zfs:tank/ROOT/knowngood: .Ed .Pp .Sh ERRORS The following values are thrown by .Nm : .Bl -tag -width XXXXX -offset indent .It 100 Any type of error in the processing of a builtin. .It -1 .Ic Abort executed. .It -2 .Ic Abort" executed. .It -56 .Ic Quit executed. .It -256 Out of interpreting text. .It -257 Need more text to succeed -- will finish on next run. .It -258 .Ic Bye executed. .It -259 Unspecified error. .El .Sh SEE ALSO .Xr libsa 3 , .Xr loader.conf 5 , .Xr tuning 7 , .Xr boot 8 , .Xr btxld 8 .Sh HISTORY The .Nm first appeared in .Fx 3.1 . .Sh AUTHORS .An -nosplit The .Nm was written by .An Michael Smith Aq msmith@FreeBSD.org . diff --git a/usr.bin/bintrans/bintrans.1 b/usr.bin/bintrans/bintrans.1 index 16ae66aa21d1..beeae1207d9a 100644 --- a/usr.bin/bintrans/bintrans.1 +++ b/usr.bin/bintrans/bintrans.1 @@ -1,281 +1,282 @@ .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. 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. 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. .\" .Dd January 23, 2024 .Dt BINTRANS 1 .Os .Sh NAME .Nm bintrans , .Nm uuencode , .Nm uudecode , .Nm b64encode , .Nm b64decode , .Nm base64 .Nd encode / decode a binary file .Sh SYNOPSIS .Nm .Op algorithm .Op ... .Nm uuencode .Op Fl m .Op Fl r .Op Fl o Ar output_file .Op Ar file .Ar name .Nm uudecode .Op Fl cimprs .Op Ar .Nm uudecode .Op Fl i .Fl o Ar output_file .Nm b64encode .Op Fl r .Op Fl w Ar column .Op Fl o Ar output_file .Op Ar file .Ar name .Nm b64decode .Op Fl cimprs .Op Ar .Nm b64decode .Op Fl i .Fl o Ar output_file .Op Ar file .Nm base64 .Op Fl d .Op Fl w Ar column .Op Ar file .Sh DESCRIPTION The .Nm uuencode and .Nm uudecode utilities are used to transmit binary files over transmission mediums that do not support other than simple .Tn ASCII data. The .Nm b64encode utility is synonymous with .Nm uuencode with the .Fl m flag specified. The .Nm b64decode utility is synonymous with .Nm uudecode with the .Fl m flag specified. .Pp The .Nm base64 utility acts as a base64 decoder when passed the .Fl -decode .Po or .Fl d .Pc flag and as a base64 encoder otherwise. As a decoder it only accepts raw base64 input and as an encoder it does not produce the framing lines. .Nm base64 reads standard input or .Ar file if it is provided and writes to standard output. Options .Fl -wrap .Po or .Fl w .Pc and .Fl -ignore-garbage .Po or .Fl i .Pc are accepted for compatibility with GNU base64, but the latter is unimplemented and silently ignored. .Pp The .Nm uuencode utility reads .Ar file (or by default the standard input) and writes an encoded version to the standard output, or .Ar output_file if one has been specified. The encoding uses only printing .Tn ASCII characters and includes the mode of the file and the operand .Ar name for use by .Nm uudecode . .Pp The .Nm uudecode utility transforms .Em uuencoded files (or by default, the standard input) into the original form. The resulting file is named either .Ar name or (depending on options passed to .Nm uudecode ) .Ar output_file and will have the mode of the original file except that setuid and execute bits are not retained. The .Nm uudecode utility ignores any leading and trailing lines. .Pp The following options are available for .Nm uuencode : .Bl -tag -width ident .It Fl m Use the Base64 method of encoding, rather than the traditional .Nm uuencode algorithm. .It Fl r Produce raw output by excluding the initial and final framing lines. .It Fl o Ar output_file Output to .Ar output_file instead of standard output. .El .Pp The following options are available for .Nm uudecode : .Bl -tag -width ident .It Fl c Decode more than one uuencoded file from .Ar file if possible. .It Fl i Do not overwrite files. .It Fl m When used with the .Fl r flag, decode Base64 input instead of traditional .Nm uuencode input. Without .Fl r it has no effect. .It Fl o Ar output_file Output to .Ar output_file instead of any pathname contained in the input data. .It Fl p Decode .Ar file and write output to standard output. .It Fl r Decode raw (or broken) input, which is missing the initial and possibly the final framing lines. The input is assumed to be in the traditional .Nm uuencode encoding, but if the .Fl m flag is used, or if the utility is invoked as .Nm b64decode , then the input is assumed to be in Base64 format. .It Fl s Do not strip output pathname to base filename. By default .Nm uudecode deletes any prefix ending with the last slash '/' for security reasons. .El .Pp Additionally, .Nm b64encode accepts the following option: .Bl -tag -width ident .It Fl w Ar column Wrap encoded output after .Ar column . .El .Pp .Nm is a generic utility that can run any of the aforementioned encoders and decoders. It can also run algorithms that are not available through a dedicated program: .Pp .Nm qp is a quoted-printable converter and accepts the following options: .Bl -tag -width ident .It Fl u Decode. .It Fl o Ar output_file Output to .Ar output_file instead of standard output. +.El .Sh EXAMPLES The following example packages up a source tree, compresses it, uuencodes it and mails it to a user on another system. When .Nm uudecode is run on the target system, the file ``src_tree.tar.Z'' will be created which may then be uncompressed and extracted into the original tree. .Pp .Bd -literal -offset indent -compact tar cf \- src_tree \&| compress \&| uuencode src_tree.tar.Z \&| mail user@example.com .Ed .Pp The following example unpacks all uuencoded files from your mailbox into your current working directory. .Pp .Bd -literal -offset indent -compact uudecode -c < $MAIL .Ed .Pp The following example extracts a compressed tar archive from your mailbox .Pp .Bd -literal -offset indent -compact uudecode -o /dev/stdout < $MAIL | zcat | tar xfv - .Ed .Sh SEE ALSO .Xr basename 1 , .Xr compress 1 , .Xr mail 1 , .Xr uucp 1 Pq Pa ports/net/freebsd-uucp , .Xr uuencode 5 .Sh HISTORY The .Nm uudecode and .Nm uuencode utilities appeared in .Bx 4.0 . .Sh BUGS Files encoded using the traditional algorithm are expanded by 35% (3 bytes become 4 plus control information).