diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 14:02:27 -0400 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 14:02:27 -0400 |
| commit | 6d8bdc65446a704d0750217efd05532fc641ea7d (patch) | |
| tree | 8ae6d698b3c9801750a8b117b3842fb369872a3a /static/openbsd/man8 | |
| parent | 2f467bd7ff8f8db0dafa40426166491d7f57f368 (diff) | |
docs: OpenBSD Man Pages Added
Diffstat (limited to 'static/openbsd/man8')
57 files changed, 10352 insertions, 0 deletions
diff --git a/static/openbsd/man8/Makefile b/static/openbsd/man8/Makefile new file mode 100644 index 00000000..1c7f17a8 --- /dev/null +++ b/static/openbsd/man8/Makefile @@ -0,0 +1,39 @@ +MAN = afterboot.8 \ + autoinstall.8 \ + boot_config.8 \ + bulk.8 \ + crash.8 \ + daily.8 \ + diskless.8 \ + genassym.sh.8 \ + intro.8 \ + netstart.8 \ + rc.8 \ + rc.conf.8 \ + rc.d.8 \ + rc.shutdown.8 \ + rc.subr.8 \ + release.8 \ + security.8 \ + ssl.8 \ + starttls.8 \ + sticky.8 \ + yp.8 + +SUBDIRS = man8.alpha \ + man8.amd64 \ + man8.arm64 \ + man8.armv7 \ + man8.hppa \ + man8.i386 \ + man8.landisk \ + man8.loongson \ + man8.luna88k \ + man8.macppc \ + man8.octeon \ + man8.powerpc64 \ + man8.riscv64 \ + man8.sparc64 + +include ../../mandoc.mk + diff --git a/static/openbsd/man8/afterboot.8 b/static/openbsd/man8/afterboot.8 new file mode 100644 index 00000000..19064ae5 --- /dev/null +++ b/static/openbsd/man8/afterboot.8 @@ -0,0 +1,568 @@ +.\" $OpenBSD: afterboot.8,v 1.175 2025/05/05 20:50:03 tedu Exp $ +.\" +.\" Copyright (c) 1997 Marshall M. Midden +.\" 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 acknowledgement: +.\" This product includes software developed by Marshall M. Midden. +.\" 4. 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. +.\" +.Dd $Mdocdate: May 5 2025 $ +.Dt AFTERBOOT 8 +.\" Originally created by Marshall M. Midden -- 1997-10-20, m4@umn.edu +.Os +.Sh NAME +.Nm afterboot +.Nd things to check after the first complete boot +.Sh DESCRIPTION +.Ss Starting out +This document attempts to list items for the system administrator +to check and set up after the installation and first complete boot of the +system. +The idea is to create a list of items that can be checked off so that you have +a warm fuzzy feeling that something obvious has not been missed. +A basic knowledge of +.Ux +is assumed, otherwise run: +.Pp +.Dl $ help +.Pp +Complete instructions for correcting and fixing items are not provided. +There are manual pages and other methodologies available for doing that. +For example, to view the man page for the +.Xr ls 1 +command, run: +.Pp +.Dl $ man 1 ls +.Pp +Administrators will rapidly become more familiar with +.Ox +by using the high quality manual pages. +.Pp +Some base programs and subsystems also come with sample configuration +files in +.Pa /etc/examples . +.Ss Errata +By the time that you have installed your system, it is possible that +bugs in the release have been found. +Security or reliability fixes can be found at +.Lk https://www.openbsd.org/errata.html . +Binary updates are made available for some architectures and can be installed +using +.Xr syspatch 8 . +.Ss Login +Log in on the console, or over the network using +.Xr ssh 1 . +For security reasons, it is bad practice to log in as root during regular use +and maintenance of the system. +Instead, administrators are encouraged to add a +.Dq regular +user, add said user to the +.Dq wheel +group, then use the +.Xr su 1 +and +.Xr doas 1 +commands when root privileges are required. +.Pp +The installation process provides an option to set up a user account. +By default, accounts created via this method are automatically added to +the +.Dq wheel +group. +If that option was not used, see the paragraph +.Sx Add new users +below. +.Pp +To deny root logins over the network, edit the +.Pa /etc/ssh/sshd_config +file and set +.Cm PermitRootLogin +to +.Dq no +(see +.Xr sshd_config 5 ) . +.Ss Root password +Change the password for the root user. +(Note that throughout the documentation, the term +.Dq superuser +is a synonym for the root user.) +Choose a password that has digits and special characters +as well as from the upper and lower case alphabet. +Do not choose any word in any language. +It is common for an intruder to use dictionary attacks. +Run the following command to change it: +.Pp +.Dl # passwd root +.Pp +To avoid the possibility of running rogue files placed in +the superuser's +.Ev PATH , +it should never contain the current directory +.Pq Dq \&. . +.Ss System date +.Xr ntpd 8 +is used to automatically synchronize clocks with remote NTP servers. +You can use +.Xr ntpctl 8 +to check the status. +To change the NTP server, see +.Xr ntpd.conf 5 . +.Pp +Check the system date with the +.Xr date 1 +command. +If needed, change the date, and/or change the symbolic link of +.Pa /etc/localtime +to the correct time zone in the +.Pa /usr/share/zoneinfo +directory. +.Pp +Examples: +.Pp +Set the current date to January 27th, 2016 3:04pm: +.Dl # date 201601271504 +.Pp +Set the time zone to Atlantic Standard Time: +.Dl # ln -fs /usr/share/zoneinfo/Canada/Atlantic /etc/localtime +.Ss Check hostname +Use the +.Ic hostname +command to verify that the name of your machine is correct. +See the man page for +.Xr hostname 1 +if it needs to be changed. +You will also need to edit the +.Pa /etc/myname +file to have it stick around for the next reboot. +.Ss Verify network interface configuration and routing tables +The first thing to do is an +.Ic ifconfig -a +to see if the network interfaces are properly configured. +Correct by editing +.Pa /etc/hostname. Ns Ar interface +(where +.Ar interface +is the interface name or link layer address, e.g., +.Dq em0 ) +and then using +.Xr ifconfig 8 +to manually configure it +if you do not wish to reboot. +Read the +.Xr hostname.if 5 +man page for more information on the format of +.Pa /etc/hostname. Ns Ar interface +files and instructions on configuring dynamic addresses. +.Pp +Routing tables are manipulated using +.Xr route 8 . +They can be viewed by issuing +.Dq route -n show . +The default gateway address is stored in the +.Xr mygate 5 +file. +If you need to edit this file, a painless way to reconfigure the network +afterwards is +.Ic route flush +followed by a +.Ic sh -x /etc/netstart +command. +Or, you may prefer to manually configure using a series of +.Ic route add +and +.Ic route delete +commands. +.Pp +Packets are not forwarded by default, due to RFC requirements. +If you wish to route packets between interfaces, add one or both +of the following directives (depending on whether IPv4 or IPv6 routing +is required) to +.Xr sysctl.conf 5 : +.Pp +.Dl net.inet.ip.forwarding=1 +.Dl net.inet6.ip6.forwarding=1 +.Pp +See +.Xr multicast 4 +for instructions on configuring multicast routing. +.Ss Check DNS +Use +.Xr host 1 +or +.Xr dig 1 +to check that domain name resolution is working properly. +.Pp +Most likely, the IP address of at least one domain name server +was added to +.Xr resolv.conf 5 +while installing the system. +.Xr resolvd 8 +maintains +.Pa /etc/resolv.conf +at runtime. +.Pp +A +.Xr hosts 5 +file can be used if there is a need for system specific name +resolution entries. +.Ss Check disk mounts +Check that the disks are mounted correctly by +comparing the +.Pa /etc/fstab +file against the output of the +.Xr mount 8 +and +.Xr df 1 +commands. +Examples: +.Bd -literal -offset indent +# cat /etc/fstab +/dev/sd0a / ffs rw 1 1 +/dev/sd0d /usr ffs rw,nodev 1 2 +/dev/sd0e /var ffs rw,nodev,nosuid 1 3 +/dev/sd0g /tmp ffs rw,nodev,nosuid 1 4 +/dev/sd0h /home ffs rw,nodev,nosuid 1 5 + +# mount +/dev/sd0a on / type ffs (local) +/dev/sd0d on /usr type ffs (local, nodev) +/dev/sd0e on /var type ffs (local, nodev, nosuid) +/dev/sd0g on /tmp type ffs (local, nodev, nosuid) +/dev/sd0h on /home type ffs (local, nodev, nosuid) + +# df +Filesystem 1024-blocks Used Avail Capacity Mounted on +/dev/sd0a 22311 14589 6606 69% / +/dev/sd0d 203399 150221 43008 78% /usr +/dev/sd0e 10447 682 9242 7% /var +/dev/sd0g 18823 2 17879 0% /tmp +/dev/sd0h 7519 5255 1888 74% /home + +# pstat -s +Device 512-blocks Used Avail Capacity Priority +/dev/sd0b 131072 84656 46416 65% 0 +.Ed +.Pp +Edit +.Pa /etc/fstab +and use the +.Xr mount 8 +and +.Xr umount 8 +commands as appropriate. +Refer to the above example and +.Xr fstab 5 +for information on the format of this file. +.Pp +You may wish to configure NFS partitions now too, or you can do them later. +.Ss Check the running system +You can use +.Xr ps 1 , +.Xr netstat 1 , +and +.Xr fstat 1 +to check on running processes, network connections, and opened files, +respectively. +.Sh FURTHER CHANGES +The system should be usable now, but you may wish to do more customizing, +such as adding users, etc. +We suggest that you +.Ic cd /etc +and edit any files in that directory as necessary. +.Pp +Note that the +.Pa /etc/motd +file is modified by +.Pa /etc/rc +whenever the system is booted. +To keep any custom message intact, ensure that you leave two blank lines +at the top, or your message will be overwritten. +.Ss Add new users +Add users. +There is an +.Xr adduser 8 +script. +You may use +.Xr vipw 8 +to add users to the +.Pa /etc/passwd +file +and edit +.Pa /etc/group +by hand to add new groups. +You may also wish to edit +.Pa /etc/login.conf +and tune some of the limits documented in +.Xr login.conf 5 . +The manual page for +.Xr su 1 +tells you to make sure to put people in +the +.Sq wheel +group if they need root access. +For example: +.Pp +.Dl wheel:*:0:root,myself +.Ss System command scripts +The +.Pa /etc/rc.*\& +scripts are invoked at boot time, after single-user mode has exited, +and at shutdown. +The whole process is controlled, more or less, by the master script +.Pa /etc/rc . +This script should not be changed by administrators. +.Pp +.Pa /etc/rc +is in turn influenced by the configuration variables present in +.Pa /etc/rc.conf . +Again, this script should not be changed by administrators: +site-specific changes should be made to +.Pq freshly created if necessary +.Pa /etc/rc.conf.local +or by using the +.Xr rcctl 8 +utility. +.Pp +Any commands which should be run before the system sets its +secure level should be made to +.Pa /etc/rc.securelevel , +and commands to be run after the system sets its +secure level should be made to +.Pa /etc/rc.local . +Commands to be run before system shutdown should be set in +.Pa /etc/rc.shutdown . +.Pp +For more information about system startup/shutdown files, see +.Xr rc 8 , +.Xr rc.conf 8 , +.Xr securelevel 7 , +and +.Xr rc.shutdown 8 . +.Pp +If you've installed X, you may want to turn on +.Xr xenodm 1 , +the X Display Manager. +To do this, change the value of +.Va xenodm_flags +in +.Pa /etc/rc.conf.local . +.Ss Set keyboard type +Some architectures permit keyboard type control. +Use the +.Xr kbd 8 +command to change the keyboard encoding. +.Ic kbd -l +will list all available encodings. +.Ic kbd xxx +will select the +.Ic xxx +encoding. +Store the encoding in +.Pa /etc/kbdtype +to make sure it is set automatically at boot time. +.Ss Printers +Edit +.Pa /etc/printcap +and +.Pa /etc/hosts.lpd +to set up any printers. +Consult +.Xr lpd 8 +and +.Xr printcap 5 +if needed. +.Ss Audio and video recording +The +.Xr audio 4 +and +.Xr video 4 +drivers by default record only silence and blanked images. +Normal recording can be enabled by adding the following directives to +.Xr sysctl.conf 5 : +.Bd -literal -offset indent +kern.audio.record=1 +kern.video.record=1 +.Ed +.Ss Power management +If the BIOS supports it, +.Xr apmd 8 +can be configured to act on different events and adjust device performance. +In the following example it is configured to start on boot in automatic +performance adjustment mode and suspend the system if no AC is connected and +the estimated battery life is equal or below 15%: +.Bd -literal -offset indent +# rcctl set apmd status on +# rcctl set apmd flags -A -z 15 +.Ed +.Ss Mail aliases +Edit +.Pa /etc/mail/aliases +and set the three standard aliases to go to either a mailing list, or +the system administrator. +.Bd -literal -offset indent +# Well-known aliases -- these should be filled in! +root: sysadm +manager: root +dumper: root +.Ed +.Ss Mail +The default mail agent on +.Ox +is +.Xr smtpd 8 . +Details on how to configure an alternative mailer are documented in +.Xr mailer.conf 5 . +.Pp +.Ox +ships with a default +.Pa /etc/mail/smtpd.conf +file that will work for simple installations. +See +.Xr smtpd.conf 5 +for information on configuring more complex setups. +For the default installation, +.Xr smtpd 8 +is configured to only accept connections from the local host. +This makes it possible to send mail locally, but not receive mail from remote +servers, which is ideal if you have one central incoming mail machine and +several clients. +To cause smtpd to accept external network connections, modify the +.Ic listen on +directive in +.Pa /etc/mail/smtpd.conf +to include the interfaces to listen on. +.Ss Daily, weekly, monthly scripts +Review +.Xr daily 8 +to understand what the periodic system maintenance scripts do and +how to customize them: +For example, to enable +.Ev ROOTBACKUP +or to add local maintenance code to +.Pa /etc/daily.local , /etc/weekly.local , +or +.Pa /etc/monthly.local . +.Ss Tighten up security +You might wish to tighten up security more by editing +.Pa /etc/fbtab +as when installing X. +Look at the other files in +.Pa /etc +and edit them as needed. +(Do not edit files ending in +.Pa .db +\(em like +.Pa pwd.db , spwd.db , +nor +.Pa localtime , +nor +.Pa rmt , +nor any directories.) +.Ss Crontab (background running processes) +Check what is running by typing +.Ic crontab -l +as root +and see if anything unexpected is present. +Do you need anything else? +Do you wish to change things? +See +.Xr crontab 5 . +.Ss Next day cleanup +After the first night's +.Xr security 8 +run, change ownerships and permissions +on files, directories, and devices; root may have received mail +with subject: "<hostname> daily insecurity output". +This mail contains a set of security recommendations, +presented as a list looking something like this: +.Bd -literal -offset indent +var/mail: + permissions (0755, 0775) +etc/daily: + user (0, 3) +.Ed +.Pp +The best bet is to follow the advice in that list. +The recommended setting is the first item in parentheses, while +the current setting is the second one. +This list is generated by +.Xr mtree 8 +using +.Pa /etc/mtree/special . +Use +.Xr chmod 1 , +.Xr chgrp 1 , +and +.Xr chown 8 +as needed. +.Ss Daemons +Enable/disable any daemon processes as necessary. +.Xr intro 8 +contains a comprehensive guide to the various daemons available on the +.Ox +system. +.Ss Packages +Install your own packages. +The +.Ox +ports collection includes a large set of third-party software. +Most of it is available as binary packages that you can install using +.Xr pkg_add 1 . +See +.Xr packages 7 +for more details. +To start daemons installed from packages, see +.Xr rc.d 8 . +.Pp +There is also other third-party software that is available +in source form only, either because it has not been ported to +.Ox +yet, or because licensing restrictions make binary redistribution +impossible. +Sometimes checking the mailing lists for +past problems that people have encountered will result in a fix posted. +.Ss Compiling a kernel +Information on building and modifying kernels +is contained within +.Xr config 8 . +.Sh SEE ALSO +.Xr doas 1 , +.Xr ksh 1 , +.Xr man 1 , +.Xr pkg_add 1 , +.Xr ps 1 , +.Xr vi 1 , +.Xr multicast 4 , +.Xr hier 7 , +.Xr config 8 , +.Xr dmesg 8 , +.Xr ifconfig 8 , +.Xr intro 8 , +.Xr rcctl 8 , +.Xr sysctl 8 +.Sh HISTORY +This document first appeared in +.Ox 2.2 . diff --git a/static/openbsd/man8/autoinstall.8 b/static/openbsd/man8/autoinstall.8 new file mode 100644 index 00000000..9fef3643 --- /dev/null +++ b/static/openbsd/man8/autoinstall.8 @@ -0,0 +1,250 @@ +.\" $OpenBSD: autoinstall.8,v 1.25 2021/11/08 16:12:10 kn Exp $ +.\" +.\" Copyright (c) 2013 Robert Peichaer <rpe@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: November 8 2021 $ +.Dt AUTOINSTALL 8 +.Os +.Sh NAME +.Nm autoinstall +.Nd unattended OpenBSD installation and upgrade +.Sh DESCRIPTION +.Nm +allows unattended installation or upgrade of +.Ox +by automatically responding to installer questions with +answers from a response file. +.Nm +uses DHCP to discover the location of the response +file and HTTP to fetch the file. +If that fails, the installer asks for the location which can either be +a URL or a local path. +.Pp +See +.Xr install.site 5 +for how to provide custom configuration. +.Pp +To start unattended installation or upgrade choose '(A)utoinstall' at the +install prompt. +If there is only one network interface, the installer fetches the response +file via that interface. +If there is more than one network interface, a selection is presented +and the installer fetches the response file via the selected interface. +.Pp +If the machine is netbooted, the +.Nm +feature is invoked if the user does not intervene within +a short time. +It behaves as if the user selected '(A)utoinstall', but +always fetches the response file via the netboot interface. +.Pp +If either +.Pa /auto_install.conf +or +.Pa /auto_upgrade.conf +is found on +.Pa bsd.rd Ns 's +built-in RAM disk, +.Nm +behaves as if the machine is netbooted, but uses the local response file. +In case both files exist, +.Pa /auto_install.conf +takes precedence. +.Pp +.Nm +uses HTTP to fetch one of the files +.Pa install.conf , +.Ar MAC_address Ns - Ns Pa install.conf +or +.Ar hostname Ns - Ns Pa install.conf +for install answers, or one of +.Pa upgrade.conf , +.Ar MAC_address Ns - Ns Pa upgrade.conf +or +.Ar hostname Ns - Ns Pa upgrade.conf +for upgrade answers. +.Pp +The URL used to fetch the file is constructed from +.Xr dhcp-options 5 +statements extracted from the DHCP lease file. +.Ic next-server +specifies the +.Ar server . +.Ic filename +specifies the +.Ar filename . +The statement +.Ic option host-name +specifies the +.Ar hostname +which is also used as the default hostname during installation. +.Pp +If +.Ar filename +is +.Cm auto_install , +then the URLs tried are, in order: +.Sm off +.Bd -unfilled -offset indent +.No http:// Ar server No / Ar MAC_address No -install.conf +.No http:// Ar server No / Ar hostname No -install.conf +.No http:// Ar server No /install.conf +.Ed +.Sm on +.Pp +where +.Ar MAC_address +is a string of six hex octets separated by colons +representing the MAC +address of the interface being used to fetch the files. +.Pp +If +.Ar filename +is +.Cm auto_upgrade , +the URLs tried are, in order: +.Sm off +.Bd -unfilled -offset indent +.No http:// Ar server No / Ar MAC_address No -upgrade.conf +.No http:// Ar server No / Ar hostname No -upgrade.conf +.No http:// Ar server No /upgrade.conf +.Ed +.Sm on +.Pp +On architectures where the +.Ic filename +statement is used to provide the name of the file to netboot +it is necessary to create symbolic links called +.Pa auto_install +and +.Pa auto_upgrade +that point to the expected boot program +and to change the value of the +.Ic filename +statement in the +.Xr dhcpd.conf 5 +file to be +.Cm auto_install +or +.Cm auto_upgrade . +.Pp +To use a subdirectory as response file location on the HTTP server, the same +directory structure containing the symbolic links has to exist in the tftproot +directory. +The value of +.Ic filename +has to be the full path to these symbolic links, and the HTTP and TFTP servers +must be on the same machine. +.Pp +The response file is a line-oriented ASCII text file. +The format of each line is: +.Pp +.D1 Ar question No = Ar answer +.Pp +.Ar question +is an installer question (not including the question mark) or a non-ambiguous +part of it, consisting of whitespace separated words. +.Ar answer +is the answer to the question. +Passwords may be in plaintext, encrypted with +.Xr encrypt 1 , +or set to +.Ql ************* +(13 '*'s) to disable password logins, only permitting alternative access methods +(for example, +.Xr ssh 1 +keys). +.Pp +If +.Nm +does not find an answer in the response file, the default answer as +provided by the installer is used. +.Pp +The response file may contain answers to the following questions, which are +only available during unattended installation to provide additional installer +features: +.Bl -tag -width Ds +.It Public ssh key for root account = Ar ssh key +.Ar ssh key +is stored in +.Pa /root/.ssh/authorized_keys . +.It Public ssh key for user puffy = Ar ssh key +.Ar ssh key +is stored in +.Pa ~puffy/.ssh/authorized_keys . +.It URL to autopartitioning template for disklabel = Ar url +A template file for +.Xr disklabel 8 +autopartitioning is fetched from +.Ar url +allowing a custom partition layout for the root disk. +.El +.Sh FILES +.Bl -tag -width "/etc/dhcpd.confXXX" -compact +.It Pa /etc/dhcpd.conf +.Xr dhcpd 8 +configuration file +.It Pa install.conf +response file for unattended installation +.It Pa upgrade.conf +response file for unattended upgrade +.El +.Sh EXAMPLES +A typical +.Pa install.conf +file will look something like this: +.Bd -literal -offset indent +System hostname = server1 +Password for root = $2b$14$Z4xRMg8vDpgYH...GVot3ySoj8yby +Change the default console to com0 = yes +Which speed should com0 use = 19200 +Setup a user = puffy +Password for user = ************* +Public ssh key for user = ssh-ed25519 AAAAC3NzaC1...g3Aqre puffy@ai +What timezone are you in = Europe/Stockholm +Location of sets = http +HTTP Server = cdn.openbsd.org +.Ed +.Pp +The same file could be used for upgrades by creating a symbolic link called +.Pa upgrade.conf +that points to +.Pa install.conf . +The upgrade process will only use the answers it needs. +.Pp +And an example +.Xr dhcpd.conf 5 +.Ic host +declaration: +.Bd -literal -offset indent +host foo { + hardware ethernet 00:50:60:49:8b:84; + fixed-address 192.168.2.180; + filename "auto_install"; + option host-name "foo"; +} +.Ed +.Sh SEE ALSO +.Xr dhcp-options 5 , +.Xr dhcpd.conf 5 , +.Xr install.site 5 , +.Xr diskless 8 +.Sh HISTORY +The +.Nm +feature first appeared in +.Ox 5.5 . +.Sh AUTHORS +.An Robert Peichaer Aq Mt rpe@openbsd.org diff --git a/static/openbsd/man8/boot_config.8 b/static/openbsd/man8/boot_config.8 new file mode 100644 index 00000000..63a228af --- /dev/null +++ b/static/openbsd/man8/boot_config.8 @@ -0,0 +1,201 @@ +.\" $OpenBSD: boot_config.8,v 1.34 2025/05/05 20:50:03 tedu Exp $ +.\" +.\" Copyright (c) 1996 Mats O Jansson +.\" 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. +.\" 4. Neither the name of the author 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 AUTHOR ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd $Mdocdate: May 5 2025 $ +.Dt BOOT_CONFIG 8 +.Os +.Sh NAME +.Nm boot_config +.Nd how to change kernel configuration at boot +.Sh DESCRIPTION +.Nm BOOT_CONFIG +is a kernel option that makes it possible to change the configuration +at boot time. +The same interface is available from userland, using the +.Fl e +argument to +.Xr config 8 . +.Pp +The boot time configuration is invoked by passing the +.Fl c +option, either from the firmware prompt or, +depending on the architecture, when the bootstrap loader +prompts for a kernel to boot: +.Bd -literal +>> OpenBSD/i386 BOOT 3.26 +.No "boot>" Ic boot -c +booting hd0a:/bsd: ... +\&... +real mem = 1073086464 (1023MB) +avail mem = 1043189760 (994MB) +User Kernel Config +UKC> +.Ed +.Pp +Changes made can be saved for the next reboot, by using +.Xr config 8 . +However, those changes would not persist across system upgrades and would +prevent kernel relinking. +To ensure these changes are carried over to upgraded kernels, they can +be saved to the +.Xr bsd.re-config 5 +configuration file. +.Sh COMMANDS +.Bl -tag -width "disable devno | dev" +.It Ic add Ar dev +Add a device through copying another. +.It Ic base Cm 8 | 10 | 16 +Change the base of numbers displayed and entered. +.It Ic change Ar devno | dev +Modify one or more devices. +.It Ic disable Ar devno | dev +Disable one or more devices. +.It Ic enable Ar devno | dev +Enable one or more devices. +.It Ic exit +Continue boot. +.It Ic find Ar devno | dev +Find one or more devices. +.It Ic help +Give a short summary of all commands and their arguments. +.It Ic list +Show all known devices, a screen at a time. +.It Ic lines Op Ar count +Set the number of rows per page. +.It Ic quit +Continue boot. +.It Ic show Op Ar attr Op Ar val +Show all devices for which attribute +.Ar attr +has the value +.Ar val . +.It Ic verbose +Toggle the autoconfig verbose variable. +.El +.Sh EXAMPLES +The Ethernet card is not detected at boot because the kernel configuration +does not match the physical hardware configuration, +e.g. wrong IRQ in OpenBSD/i386. +The Ethernet card is supposed to use the +.Xr ne 4 +driver. +.Bd -literal +.No UKC> Ic find ne +24 ne0 at isa0 port 0x240 size 0 iomem 0xd8000 iosiz 0 irq 9 drq -1 drq2 -1 flags 0x0 +25 ne1 at isa0 port 0x300 size 0 iomem -1 iosiz 0 irq 10 drq -1 drq2 -1 flags 0x0 +26 ne* at isapnp0 port -1 size 0 iomem -1 iosiz 0 irq -1 drq -1 flags 0x0 +27 ne* at pci* dev -1 function -1 flags 0x0 +28 ne* at pcmcia* function -1 irq -1 flags 0x0 +UKC> +.Ed +.Pp +ne1 seems to match the configuration except it uses IRQ 5 instead of IRQ 10. +So the irq on ne1 should be changed via the +.Fa change +command. +The device can be specified by either name or number. +.Bd -literal +.No UKC> Ic change ne1 +25 ne1 at isa0 port 0x300 size 0 iomem -1 iosiz 0 irq 10 drq -1 drq2 -1 flags 0x0 +.No change (y/n) \&? Ic y +.No port [0x300] \&? +.No size [0] \&? +.No iomem [-1] \&? +.No iosiz [0] \&? +.No irq [10] \&? Ic 5 +.No drq [-1] \&? +.No drq2 [-1] \&? +.No flags [0] \&? +25 ne1 changed +25 ne1 at isa0 port 0x300 size 0 iomem -1 iosiz 0 irq 5 drq -1 drq2 -1 flags 0x0 +UKC> +.Ed +.Pp +The show command is useful for finding which devices have a certain attribute. +It can also be used to find those devices with a particular value for +an attribute. +.Bd -literal +.No UKC> Ic show slot + 2 ahc* at eisa0 slot -1 flags 0x0 + 10 uha* at eisa0 slot -1 flags 0x0 + 12 ep0 at eisa0 slot -1 flags 0x0 + 17 ep* at eisa0 slot -1 flags 0x0 +102 ahb* at eisa0 slot -1 flags 0x0 +103 fea* at eisa0 slot -1 flags 0x0 +.No UKC> Ic show port 0x300 + 25 ne1 at isa0 port 0x300 size 0 iomem -1 iosiz 0 irq 10 drq -1 drq2 -1 flags 0x0 + 72 we1 at isa0 port 0x300 size 0 iomem 0xcc000 iosiz 0 irq 10 drq -1 drq2 -1 flags 0x0 + 75 el0 at isa0 port 0x300 size 0 iomem -1 iosiz 0 irq 9 drq -1 drq2 -1 flags 0x0 + 77 ie1 at isa0 port 0x300 size 0 iomem -1 iosiz 0 irq 10 drq -1 drq2 -1 flags 0x0 +UKC> +.Ed +.Pp +It is possible to add new devices, but only devices that were linked into the +kernel. +If a new device is added, following devices will be renumbered. +.Bd -literal +.No UKC> Ic find ep + 11 ep0 at isa0 port -1 size 0 iomem -1 iosiz 0 irq -1 drq -1 drq2 -1 flags 0x0 + 12 ep0 at eisa0 slot -1 flags 0x0 + 13 ep0 at pci* dev -1 function -1 flags 0x0 + 14 ep* at isapnp0 port -1 size 0 iomem -1 iosiz 0 irq -1 drq -1 flags 0x0 + 15 ep* at isa0 port -1 size 0 iomem -1 iosiz 0 irq -1 drq -1 drq2 -1 flags 0x0 + 16 ep* at eisa0 slot -1 flags 0x0 + 17 ep* at pci* dev -1 function -1 flags 0x0 + 18 ep* at pcmcia* dev -1 irq -1 flags 0x0 +.No UKC> Ic add ep1 +.No "Clone Device (DevNo, 'q' or '\&?') \&?" Ic 13 +.No "Insert before Device (DevNo, 'q' or '\&?')" Ic 14 + 14 ep1 at pci* dev -1 function -1 +.No UKC> Ic change 14 + 14 ep1 at pci* dev -1 function -1 +.No change (y/n) \&? Ic y +.No dev [-1] \&? Ic 14 +.No function [-1] \&? +.No flags [0] \&? Ic 18 + 14 ep1 changed + 14 ep1 at pci* dev 14 function -1 flags 0x12 +UKC> +.Ed +.Pp +When configuration is completed, booting can proceed by issuing the +.Ic quit +or +.Ic exit +commands. +.Bd -literal +.No UKC> Ic quit +Continuing... +mainbus0 (root) +.Ed +.Sh SEE ALSO +.Xr bsd.re-config 5 , +.Xr config 8 +.Sh AUTHORS +.An Mats O Jansson Aq Mt moj@stacken.kth.se diff --git a/static/openbsd/man8/bulk.8 b/static/openbsd/man8/bulk.8 new file mode 100644 index 00000000..ef333e85 --- /dev/null +++ b/static/openbsd/man8/bulk.8 @@ -0,0 +1,208 @@ +.\" $OpenBSD: bulk.8,v 1.11 2025/06/15 19:27:34 tb Exp $ +.\" +.\" Copyright (c) 2016 Marc Espie <espie@openbsd.org> +.\" +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.Dd $Mdocdate: June 15 2025 $ +.Dt BULK 8 +.Os +.Sh NAME +.Nm bulk +.Nd building OpenBSD packages in bulk +.Sh DESCRIPTION +There are quite a few steps necessary to build packages on a cluster. +They are: +.Pp +.Bl -enum -compact -offset indent +.It +Choose master machine setup and create partitions. +.It +Setup chrooted builds on the master. +.It +Add slaves and do a full bulk. +.It +Clean up and do subsequent bulks. +.It +Perform additional maintenance. +.El +.Ss 1. Choose master machine setup and create partitions +Setup a master machine with enough room for a chroot, say +.Pa /build . +Assuming you are using a cluster of machines, +this chroot should contain NFS exportable partitions for distfiles, +plists, and packages (one single partition can be used for simplicity). +A full setup currently requires in the order of 120GB for distfiles +and 80GB for packages. +Expect these numbers to grow. +150GB for each should last a few years. +.Pp +It is possible to build packages without a chroot, but the space +requirement difference is negligible (a full +.Ox +install is less than 2GB), and having everything chrooted means you may +install useful tools to help with the process outside of the chroot +.Po +for instance +.Xr rsync 1 +.Pc . +.Pp +Reserve one "scratch" partition under the chroot for WRKOBJDIR +(for instance, mfs, async, or SSD). +This can often double as +.Pa /tmp +under the chroot. +The largest ports can take in excess of 20GB each (more for a debug +build) and you may have several of these built at the same time. +50GB is probably a reasonable minimum on an architecture which can build +chromium, though 100GB would not be overkill, especially if you have +many cores. +.Pp +Alternately, you can setup your whole chroot as a scratch partition, +and reserve one more permanent space under it for distfiles, +packages, and plists. +.Pp +Choose a strategy for the ports tree itself. +There must be a copy under +.Pa /build . +You can either copy it from outside the chroot, have it in an NFS +partition, or manually make sure all machines on the cluster have the +same ports tree (cvs checkout, rsync ...). +.Pp +Note that logs are only produced on the master, and thus do not +need to be nfs exportable, nor even inside the chroot. +.Pp +.Ox +now comes with default users for package builds, namely _pbuild and _pfetch. +.Pp +The default +.Xr login.conf 5 +is appropriate for most setups, but _pbuild's datasize-cur may need +to be bumped for a few ports. +Likewise, maxproc-cur is too small for machines with more than 4-6 cpus. +.Pp +Note that _pbuild does not need network access, and is now blocked by default +in +.Xr pf 4 . +.Pp +Recent +.Ox +systems do not need any kind of +.Xr doas 1 +setup for bulk ports builds, as +.Xr dpb 1 +is run as root and drops permissions appropriately. +.Pp +However, you may still want to setup +.Xr doas 1 +for root, if you want to manually fix ports, as +.Ar PORTS_PRIVSEP +relies on it. +.Ss 2. Setup chrooted builds on the master +Populate the initial chroot with +.Xr proot 1 . +Point DISTDIR, PACKAGE_REPOSITORY, PLIST_REPOSITORY, WRKOBJDIR +to appropriate locations. +.Pp +Pay attention to nodev and wxallowed warnings. +A chroot setup that can't have devices won't work at all. +A setup without wxallowed in /usr/local and WRKOBJDIR won't +build a lot of things. +.Pp +Check that this setup can build ports by running +.Li dpb -B /build +as root. +Fix any issues related to file ownership at this point. +See +.Xr dpb 1 +for details. +.Pp +If your WRKOBJDIR is a temporary partition, make sure it +belongs to _pbuild:_pbuild after a reboot. +.Ss 3. Add slaves and do a full bulk +Create identical slave machines with the same release material. +Have them import the NFS partitions from the master, they +don't need root access to the partitions. +Set up +.Xr ssh 1 +so that the master can connect to the slaves, using ssh protocol 2, +as root, preferably without a password or passphrase (however, +.Xr dpb 1 +uses a master connection, so a password would be required just once per host). +.Pp +Note that code on slave machines will only run as _pbuild +(during builds) or root (during dependency installation). +Slave machines only require highly restricted network access. +They just need to act as nfs clients to the master and to be reachable +through ssh from the master. +.Pp +Use a similar +.Xr proot 1 +config to populate each slave. +.Pp +You should now be able to build ports on the slaves. +A simple config will just have +.Bd -literal -offset indent +DEFAULT chroot=/build +localhost +host1 +\&... +.Ed +.Pp +Check that the full config can still build ports. +.Pp +You're now ready for a full bulk. +Beware that even fast configs (3 amd64 with 8 cores each) may take over 24 hours +to finish. +It's generally appropriate to run +.Xr dpb 1 +under +.Xr tmux 1 . +.Ss 4. Clean up and do subsequent bulks +Before running the next bulk, you should set up rotating logs and move the +PACKAGE_REPOSITORY away. +Save the PLIST_REPOSITORY and DISTDIR though. +PLIST_REPOSITORY will catch problems in packing-lists. +.Pa ${PLIST_REPOSITORY}/${ARCH}/history +is also used to store +.Xr sha256 1 +history, necessary to reorder files inside packages to speed updates up. +.Pp +The DISTDIR contains history information as well as DISTDIR/build-stats +to speed further runs up. +.Pp +How you wipe things out depends on your setup. +If you run +.Xr proot 1 +again each time, most things will get cleaned up automatically +.Po +.Pa /build/usr/local , /build/var/db/pkg ... +.Pc . +Note that known directories such as WRKOBJDIR do not get cleaned up +automatically, so you may want to set up a STARTUP_SCRIPT in +.Xr dpb 1 . +.Ss 5. Perform additional maintenance +.Xr clean-old-distfiles 1 +should be run occasionally since the DISTDIR will continue growing. +.Pp +.Xr pkg_check-problems 1 +should be run occasionally to find out conflicts and dependency issues. +.Sh SEE ALSO +.Xr clean-old-distfiles 1 , +.Xr dpb 1 , +.Xr pkg_check-problems 1 , +.Xr proot 1 , +.Xr register-plist 1 , +.Xr tmux 1 , +.Xr bsd.port.mk 5 , +.Xr release 8 diff --git a/static/openbsd/man8/crash.8 b/static/openbsd/man8/crash.8 new file mode 100644 index 00000000..54a958a2 --- /dev/null +++ b/static/openbsd/man8/crash.8 @@ -0,0 +1,343 @@ +.\" $OpenBSD: crash.8,v 1.37 2022/09/11 06:38:11 jmc Exp $ +.\" +.\" Copyright (c) 1980, 1991 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. +.\" +.\" from: @(#)crash.8 6.5 (Berkeley) 4/20/91 +.\" +.Dd $Mdocdate: September 11 2022 $ +.Dt CRASH 8 +.Os +.Sh NAME +.Nm crash +.Nd system failure and diagnosis +.Sh DESCRIPTION +This section explains what happens when the system crashes +and (very briefly) how to analyze crash dumps. +.Pp +When the system crashes voluntarily it prints a message of the form +.Bd -literal -offset indent +panic: why i gave up the ghost +.Ed +.Pp +on the console and enters the kernel debugger, +.Xr ddb 4 . +.Pp +If you wish to report this panic, you should include the output of +the +.Ic ps +and +.Ic trace +commands. +Unless the +.Sq ddb.log +sysctl has been disabled, anything output to screen will be +appended to the system message buffer, from where it may be +possible to retrieve it through the +.Xr dmesg 8 +command after a warm reboot. +If the debugger command +.Ic boot dump +is entered, or if the debugger was not compiled into the kernel, or +the debugger was disabled with +.Xr sysctl 8 , +then the system dumps the contents of physical memory +onto a mass storage peripheral device. +The particular device used is determined by the +.Sq dumps on +directive in the +.Xr config 8 +file used to build the kernel. +.Pp +After the dump has been written, the system then +invokes the automatic reboot procedure as +described in +.Xr reboot 8 . +If auto-reboot is disabled (in a machine dependent way), the system +will simply halt at this point. +.Pp +Upon rebooting, and +unless some unexpected inconsistency is encountered in the state +of the file systems due to hardware or software failure, the system +will copy the previously written dump into +.Pa /var/crash +using +.Xr savecore 8 , +before resuming multi-user operations. +.Ss Causes of system failure +The system has a large number of internal consistency checks; if one +of these fails, then it will panic with a very short message indicating +which one failed. +In many instances, this will be the name of the routine which detected +the error, or a two-word description of the inconsistency. +A full understanding of most panic messages requires perusal of the +source code for the system. +.Pp +The most common cause of system failures is hardware failure +.Pq e.g., bad memory +which +can reflect itself in different ways. +Here are the messages which are most likely, with some hints as to causes. +Left unstated in all cases is the possibility that a hardware or software +error produced the message in some unexpected way. +.Bl -tag -width indent +.It no init +This panic message indicates filesystem problems, and reboots are likely +to be futile. +Late in the bootstrap procedure, the system was unable to +locate and execute the initialization process, +.Xr init 8 . +The root filesystem is incorrect or has been corrupted, or the mode +or type of +.Pa /sbin/init +forbids execution. +.It trap type %d, code=%x, pc=%x +A unexpected trap has occurred within the system; the trap types are +machine dependent and can be found listed in +.Pa /sys/arch/ARCH/include/trap.h . +.Pp +The code is the referenced address, and the pc is the program counter at the +time of the fault is printed. +Hardware flakiness will sometimes generate this panic, but if the cause +is a kernel bug, +the kernel debugger +.Xr ddb 4 +can be used to locate the instruction and subroutine inside the kernel +corresponding +to the PC value. +If that is insufficient to suggest the nature of the problem, +more detailed examination of the system status at the time of the trap +usually can produce an explanation. +.It init died +The system initialization process has exited. +This is bad news, as no new users will then be able to log in. +Rebooting is the only fix, so the system just does it right away. +.It out of mbufs: map full +The network has exhausted its private page map for network buffers. +This usually indicates that buffers are being lost, and rather than +allow the system to slowly degrade, it reboots immediately. +The map may be made larger if necessary. +.El +.Pp +That completes the list of panic types you are likely to see. +.Ss Analyzing a dump +When the system crashes it writes (or at least attempts to write) +an image of memory, including the kernel image, onto the dump device. +On reboot, the kernel image and memory image are separated and preserved in +the directory +.Pa /var/crash . +.Pp +To analyze the kernel and memory images preserved as +.Pa bsd.0 +and +.Pa bsd.0.core , +you should run +.Xr gdb 1 , +loading in the images with the following commands: +.Bd -literal -offset indent +# gdb +GNU gdb 6.3 +Copyright 2004 Free Software Foundation, Inc. +GDB is free software, covered by the GNU General Public License, and you are +welcome to change it and/or distribute copies of it under certain conditions. +Type "show copying" to see the conditions. +There is absolutely no warranty for GDB. Type "show warranty" for details. +This GDB was configured as "i386-unknown-openbsd4.6". +(gdb) file /var/crash/bsd.0 +Reading symbols from /var/crash/bsd.0...(no debugging symbols found)...done. +(gdb) target kvm /var/crash/bsd.0.core +.Ed +.Pp +[Note that the +.Dq kvm +target is currently only supported by +.Xr gdb 1 +on some architectures.] +.Pp +After this, you can use the +.Ic where +command to show trace of procedure calls that led to the crash. +.Pp +For custom-built kernels, you should use +.Pa bsd.gdb +instead of +.Pa bsd , +thus allowing +.Xr gdb 1 +to show symbolic names for addresses and line numbers from the source. +.Pp +Analyzing saved system images is sometimes called post-mortem debugging. +There are a class of analysis tools designed to work on +both live systems and saved images, most of them are linked with the +.Xr kvm 3 +library and share option flags to specify the kernel and memory image. +These tools typically take the following flags: +.Bl -tag -width indent +.It Fl M Ar core +Normally this +.Ar core +is an image produced by +.Xr savecore 8 +but it can be +.Pa /dev/mem +too, if you are looking at the live system. +.It Fl N Ar system +Takes a kernel +.Ar system +image as an argument. +This is where the symbolic information is gotten from, +which means the image cannot be stripped. +In some cases, using a +.Pa bsd.gdb +version of the kernel can assist even more. +.El +.Pp +The following commands understand these options: +.Xr fstat 1 , +.Xr netstat 1 , +.Xr nfsstat 1 , +.Xr ps 1 , +.Xr w 1 , +.Xr dmesg 8 , +.Xr iostat 8 , +.Xr kgmon 8 , +.Xr pstat 8 , +.Xr trpt 8 , +.Xr vmstat 8 +and many others. +There are exceptions, however. +For instance, +.Xr ipcs 1 +has renamed the +.Fl M +argument to be +.Fl C +instead. +.Pp +Examples of use: +.Bd -literal -offset indent +# ps -N /var/crash/bsd.0 -M /var/crash/bsd.0.core -O paddr +.Ed +.Pp +The +.Fl O Ar paddr +option prints each process' +.Vt struct proc +address. +This is very useful information if you are analyzing process contexts in +.Xr gdb 1 . +.Bd -literal -offset indent +# vmstat -N /var/crash/bsd.0 -M /var/crash/bsd.0.core -m +.Ed +.Pp +This analyzes memory allocations at the time of the crash. +Perhaps some resource was starving the system? +.Ss Analyzing a live kernel +Like the tools mentioned above, +.Xr gdb 1 +can be used to analyze a live system as well. +This can be accomplished by not specifying a crash dump when selecting the +.Dq kvm +target: +.Bd -literal -offset indent +(gdb) target kvm +.Ed +.Pp +It is possible to inspect processes that entered the kernel by +specifying a process' +.Vt struct proc +address to the +.Ic kvm proc +command: +.Bd -literal -offset indent +(gdb) kvm proc 0xd69dada0 +#0 0xd0355d91 in sleep_finish (sls=0x0, do_sleep=0) + at ../../../../kern/kern_synch.c:217 +217 mi_switch(); +.Ed +.Pp +After this, the +.Ic where +command will show a trace of procedure calls, right back to where the +selected process entered the kernel. +.Sh CRASH LOCATION DETERMINATION +The following example should make it easier for a novice kernel +developer to find out where the kernel crashed. +.Pp +First, in +.Xr ddb 4 +find the function that caused the crash. +It is either the function at the top of the traceback or the function +under the call to +.Fn panic +or +.Fn uvm_fault . +.Pp +The point of the crash usually looks something like this "function+0x4711". +.Pp +Find the function in the sources, let's say that the function is in "foo.c". +.Pp +Go to the kernel build directory, e.g., +.Pa /sys/arch/ARCH/compile/GENERIC , +and do the following: +.Bd -literal -offset indent +# objdump -S foo.o | less +.Ed +.Pp +Find the function in the output. +The function will look something like this: +.Bd -literal -offset indent +0: 17 47 11 42 foo %x, bar, %y +4: foo bar allan %kaka +8: XXXX boink %bloyt +etc. +.Ed +.Pp +The first number is the offset. +Find the offset that you got in the ddb trace +(in this case it's 4711). +.Pp +When reporting data collected in this way, include ~20 lines before and ~10 +lines after the offset from the objdump output in the crash report, as well +as the output of +.Xr ddb 4 Ns 's +"show registers" command. +It's important that the output from objdump includes at least two or +three lines of C code. +.Sh REPORTING +If you are sure you have found a reproducible software bug in the kernel, +and need help in further diagnosis, or already have a fix, use +.Xr sendbug 1 +to send the developers a detailed description including the entire session +from +.Xr gdb 1 . +.Sh SEE ALSO +.Xr gdb 1 , +.Xr sendbug 1 , +.Xr ddb 4 , +.Xr reboot 8 , +.Xr savecore 8 diff --git a/static/openbsd/man8/daily.8 b/static/openbsd/man8/daily.8 new file mode 100644 index 00000000..22071017 --- /dev/null +++ b/static/openbsd/man8/daily.8 @@ -0,0 +1,272 @@ +.\" $OpenBSD: daily.8,v 1.31 2024/07/04 05:06:58 bket Exp $ +.\" +.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: July 4 2024 $ +.Dt DAILY 8 +.Os +.Sh NAME +.Nm daily , weekly , monthly +.Nd periodic system maintenance +.Sh DESCRIPTION +The three files +.Pa /etc/daily , +.Pa /etc/weekly , +and +.Pa /etc/monthly +are shell scripts run on a periodic basis by the clock daemon, +.Xr cron 8 . +They take care of some basic administrative tasks. +Their output, if any, is mailed to root. +.Pp +.Sy Note : +The scripts are all run as part of root's +.Xr crontab 5 . +However, it is strongly suggested that the root mail account +be an alias that forwards messages to a real user or set of users. +Otherwise, root's mail will simply accumulate in +.Pa /var/mail +until the partition holding it runs out of space. +See +.Xr newaliases 8 +for further details. +.Pp +These scripts should not be altered. +Local additions should be made to the files +.Pa /etc/daily.local , +.Pa /etc/weekly.local , +and +.Pa /etc/monthly.local , +which will be executed by +.Pa /etc/daily , +.Pa /etc/weekly , +and +.Pa /etc/monthly , +respectively. +The +.Pa *.local +files are executed first, which makes it convenient to do any necessary +cleanup and backup and to define any required shell variables before the +script is run. +.Ss /etc/daily +This script is run daily. +It currently does the following: +.Bl -dash +.It +Runs the script +.Pa /etc/daily.local , +if it exists. +.It +Removes scratch and junk files from +.Pa /tmp . +.It +Purges accounting records from +.Pa /var/account , +if they exist. +Processes that were killed due to pledge or memory access violations, +or had file access prevented by unveil, +are reported in the daily mail. +See +.Xr accton 8 , +.Xr lastcomm 1 , +and +.Xr sa 8 . +.It +Creates a backup root file system which is updated daily. +This only happens if the following conditions are met: +.Bl -enum -offset indent +.It +The environment variable +.Ev ROOTBACKUP +must be set. +For example, the following can be added to +.Pa /etc/daily.local : +.Pp +.Dl ROOTBACKUP=1 +.It +The mount directory +.Pa /altroot +must exist, and there must be an +.Pa /etc/fstab +entry specifying a configured disk device, the file system type +.Sq ffs , +and +.Sq xx +for the mount options, e.g. +.Pp +.Dl /dev/wd0j /altroot ffs xx 0 0 +.El +.It +Checks daemon status. +Lists any daemons which are enabled in +.Xr rc.conf.local 8 +but which are not actually running. +.It +Reports on which file systems need to be dumped via +.Xr dump 8 . +.It +Runs the +.Xr calendar 1 +utility unless the environment variable +.Ev CALENDAR +is set to 0 in +.Pa /etc/daily.local +or the host is a +.Xr yp 8 +client. +.It +If +.Ev CHECKFILESYSTEMS +is set to 1 in +.Pa /etc/daily.local , +runs +.Xr fsck 8 +with the no-write flag +.Pq Fl n . +.It +If the file +.Pa /etc/Distfile +exists, runs the +.Xr rdist 1 +utility. +.It +Runs the system +.Xr security 8 +check script. +.El +.Ss /etc/weekly +This script is run weekly. +It currently does the following: +.Bl -dash +.It +Runs the script +.Pa /etc/weekly.local , +if it exists. +.It +Rebuilds the +.Xr locate 1 +database, if there is an existing +.Pa /var/db/locate.database +file. +.It +Rebuilds the +.Xr whatis 1 +database(s) via +.Xr makewhatis 8 . +.It +If +.Ev LOGINACCOUNTING +is set to 1 in +.Pa /etc/weekly.local +and the +.Pa /var/log/wtmp +file exists, show individual users' login via the +.Xr ac 8 +utility. +.El +.Ss /etc/monthly +This script is run monthly. +It currently does the following: +.Bl -dash +.It +Runs the script +.Pa /etc/monthly.local , +if it exists. +.El +.Sh ENVIRONMENT +The following variables can be set in +.Pa /etc/daily.local : +.Pp +.Bl -tag -width "CHECKFILESYSTEMS" -compact +.It Ev CALENDAR +If set to 0, do not run +.Xr calendar 1 . +.It Ev CHECKFILESYSTEMS +If set to 1, run +.Xr fsck 8 +with the no-write flag. +.It Ev ROOTBACKUP +If set to 1, make a backup of the root file system. +.El +.Pp +The following variables can be set in +.Pa /etc/weekly.local : +.Pp +.Bl -tag -width "CHECKFILESYSTEMS" -compact +.It Ev LOGINACCOUNTING +If set to 1, run +.Xr ac 8 +to report login accounting. +.It Ev MAKEWHATISARGS +Arguments for +.Xr makewhatis 8 ; +empty by default. +.El +.Sh FILES +.Bl -tag -width "/var/cron/tabs/root" -compact +.It Pa /etc/daily +Daily maintenance script. +.It Pa /etc/daily.local +Site specific daily maintenance script. +.It Pa /etc/weekly +Weekly maintenance script. +.It Pa /etc/weekly.local +Site specific weekly maintenance script. +.It Pa /etc/monthly +Monthly maintenance script. +.It Pa /etc/monthly.local +Site specific monthly maintenance script. +.It Pa /var/cron/tabs/root +Root +.Xr crontab 5 . +.El +.Sh SEE ALSO +.Xr calendar 1 , +.Xr crontab 1 , +.Xr locate 1 , +.Xr rdist 1 , +.Xr whatis 1 , +.Xr crontab 5 , +.Xr ac 8 , +.Xr accton 8 , +.Xr cron 8 , +.Xr dump 8 , +.Xr fsck 8 , +.Xr makewhatis 8 , +.Xr sa 8 , +.Xr security 8 , +.Xr yp 8 +.Sh HISTORY +The +.Nm daily , weekly , +and +.Nm monthly +scripts first appeared in +.Bx 4.3 Reno . +This manual page first appeared in +.Ox 3.4 . +.Sh CAVEATS +If the host machine is not running 24/7, these scripts may never be run. +Adjusting the time fields in the system +.Xr crontab 5 +may partially alleviate this problem. +.Pp +Be careful when adding local additions. +Services such as +.Qq www +have their own users, and should be run as such, not as root. +It may be more appropriate to create a separate +.Xr crontab 5 +for such services. diff --git a/static/openbsd/man8/diskless.8 b/static/openbsd/man8/diskless.8 new file mode 100644 index 00000000..30f0e4f3 --- /dev/null +++ b/static/openbsd/man8/diskless.8 @@ -0,0 +1,425 @@ +.\" $OpenBSD: diskless.8,v 1.72 2022/06/26 12:34:41 deraadt Exp $ +.\" $NetBSD: diskless.8,v 1.7.4.1 1996/05/30 18:58:10 cgd Exp $ +.\" +.\" +.\" Copyright (c) 1994 Gordon W. Ross, Theo de Raadt +.\" 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. 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. +.\" +.Dd $Mdocdate: June 26 2022 $ +.Dt DISKLESS 8 +.Os +.Sh NAME +.Nm diskless +.Nd booting a system over the network +.Sh DESCRIPTION +The ability to boot a machine over the network is useful for +.Em diskless +or +.Em dataless +machines, or as a temporary measure while repairing or +re-installing filesystems on a local disk. +This file provides a general description of the interactions between +a client and its server when a client is booting over the network. +The general description is followed by specific instructions for +configuring a server for diskless clients. +.Pp +When booting a system over the network, there are three +phases of interaction between client and server: +.Pp +.Bl -enum -compact +.It +The PROM (or stage-1 bootstrap) loads a boot program. +.It +The boot program loads a kernel. +.It +The kernel does NFS mounts for root and swap. +.El +.Pp +Each of these phases are described in further detail below. +.Pp +In +.Em phase 1 , +the PROM loads a boot program. +PROM designs vary widely, so this phase is inherently +machine-specific. +Sun and Motorola machines use RARP to determine the client's IP address +and then use TFTP to download a boot program +from whoever sent the RARP reply. +HP 300-series machines use the +HP Remote Maintenance Protocol +to download a boot program. +Other machines may load a +network boot program either from diskette or +using a special PROM on the network card. +.Pp +In +.Em phase 2 , +the boot program loads a kernel. +Operation in this phase depends on the design of the boot program. +The procedure used by the boot program is as follows: +.Pp +.Bl -enum -compact +.It +The boot program +gets the client IP address using RARP. +.It +The boot program +gets the client name and server IP address by broadcasting an +RPC/BOOTPARAMS/WHOAMI request with the client IP address. +.It +The boot program +gets the server path for this client's root +using an RPC/BOOTPARAMS/GETFILE request with the client name. +.It +The boot program +gets the root file handle by calling +.Xr mountd 8 +with the server path for the client root. +.It +The boot program +gets the kernel file handle by calling +NFS lookup on the root file handle. +.It +The boot program +loads the kernel using +NFS read calls on the kernel file handle. +.It +The boot program +transfers control to the kernel entry point. +.El +.Pp +In +.Em phase 3 , +the kernel does NFS mounts for root and swap. +The kernel repeats much of the work done by the boot program +because there is no standard way for the boot program to pass +the information it gathered on to the kernel. +The procedure used by the kernel is as follows: +.Pp +.Bl -enum -compact +.It +The kernel finds a boot server using the same procedure +as described in steps 1 and 2 of phase 2, above. +.It +The kernel gets the NFS +file handle for root using the same procedure +as described in steps 3, 4, and 5 of phase 2, above. +.It +The kernel calls the NFS +getattr function to get the last-modified time of the root +directory, and uses it to check the system clock. +.It +If the kernel is configured for swap on NFS, +it uses the same mechanism as for root, but uses the NFS +getattr function to determine the size of the swap area. +.El +.Pp +The +.Pa INSTALL. Ns Aq Ar arch +notes that come with each distribution +also give details on the specifics of net/diskless booting +for each architecture. +.Pp +The procedures for AMD64 and i386 clients vary somewhat +to the stages detailed above. +See +.Xr pxeboot 8 +for more detailed information. +.Sh EXAMPLES +Before a client can boot over the network, +its server must be configured correctly. +This example will demonstrate how to configure a server and client. +.Pp +Assuming the client's hostname is to be +"myclient": +.Bl -enum +.It +Add an entry to +.Pa /etc/ethers +corresponding to the client's Ethernet address: +.Bd -literal -offset indent +8:0:20:7:c5:c7 myclient +.Ed +.Pp +This will be used by +.Xr rarpd 8 . +.It +Assign an IP address for myclient in +.Pa /etc/hosts : +.Bd -literal -offset indent +192.197.96.12 myclient +.Ed +.It +If booting an alpha, amd64, hppa, i386, +or sparc64 client, +ensure that +.Xr tftpd 8 +is configured to run in the directory +.Pa /tftpboot . +.Pp +If booting an HP 300 or older HPPA machine, ensure that +.Pa /etc/rbootd.conf +is configured properly to transfer the boot program to the client. +An entry might look like this: +.Bd -literal -offset indent +08:00:09:01:23:E6 SYS_UBOOT # myclient +.Ed +.Pp +See the +.Xr rbootd 8 +manual page for more information. +.It +If booting a newer alpha, amd64, hppa, i386, +or sparc64 client, +install a copy of the appropriate diskless boot loader in the +.Pa /tftpboot +directory. +.Pp +If booting a Motorola or Sun client, +make a link such that the boot program is +accessible as a file named after the client's IP address in hex. +For example: +.Bd -literal -offset indent +# cd /tftpboot +# ln -s boot.net C0C5600C +.Ed +.Pp +The following example converts an IP address to hex: +.Bd -literal -offset indent +$ echo 192.197.96.12 | awk -F . \e + '{ printf "%02X%02X%02X%02X\en", $1, $2, $3, $4 }' +.Ed +.Pp +Sun Sparc machines also require a +.Dq . Ns Aq Ar arch +suffix. +So the filename in the example above for a Sun4 machine would be +.Dq C0C5600C.SUN4 . +The name used is really architecture dependent: +it simply has to match what the booting client's PROM wishes it to be. +If the client's PROM fails to fetch the expected file, +.Xr tcpdump 8 +can be used to discover which filename the client is trying to read. +.Pp +Architectures using DHCP +(newer alpha, amd64, hppa, or i386) +should ensure that +.Xr dhcpd 8 +is configured on the server to serve BOOTP protocol requests. +An example entry in +.Xr dhcpd.conf 5 : +.Bd -literal -offset indent +subnet 10.0.0.0 netmask 255.0.0.0 { + host myclient { + filename "netboot"; + option root-path "/export/myclient/root"; + hardware ethernet 00:02:56:00:73:31; + fixed-address 10.42.42.42; + } +} +.Ed +.Pp +Note that procedures for AMD64 and i386 clients vary somewhat. +See +.Xr pxeboot 8 +for more detailed information. +.Pp +Architectures using the HP remote boot server +(HP 300 or older HPPA) +should ensure that the general purpose +boot program is installed in the directory +.Pa /usr/mdec/rbootd . +.Pp +Architectures using MOP +(older Alpha) +should follow the instructions in +.Xr mopd 8 +for setting up a TFTP boot. +.It +Add myclient to the bootparams database +.Pa /etc/bootparams : +.Bd -literal -offset indent +myclient root=server:/export/myclient/root \e + swap=server:/export/myclient/swap +.Ed +.Pp +Note that some bootparam servers are somewhat sensitive. +Some require fully qualified hostnames or partially qualified hostnames +(which can be solved by having both fully and partially qualified entries). +Other servers are case sensitive. +.It +Build the swap file for myclient: +.Bd -literal -offset indent +# mkdir -p /export/myclient/root/swap +# cd /export/myclient +# dd if=/dev/zero of=swap bs=1m count=120 +.Ed +.Pp +This creates a 120 Megabyte swap file and an empty /swap directory. +A smaller swap file may be created if the boot is for +maintenance (i.e. temporary) purposes only. +.It +Populate myclient's root +filesystem on the server. +How this is done depends on the client architecture and the version of the +.Ox +distribution. +It can be as simple as copying and modifying the server's root +filesystem, or perhaps the files can be taken from the +standard binary distribution. +.It +Export the required filesystems in +.Pa /etc/exports : +.Bd -literal -offset indent +/usr -ro myclient +/export/myclient -maproot=root -alldirs myclient +.Ed +.Pp +If the server and client are of the same architecture, then the client +can share the server's +.Pa /usr +filesystem (as is done above). +If not, a properly fleshed out +.Pa /usr +partition will have to be built for the client in some other place. +.It +Copy and customize at least the following files in +.Pa /export/myclient/root : +.Bd -literal -offset indent +# cd /export/myclient/root/etc +# cp /etc/fstab fstab +# cp /etc/hosts hosts +# echo myclient > myname +# echo inet 192.197.96.12 > hostname.le0 +.Ed +.Pp +Note that "le0" above should be replaced with the name of +the network interface that the client will use for booting. +.It +Correct at least +the critical mount points in the client's +.Xr fstab 5 +(which will be +.Pa /export/myclient/root/etc/fstab ) : +.Bd -literal -offset indent +myserver:/export/myclient/root / nfs rw 0 0 +myserver:/export/myclient/swap none swap sw,nfsmntpt=/swap +myserver:/export/myclient/root/usr /usr nfs rw,nodev 0 0 +.Ed +.Pp +The above example works even if +.Pa /usr +is not on a separate partition. +It allows them to be mounted with NFSv3, +if the server allows it, +and to specify per-partition mount options, +such as +.Cm nodev . +.Pp +If the +.Pa /usr +partition is to be shared between machines, +as in the example +.Pa /etc/exports +above, a more suitable entry might be: +.Bd -literal -offset indent +myserver:/usr /usr nfs ro 0 0 +.Ed +.It +Make sure the correct processes are enabled on the server. +See +.Xr rc.conf 8 +for details of how to start these processes at boot. +.Pp +For all clients: +.Xr mountd 8 , +.Xr nfsd 8 , +.Xr portmap 8 , +.Xr rarpd 8 , +and +.Xr rpc.bootparamd 8 . +.Pp +For alpha, amd64, hppa, i386, and sparc64 clients: +.Xr tftpd 8 +.Pp +For HP 300 and older HPPA clients: +.Xr rbootd 8 +.Pp +For newer alpha, amd64, hppa, and i386 clients: +.Xr dhcpd 8 +.Pp +For older alpha clients: +.Xr mopd 8 +.It +Net boot the client. +.El +.Sh FILES +.Bl -tag -width "/usr/mdec/rbootdXX" -compact +.It Pa /etc/bootparams +Client root and swap pathnames. +.It Pa /etc/dhcpd.conf +DHCP daemon configuration file. +.It Pa /etc/ethers +Ethernet addresses of known clients. +.It Pa /etc/exports +Exported NFS mount points. +.It Pa /etc/fstab +Static information about the filesystems. +.It Pa /etc/hostname.$if +Interface-specific configuration file. +.It Pa /etc/hosts +Host name database. +.It Pa /etc/myname +Default hostname. +.It Pa /etc/mygate +Default gateway. +.It Pa /etc/rbootd.conf +Configuration file for HP Remote Boot Daemon. +.It Pa /tftpboot +Location of boot programs loaded by the Sun PROM. +.It Pa /usr/mdec/rbootd +Location of boot programs loaded by the HP Boot ROM. +.El +.Sh SEE ALSO +.Xr bootparams 5 , +.Xr dhcpd.conf 5 , +.Xr ethers 5 , +.Xr exports 5 , +.Xr fstab 5 , +.Xr hostname.if 5 , +.Xr hosts 5 , +.Xr mygate 5 , +.Xr myname 5 , +.Xr dhcpd 8 , +.Xr mopd 8 , +.Xr mountd 8 , +.Xr nfsd 8 , +.Xr portmap 8 , +.Xr pxeboot 8 , +.Xr rarpd 8 , +.Xr rbootd 8 , +.Xr rpc.bootparamd 8 , +.Xr tcpdump 8 , +.Xr tftpd 8 diff --git a/static/openbsd/man8/genassym.sh.8 b/static/openbsd/man8/genassym.sh.8 new file mode 100644 index 00000000..ab34b0e0 --- /dev/null +++ b/static/openbsd/man8/genassym.sh.8 @@ -0,0 +1,93 @@ +.\" $OpenBSD: genassym.sh.8,v 1.9 2015/03/13 19:58:41 jmc Exp $ +.\" $NetBSD: genassym.sh.8,v 1.5 1999/03/17 20:31:19 garbled Exp $ +.\" +.\" Copyright (c) 1997 Matthias Pfaller. +.\" 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. +.\" +.Dd $Mdocdate: March 13 2015 $ +.Dt GENASSYM.SH 8 +.Os +.Sh NAME +.Nm genassym.sh +.Nd emit an assym.h file +.Sh SYNOPSIS +.Nm sh genassym.sh +.Op Fl c +.Ar C compiler invocation +.Sh DESCRIPTION +.Nm +is a shell script normally used during the kernel build process to +create an assym.h file. +This file defines a number of cpp constants derived from the configuration +information +.Nm +reads from stdin. +The generated file is used by kernel sources +written in assembler to gain access to information (e.g. structure +offsets and sizes) normally only known to the C compiler. +.Pp +.Nm +resides in the +.Pa /sys/kern +directory. +Arguments to +.Nm +are usually of the form +.Ar ${CC} ${CFLAGS} ${CPPFLAGS} +where +.Ar ${CC} +is the C compiler used to compile the kernel, while +.Ar ${CFLAGS} +and +.Ar ${CPPFLAGS} +are flag arguments to the C compiler. +The script creates a C source file from its input. +Then the C compiler is called according to the script's arguments +to compile this file. +.Pp +Normally +.Nm +instructs the C compiler to create an assembler source from the constructed +C source. +The resulting file is then processed to extract the information +needed to create the assym.h file. +The +.Fl c +flag instructs +.Nm +to create slightly different code, generate an executable from this code +and run it. +In both cases the assym.h file is written to stdout. +.Sh DIAGNOSTICS +Either self-explanatory, or generated by one of the programs +called from the script. +The script will exit with the return code from the compiler or, in the +.Fl c +case, with the return code from the generated executable. +.Sh SEE ALSO +.Xr genassym.cf 5 +.Sh HISTORY +The +.Nm +script first appeared in +.Ox 2.2 . diff --git a/static/openbsd/man8/intro.8 b/static/openbsd/man8/intro.8 new file mode 100644 index 00000000..b7f8c71e --- /dev/null +++ b/static/openbsd/man8/intro.8 @@ -0,0 +1,299 @@ +.\" $OpenBSD: intro.8,v 1.29 2019/05/26 00:52:22 naddy Exp $ +.\" $NetBSD: intro.8,v 1.3 1994/11/30 19:36:24 jtc Exp $ +.\" +.\" Copyright (c) 1983, 1991, 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. +.\" +.\" @(#)intro.8 8.2 (Berkeley) 12/11/93 +.\" +.Dd $Mdocdate: May 26 2019 $ +.Dt INTRO 8 +.Os +.Sh NAME +.Nm intro +.Nd introduction to system maintenance and operation commands +.Sh DESCRIPTION +The manual pages in section 8 contain information related to +system operation and maintenance. +They describe commands concerning file systems, +such as +.Xr edquota 8 , +.Xr fsck 8 , +.Xr mount 8 , +and +.Xr newfs 8 . +They also cover commands concerning system backup/recovery, such as +.Xr dump 8 +and +.Xr restore 8 . +.Pp +There are pages which document the running of the system, such as +.Xr afterboot 8 , +.Xr ifconfig 8 , +.Xr security 8 , +and the configuration files located in +.Pa /etc . +Procedures concerning system failure are documented in +.Xr crash 8 . +.Pp +Section 8 pages also describe network services and daemons. +The rest of this page discusses some of the main daemons +available on the +.Ox +system, +and how to enable/disable them. +.Pp +System daemons are controlled by the script +.Xr rc 8 , +which is in turn configured by +.Xr rc.conf 8 . +For example the HTTP daemon +.Xr httpd 8 +is controlled by the following line from +.Xr rc.conf 8 : +.Bd -literal -offset indent +httpd_flags=NO +.Ed +.Pp +Thus it is not started by default. +To enable or disable daemon processes, +administrators should edit the file +.Xr rc.conf.local 8 +or use the +.Xr rcctl 8 +utility. +The +.Xr rc.conf.local 8 +file overrides variable assignments in +.Xr rc.conf 8 . +So to enable +.Xr httpd 8 , +the following line might be added to +.Pa /etc/rc.conf.local : +.Bd -literal -offset indent +httpd_flags="-v" +.Ed +.Pp +As can be seen above, +this method is also used to specify additional options. +.Pp +Below is a list of some of the daemons available. +For further information, see +.Xr rc 8 +and the individual pages for the utilities. +.Ss Automounter daemon (amd) +If using the +.Xr amd 8 +daemon, +go into the +.Pa /etc/amd +directory and set it up by +renaming +.Pa master.sample +to +.Pa master +and editing it and creating other maps as needed. +Alternatively, you can get your maps with YP. +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va amd_flags +and +.Va amd_master . +.Ss DNS server +If you are using a name server, check the +.Pa /etc/resolv.conf +file. +It may look something like: +.Bd -literal -offset indent +domain nts.umn.edu +nameserver 128.101.101.101 +nameserver 134.84.84.84 +search nts.umn.edu. umn.edu. +lookup file bind +.Ed +.Pp +If using a caching name server, add the line "nameserver 127.0.0.1" first. +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va nsd_flags +and +.Va unbound_flags . +.Ss Clock synchronisation +In order to make sure the system clock is correct, +it may be synchronised with a number of external sources. +The utilities available are: +.Xr ntpd 8 +and +.Xr rdate 8 . +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va ntpd_flags . +.Ss BOOTP/DHCP server +If this is a +BOOTP or DHCP +server, edit +.Pa /etc/dhcpd.conf +as needed. +See also +.Xr diskless 8 . +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va bootparamd_flags , +.Va dhcpd_flags , +and +.Va dhcrelay_flags . +.Ss HP remote boot server +Edit +.Pa /etc/rbootd.conf +if needed for remote booting. +If you do not have HP computers doing remote booting, do not enable this. +See also +.Xr diskless 8 . +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va rbootd_flags . +.Ss httpd web server (HTTP) +On +.Ox +it will +.Xr chroot 2 +to +.Pa /var/www . +Detailed information is available in +.Xr httpd 8 +and +.Xr httpd.conf 5 . +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va httpd_flags . +.Ss NFS server +If this is an NFS server, +edit +.Pa /etc/exports . +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va mountd_flags +and +.Va nfsd_flags . +.Ss Relay Daemon +A relay daemon, +.Xr relayd 8 , +able to run as a +load-balancer, application layer gateway, or transparent proxy. +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va relayd_flags . +.Ss Routing Daemons +Various daemons for managing routing tables are available: +.Xr bgpd 8 , +.Xr eigrpd 8 , +.Xr ospfd 8 , +and +.Xr ripd 8 . +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va bgpd_flags , +.Va eigrpd_flags , +.Va ospfd_flags , +and +.Va ripd_flags . +.Ss RPC-based network services +Several services depend on the RPC portmapper, +.Xr portmap 8 , +being running for proper operation. +This includes YP and NFS exports, among other services. +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va portmap_flags . +.Ss YP setup +Check the YP domain name with the +.Xr domainname 1 +command. +If necessary, correct it by editing the +.Pa /etc/defaultdomain +file (see +.Xr defaultdomain 5 ) . +The +.Pa /etc/netstart +script reads this file on boot to determine and set the domain name. +You may also set the running system's domain name with the +.Xr domainname 1 +command. +.Pp +Relevant +.Xr rc.conf 8 +variables: +.Va ypbind_flags . +.Pp +After starting YP client services, perform the remaining YP activation +as described in +.Xr passwd 5 +and +.Xr group 5 . +.Pp +In particular, to enable YP passwd support, you'll need to add the following +line to +.Pa /etc/master.passwd : +.Pp +.Dl +:*:::::::: +.Pp +You do this by using +.Xr vipw 8 . +.Pp +There are many more YP man pages available to help you. +You can find more information by starting with +.Xr yp 8 . +.Sh SEE ALSO +.Xr afterboot 8 , +.Xr rc 8 , +.Xr rc.conf 8 , +.Xr rcctl 8 +.Sh HISTORY +An +.Nm intro +manual for section 8 appeared in +.Bx 4.2 . diff --git a/static/openbsd/man8/man8.alpha/MAKEDEV.8 b/static/openbsd/man8/man8.alpha/MAKEDEV.8 new file mode 100644 index 00000000..d97b634d --- /dev/null +++ b/static/openbsd/man8/man8.alpha/MAKEDEV.8 @@ -0,0 +1,284 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.85 2025/09/29 01:02:58 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.alpha/MAKEDEV.md,v 1.79 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 alpha +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The alpha supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on alpha. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar fd* +Floppy disk drives (3 1/2", 5 1/4"), see +.Xr fd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.It Ar ttyc* +Cyclades serial ports, see +.Xr cy 4 . +.It Ar ttyB* +DEC 3000 serial ports, see +.Xr zs 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy Printers +.Bl -tag -width tenletters -compact +.It Ar lpa* +Polled printer port, see +.Xr lpt 4 . +.It Ar lpt* +IEEE 1284 centronics printer, see +.Xr lpt 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bktr* +Video frame grabbers, see +.Xr bktr 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar speaker +PC speaker, see +.Xr spkr 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar tuner* +Tuner devices, see +.Xr bktr 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.alpha/Makefile b/static/openbsd/man8/man8.alpha/Makefile new file mode 100644 index 00000000..8e160c60 --- /dev/null +++ b/static/openbsd/man8/man8.alpha/Makefile @@ -0,0 +1,4 @@ +MAN = boot_alpha.8 \ + MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.alpha/boot_alpha.8 b/static/openbsd/man8/man8.alpha/boot_alpha.8 new file mode 100644 index 00000000..e6eb7b39 --- /dev/null +++ b/static/openbsd/man8/man8.alpha/boot_alpha.8 @@ -0,0 +1,115 @@ +.\" $OpenBSD: boot_alpha.8,v 1.17 2023/03/13 20:32:28 miod Exp $ +.\" +.\" Copyright (c) 2002, Miodrag Vallat. +.\" 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. +.Dd $Mdocdate: March 13 2023 $ +.Dt BOOT_ALPHA 8 alpha +.Os +.Sh NAME +.Nm boot_alpha +.Nd Alpha system bootstrapping procedures +.Sh DESCRIPTION +.Ss Cold starts +When powered on, the SRM firmware will proceed to its initialization, and +will boot an operating system if the +.Em auto_action +variable is set to +.Dq boot +or +.Dq restart , +or will wait for interactive commands if set to +.Dq halt . +.Ss Warm starts +After a panic, or if the system is rebooted via +.Xr reboot 8 +or +.Xr shutdown 8 , +the SRM console will only restart the system if the +.Em auto_action +variable is set to +.Dq boot . +.Ss Boot process options +The SRM console will attempt to boot from the device listed in the +.Em bootdef_dev +variable. +A list of the recognized SRM devices can be obtained with the command +.Ic show dev +at the SRM prompt. +.Pp +The +.Ox +alpha boot loader program is extensively described in a separate document, +.Xr boot 8 . +.Ss Abnormal system termination +In case of system crashes, the kernel will usually enter the kernel +debugger, +.Xr ddb 4 , +unless it is not present in the kernel, or it is disabled via the +.Em ddb.panic +sysctl. +Upon leaving ddb, or if ddb was not entered, the kernel will halt the system +if it was still in device configuration phase, or attempt a dump to the +configured dump device, if possible. +The crash dump will then be recovered by +.Xr savecore 8 +during the next multi-user boot cycle. +It is also possible to force other behaviours from ddb. +.Sh FILES +.Bl -tag -width /usr/mdec/netboot -compact +.It Pa /bsd +default system kernel +.It Pa /bsd.rd +standalone installation kernel, suitable for disaster recovery +.It Pa /usr/mdec/bootxx +primary bootstrap for +.Dq ffs +file system +.It Pa /usr/mdec/boot +secondary bootstrap (usually also installed as +.Pa /boot ) +.It Pa /usr/mdec/netboot +network bootstrap +.El +.Sh SEE ALSO +.Xr ddb 4 , +.Xr boot 8 , +.Xr boot_config 8 , +.Xr halt 8 , +.Xr init 8 , +.Xr installboot 8 , +.Xr reboot 8 , +.Xr savecore 8 , +.Xr setnetbootinfo 8 , +.Xr shutdown 8 +.Rs +.%T "Alpha Architecture Reference Manual Third Edition" +.%Q "Alpha Architecture Committee" +.%I "Digital Press" +.%D 1998 +.Re +.Sh BUGS +The device names used by +.Ox Ns / Ns alpha +and the +.Tn SRM Console +often have no relation to each other. diff --git a/static/openbsd/man8/man8.amd64/MAKEDEV.8 b/static/openbsd/man8/man8.amd64/MAKEDEV.8 new file mode 100644 index 00000000..1a32b0c4 --- /dev/null +++ b/static/openbsd/man8/man8.amd64/MAKEDEV.8 @@ -0,0 +1,317 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.99 2025/09/29 01:02:58 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.amd64/MAKEDEV.md,v 1.85 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 amd64 +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The amd64 supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on amd64. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar fd* +Floppy disk drives (3 1/2", 5 1/4"), see +.Xr fd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.It Ar ttyc* +Cyclades serial ports, see +.Xr cy 4 . +.It Ar ttyVI* +Virtio serial ports, see +.Xr viocon 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy Printers +.Bl -tag -width tenletters -compact +.It Ar lpa* +Polled printer port, see +.Xr lpt 4 . +.It Ar lpt* +IEEE 1284 centronics printer, see +.Xr lpt 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar apm +Power Management Interface, see +.Xr apm 4 . +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bktr* +Video frame grabbers, see +.Xr bktr 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dri +Direct Rendering Infrastructure, see +.Xr drm 4 . +.It Ar efi +EFI runtime services, see +.Xr efi 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar gpio* +General Purpose Input/Output, see +.Xr gpio 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar ipmi* +IPMI BMC access, see +.Xr ipmi 4 . +.It Ar nvram +NVRAM access, see +.Xr nvram 4 . +.It Ar kcov +Kernel code coverage tracing, see +.Xr kcov 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pctr* +PC Performance Tuning Register access device, see +.Xr pctr 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar speaker +PC speaker, see +.Xr spkr 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar tuner* +Tuner devices, see +.Xr bktr 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vmm +Virtual Machine Monitor, see +.Xr vmm 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar pvbus* +paravirtual device tree root, see +.Xr pvbus 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.It Ar psp +Platform Security Processor, see +.Xr psp 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.amd64/Makefile b/static/openbsd/man8/man8.amd64/Makefile new file mode 100644 index 00000000..e8fe087c --- /dev/null +++ b/static/openbsd/man8/man8.amd64/Makefile @@ -0,0 +1,4 @@ +MAN = boot_amd64.8 \ + MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.amd64/boot_amd64.8 b/static/openbsd/man8/man8.amd64/boot_amd64.8 new file mode 100644 index 00000000..6c6926a2 --- /dev/null +++ b/static/openbsd/man8/man8.amd64/boot_amd64.8 @@ -0,0 +1,191 @@ +.\" $OpenBSD: boot_amd64.8,v 1.9 2016/02/25 09:43:52 tb Exp $ +.\" +.\" Copyright (c) 1997 Tobias Weingartner +.\" +.\" 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 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 $Mdocdate: February 25 2016 $ +.Dt BOOT_AMD64 8 amd64 +.Os +.Sh NAME +.Nm boot_amd64 +.Nd amd64 system bootstrapping procedures +.Sh DESCRIPTION +.Ss Cold starts +The +.Tn Athlon64 +computers and clones will perform a POST (Power On Self Test) upon +being booted cold. +This test will find and initialize memory, keyboard, and other devices. +It will search for and initialize any extension ROMs that are present, +and then attempt to boot the operating system from an available boot +drive. +.Pp +The boot drive is usually specified in the BIOS setup. +.Ss Warm starts +The BIOS loads the first block (at physical location: track 0, head 0, +sector 1) off the boot device into memory, and if the last two bytes in the +block match the signature 0xAA55, the BIOS considers the block a valid +bootable drive. +The BIOS then proceeds to call the machine code program in this block. +If the BIOS is current, it will also pass the boot drive +to the boot block in register %dl. +.Pp +There are two different types of boot blocks on devices. +There is the +MBR (master boot record) and the PBR (partition boot record). +A digression +into a little piece of history will quickly give light as to why this is so. +In the beginning, the PC +.Dq architecture +came with single or dual floppy +drives, and no hard drives. +The only type of bootable sectors on any device were the PBRs. +They were responsible for loading the rest of the operating +system from the correct device. +When hard disks came out, it was felt that +such a huge space should be able to be partitioned into separate drives, +and this is when the MBR was invented. +.Pp +The MBR relocates itself upon being loaded and invoked by the BIOS. +Embedded within the MBR is a partition table, with four partition table +entries. +The MBR code traverses this table (which was loaded with the +MBR by the BIOS), looking for an active entry, and then loads the MBR or +PBR from the disk location specified by the partition table entry. +So in reality, the MBR is nothing more than a fancy chaining PBR. +.Pp +Note: The MBR could load another MBR, which is the case when you are booting +off an extended partition. +In other words, the first block of an extended +partition is really an MBR, which will then load the corresponding MBR or PBR +out of its extended partition's partition table. +.Ss Geometry translation +.Em WARNING : +This portion of the +.Dq PC BIOS Architecture +is a mess, and a compatibility nightmare. +.Pp +The PC BIOS has an API to manipulate any disk that the BIOS happens to +support. +This interface uses 10 bits to address the cylinder, 8 bits to +address the head, and 6 bits to address the sector of a drive. +This restricts any application using the BIOS to being able to address only +1024 cylinders, 256 heads, and 63 (since the sectors are 1 based) sectors +on a disk. +These limitations proved to be fine for roughly 3 years after +the debut of hard disks on PC computers. +.Pp +Many (if not all) newer drives have many more cylinders than the BIOS API +can support, and likely more sectors per track as well. +To allow the BIOS the ability of accessing these large drives, the BIOS would +.Dq re-map +the +cylinder/head/sector of the real drive geometry into something that would +allow the applications using the BIOS to access a larger portion of the +drive, still using the restricted BIOS API. +.Pp +The reason this has become a problem is that any modern OS will use its own +drivers to access the disk drive, bypassing the BIOS completely. +However, +the MBR, PBR, and partition tables are all still written using the original +BIOS access methods. +This is for backwards compatibility to the original IBM PC! +.Pp +So the gist of it is, the MBR, PBR, and partition table need to have BIOS +geometry offsets and cylinder/head/sector values for them to be able to +load any type of operating system. +This geometry can, and likely will, +change whenever you move a disk from machine to machine, or from controller +to controller. +.Em They are controller and machine specific . +.Ss Boot process options +On most +.Ox +systems, booting +.Ox +from the BIOS will load the +.Ox Ns -specific +first-stage bootstrap, +.Xr biosboot 8 , +which in turn will locate and load the second-stage bootstrap, +.Xr boot 8 . +Other bootstrapping software may be used, and can chain-load the +.Ox +bootstrapping code, or directly load the kernel. +In the latter case, refer to your bootloader documentation to know which +options are available. +.Ss Abnormal system termination +In case of system crashes, the kernel will usually enter the kernel +debugger, +.Xr ddb 4 , +unless it is not present in the kernel, or it is disabled via the +.Em ddb.panic +sysctl. +Upon leaving ddb, or if ddb was not entered, the kernel will halt the system +if it was still in device configuration phase, or attempt a dump to the +configured dump device, if possible. +The crash dump will then be recovered by +.Xr savecore 8 +during the next multi-user boot cycle. +It is also possible to force other behaviours from ddb. +.Sh FILES +.Bl -tag -width /usr/mdec/biosboot -compact +.It Pa /bsd +default system kernel +.It Pa /bsd.sp +single processor capable kernel +.It Pa /bsd.mp +multiprocessor capable kernel +.It Pa /bsd.rd +standalone installation kernel, suitable for disaster recovery +.It Pa /usr/mdec/mbr +system MBR image +.It Pa /usr/mdec/biosboot +system primary stage bootstrap (PBR) +.It Pa /usr/mdec/boot +system second stage bootstrap (usually also installed as +.Pa /boot ) +.It Pa /usr/mdec/pxeboot +PXE bootstrap +.El +.Sh SEE ALSO +.Xr ddb 4 , +.Xr biosboot 8 , +.Xr boot 8 , +.Xr halt 8 , +.Xr init 8 , +.Xr installboot 8 , +.Xr pxeboot 8 , +.Xr reboot 8 , +.Xr savecore 8 , +.Xr shutdown 8 +.Sh BUGS +The +.Dq PC BIOS Architecture +makes this process very prone to weird and +wonderful interactions between different operating systems. +.Pp +There is no published standard to the MBR and PBR, +which makes coding these a nightmare. diff --git a/static/openbsd/man8/man8.arm64/MAKEDEV.8 b/static/openbsd/man8/man8.arm64/MAKEDEV.8 new file mode 100644 index 00000000..363978d5 --- /dev/null +++ b/static/openbsd/man8/man8.arm64/MAKEDEV.8 @@ -0,0 +1,278 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.17 2025/09/29 01:02:58 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.arm64/MAKEDEV.md,v 1.18 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 arm64 +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The arm64 supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on arm64. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy Printers +.Bl -tag -width tenletters -compact +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar apm +Power Management Interface, see +.Xr apm 4 . +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bktr* +Video frame grabbers, see +.Xr bktr 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dri +Direct Rendering Infrastructure, see +.Xr drm 4 . +.It Ar efi +EFI runtime services, see +.Xr efi 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar gpio* +General Purpose Input/Output, see +.Xr gpio 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar ipmi* +IPMI BMC access, see +.Xr ipmi 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar tuner* +Tuner devices, see +.Xr bktr 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.arm64/Makefile b/static/openbsd/man8/man8.arm64/Makefile new file mode 100644 index 00000000..a12ae7d7 --- /dev/null +++ b/static/openbsd/man8/man8.arm64/Makefile @@ -0,0 +1,3 @@ +MAN = MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.armv7/MAKEDEV.8 b/static/openbsd/man8/man8.armv7/MAKEDEV.8 new file mode 100644 index 00000000..46187e7e --- /dev/null +++ b/static/openbsd/man8/man8.armv7/MAKEDEV.8 @@ -0,0 +1,264 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.24 2025/09/29 01:02:58 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.armv7/MAKEDEV.md,v 1.23 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 armv7 +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The armv7 supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on armv7. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar apm +Power management device, see +.Xr apm 4 . +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bktr* +Video frame grabbers, see +.Xr bktr 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar gpio* +General Purpose Input/Output, see +.Xr gpio 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar tuner* +Tuner devices, see +.Xr bktr 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.armv7/Makefile b/static/openbsd/man8/man8.armv7/Makefile new file mode 100644 index 00000000..a12ae7d7 --- /dev/null +++ b/static/openbsd/man8/man8.armv7/Makefile @@ -0,0 +1,3 @@ +MAN = MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.hppa/MAKEDEV.8 b/static/openbsd/man8/man8.hppa/MAKEDEV.8 new file mode 100644 index 00000000..fcb4e6a1 --- /dev/null +++ b/static/openbsd/man8/man8.hppa/MAKEDEV.8 @@ -0,0 +1,263 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.79 2025/09/29 01:02:58 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.hppa/MAKEDEV.md,v 1.71 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 hppa +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The hppa supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on hppa. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar fd* +Floppy disk drives (3 1/2", 5 1/4"), see +.Xr fd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy Printers +.Bl -tag -width tenletters -compact +.It Ar lpt* +IEEE 1284 centronics printer, see +.Xr lpt 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pdc +PDC device, see +.Xr pdc 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.hppa/Makefile b/static/openbsd/man8/man8.hppa/Makefile new file mode 100644 index 00000000..730e61ee --- /dev/null +++ b/static/openbsd/man8/man8.hppa/Makefile @@ -0,0 +1,4 @@ +MAN = boot_hppa.8 \ + MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.hppa/boot_hppa.8 b/static/openbsd/man8/man8.hppa/boot_hppa.8 new file mode 100644 index 00000000..70d0eeb5 --- /dev/null +++ b/static/openbsd/man8/man8.hppa/boot_hppa.8 @@ -0,0 +1,347 @@ +.\" $OpenBSD: boot_hppa.8,v 1.15 2022/09/05 10:29:27 kn Exp $ +.\" +.\" Copyright (c) 2002, Miodrag Vallat. +.\" 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 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 $Mdocdate: September 5 2022 $ +.Dt BOOT_HPPA 8 hppa +.Os +.Sh NAME +.Nm boot_hppa +.Nd hppa system bootstrapping procedures +.Sh DESCRIPTION +.Ss System starts +When powered on, after a panic, or if the system is rebooted via +.Xr reboot 8 +or +.Xr shutdown 8 , +the hppa firmware +.Pq Dq PDC +will proceed to its initialization, and will boot an operating system +if autoboot is enabled. +.\" +.Ss Boot process description +System boot blocks are provided as a +.Dq LIF +.Pq Logical Interchange Format +archive, either on a disk device, or via the network, using the +.Em bootp +or +.Em rboot +protocols, depending on the PDC version. +A small +.Xr mkboot 8 +utility +is provided for combining primary boot and a number +of images (OS kernels or standalone binaries) +into one +.Dq LIF +volume suitable for booting. +.Ss PDC concepts +If autoboot is enabled, the PDC will attempt to boot from the specified +.Dq boot path +value. +If no +.Dq boot path +has been specified, the PDC will then scan for bootable devices and +boot from the first found, after a few seconds allowing the user to +interrupt the boot process. +If autoboot is disabled, the PDC will enter interactive mode, after an +optional device scan. +In all cases, it is possible to enter interactive mode by holding the +escape key during the selftests, or when prompted to do so to abort +the current operation, unless the PDC has been configured in +.Dq secure mode . +.\" +.Ss ISL interaction +.Dq ISL +stands for +.Dq Initial System Loader +and is the +.Xr boot 8 +program in +.Ox . +On all versions of the PDC except for the 712 and 725 models the +.Dq boot +command (see below) will be followed by the question: +.Dq Interact with IPL (Y, N, or Cancel)?> +where a positive answer will invoke an interactive prompt in the +.Xr boot 8 +program later and negative will thus suppress it. +A cancellation will abort the boot process. +.Pp +On the 712 and 725 models firmware an additional +.Dq isl +argument should be given to the +.Dq boot +command to invoke the +.Xr boot 8 +interactive prompt. +With the default behaviour being a non-interactive boot process. +.\" +.Ss Old PDC operation +This version is used on the following models: +705, 7x0, 715/33/50/75, 725/50/75, 735, 755. +There are two levels of interactive commands in this version. +The first level is a short menu: +.Bd -literal -offset indent +b) Boot from specified device +s) Search for bootable device +a) Enter Boot Administration mode +x) Exit and continue boot sequence + +Select from menu: +.Ed +.Pp +which provides the following commands: +.Pp +.Bl -tag -width "XXX" -offset indent -compact +.It Cm b +boot from a device found during the scan, +either with its short +.Dq P# +form, or a complete name specification. +For example, to boot from the +.Tn SCSI +disk with id 6 off the built-in (first) controller, +one would enter +.Ic b Ar scsi.6.0 . +.It Cm s +rescan for bootable devices. +.It Cm a +enter the second part of interactive mode. +.It Cm x +resume an interrupted boot sequence. +.El +.Pp +The +.Dq Boot Administration +mode, recognizable with its +.Em BOOT_ADMIN> +prompt, controls the various boot options. +The complete list of commands depends on the machine and PDC version. +The following list only mentions commands impacting the boot process. +.Bl -tag -width AUTOSELECT -offset indent +.It AUTOSELECT +Displays or changes the autoboot setting. +If autoselect is set to +.Dq on , +the PDC will always attempt to boot the first bootable device found in +this order: +.Bl -enum -offset indent -compact +.It +Boot device +.Em path +setting. +.It +.Tn SCSI +devices connected to the built-in +.Tn SCSI +controller, +the highest ID numbers being preferred. +.It +Network +.Em rboot +server (see also +.Xr rbootd 8 ) . +.It +Other +.Tn SCSI +devices connected to secondary controllers, +the highest ID numbers being preferred. +.El +If the +.Em primary path +setting defines a bootable device, no device scan will occur. +.It BOOT +Boots off the specified device. +It is similar to the +.Ic b +command from the short menu above. +The +.Dq primary +and +.Dq alternate +path settings may be booted with +.Ic boot Ar pri +and +.Ic boot Ar alt +respectively. +.It PATH +Displays or changes the boot and console devices. +The boot device is defined as the +.Dq primary +path, and another setting may be stored as the +.Dq alternate +path for rescue purposes. +For example, to define the primary boot path to the +.Tn SCSI +disk with ID 5 connected to the built-in controller, one would enter +.Ic path primary Ar scsi.5 +.Pp +When invoked without parameters, +.Ic path +will list the various path settings. +.El +.\" +.Ss Modern PDC operation +Machines equipped with 7100LC, 7200 or 7300LC CPU types are +usually blessed with a different kind of PDC. +There is only one interactive mode, with a +.Em BOOT_ADMIN> +prompt, which provides both boot settings and commands. +The complete list of commands depends on the machine and PDC version. +The following list only mentions commands impacting the boot process. +.Bl -tag -width auto\ search -offset indent +.It Ic auto boot +Displays or changes the autoboot setting. +If +.Ic auto boot +is set to +.Dq on , +the PDC will always attempt to boot. +The booted device chosen will depend on the +.Ic auto search +setting. +.It Ic auto search +Displays or changes the device scan setting. +If +.Ic auto search +is set to +.Dq on , +the PDC will attempt to boot the first bootable device found in +this order: +.Bl -enum -offset indent -compact +.It +Boot device +.Em path +setting. +.It +.Tn SCSI +devices connected to the built-in +.Tn SCSI +controller, +the highest ID numbers being preferred. +.It +Network +.Em bootp +server (see also +.Xr dhcpd 8 ) . +.It +Other +.Tn SCSI +devices connected to secondary controllers, +the highest ID numbers being preferred. +.El +If +.Ic auto search +is set to +.Dq off +and the primary boot path points to a bootable device, +no device scan will occur. +.Pp +Note that setting +.Ic auto search +to +.Dq on +will force autoboot, regardless of the +.Ic auto boot +value. +.It Ic boot +Boots off the specified device. +The +.Dq primary +and +.Dq alternate +path settings may be booted with +.Ic boot Ar pri +and +.Ic boot Ar alt +respectively. +.It Ic path +Displays or changes the boot and console devices. +The boot device is defined as the +.Dq primary +path, and another setting may be stored as the +.Dq alternate +path for rescue purposes. +For example, to define the primary boot path to the +.Tn SCSI +disk with ID 5 connected to the built-in controller, one would enter +.Ic path pri Ar scsi.5 . +.Pp +When invoked without parameters, +.Ic path +will list the various path settings. +.El +.\" +.Ss Boot process options +The +.Ox +hppa boot loader program is extensively described in a separate document, +.Xr boot 8 . +.Ss Abnormal system termination +If the system crashes, it will enter the kernel debugger, +.Xr ddb 4 , +if it is configured in the kernel. +If the crash occurred during +initialization and the debugger is not present or is exited, the +kernel will halt the system. +If the crash occurred during normal operation and the debugger +is not present or is exited, the system will attempt a dump to the +configured dump device (which will be automatically recovered with +.Xr savecore 8 +during the next multi-user boot cycle), and after the dump is complete +(successful or not) the kernel will attempt a reboot. +.Sh FILES +.Bl -tag -width /usr/mdec/xxbootxx -compact +.It Pa /bsd +default system kernel +.It Pa /bsd.rd +standalone installation kernel, suitable for disaster recovery +.It Pa boot.lif +network bootstrap and kernel combined image +.It Pa /usr/mdec/cdboot +primary bootstrap for +.Dq cd9660 +file system +.It Pa /usr/mdec/xxboot +primary bootstrap for +.Dq ffs +file system +.It Pa /usr/mdec/boot +system bootstrap (usually also installed as +.Pa /boot ) +.El +.Sh SEE ALSO +.Xr ddb 4 , +.Xr boot 8 , +.Xr dhcpd 8 , +.Xr halt 8 , +.Xr init 8 , +.Xr installboot 8 , +.Xr rbootd 8 , +.Xr reboot 8 , +.Xr savecore 8 , +.Xr shutdown 8 diff --git a/static/openbsd/man8/man8.i386/MAKEDEV.8 b/static/openbsd/man8/man8.i386/MAKEDEV.8 new file mode 100644 index 00000000..48bd00b9 --- /dev/null +++ b/static/openbsd/man8/man8.i386/MAKEDEV.8 @@ -0,0 +1,311 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.124 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.i386/MAKEDEV.md,v 1.97 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 i386 +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The i386 supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on i386. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar fd* +Floppy disk drives (3 1/2", 5 1/4"), see +.Xr fd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.It Ar ttyc* +Cyclades serial ports, see +.Xr cy 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy Printers +.Bl -tag -width tenletters -compact +.It Ar lpa* +Polled printer port, see +.Xr lpt 4 . +.It Ar lpt* +IEEE 1284 centronics printer, see +.Xr lpt 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar amdmsr +AMD MSR access device, see +.Xr amdmsr 4 . +.It Ar apm +Power management device, see +.Xr apm 4 . +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bktr* +Video frame grabbers, see +.Xr bktr 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dri +Direct Rendering Infrastructure, see +.Xr drm 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar gpio* +General Purpose Input/Output, see +.Xr gpio 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar ipmi* +IPMI BMC access, see +.Xr ipmi 4 . +.It Ar joy* +Joystick driver, see +.Xr joy 4 . +.It Ar kcov +Kernel code coverage tracing, see +.Xr kcov 4 . +.It Ar nvram +NVRAM access, see +.Xr nvram 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pctr* +PC Performance Tuning Register access device, see +.Xr pctr 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar speaker +PC speaker, see +.Xr spkr 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar tuner* +Tuner devices, see +.Xr bktr 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar pvbus* +paravirtual device tree root, see +.Xr pvbus 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.i386/Makefile b/static/openbsd/man8/man8.i386/Makefile new file mode 100644 index 00000000..f8f6bf9a --- /dev/null +++ b/static/openbsd/man8/man8.i386/Makefile @@ -0,0 +1,4 @@ +MAN = boot_i386.8 \ + MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.i386/boot_i386.8 b/static/openbsd/man8/man8.i386/boot_i386.8 new file mode 100644 index 00000000..793d2141 --- /dev/null +++ b/static/openbsd/man8/man8.i386/boot_i386.8 @@ -0,0 +1,193 @@ +.\" $OpenBSD: boot_i386.8,v 1.17 2016/02/25 09:43:52 tb Exp $ +.\" +.\" Copyright (c) 1997 Tobias Weingartner +.\" +.\" 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 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 $Mdocdate: February 25 2016 $ +.Dt BOOT_I386 8 i386 +.Os +.Sh NAME +.Nm boot_i386 +.Nd i386 system bootstrapping procedures +.Sh DESCRIPTION +.Ss Cold starts +The +.Tn IBM PC +computers and clones will perform a POST (Power On Self Test) upon +being booted cold. +This test will find and initialize memory, keyboard, and other devices. +It will search for and initialize any extension ROMs that are present, +and then attempt to boot the operating system from an available boot +drive. +.Pp +The boot drive is usually specified in the BIOS setup. +.Ss Warm starts +The BIOS loads the first block (at physical location: track 0, head 0, +sector 1) off the boot device into memory, and if the last two bytes in the +block match the signature 0xAA55, the BIOS considers the block a valid +bootable drive. +The BIOS then proceeds to call the machine code program in this block. +If the BIOS is current, it will also pass the boot drive +to the boot block in register %dl. +.Pp +There are two different types of boot blocks on devices. +There is the +MBR (master boot record) and the PBR (partition boot record). +A digression +into a little piece of history will quickly give light as to why this is so. +In the beginning, the PC +.Dq architecture +came with single or dual floppy +drives, and no hard drives. +The only type of bootable sectors on any device were the PBRs. +They were responsible for loading the rest of the operating +system from the correct device. +When hard disks came out, it was felt that +such a huge space should be able to be partitioned into separate drives, +and this is when the MBR was invented. +.Pp +The MBR relocates itself upon being loaded and invoked by the BIOS. +Embedded within the MBR is a partition table, with four partition table +entries. +The MBR code traverses this table (which was loaded with the +MBR by the BIOS), looking for an active entry, and then loads the MBR or +PBR from the disk location specified by the partition table entry. +So in reality, the MBR is nothing more than a fancy chaining PBR. +.Pp +Note: The MBR could load another MBR, which is the case when you are booting +off an extended partition. +In other words, the first block of an extended +partition is really an MBR, which will then load the corresponding MBR or PBR +out of its extended partition's partition table. +.Ss Geometry translation +.Em WARNING : +This portion of the +.Dq PC BIOS Architecture +is a mess, and a compatibility nightmare. +.Pp +The PC BIOS has an API to manipulate any disk that the BIOS happens to +support. +This interface uses 10 bits to address the cylinder, 8 bits to +address the head, and 6 bits to address the sector of a drive. +This restricts any application using the BIOS to being able to address only +1024 cylinders, 256 heads, and 63 (since the sectors are 1 based) sectors +on a disk. +These limitations proved to be fine for roughly 3 years after +the debut of hard disks on PC computers. +.Pp +Many (if not all) newer drives have many more cylinders than the BIOS API +can support, and likely more sectors per track as well. +To allow the BIOS the ability of accessing these large drives, the BIOS would +.Dq re-map +the +cylinder/head/sector of the real drive geometry into something that would +allow the applications using the BIOS to access a larger portion of the +drive, still using the restricted BIOS API. +.Pp +The reason this has become a problem is that any modern OS will use its own +drivers to access the disk drive, bypassing the BIOS completely. +However, +the MBR, PBR, and partition tables are all still written using the original +BIOS access methods. +This is for backwards compatibility to the original IBM PC! +.Pp +So the gist of it is, the MBR, PBR, and partition table need to have BIOS +geometry offsets and cylinder/head/sector values for them to be able to +load any type of operating system. +This geometry can, and likely will, +change whenever you move a disk from machine to machine, or from controller +to controller. +.Em They are controller and machine specific . +.Ss Boot process options +On most +.Ox +systems, booting +.Ox +from the BIOS will load the +.Ox Ns -specific +first-stage bootstrap, +.Xr biosboot 8 , +which in turn will locate and load the second-stage bootstrap, +.Xr boot 8 . +Other bootstrapping software may be used, and can chain-load the +.Ox +bootstrapping code, or directly load the kernel. +In the latter case, refer to your bootloader documentation to know which +options are available. +.Ss Abnormal system termination +In case of system crashes, the kernel will usually enter the kernel +debugger, +.Xr ddb 4 , +unless it is not present in the kernel, or it is disabled via the +.Em ddb.panic +sysctl. +Upon leaving ddb, or if ddb was not entered, the kernel will halt the system +if it was still in device configuration phase, or attempt a dump to the +configured dump device, if possible. +The crash dump will then be recovered by +.Xr savecore 8 +during the next multi-user boot cycle. +It is also possible to force other behaviours from ddb. +.Sh FILES +.Bl -tag -width /usr/mdec/biosboot -compact +.It Pa /bsd +default system kernel +.It Pa /bsd.sp +single processor capable kernel +.It Pa /bsd.mp +multiprocessor capable kernel +.It Pa /bsd.rd +standalone installation kernel, suitable for disaster recovery +.It Pa /usr/mdec/mbr +system MBR image +.It Pa /usr/mdec/biosboot +system primary stage bootstrap (PBR) +.It Pa /usr/mdec/boot +system second stage bootstrap (usually also installed as +.Pa /boot ) +.It Pa /usr/mdec/pxeboot +PXE bootstrap +.El +.Sh SEE ALSO +.Xr ddb 4 , +.Xr biosboot 8 , +.Xr boot 8 , +.Xr halt 8 , +.Xr init 8 , +.Xr installboot 8 , +.Xr pxeboot 8 , +.Xr reboot 8 , +.Xr savecore 8 , +.Xr shutdown 8 +.Sh BUGS +The +.Dq PC BIOS Architecture +makes this process very prone to weird and +wonderful interactions between different operating systems. +.Pp +There is no published standard to the MBR and PBR, +which makes coding these a nightmare. +.\" .Pp +.\" Somebody *please* write me a decent BIOS, and make them (the masses) use it! diff --git a/static/openbsd/man8/man8.landisk/MAKEDEV.8 b/static/openbsd/man8/man8.landisk/MAKEDEV.8 new file mode 100644 index 00000000..5ed9b76c --- /dev/null +++ b/static/openbsd/man8/man8.landisk/MAKEDEV.8 @@ -0,0 +1,252 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.58 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.landisk/MAKEDEV.md,v 1.53 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 landisk +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The landisk supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on landisk. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar ttya +on-board serial port, see +.Xr scif 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.landisk/Makefile b/static/openbsd/man8/man8.landisk/Makefile new file mode 100644 index 00000000..a12ae7d7 --- /dev/null +++ b/static/openbsd/man8/man8.landisk/Makefile @@ -0,0 +1,3 @@ +MAN = MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.loongson/MAKEDEV.8 b/static/openbsd/man8/man8.loongson/MAKEDEV.8 new file mode 100644 index 00000000..84c4521c --- /dev/null +++ b/static/openbsd/man8/man8.loongson/MAKEDEV.8 @@ -0,0 +1,256 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.45 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.loongson/MAKEDEV.md,v 1.39 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 loongson +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The loongson supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on loongson. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar apm +Power management device, see +.Xr apm 4 . +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dri +Direct Rendering Infrastructure, see +.Xr drm 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.loongson/Makefile b/static/openbsd/man8/man8.loongson/Makefile new file mode 100644 index 00000000..a12ae7d7 --- /dev/null +++ b/static/openbsd/man8/man8.loongson/Makefile @@ -0,0 +1,3 @@ +MAN = MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.luna88k/MAKEDEV.8 b/static/openbsd/man8/man8.luna88k/MAKEDEV.8 new file mode 100644 index 00000000..f968aad6 --- /dev/null +++ b/static/openbsd/man8/man8.luna88k/MAKEDEV.8 @@ -0,0 +1,225 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.58 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.luna88k/MAKEDEV.md,v 1.38 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 luna88k +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The luna88k supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on luna88k. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar ttya +On-board serial console port, see +.Xr sio 4 . +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar lcd +front panel LCD display, see +.Xr lcd 4 . +.It Ar pcex* +PC-9801 extension board slot, see +.Xr pcexmem 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar xp +HD647180 I/O processor, see +.Xr xp 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.luna88k/Makefile b/static/openbsd/man8/man8.luna88k/Makefile new file mode 100644 index 00000000..7b9b64d3 --- /dev/null +++ b/static/openbsd/man8/man8.luna88k/Makefile @@ -0,0 +1,4 @@ +MAN = boot_luna88k.8 \ + MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.luna88k/boot_luna88k.8 b/static/openbsd/man8/man8.luna88k/boot_luna88k.8 new file mode 100644 index 00000000..b289d64c --- /dev/null +++ b/static/openbsd/man8/man8.luna88k/boot_luna88k.8 @@ -0,0 +1,107 @@ +.\" $OpenBSD: boot_luna88k.8,v 1.8 2023/01/12 19:37:53 miod Exp $ +.\" +.\" Copyright (c) 2004, Miodrag Vallat. +.\" 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. Redistribution 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. +.\" +.Dd $Mdocdate: January 12 2023 $ +.Dt BOOT_LUNA88K 8 luna88k +.Os +.Sh NAME +.Nm boot_luna88k +.Nd luna88k system bootstrapping procedures +.Sh DESCRIPTION +.Ss Boot process description +When powered on, or after a system reboot, the luna88k ROM monitor will +proceed to its initialization, and will boot the operating system +configured in nvram if autoboot is enabled. +.Ss DIP switches description +The behaviour of the ROM monitor, as well as some kernel options, are +controlled through the SW1 set of DIP switches on the front panel. +.Pp +The switch positions are not the same on LUNA-88K and LUNA-88K2 models. +On LUNA-88K, a switch is enabled when in the +.Em down +position, while on the LUNA-88K2, a switch is enabled when in the +.Em up +position. +.Pp +The following SW1 switches alter the ROM monitor behaviour: +.Bl -column "Switch" "interact with ROM monitor" "Disabled" +.It Sy Switch Ta Sy Enabled Ta Sy Disabled +.It Li 1 Ta "interact with ROM monitor" Ta "auto-boot" +.It Li 2 Ta "serial console" Ta "graphics console" +.El +.Pp +The following switches alter the kernel behaviour: +.Bl -column "Switch" "interact with ROM monitor" "Disabled" +.It Sy Switch Ta Sy Enabled Ta Sy Disabled +.It Li 1 Ta "boot in single-user mode" Ta "boot in multi-user mode" +.It Li 3 Ta "prompt for root device" Ta "do not prompt for root device" +.It Li 4 Ta "enter UKC mode" Ta "do not enter UKC mode" +.El +Note that the same behaviour can be used by passing the +.Fl s , +.Fl a , +and +.Fl c +options respectively in the boot loader, rather than using the switches. +.Pp +For more details about the +.Dq User Kernel Configuration +mode +.Pq UKC , +see +.Xr boot_config 8 . +.Pp +Note that the first switch controls both the kernel and the ROM monitor +behaviour. +.Ss Abnormal system termination +In case of system crashes, the kernel will usually enter the kernel +debugger, +.Xr ddb 4 , +unless it is not present in the kernel, or it is disabled via the +.Em ddb.panic +sysctl. +Upon leaving ddb, or if ddb was not entered, the kernel will halt the system +if it was still in device configuration phase, or attempt a dump to the +configured dump device, if possible. +The crash dump will then be recovered by +.Xr savecore 8 +during the next multi-user boot cycle. +It is also possible to force other behaviours from ddb. +.Sh FILES +.Bl -tag -width /bsd.rd -compact +.It Pa /bsd +default system kernel +.It Pa /bsd.rd +standalone installation kernel, suitable for disaster recovery +.El +.Sh SEE ALSO +.Xr ddb 4 , +.Xr boot 8 , +.Xr boot_config 8 , +.Xr halt 8 , +.Xr init 8 , +.Xr reboot 8 , +.Xr savecore 8 , +.Xr shutdown 8 diff --git a/static/openbsd/man8/man8.macppc/MAKEDEV.8 b/static/openbsd/man8/man8.macppc/MAKEDEV.8 new file mode 100644 index 00000000..ff8ff687 --- /dev/null +++ b/static/openbsd/man8/man8.macppc/MAKEDEV.8 @@ -0,0 +1,277 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.89 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.macppc/MAKEDEV.md,v 1.82 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 macppc +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The macppc supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on macppc. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar cua[a-z]* +Zilog 8530 serial ports, see +.Xr zs 4 . +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.It Ar tty[a-z]* +Zilog 8530 serial ports, see +.Xr zs 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar apm +Power management device, see +.Xr apm 4 . +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bktr* +Video frame grabbers, see +.Xr bktr 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dri +Direct Rendering Infrastructure, see +.Xr drm 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar gpio* +General Purpose Input/Output, see +.Xr gpio 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar tuner* +Tuner devices, see +.Xr bktr 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.macppc/Makefile b/static/openbsd/man8/man8.macppc/Makefile new file mode 100644 index 00000000..02284efb --- /dev/null +++ b/static/openbsd/man8/man8.macppc/Makefile @@ -0,0 +1,4 @@ +MAN = boot_macppc.8 \ + MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.macppc/boot_macppc.8 b/static/openbsd/man8/man8.macppc/boot_macppc.8 new file mode 100644 index 00000000..93e580b1 --- /dev/null +++ b/static/openbsd/man8/man8.macppc/boot_macppc.8 @@ -0,0 +1,177 @@ +.\" $OpenBSD: boot_macppc.8,v 1.23 2022/09/05 10:29:27 kn Exp $ +.\" +.\" Copyright (c) 1992, 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. +.\" +.\" @(#)boot_macppc.8 +.\" +.Dd $Mdocdate: September 5 2022 $ +.Dt BOOT_MACPPC 8 macppc +.Os +.Sh NAME +.Nm boot_macppc +.Nd macppc system bootstrapping procedures +.Sh DESCRIPTION +.Ss System startup +When powered on, after a panic, or if the system is rebooted via +.Xr reboot 8 +or +.Xr shutdown 8 , +the Open Firmware will proceed to its initialization, +and will boot an operating system if the +.Va auto-boot?\& +variable is set to +.Dq true , +or will wait for interactive commands otherwise. +.Ss Boot process description +The Apple Open Firmware will normally load the kernel from the device and +filename as instructed by the +.Va boot-device +and +.Va boot-file +variables. +If the +.Va boot-file +variable is empty, the +.Ox +bootloader will look for a kernel named +.Pa bsd , +unless a different filename has been specified in the boot command. +To reset this variable to its default, empty, value, type the following +at the Open Firmware prompt: +.Pp +.Dl set-default boot-device +.Pp +The +.Ox +bootstrap program is named +.Dq ofwboot . +It can be installed either in a HFS partition or in a +MSDOS partition on the disk. +If MBR partitioning is chosen for +the disk, the bootstrap program will be installed automatically during the +.Ox +installation procedure. +For HFS shared disks, the +.Pa ofwboot +file must be installed manually. +The ofwboot program can be loaded from any Open Firmware recognized +disk or network device. +.Ss Boot process options +If invoked manually without parameters, or if the specified kernel could +not be loaded, the +.Ox +bootloader will let the user enter a boot device, kernel +filename and boot options. +.Pp +If the special line +.Ic exit +is entered, the bootloader will attempt to restart the machine. +.Pp +The file specification used is of the form: +.Pp +.Dl Oo Oo Ar promdev : Oc Ns Ar filename Oc Op Fl acds +.Pp +where +.Ar promdev +is an optional Open Firmware device name (such as +.Dq hd +or +.Dq ide ) . +Normal line editing characters can be used when typing the file +specification. +.Pp +The following options are recognized: +.Pp +.Bl -tag -width "-XXX" -offset indent -compact +.It Fl a +Prompt for the root filesystem and swap devices after the devices have +been configured. +.It Fl c +Enter the +.Dq User Kernel Config +mode upon startup +.Pq see Xr boot_config 8 . +.It Fl d +Enter the debugger, +.Xr ddb 4 , +as soon as the kernel console has been initialized. +.It Fl s +Boot the system single-user. +The system will be booted multi-user unless this option is specified. +.El +.Ss Abnormal system termination +In case of system crashes, the kernel will usually enter the kernel +debugger, +.Xr ddb 4 , +unless it is not present in the kernel, or it is disabled via the +.Va ddb.panic +sysctl. +Upon leaving ddb, or if ddb was not entered, the kernel will halt the system +if it was still in device configuration phase, or attempt a dump to the +configured dump device, if possible. +The crash dump will then be recovered by +.Xr savecore 8 +during the next multi-user boot cycle. +It is also possible to force other behaviours from ddb. +.Ss Accessing the PROM +The prom can only be accessed during system reset, or at power-up. +To enter Open Firmware, press and hold +.Dq Cntrl +.Dq Cmd +.Dq o +.Dq f +as the machine resets until it enters the Open Firmware debugger. +.Pp +On an Xserve using serial console the System Identifier button is used to +enter Open Firmware instead of the keyboard. +To enter Open Firmware, hold down the System Identifier button while pressing +the Power button. +When the upper LED bank begins lighting up in sequence, repeatedly press +the System Identifier button until the seventh LED from the right is +highlighted in the lower bank. +Now hold the System Identifier button for two seconds, until all the top +row LEDs light up. +.Sh FILES +.Bl -tag -width /usr/mdec/ofwboot -compact +.It Pa /bsd +default system kernel +.It Pa /bsd.rd +standalone installation kernel, suitable for disaster recovery +.It Pa /usr/mdec/ofwboot +system bootstrap (usually installed on a stand-alone FAT partition or an +Apple HFS partition, to be readable by Open Firmware) +.El +.Sh SEE ALSO +.Xr ddb 4 , +.Xr boot_config 8 , +.Xr halt 8 , +.Xr init 8 , +.Xr installboot 8 , +.Xr reboot 8 , +.Xr savecore 8 , +.Xr shutdown 8 diff --git a/static/openbsd/man8/man8.octeon/MAKEDEV.8 b/static/openbsd/man8/man8.octeon/MAKEDEV.8 new file mode 100644 index 00000000..89c741a2 --- /dev/null +++ b/static/openbsd/man8/man8.octeon/MAKEDEV.8 @@ -0,0 +1,247 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.24 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.octeon/MAKEDEV.md,v 1.23 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 octeon +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The octeon supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on octeon. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.It Ar octcf* +octeon compact flash, see +.Xr octcf 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.octeon/Makefile b/static/openbsd/man8/man8.octeon/Makefile new file mode 100644 index 00000000..a12ae7d7 --- /dev/null +++ b/static/openbsd/man8/man8.octeon/Makefile @@ -0,0 +1,3 @@ +MAN = MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.powerpc64/MAKEDEV.8 b/static/openbsd/man8/man8.powerpc64/MAKEDEV.8 new file mode 100644 index 00000000..f99b2ebf --- /dev/null +++ b/static/openbsd/man8/man8.powerpc64/MAKEDEV.8 @@ -0,0 +1,265 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.13 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.powerpc64/MAKEDEV.md,v 1.12 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 powerpc64 +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The powerpc64 supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on powerpc64. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Printers +.Bl -tag -width tenletters -compact +.It Ar lpt* +IEEE 1284 centronics printer, see +.Xr lpt 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dri +Direct Rendering Infrastructure, see +.Xr drm 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar ipmi* +IPMI BMC access, see +.Xr ipmi 4 . +.It Ar kcov +Kernel code coverage tracing, see +.Xr kcov 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.powerpc64/Makefile b/static/openbsd/man8/man8.powerpc64/Makefile new file mode 100644 index 00000000..a12ae7d7 --- /dev/null +++ b/static/openbsd/man8/man8.powerpc64/Makefile @@ -0,0 +1,3 @@ +MAN = MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.riscv64/MAKEDEV.8 b/static/openbsd/man8/man8.riscv64/MAKEDEV.8 new file mode 100644 index 00000000..dfcb7ff6 --- /dev/null +++ b/static/openbsd/man8/man8.riscv64/MAKEDEV.8 @@ -0,0 +1,272 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.9 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.riscv64/MAKEDEV.md,v 1.6 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 riscv64 +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The riscv64 supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on riscv64. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy Printers +.Bl -tag -width tenletters -compact +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar apm +Power Management Interface, see +.Xr apm 4 . +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bktr* +Video frame grabbers, see +.Xr bktr 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dri +Direct Rendering Infrastructure, see +.Xr drm 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar gpio* +General Purpose Input/Output, see +.Xr gpio 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar ipmi* +IPMI BMC access, see +.Xr ipmi 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar radio* +FM tuner devices, see +.Xr radio 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.riscv64/Makefile b/static/openbsd/man8/man8.riscv64/Makefile new file mode 100644 index 00000000..a12ae7d7 --- /dev/null +++ b/static/openbsd/man8/man8.riscv64/Makefile @@ -0,0 +1,3 @@ +MAN = MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.sparc64/MAKEDEV.8 b/static/openbsd/man8/man8.sparc64/MAKEDEV.8 new file mode 100644 index 00000000..38f90196 --- /dev/null +++ b/static/openbsd/man8/man8.sparc64/MAKEDEV.8 @@ -0,0 +1,319 @@ +.\" $OpenBSD: MAKEDEV.8,v 1.88 2025/09/29 01:02:59 deraadt Exp $ +.\" +.\" THIS FILE AUTOMATICALLY GENERATED. DO NOT EDIT. +.\" generated from: +.\" +.\" OpenBSD: etc.sparc64/MAKEDEV.md,v 1.102 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.common,v 1.122 2025/01/08 23:09:25 kirill Exp +.\" OpenBSD: MAKEDEV.man,v 1.10 2025/09/29 01:00:14 deraadt Exp +.\" OpenBSD: MAKEDEV.mansub,v 1.2 2004/02/20 19:13:01 miod Exp +.\" +.\" Copyright (c) 2004, Miodrag Vallat +.\" Copyright (c) 2001-2004 Todd T. Fries <todd@OpenBSD.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: September 29 2025 $ +.Dt MAKEDEV 8 sparc64 +.Os +.Sh NAME +.Nm MAKEDEV +.Nd create system and device special files +.Sh SYNOPSIS +.Nm MAKEDEV +.Op Ar name ... +.Sh DESCRIPTION +The shell script +.Nm , +found in the +.Pa /dev +directory, is used to create various special files. +See +.Xr intro 4 +for a more complete discussion of special files. +.Pp +.Nm +takes any number of device names as arguments, where the names are +the common abbreviation for the device or group of devices. +Files are created in the current working directory. +.Pp +Where a device name is followed by a star +.Sq * , +the star must be replaced by a unit number. +If units are expected for a device but not provided, +.Nm +will supply the standard numbers in most cases. +.Pp +The sparc64 supports the following devices: +.Pp +.Sy Special device names +.Bl -tag -width tenletters -compact +.It Ar all +Creates special files for all devices on sparc64. +.It Ar ramdisk +Ramdisk kernel devices. +.It Ar std +Creates the +.Sq standard +devices (console, klog, kmem, ksyms, mem, null, +stderr, stdin, stdout, tty, zero) +which are absolutely necessary for the system to function properly. +.It Ar local +Creates configuration-specific devices, by invoking the shell file +.Pa MAKEDEV.local . +.It Ar redodisks +Recreates all partitions for disks found in +.Pa /etc . +.El +.Pp +.Sy Disks +.Bl -tag -width tenletters -compact +.It Ar cd* +ATAPI and SCSI CD-ROM drives, see +.Xr cd 4 . +.It Ar fd* +Floppy disk drives (3 1/2", 5 1/4"), see +.Xr fd 4 . +.It Ar rd* +.Dq rd +pseudo-disks, see +.Xr rd 4 . +.It Ar sd* +SCSI disks, including flopticals, see +.Xr sd 4 . +.It Ar vnd* +.Dq file +pseudo-disk devices, see +.Xr vnd 4 . +.It Ar wd* +.Dq winchester +disk drives (ST506, IDE, ESDI, RLL, ...), see +.Xr wd 4 . +.El +.Pp +.Sy Tapes +.Bl -tag -width tenletters -compact +.It Ar ch* +SCSI media changers, see +.Xr ch 4 . +.It Ar st* +SCSI tape drives, see +.Xr st 4 . +.El +.Pp +.Sy Terminal ports +.Bl -tag -width tenletters -compact +.It Ar cua[a-z]* +Zilog 8530 serial port, see +.Xr zs 4 . +.It Ar magma* +Magma multiport cards, see +.Xr magma 4 . +.It Ar spif* +.Dq spif +multiport cards, see +.Xr spif 4 . +.It Ar tty[0-7][0-9a-f] +NS16x50 serial ports, see +.Xr com 4 . +.It Ar tty[a-z]* +Zilog 8530 serial port, see +.Xr zs 4 . +.It Ar ttyh* +Sab82532 serial devices, see +.Xr sab 4 . +.It Ar ttyV* +Virtual console concentrator, see +.Xr vcctty 4 . +.El +.Pp +.Sy Pseudo terminals +.Bl -tag -width tenletters -compact +.It Ar ptm +pty master device, see +.Xr ptm 4 . +.It Ar pty* +Set of 62 master pseudo terminals, see +.Xr pty 4 . +.It Ar tty* +Set of 62 slave pseudo terminals, see +.Xr tty 4 . +.El +.Pp +.Sy Console ports +.Bl -tag -width tenletters -compact +.It Ar console +PROM console, see +.Xr pcons 4 . +.It Ar ttyC-J* +wscons display devices, see +.Xr wsdisplay 4 . +.It Ar wscons +Minimal wscons devices, see +.Xr wscons 4 . +.It Ar wskbd* +wscons keyboards, see +.Xr wskbd 4 . +.It Ar wsmux +wscons keyboard/mouse mux devices, see +.Xr wsmux 4 . +.El +.Pp +.Sy Pointing devices +.Bl -tag -width tenletters -compact +.It Ar wsmouse* +wscons mice, see +.Xr wsmouse 4 . +.El +.Pp +.Sy Printers +.Bl -tag -width tenletters -compact +.It Ar bpp* +Parallel port, see +.Xr bpp 4 . +.It Ar bpp[jkl] +.Dq spif +parallel port, see +.Xr spif 4 . +.It Ar bppmag[mno] +Magma parallel port, see +.Xr magma 4 . +.It Ar lpa* +Polled printer port, see +.Xr lpt 4 . +.It Ar lpt* +IEEE 1284 centronics printer, see +.Xr lpt 4 . +.El +.Pp +.Sy USB devices +.Bl -tag -width tenletters -compact +.It Ar ttyU* +USB serial ports, see +.Xr ucom 4 . +.It Ar uall +All USB devices, see +.Xr usb 4 . +.It Ar ugen* +Generic USB devices, see +.Xr ugen 4 . +.It Ar uhid* +Generic HID devices, see +.Xr uhid 4 . +.It Ar fido +fido/* nodes, see +.Xr fido 4 . +.It Ar ujoy +ujoy/* nodes, see +.Xr ujoy 4 . +.It Ar ulpt* +Printer devices, see +.Xr ulpt 4 . +.It Ar usb* +Bus control devices used by usbd for attach/detach, see +.Xr usb 4 . +.El +.Pp +.Sy Special purpose devices +.Bl -tag -width tenletters -compact +.It Ar audio* +Audio devices, see +.Xr audio 4 . +.It Ar bio +ioctl tunnel pseudo-device, see +.Xr bio 4 . +.It Ar bpf +Berkeley Packet Filter, see +.Xr bpf 4 . +.It Ar diskmap +Disk mapper, see +.Xr diskmap 4 . +.It Ar dri +Direct Rendering Infrastructure, see +.Xr drm 4 . +.It Ar fd +fd/* nodes, see +.Xr fd 4 . +.It Ar dt +Dynamic Tracer, see +.Xr dt 4 . +.It Ar fuse +Userland Filesystem, see +.Xr fuse 4 . +.It Ar hotplug +devices hot plugging, see +.Xr hotplug 4 . +.It Ar openprom +PROM settings, see +.Xr openprom 4 . +.It Ar pci* +PCI bus devices, see +.Xr pci 4 . +.It Ar pf +Packet Filter, see +.Xr pf 4 . +.It Ar pppx* +PPP Multiplexer, see +.Xr pppx 4 . +.It Ar pppac* +PPP Access Concentrator, see +.Xr pppac 4 . +.It Ar rmidi* +Raw MIDI devices, see +.Xr midi 4 . +.It Ar *random +In-kernel random data source, see +.Xr random 4 . +.It Ar tun* +Network tunnel driver, see +.Xr tun 4 . +.It Ar tap* +Ethernet tunnel driver, see +.Xr tap 4 . +.It Ar uk* +Unknown SCSI devices, see +.Xr uk 4 . +.It Ar uperf +Performance counters, see +.Xr uperf 4 . +.It Ar video* +Video V4L2 devices, see +.Xr video 4 . +.It Ar vscsi* +Virtual SCSI controller, see +.Xr vscsi 4 . +.It Ar hvctl +Hypervisor control channel, see +.Xr vldcp 4 . +.It Ar spds +Service processor domain services channel, see +.Xr vldcp 4 . +.It Ar ldom* +Logical domain services channels, see +.Xr vldcp 4 . +.It Ar vdsp* +Virtual disk server ports, see +.Xr vdsp 4 . +.It Ar kstat +Kernel Statistics, see +.Xr kstat 4 . +.El +.Sh FILES +.Bl -tag -width /dev -compact +.It Pa /dev +The special file directory. +.El +.Sh SEE ALSO +.Xr intro 4 , +.Xr config 8 , +.Xr mknod 8 diff --git a/static/openbsd/man8/man8.sparc64/Makefile b/static/openbsd/man8/man8.sparc64/Makefile new file mode 100644 index 00000000..59685cf6 --- /dev/null +++ b/static/openbsd/man8/man8.sparc64/Makefile @@ -0,0 +1,4 @@ +MAN = boot_sparc64.8 \ + MAKEDEV.8 + +include ../../../mandoc.mk diff --git a/static/openbsd/man8/man8.sparc64/boot_sparc64.8 b/static/openbsd/man8/man8.sparc64/boot_sparc64.8 new file mode 100644 index 00000000..173d9d01 --- /dev/null +++ b/static/openbsd/man8/man8.sparc64/boot_sparc64.8 @@ -0,0 +1,169 @@ +.\" $OpenBSD: boot_sparc64.8,v 1.18 2022/09/05 10:29:28 kn Exp $ +.\" +.\" Copyright (c) 1992, 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. +.\" +.\" @(#)boot_sparc.8 8.2 (Berkeley) 4/19/94 +.\" +.Dd $Mdocdate: September 5 2022 $ +.Dt BOOT_SPARC64 8 sparc64 +.Os +.Sh NAME +.Nm boot_sparc64 +.Nd sparc64 system bootstrapping procedures +.Sh DESCRIPTION +.Ss System starts +When powered on, after a panic, or if the system is rebooted via +.Xr reboot 8 +or +.Xr shutdown 8 , +the PROM will proceed to its initialization, and will boot an operating +system if autoboot is enabled. +.Ss Boot process description +The sparc64 boot process is split into two parts: a small first-stage bootblock +that is written into the superblock area of a partition +.Po +and hence is limited in size to SBSIZE - DEV_BSIZE bytes +.Pc , +and a second-stage boot program that resides in the filesystem proper. +The first-stage bootblock is loaded into memory by the PROM. +After it receives control, it loads the second-stage boot program +.Sy ofwboot +from the filesystem. +The second-stage boot program uses the device driver interface to +the PROM and the stand-alone filesystem code in +.Pa libsa.a +to locate and load the kernel. +The first-stage bootblock and second-stage boot program can be found in +.Pa /usr/mdec/bootblk +and +.Pa /usr/mdec/ofwboot +respectively. +The second-stage boot program commonly resides in the root directory as +.Pa /ofwboot . +.Pp +The boot program attempts to load the kernel from the selected +boot device, which must currently be an SCSI +.Pq Pa sd +or IDE +.Pq Pa wd +disk drive, or a CD-ROM +.Pq Pa cd , +or an SCSI tape drive +.Pq Pa st . +.Pp +The UltraSPARC Open Firmware +will normally look for a bootloader on the device specified by the +.Va boot-device +variable. +The +.Ox +bootloader will then look for a kernel named +.Pa bsd +by default, unless the +.Va boot-file +variable contains a filename, or a different filename has been specified +in the boot command. +To reset this variable to its default, empty, value, type the following: +.Pp +.D1 Sy ok Li set-default boot-file +.Pp +Autoboot is enabled by setting the +.Va auto-boot?\& +variable to +.Dq true , +and is the factory default. +.Ss Boot process options +The following options are recognized: +.Pp +.Bl -tag -width "-XXX" -offset indent -compact +.It Fl a +Prompt for the root filesystem and swap devices after the devices have +been configured. +.It Fl c +Enter the +.Dq User Kernel Configuration +mode upon startup +.Pq see Xr boot_config 8 . +.It Fl d +Enter the debugger, +.Xr ddb 4 , +as soon as the kernel console has been initialized. +.It Fl s +Boot the system single-user. +The system will be booted multi-user unless this option is specified. +.El +.Ss Accessing the PROM during runtime +If the +.Xr sysctl 8 +variable +.Va ddb.console +is enabled, at any time you can break back to the ROM by pressing the +.Sq L1 +.Pq also known as the Dq stop key +and +.Sq a +keys at the same time (if the console is a serial port the same is +achieved by sending a +.Dq break ) , +and entering +.Ic machine prom +at the prompt. +If you do this accidentally you can continue whatever was in progress +by typing +.Ic go +at the PROM prompt, and then +.Ic cont +to return to the system. +.Sh FILES +.Bl -tag -width /usr/mdec/ofwboot.net -compact +.It Pa /bsd +default system kernel +.It Pa /bsd.rd +standalone installation kernel, suitable for disaster recovery +.It Pa /usr/mdec/bootblk +primary bootstrap for +.Dq ffs +file system +.It Pa /usr/mdec/ofwboot +secondary bootstrap (usually also installed as +.Pa /ofwboot ) +.It Pa /usr/mdec/ofwboot.net +network bootstrap +.It Pa /usr/mdec/ofwbootfd +floppy disk bootstrap +.El +.Sh SEE ALSO +.Xr ddb 4 , +.Xr softraid 4 , +.Xr boot_config 8 , +.Xr halt 8 , +.Xr init 8 , +.Xr installboot 8 , +.Xr reboot 8 , +.Xr savecore 8 , +.Xr shutdown 8 diff --git a/static/openbsd/man8/netstart.8 b/static/openbsd/man8/netstart.8 new file mode 100644 index 00000000..8bfa5153 --- /dev/null +++ b/static/openbsd/man8/netstart.8 @@ -0,0 +1,113 @@ +.\" $OpenBSD: netstart.8,v 1.31 2022/10/25 17:10:13 kn Exp $ +.\" +.\" Copyright (c) 2002, Miodrag Vallat. +.\" 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. +.\" +.\" @(#)rc.8 8.2 (Berkeley) 12/11/93 +.\" +.Dd $Mdocdate: October 25 2022 $ +.Dt NETSTART 8 +.Os +.Sh NAME +.Nm netstart +.Nd network startup script +.Sh SYNOPSIS +.Cm sh Pa /etc/netstart +.Op Fl n +.Op Ar interface ... +.Sh DESCRIPTION +.Nm +is a +.Xr sh 1 +script invoked by +.Xr rc 8 +during an automatic reboot and after single-user mode is exited; +it performs network initialization. +.Pp +.Nm +can also be used to start newly created interfaces. +Its behaviour is controlled to some extent by variables defined in +.Xr rc.conf 8 . +.Pp +During the system boot, +.Nm +is executed. +.Nm +performs the following operations, in the sequence given: +.Pp +.Bl -bullet -compact -offset indent +.It +Configure the loopback interface. +.It +Configure all physical interfaces. +.It +Configure non-physical interfaces that can provide the default gateway, +such as +.Xr aggr 4 , +.Xr trunk 4 , +.Xr svlan 4 , +.Xr vlan 4 , +.Xr carp 4 , +and +.Xr pppoe 4 . +.It +Initialize the routing table and set up the default routes. +.It +Configure tunnel interfaces that require a working network +to reach the other end of the tunnel, +such as +.Xr tun 4 , +.Xr tap 4 , +.Xr gif 4 , +.Xr etherip 4 , +.Xr gre 4 , +.Xr egre 4 , +.Xr pflow 4 , +and +.Xr wg 4 . +.El +.Pp +After the system is completely initialized, it is possible to start +newly created interfaces or apply configuration from +.Xr hostname.if 5 +files to an existing interfaces. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl n +Reports the steps that would be taken, +without actually configuring anything. +.El +.Sh SEE ALSO +.Xr multicast 4 , +.Xr defaultdomain 5 , +.Xr hostname.if 5 , +.Xr mygate 5 , +.Xr ifconfig 8 , +.Xr rc 8 , +.Xr rc.conf 8 +.Sh HISTORY +The +.Nm +command first appeared in +.Bx 4.0 . diff --git a/static/openbsd/man8/rc.8 b/static/openbsd/man8/rc.8 new file mode 100644 index 00000000..e4940e4c --- /dev/null +++ b/static/openbsd/man8/rc.8 @@ -0,0 +1,223 @@ +.\" $OpenBSD: rc.8,v 1.48 2025/06/01 07:36:05 kn Exp $ +.\" +.\" Copyright (c) 1980, 1991, 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. +.\" +.\" @(#)rc.8 8.2 (Berkeley) 12/11/93 +.\" +.Dd $Mdocdate: June 1 2025 $ +.Dt RC 8 +.Os +.Sh NAME +.Nm rc , +.Nm rc.firsttime , +.Nm rc.local , +.Nm rc.securelevel +.Nd command scripts for system startup +.Sh DESCRIPTION +.Nm rc +is the command script that is invoked by +.Xr init 8 +when the system starts up. +It performs system housekeeping chores and starts up system daemons. +Additionally, +.Nm rc +is intricately tied to the +.Xr netstart 8 +script, which runs commands and daemons pertaining to the network. +.Nm rc +is also used to execute any +.Xr rc.d 8 +scripts defined in +.Xr rc.conf.local 8 . +The +.Nm rc.securelevel , +.Nm rc.firsttime , +and +.Nm rc.local +scripts hold commands which are pertinent only to a specific site. +.Pp +All of these startup scripts are controlled to some +extent by variables defined in +.Xr rc.conf 8 , +which specify which daemons and services to run. +.Pp +Before +.Xr init 8 +starts +.Nm rc , +it sets the process priority, umask, and resource limits according to the +.Dq daemon +login class as described in +.Xr login.conf 5 . +It then starts +.Nm rc +and attempts to execute the sequence of commands therein. +.Pp +The first part of +.Nm rc +runs an +.Xr fsck 8 +with option +.Fl p +to +.Dq preen +all disks of minor inconsistencies resulting +from the last system shutdown and to check for serious inconsistencies +caused by hardware or software failure. +If this auto-check and repair succeeds, then the second part of +.Nm rc +is run. +However, if the file +.Pa /fastboot +exists, +fsck will not be invoked. +The file is then removed so that fsck will be run on subsequent boots. +.Pp +The second part of +.Nm rc +then asks +.Xr rc.conf 8 +for configuration variables, +mounts filesystems, saves +.Xr dmesg 8 +output to the file +.Pa /var/run/dmesg.boot , +starts system daemons, +preserves editor files, +clears the scratch directory +.Pa /tmp , +uses +.Xr savecore 8 +to save any possible core image that might have been +generated as a result of a system crash, +and relinks kernel objects in a random order. +.Pp +If at any point the boot script fails, +.Xr init 8 +enters single-user mode, +allowing the superuser a shell on the console. +On exiting this mode, +init again invokes +.Nm rc , +but this time without performing the file system preen. +.Pp +Before +.Nm rc +starts most system daemons, +.Xr netstart 8 +is executed. +.Pp +.Nm rc.securelevel +is executed by +.Nm rc +to start daemons that must be run before the security level changes. +Following this, +.Nm rc +then sets the security level to '1' if it wasn't set already by +.Nm rc.securelevel . +See +.Xr securelevel 7 +for the effects of setting the security level. +.Pp +If +.Nm rc.firsttime +exists, it is executed once and then deleted. +Any output is mailed to root. +.Pp +.Nm rc.local +is executed towards the end of +.Nm rc +(it is not the very last as there are a few services that must be +started at the very end). +Normally, +.Nm rc.local +contains commands and daemons that are not part of the +stock installation. +.Sh FILES +.Bl -tag -width "/etc/rc.securelevelXX" -compact +.It Pa /etc/netstart +Command script for network startup. +.It Pa /etc/rc +Command scripts for system startup. +.It Pa /etc/rc.conf +System daemon configuration database. +.It Pa /etc/rc.conf.local +Site specific daemon configuration database. +.It Pa /etc/rc.d +Directory to hold +.Xr rc.d 8 +scripts. +.It Pa /etc/rc.d/rc.subr +Functions used by the +.Xr rc.d 8 +scripts. +.It Pa /etc/rc.firsttime +Commands run on the first boot after creation. +.It Pa /etc/rc.local +Site specific command scripts for system startup. +.It Pa /etc/rc.securelevel +Commands run before the security level changes. +.It Pa /etc/rc.shutdown +Commands run at system shutdown. +.It Pa /etc/examples/rc.* +Examples of site specific scripts. +.It Pa /fastboot +Tells +.Nm rc +not to run +.Xr fsck 8 +during the next boot. +.It Pa /var/run/dmesg.boot +Copy of +.Xr dmesg 8 +saved by +.Nm rc +at boot time. +.It Pa /etc/random.seed +Random seed file read by the bootloader; +updated at system startup and shutdown. +.It Pa /var/db/host.random +Random seed file read by +.Nm rc +and the installer on upgrades; +updated at system startup and shutdown. +.El +.Sh SEE ALSO +.Xr sysctl.conf 5 , +.Xr securelevel 7 , +.Xr init 8 , +.Xr netstart 8 , +.Xr rc.conf 8 , +.Xr rc.d 8 , +.Xr rc.shutdown 8 , +.Xr rcctl 8 +.Sh HISTORY +The +.Nm +command appeared in +.At v4 . diff --git a/static/openbsd/man8/rc.conf.8 b/static/openbsd/man8/rc.conf.8 new file mode 100644 index 00000000..e076ec29 --- /dev/null +++ b/static/openbsd/man8/rc.conf.8 @@ -0,0 +1,237 @@ +.\" $OpenBSD: rc.conf.8,v 1.31 2022/09/25 22:47:27 kn Exp $ +.\" +.\" Copyright (c) 1997 Ian F. Darwin +.\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org> +.\" 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. 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. +.\" +.Dd $Mdocdate: September 25 2022 $ +.Dt RC.CONF 8 +.Os +.Sh NAME +.Nm rc.conf , +.Nm rc.conf.local +.Nd system daemon configuration database +.Sh DESCRIPTION +The file +.Nm rc.conf +contains a series of variable assignments that are used to configure +the system daemons. +These variables are read by +.Xr rc 8 +early on in the boot sequence and every time an +.Xr rc.d 8 +script is executed. +.Pp +It is advisable to leave +.Nm rc.conf +untouched, and instead create and edit a new +.Nm rc.conf.local +file or use the +.Xr rcctl 8 +utility. +Since only the last assignment to any variable takes effect, +variables set in this file override variables previously set in +.Nm rc.conf . +.Pp +.Nm rc.conf +is made up of variable assignments +.Pq Ar variable Ns = Ns Ar value +with comments designated by a hash mark +.Pq Sq # . +.Pp +.Sy Base system daemon +configuration variables are used to enable and disable daemon programs +that are installed by default, and to set their command line options. +.Pp +All of these variables follow the format +.Dq Ar daemon Ns _flags +where +.Ar daemon +is the name of one of the +.Xr rc.d 8 +daemon control scripts. +The list of base system daemons, including the information whether +they are enabled by default, can be displayed with this command: +.Pp +.Dl grep _flags /etc/rc.conf +.Pp +If one of these variables is set to +.Cm NO , +the respective +.Ar daemon +is disabled. +If set to the empty string, the +.Ar daemon +is run with the default command line arguments defined in its +.Xr rc.d 8 +.Ar daemon +script, or without command line arguments if no such default exists. +If set to any other value, including a string containing +only a single blank character, the +.Ar daemon +is run with those command line arguments. +.Pp +.Sy Package daemon +configuration variables are used to enable and disable +daemon programs installed from +.Xr packages 7 , +and to set their command line options. +.Pp +The special +.Cm pkg_scripts +variable lists +.Xr rc.d 8 +.Ar daemon +control scripts to be started in the specified order. +For each +.Ar daemon +listed, its default command line options can optionally be overridden +using the variable +.Ar daemon Ns _flags +as described above. +.Pp +.Sy Base system service +configuration variables control features available by default +that are not implemented as daemons. +They can be set to either +.Cm YES +or +.Cm NO . +When set to +.Cm YES , +they have the following effects: +.Bl -tag -width check_quotas +.It Cm accounting +rc calls: +.Xr accton 8 +.Pa /var/account/acct +.It Cm check_quotas +rc calls: +.Xr quotacheck 8 +.Fl a ; +.Xr quotaon 8 +.Fl a +.It Cm ipsec +rc calls: +.Xr ipsecctl 8 +.Fl f Pa /etc/ipsec.conf +.It Cm library_aslr +rc reorders some libraries for improved protection against ROP. +.It Cm multicast +See +.Xr multicast 4 . +.It Cm pf +rc calls: +.Xr pfctl 8 +.Fl ef Pa /etc/pf.conf +.It Cm spamd_black +The script +.Pa /etc/rc.d/spamd +uses +.Fl b +in front of any other configured command line arguments when running +.Xr spamd 8 +and +.Xr spamd-setup 8 . +.El +.Pp +.Sy Auxiliary +configuration variables mostly determine +the locations of specific configuration files. +The boot scripts use them as follows: +.Bl -tag -width amd_master +.It Cm amd_master +The +.Xr amd 8 +master map file. +The script +.Pa /etc/rc.d/amd +appends its content to the command line when starting the auto mounter daemon. +.It Cm shlib_dirs +Extra shared library search path entries. +rc calls: +.Xr ldconfig 8 +.Pa /usr/X11R6/lib +.Pa /usr/local/lib +.Pf $ Brq Ar shlib_dirs +.It Cm savecore_flags +rc calls: +.Xr savecore 8 +.Pf $ Brq Ar savecore_flags +.Pa /var/crash +.El +.Sh EXAMPLES +Do not start the +.Xr dhcpd 8 +daemon when booting the system: +.Bd -literal -offset indent +dhcpd_flags=NO +.Ed +.Pp +To run the dhcpd daemon, +add the following line to +.Nm rc.conf.local : +.Bd -literal -offset indent +dhcpd_flags= +.Ed +.Pp +To start it with some options: +.Bd -literal -offset indent +dhcpd_flags=-A abandoned +.Ed +.Pp +Run +.Pa /etc/rc.d/messagebus +then +.Pa /etc/rc.d/cupsd +with the +.Cm start +argument at boot time, +and in reverse order with the +.Cm stop +argument at shutdown: +.Bd -literal -offset indent +pkg_scripts=messagebus cupsd +.Ed +.Pp +The default location of the +.Xr amd 8 +master map file is: +.Bd -literal -offset indent +amd_master=/etc/amd/master # AMD 'master' map +.Ed +.Sh SEE ALSO +.Xr init 8 , +.Xr intro 8 , +.Xr rc 8 , +.Xr rc.d 8 , +.Xr rcctl 8 +.Sh HISTORY +The +.Nm +file first appeared in +.Ox 2.2 . diff --git a/static/openbsd/man8/rc.d.8 b/static/openbsd/man8/rc.d.8 new file mode 100644 index 00000000..ff4a9bc4 --- /dev/null +++ b/static/openbsd/man8/rc.d.8 @@ -0,0 +1,207 @@ +.\" $OpenBSD: rc.d.8,v 1.42 2025/08/15 11:35:18 ajacoutot Exp $ +.\" +.\" Copyright (c) 2021 Antoine Jacoutot +.\" Copyright (c) 2011 Robert Nagy, Antoine Jacoutot, Ingo Schwarze +.\" 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 AUTHORS ``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 AUTHORS 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 $Mdocdate: August 15 2025 $ +.Dt RC.D 8 +.Os +.Sh NAME +.Nm rc.d +.Nd daemon control scripts +.Sh SYNOPSIS +.Nm /etc/rc.d/ Ns Ar daemon +.Op Fl d | q +.Op Fl f +.Ar action +.Sh DESCRIPTION +The +.Pa /etc/rc.d +directory contains +.Xr ksh 1 +scripts to start, stop, and reconfigure daemon +programs +.Pq Dq services . +.Pp +Services installed from +.Xr packages 7 +may be started at boot time in the order specified by the +.Va pkg_scripts +variable from +.Xr rc.conf 8 ; +the order will be reversed during shutdown. +Services comprising +.Ox +base are started by +.Xr rc 8 . +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl d +Setting this option will print the function names as they are called +and prevent the +.Xr rc.subr 8 +framework from redirecting stdout and stderr to /dev/null. +This is used to allow debugging of failed +.Ar actions . +.It Fl f +This option only affects the +.Cm start +action. +It will forcibly start the daemon whatever value +.Va daemon_flags +is set to. +If +.Va daemon_flags +is set to +.Dq NO , +execution will continue with the script's own defaults unless other +flags are specified. +.It Fl q +Quiet mode. +Only display the script name and the result of the +.Ar action +on error. +.El +.Pp +Each such script responds to the following +.Ar actions : +.Pp +.Bl -tag -width configtest -offset indent -compact +.It Cm start +Start the service, if not already running. +.It Cm stop +Stop the service. +.It Cm reload +Tell the daemon to reload its configuration. +.It Cm restart +Perform a stop, then a start. +.It Cm check +Return 0 if the daemon is running or 1 if it is not. +.It Cm configtest +Check that the daemon configuration is valid. +.El +.Sh ENVIRONMENT +Daemon control scripts use a fixed number of +.Xr ksh 1 +variables when starting a daemon. +The following can be overridden by site-specific values provided in +.Xr rc.conf.local 8 : +.Bl -tag -width daemon_timeout -offset indent +.It Ar daemon Ns _execdir +Run daemon from the specified directory. +.It Ar daemon Ns _flags +Additional arguments to call the daemon with. +These will be appended to any mandatory arguments already contained in the +.Va daemon +variable defined in the control script. +If +.Ar daemon Ns _flags +is set to +.Dq NO , +it will prevent the daemon from starting even when listed in +.Va pkg_scripts . +.It Ar daemon Ns _logger +Redirect standard output and error to +.Xr logger 1 +using the configured priority (e.g. "daemon.info"). +.It Ar daemon Ns _rtable +Routing table to run the daemon under, using +.Xr route 8 . +.It Ar daemon Ns _timeout +Maximum time in seconds to wait for the +.Cm start , +.Cm stop +and +.Cm reload +actions to return. +This is only guaranteed with the default +.Ic rc_start , +.Ic rc_stop +and +.Ic rc_reload +functions. +.It Ar daemon Ns _user +User to run the daemon as, using +.Xr su 1 . +.El +.Pp +To obtain the actual variable names, replace +.Ar daemon +with the name of the script. +For example, postgres is managed through +.Pa /etc/rc.d/postgresql : +.Pp +.Dl daemon_flags=-D /var/postgresql/data -w -l /var/postgresql/logfile +.Pp +To override this and increase the debug log level (keeping the existing +flags), define the following in +.Xr rc.conf.local 8 : +.Pp +.Dl postgresql_flags=-D /var/postgresql/data -w -l /var/postgresql/logfile -d 5 +.Pp +Each script may define its own defaults, as explained in +.Xr rc.subr 8 . +.Pp +.Va daemon_class +is a special read-only variable. +It is set to +.Dq daemon +unless there is a login class configured in +.Xr login.conf 5 +with the same name as the +.Nm rc.d +script itself, +in which case it will be set to that login class. +This allows setting many initial process properties, for example +environment variables, scheduling priority, and process limits +such as maximum memory use and number of files. +.Sh FILES +.Bl -tag -width Ds +.It Pa /etc/rc.d/ +Directory containing daemon control scripts. +.It Pa /etc/rc.d/rc.subr +Functions and variables used by +.Nm rc.d +scripts. +.It Pa /var/run/rc.d/ +Directory containing files recording the variables of currently running daemons. +Some are informational and some are for matching daemons using +.Xr pgrep 1 +and +.Xr pkill 1 . +.El +.Sh SEE ALSO +.Xr ksh 1 , +.Xr rc 8 , +.Xr rc.conf 8 , +.Xr rc.subr 8 , +.Xr rcctl 8 +.Sh HISTORY +The +.Pa /etc/rc.d +directory +first appeared in +.Ox 4.9 . diff --git a/static/openbsd/man8/rc.shutdown.8 b/static/openbsd/man8/rc.shutdown.8 new file mode 100644 index 00000000..fae45aaf --- /dev/null +++ b/static/openbsd/man8/rc.shutdown.8 @@ -0,0 +1,90 @@ +.\" $OpenBSD: rc.shutdown.8,v 1.17 2024/09/15 19:39:26 kn Exp $ +.\" +.\" Copyright (c) 1999 Aaron Campbell +.\" 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. +.\" +.Dd $Mdocdate: September 15 2024 $ +.Dt RC.SHUTDOWN 8 +.Os +.Sh NAME +.Nm rc.shutdown +.Nd command script run at system shutdown +.Sh DESCRIPTION +When the system is shut down using the +.Xr reboot 8 +or +.Xr halt 8 +commands, +or when +.Xr init 8 +is signalled to do so, +or when a keyboard-requested halt is issued (if the architecture supports it), +.Xr rc 8 +is invoked with the argument +.Dq shutdown . +This document details the actions taken by +.Xr rc 8 +in such an instance. +.Pp +Firstly it saves random data for reseeding the kernel random number +generator during the next boot. +It then stops any daemons +defined in the +.Va pkg_scripts +variable in +.Xr rc.conf.local 8 , +as well as +.Xr vmd 8 , +in that order, +by passing them the +.Cm stop +argument. +.Pp +.Xr rc 8 +then runs +.Nm . +The administrator should place in this file +any commands they wish to have executed during shutdown. +.Pp +Finally, all +.Xr carp 4 +interfaces are brought down and then the system shuts down. +.Pp +If +.Xr init 8 +is exiting single-user mode it will also run the first part of shutdown +(saving random data), +though not the latter. +.Sh FILES +.Bl -tag -width "/etc/rc.shutdown" +.It Pa /etc/rc.shutdown +Command script run at system shutdown. +.It Pa /etc/examples/rc.shutdown +Example script. +.El +.Sh SEE ALSO +.Xr init 8 , +.Xr rc 8 , +.Xr rc.conf 8 , +.Xr reboot 8 diff --git a/static/openbsd/man8/rc.subr.8 b/static/openbsd/man8/rc.subr.8 new file mode 100644 index 00000000..0451748f --- /dev/null +++ b/static/openbsd/man8/rc.subr.8 @@ -0,0 +1,437 @@ +.\" $OpenBSD: rc.subr.8,v 1.49 2022/10/22 10:34:56 ajacoutot Exp $ +.\" +.\" Copyright (c) 2021, 2022 Antoine Jacoutot +.\" Copyright (c) 2011 Robert Nagy, Antoine Jacoutot, Ingo Schwarze +.\" 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 AUTHORS ``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 AUTHORS 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 $Mdocdate: October 22 2022 $ +.Dt RC.SUBR 8 +.Os +.Sh NAME +.Nm rc.subr +.Nd daemon control scripts routines +.Sh SYNOPSIS +.Nm daemon Ns = Ns Ar path_to_executable +.Nm .\& +.Pa /etc/rc.d/rc.subr +.Nm rc_cmd +.Ar action +.Sh DESCRIPTION +Apart from a few notable exceptions, rc scripts must follow this +naming policy: +.Pp +.Bl -enum -compact +.It +When possible, use the same name as the +.Nm daemon +it is referring to. +.It +It must follow +.Xr ksh 1 +variable naming: begin with an alphabetic or underscore character, followed by +one or more alphanumeric or underscore characters. +Dashes +.Pq Sq - +have to be converted to +underscores +.Pq Sq _ . +.El +.Pp +Every script under +.Pa /etc/rc.d +follows this pattern: +.Pp +.Bl -enum -compact +.It +Define the +.Va daemon +variable. +.It +Define service-specific defaults for one or more +.Va daemon_* +variables (optional). +.It +Source +.Nm , +which defines default shell functions and variable values. +.It +Override the +.Va pexp +variable or any of the +.Ic rc_* +functions and set the +.Va rc_bg +or +.Va rc_reload +variables, if needed. +.It +Define an +.Ic rc_pre +and/or +.Ic rc_post +function, if needed. +.It +Call the +.Ic rc_cmd +function as +.Dq "rc_cmd $1" . +.El +.Pp +The following shell functions are defined by +.Nm : +.Bl -tag -width rc_reload +.It Ic rc_check +Search for processes of the service with +.Xr pgrep 1 +using the regular expression given in the +.Va pexp +variable. +.It Ic rc_cmd Ar action +Run the +.Ar action +for the current +.Nm rc.d +script, based on the settings of various shell variables. +.Ic rc_cmd +is extremely flexible, and allows fully functional +.Nm rc.d +scripts to be implemented in a small amount of shell code. +For a given +.Ar action , +if the +.Ic rc_${action} +function is not defined, then a default function is provided by +.Nm rc.subr . +In addition actions can be disabled by setting the +.Va rc_${action} +variable to +.Dq NO . +For example, if +.Dq rc_reload=NO +is set in the +.Nm rc.d +script, and +.Ic rc_cmd +is called for the reload action, an error will be raised. +Similarly, the special variable +.Va rc_usercheck +must be set to +.Dq NO +if the +.Cm check +.Ar action +requires root privileges. +.Pp +The +.Ar action +argument can be +.Cm start , +.Cm stop , +.Cm reload , +.Cm restart , +or +.Cm check : +.Bl -tag -width restart +.It Ic check +Call +.Ic rc_check . +Return 0 if the daemon is running or 1 if it is not. +.It Ic start +Check that the service is running by calling +.Ic rc_check . +If it's not running, call +.Ic rc_pre +if it exists, then +.Ic rc_start . +.It Ic stop +Check that the service is running by calling +.Ic rc_check . +If it is running, +call +.Ic rc_stop +and wait up to 30 seconds for the daemon to properly shutdown. +If successful, run +.Ic rc_post +if it exists. +.It Ic restart +Run the +.Ar action +argument +.Cm stop , +then if successful run +.Cm start . +.It Ic reload +Check that the service is running by calling +.Ic rc_check . +If it is running, +call +.Ic rc_reload . +.El +.It Ic rc_configtest +Check daemon configuration before running +.Cm start , +.Cm reload +and +.Cm restart +if implemented by the +.Xr rc.d 8 +script. +.It Ic rc_exec +Execute argument using +.Xr su 1 +according to +.Va daemon_class , +.Va daemon_execdir , +.Va daemon_user , +.Va daemon_rtable +and +.Va daemon_logger +values. +.It Ic rc_post +This function is run after +.Cm stop +if implemented by the +.Xr rc.d 8 +script. +.It Ic rc_pre +This function is run before +.Cm start +if implemented by the +.Xr rc.d 8 +script. +.It Ic rc_reload +Send the +.Va rc_reload_signal +using +.Xr pkill 1 +on the regular expression given in the +.Va pexp +variable. +One has to make sure that sending +.Dv SIGHUP +to a daemon will have the desired effect, +i.e. that it will reload its configuration. +.It Ic rc_start +Start the daemon. +Defaults to: +.Bd -literal -offset indent +rc_exec "${daemon} ${daemon_flags}" +.Ed +.It Ic rc_stop +Stop the daemon. +Send the +.Va rc_stop_signal +using +.Xr pkill 1 +on the regular expression given in the +.Va pexp +variable. +.El +.Sh ENVIRONMENT +.Ic rc_cmd +uses the following shell variables to control its behaviour. +.Bl -tag -width "daemon_timeout" +.It Va daemon +The path to the daemon, optionally followed by one or more +whitespace separated arguments. +Arguments included here are always used, even if +.Va daemon_flags +is empty. +This variable is required. +It is an error to source +.Nm +without defining +.Va daemon +first. +.It Va daemon_class +Login class to run the daemon with, using +.Xr su 1 . +This is a read only variable that gets set by +.Nm rc.subr +itself. +It searches +.Xr login.conf 5 +for a login class that has the same name as the +.Nm rc.d +script itself and uses that. +If no such login class exists then +.Dq daemon +will be used. +.It Va daemon_execdir +Change to this directory before running +.Ic rc_exec . +.It Va daemon_flags +Arguments to call the daemon with. +.It Va daemon_logger +Redirect standard output and error to +.Xr logger 1 +using the configured priority (e.g. "daemon.info"). +.It Va daemon_rtable +Routing table to run the daemon under, using +.Xr route 8 . +.It Va daemon_timeout +Maximum time in seconds to wait for the +.Cm start , +.Cm stop +and +.Cm reload +actions to return. +This is only guaranteed with the default +.Ic rc_start , +.Ic rc_stop +and +.Ic rc_reload +functions. +.It Va daemon_user +User to run the daemon as, using +.Xr su 1 . +.It Va pexp +A regular expression to be passed to +.Xr pgrep 1 +in order to find the desired process or to be passed to +.Xr pkill 1 +to stop it. +By default this variable contains the +.Va daemon +and +.Va daemon_flags +variables. +To override the default value, an +.Nm rc.d +script has to redefine this variable +.Em after +sourcing +.Nm . +.It Va rc_bg +Can be set to +.Cm YES +in an +.Nm rc.d +script to force starting the daemon in background when using the default +.Ic rc_start . +.It Va rc_reload +Can be set to +.Dq NO +in an +.Nm rc.d +script to disable the reload action if the respective daemon +does not support reloading its configuration. +.Em The same is possible, but almost never useful, for other actions. +.It Va rc_reload_signal +Signal sent to the daemon process +.Pq Va pexp +by the default +.Fn rc_reload +function. +Defaults to +.Em HUP . +.It Va rc_stop_signal +Signal sent to the daemon process +.Pq Va pexp +by the default +.Fn rc_stop +function. +Default to +.Em TERM . +.It Va rc_usercheck +Can be set to +.Dq NO +in an +.Nm rc.d +script, if the +.Cm check +action needs root privileges. +.El +.Pp +All +.Va daemon_* +variables are set in the following ways: +.Bl -enum +.It +Global defaults are provided by +.Nm : +.Bd -literal -offset indent +daemon_class=daemon +daemon_execdir= +daemon_flags= +daemon_logger= +daemon_rtable=0 +daemon_timeout=30 +daemon_user=root +.Ed +.It +Service-specific defaults may be provided in the respective +.Nm rc.d +script +.Em before +sourcing +.Nm , +thus overriding the global defaults. +.It +As noted in +.Xr rc.d 8 , +site-specific values provided in +.Xr rc.conf.local 8 +for +.Va daemon_execdir , +.Va daemon_flags , +.Va daemon_logger , +.Va daemon_rtable , +.Va daemon_timeout , +and +.Va daemon_user +will override those defaults. +.El +.Sh FILES +.Bl -tag -width Ds +.It Pa /etc/rc.d/ +Directory containing daemon control scripts. +.It Pa /etc/rc.d/rc.subr +Functions and variables used by +.Nm rc.d +scripts. +.It Pa /usr/ports/infrastructure/templates/rc.template +A sample +.Nm rc.d +script. +.El +.Sh SEE ALSO +.Xr rc 8 , +.Xr rc.conf 8 , +.Xr rc.d 8 +.Sh HISTORY +The +.Nm +framework +first appeared in +.Ox 4.9 . +.Sh AUTHORS +.An -nosplit +The +.Nm +framework was written by +.An Robert Nagy Aq Mt robert@openbsd.org , +.An Antoine Jacoutot Aq Mt ajacoutot@openbsd.org , +and +.An Ingo Schwarze Aq Mt schwarze@openbsd.org . diff --git a/static/openbsd/man8/release.8 b/static/openbsd/man8/release.8 new file mode 100644 index 00000000..8e126001 --- /dev/null +++ b/static/openbsd/man8/release.8 @@ -0,0 +1,293 @@ +.\" $OpenBSD: release.8,v 1.101 2026/04/18 16:54:22 kettenis Exp $ +.\" +.\" Copyright (c) 2000 Marco S. Hyman +.\" Copyright (c) 2016 Theo Buehler <tb@openbsd.org> +.\" +.\" Permission to copy all or part of this material for any purpose is +.\" granted provided that the above copyright notice and this paragraph +.\" are duplicated in all copies. THIS SOFTWARE IS PROVIDED ``AS IS'' +.\" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT +.\" LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE. +.\" +.Dd $Mdocdate: April 18 2026 $ +.Dt RELEASE 8 +.Os +.Sh NAME +.Nm release +.Nd building an OpenBSD release +.Sh DESCRIPTION +There are several steps necessary to build a release: +.Pp +.Bl -enum -compact -offset indent +.It +Update sources. +.It +Build and install a new kernel. +.It +Build a new base system. +.It +Make and validate the base system release. +.It +Build and install Xenocara. +.It +Make and validate the Xenocara release. +.It +Create boot and installation disk images. +.It +Make the third party packages. +.El +.Pp +This manual describes the steps for the +.Em release +and +.Em stable +branches. +To build a +.Em current +release, additional steps may be required. +See +.Lk https://www.openbsd.org/faq/current.html +for any needed workarounds. +.Pp +Commands to be run as a user are preceded by a dollar sign +.Sq $ . +Commands that must be run as the superuser are preceded by a hash mark +.Sq # . +Privileges will be de-escalated to the user +.Sy build +whenever possible. +.Pp +Most of the defaults can be overridden by setting +the appropriate variables in +.Xr mk.conf 5 . +.Ss 1. Update sources +A +.Nm +should use sources that were checked out using the same +.Xr cvs 1 +tag. +There are two families of tags: +.Bl -tag -width OPENBSD_x_y_BASE +.It OPENBSD_x_y_BASE +The sources for the +.Ox x.y +release. +.It OPENBSD_x_y +The sources for the +.Ox x.y +stable branch. +It contains the patches described in +.Lk https://www.openbsd.org/stable.html . +.El +.Pp +See +.Lk https://www.openbsd.org/anoncvs.html +for instructions on fetching the sources for the first time. +.Pp +To update existing sources to the versions identified by one of the above +tags, use the commands: +.Bd -literal -offset indent +$ cd /usr/src && cvs up -r TAG -Pd +$ cd /usr/xenocara && cvs up -r TAG -Pd +$ cd /usr/ports && cvs up -r TAG -Pd +.Ed +.Pp +.Sy Warning : +.Xr cvs 1 +tags are +.Sq sticky . +See +.Xr cvs 1 +for more information. +.Ss 2. Build and install a new kernel +Always build and install a new kernel and reboot before +building the programs that will use the kernel. +This ensures that any new system calls, for example, will be present +when needed. +.Pp +.Dl # cd /sys/arch/$(machine)/compile/GENERIC.MP +.Pp +Replace +.Pa GENERIC.MP +with a different kernel configuration if necessary. +.Pp +Create the build directory and configuration file, +then compile and install the kernel: +.Bd -literal -offset indent +# make obj +# make config +# make && make install +.Ed +.Pp +The current kernel is copied to +.Pa /obsd +and the new kernel to +.Pa /bsd . +Reboot. +.Ss 3. Build a new base system +The build process will place the object files in a tree under +.Pa /usr/obj . +This directory must be owned by build:wobj with mode 770. +.Pp +Create the tree of obj directories and begin the build: +.Bd -literal -offset indent +# cd /usr/src +# make obj && make build +.Ed +.Pp +After the build is completed, update +.Pa /etc , +.Pa /var , +and +.Pa /dev , +using +.Xr sysmerge 8 +and +.Xr MAKEDEV 8 : +.Bd -literal -offset indent +# sysmerge +# cd /dev && ./MAKEDEV all +.Ed +.Pp +At this point, the base system is up to date with the code +that will be made into a release. +.Ss 4. Make and validate the base system release +The base system release consists of at least one generic kernel, +some installation media, the release tarballs, +installation instructions, and checksum files. +.Pp +On arm64, armv7 and riscv64 architectures, additional files are required. +Install the following packages using +.Xr pkg_add 1 +or from +.Xr ports 7 : +.Pp +.Bl -tag -width "riscv64" -offset indent -compact +.It arm64 +raspberrypi-firmware u-boot-rpi +.It armv7 +dtb u-boot-arm +.El +.Pp +and install the following firmwares using +.Xr fw_update 8 : +.Pp +.Bl -tag -width "riscv64" -offset indent -compact +.It riscv64 +riscv64-spacemit-dtb +.El +.Pp +Create a +.Va RELEASEDIR +directory to store the release files. +This directory must be writable by +.Sy build . +.Pp +To build a release, it is necessary to prepare a filesystem mounted with the +.Em noperm +.Xr mount 8 +option. +Either standard FFS or +.Xr mount_mfs 8 +may be used. +The root of this filesystem must have owner +.Sy build +and mode 700. +On this filesystem, create a +.Va DESTDIR +directory. +This will be the root of a complete +.Ox +installation. +.Pp +.Sy Warning : +.Va DESTDIR +and +.Va RELEASEDIR +must not refer to any directory with +.Pa /mnt +in its path, as +.Pa /mnt +is used in the release generation process. +The +.Xr vnd 4 +device vnd0 +is also used and must not be configured. +.Pp +Make the release and check the contents of the release tarballs: +.Bd -literal -offset indent +# export DESTDIR=your-destdir RELEASEDIR=your-releasedir +# cd /usr/src/etc && make release +# cd /usr/src/distrib/sets && sh checkflist +# unset RELEASEDIR DESTDIR +.Ed +.Ss 5. Build and install Xenocara +Xenocara is based on the X.Org modular build system. +Its sources are supposed to be in +.Pa /usr/xenocara . +The +.Pa /usr/src +tree is also needed while building Xenocara. +The object directory +.Pa /usr/xobj +should be empty and owned by build:wobj with mode 770. +.Pp +The following steps will build and install Xenocara. +.Bd -literal -offset indent +# cd /usr/xenocara +# make bootstrap +# make obj +# make build +.Ed +.Ss 6. Make and validate the Xenocara release +Xenocara uses +.Va DESTDIR +and +.Va RELEASEDIR +as described above. +Use a different +.Va DESTDIR +for the Xenocara release than for the base release, +as the contents of +.Va DESTDIR +will be removed. +.Pp +The steps to build and validate the Xenocara release are: +.Bd -literal -offset indent +# export DESTDIR=your-destdir RELEASEDIR=your-releasedir +# make release +# make checkdist +# unset RELEASEDIR DESTDIR +.Ed +.Pp +At this point, +.Ox +base system and X Window System tarballs are in +.Va RELEASEDIR . +.Ss 7. Create boot and installation disk images +The disk images +.No install${ Ns Va VERSION Ns }.img +and +.No install${ Ns Va VERSION Ns }.iso +are suitable for installs without network connectivity. +They contain the tarballs built in the previous steps. +.Bd -literal -offset indent +# export RELDIR=your-releasedir RELXDIR=your-xenocara-releasedir +# cd /usr/src/distrib/$(machine)/iso && make +# make install +.Ed +.Pp +The two installer images are now stored in the local release +directory. +.Ss 8. Make the third party packages +The ports subsystem of contributed applications is capable of producing +packages for installation, either individually or in bulk. +This is described in +.Xr ports 7 . +.Sh SEE ALSO +.Xr cvs 1 , +.Xr pkg_add 1 , +.Xr mk.conf 5 , +.Xr ports 7 , +.Xr sysmerge 8 diff --git a/static/openbsd/man8/security.8 b/static/openbsd/man8/security.8 new file mode 100644 index 00000000..28c300c4 --- /dev/null +++ b/static/openbsd/man8/security.8 @@ -0,0 +1,173 @@ +.\" $OpenBSD: security.8,v 1.28 2025/03/31 17:35:28 schwarze Exp $ +.\" +.\" David Leonard, 2001. Public Domain. +.\" +.Dd $Mdocdate: March 31 2025 $ +.Dt SECURITY 8 +.Os +.Sh NAME +.Nm security +.Nd periodic system security check +.Sh DESCRIPTION +.Nm +is a command script that examines the system for some signs of security +weaknesses. +It is only a security aid and does not offer complete protection. +.Nm +is run by +.Xr daily 8 , +which mails any output to root on a daily basis. +.Pp +The +.Nm +script carries out the following list of simple checks: +.Bl -bullet +.It +Check the +.Xr master.passwd 5 +and +.Xr group 5 +files for +syntax, empty passwords, partially closed accounts, +suspicious UIDs, suspicious GIDs, and duplicate entries. +.It +Check root's home directory and login environment for +insecure permissions, suspicious paths, and umask commands in the +dotfiles. +.It +Check for suspicious commands in +.Pa /etc/mail/aliases . +.It +Check for insecurities in +.Pa /etc/hosts.lpd . +.It +Check user +.Pa .rhosts +and +.Pa .shosts +files for open access. +.It +Check user home directory permissions. +.It +Check many user dotfile permissions. +.It +Check user mailbox permissions. +.It +Check NFS +.Xr exports 5 +file for global export entries. +.It +Check for changes in setuid/setgid files and devices. +.It +Check disk ownership and permissions. +.It +Check for changes in the device file list. +.It +Check for permission changes in special files and system binaries listed in +.Pa /etc/mtree/special . +.Nm +also provides hooks for administrators to create their own lists. +These lists should be kept in +.Pa /etc/mtree/ +and filenames must have the suffix +.Dq .secure . +The following example shows how to create such a list, +to protect the programs in +.Pa /bin : +.Bd -literal -offset 4n +# mtree -cx -p /bin -K sha256digest,type > /etc/mtree/bin.secure +# chown root:wheel /etc/mtree/bin.secure +# chmod 600 /etc/mtree/bin.secure +.Ed +.Pp +.Sy Note: +These checks do not provide complete protection against +Trojan horse binaries, as +the miscreant can modify the tree specification to match the replaced binary. +For details on really protecting yourself against modified binaries, see +.Xr mtree 8 . +.It +Check for changes in files listed in +.Pa /etc/changelist . +Files being created or deleted, +as well as content change in the files themselves, +are reported. +See +.Xr changelist 5 +for further details. +.It +Check for changes to the disklabels and partition tables of mounted disks. +.It +Report on the installation or removal of any system +.Xr package 5 . +.It +Check +.Xr hostname.if 5 +file permissions. +.El +.Pp +The intent of the +.Nm +script is to point out some obvious holes to the system administrator. +.Sh ENVIRONMENT +The following variables can be set in +.Pa /etc/daily.local : +.Pp +.Bl -tag -width "PASSWDSKIP" -compact +.It Ev PASSWDSKIP +A whitespace-separated list of +.Ar name : Ns Ar shell +pairs allowed to have empty passwords. +For example, a machine running both CVS and gotd for anonymous access +might set: +.Bd -literal -offset indent +PASSWDSKIP="anoncvs:/usr/local/bin/anoncvssh + anonymous:/usr/local/bin/gotsh" +.Ed +.Pp +.It Ev SUIDSKIP +A whitespace-separated list of absolute paths to be skipped +in setuid/setgid file checks and in device special file checks. +Avoid trailing slashes. +.El +.Sh FILES +.Bl -tag -width /dev/changelist -compact +.It Pa /etc/changelist +.It Pa /etc/daily +.It Pa /etc/mtree +.It Pa /usr/libexec/security +.It Pa /var/backups +.El +.Sh SEE ALSO +.Xr changelist 5 , +.Xr daily 8 , +.Xr mtree 8 +.Sh HISTORY +A +.Nm +shell script appeared in +.Bx 4.3 Reno , +but most functionality only came with +.Bx 4.4 . +.Sh AUTHORS +.An -nosplit +The present manual was written by +.An David Leonard +for +.Ox 2.9 . +.An Andrew Fresh Aq Mt afresh1@openbsd.org +and +.An Ingo Schwarze Aq Mt schwarze@openbsd.org +rewrote +.Nm +from scratch in +.Xr perl 1 +for +.Ox 5.0 . +.Sh BUGS +The name of this script may provide a false sense of +.Nm security . +.\" Well, I thought it was amusing. +.Pp +There are perhaps an infinite number of ways the system can be compromised +without this script noticing. diff --git a/static/openbsd/man8/ssl.8 b/static/openbsd/man8/ssl.8 new file mode 100644 index 00000000..98ebc118 --- /dev/null +++ b/static/openbsd/man8/ssl.8 @@ -0,0 +1,175 @@ +.\" $OpenBSD: ssl.8,v 1.70 2024/05/30 14:06:23 tb Exp $ +.\" +.\" Copyright (c) 1999 Theo de Raadt, Bob Beck +.\" 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. +.\" +.Dd $Mdocdate: May 30 2024 $ +.Dt SSL 8 +.Os +.Sh NAME +.Nm ssl +.Nd details for libssl and libcrypto +.Sh DESCRIPTION +This document describes some of the issues relating to the use of +the OpenSSL libssl and libcrypto libraries. +This document is intended as an overview of what the libraries do, +and what uses them. +.Pp +The libssl and libcrypto libraries implement the TLS version 1 protocol. +It is most commonly used by the HTTPS protocol for encrypted +web transactions, as can be done with +.Xr httpd 8 . +The libcrypto library is also used by various programs such as +.Xr ssh 1 , +.Xr sshd 8 , +and +.Xr isakmpd 8 . +.Sh SERVER CERTIFICATES +The most common uses of TLS will require you to generate a server +certificate, which is provided by your host as evidence of its identity +when clients make new connections. +The certificates reside in the +.Pa /etc/ssl +directory, with the keys in the +.Pa /etc/ssl/private +directory. +.Pp +Private keys can be encrypted using AES and a passphrase to protect their +integrity should the encrypted file be disclosed. +However, it is important to note that encrypted server keys mean that the +passphrase needs to be typed in every time the server is started. +If a passphrase is not used, you will need to be absolutely sure your +key file is kept secure. +.Sh GENERATING RSA SERVER CERTIFICATES FOR WEB SERVERS +To support HTTPS transactions in +.Xr httpd 8 +you will need to generate an RSA certificate. +Start by creating a private key of the desired length: +.Bd -literal -offset indent +# openssl genrsa -out /etc/ssl/private/server.key 4096 +.Ed +.Pp +Or, if you wish the key to be encrypted with a passphrase that you will +have to type in when starting servers +.Bd -literal -offset indent +# openssl genrsa -aes256 -out /etc/ssl/private/server.key 4096 +.Ed +.Pp +If you are only generating a private key to use with +.Xr acme-client 1 +(for example, with a non-default key length) +you may stop here. +.Pp +Otherwise, the next step is to generate a Certificate Signing Request (CSR) +which is used to get a Certificate Authority (CA) to sign your certificate. +To do this use the command: +.Bd -literal -offset indent +# openssl req -new -key /etc/ssl/private/server.key \e + -out /etc/ssl/private/server.csr +.Ed +.Pp +This +.Pa server.csr +file can then be given to a Certificate Authority who will sign the key. +.Pp +You can also sign the key yourself, using the command: +.Bd -literal -offset indent +# openssl x509 -sha256 -req -days 365 \e + -in /etc/ssl/private/server.csr \e + -signkey /etc/ssl/private/server.key \e + -out /etc/ssl/server.crt +.Ed +.Pp +Note that standard web browsers do not use the common name of a subject, +but instead require that subject alt names are provided. +This requires the use of +.Ar -extfile Pa server.ext +when self-signing. +.Bd -literal -offset indent +# this is an example server.ext file +subjectAltName=DNS:example.com,DNS:www.example.com +.Ed +.Pp +With +.Pa /etc/ssl/server.crt +and +.Pa /etc/ssl/private/server.key +in place, you should be able to start +.Xr httpd 8 +with SSL configured, enabling HTTPS transactions with your machine on port 443. +.Pp +You will most likely want to generate a self-signed certificate in the +manner above along with your certificate signing request to test your +server's functionality even if you are going to have the certificate +signed by another Certificate Authority. +Once your Certificate Authority returns the signed certificate to you, +you can switch to using the new certificate by replacing the self-signed +.Pa /etc/ssl/server.crt +with the certificate signed by your Certificate Authority, and then +restarting +.Xr httpd 8 . +.Sh GENERATING ECDSA SERVER CERTIFICATES +First, generate a private ECDSA key. +The following command will use a NIST/SECG curve over a 384-bit +prime field: +.Bd -literal -offset indent +# openssl ecparam -name secp384r1 -genkey \e + -noout -out /etc/ssl/private/eccert.key +.Ed +.Pp +Note that some Certificate Authorities will only issue certificates for +keys generated using prime256v1 parameters. +.Pp +If you are only generating a private key to use with +.Xr acme-client 1 , +you may stop here. +Otherwise, the next step is to generate a Certificate Signing Request (CSR) +which is used to get a Certificate Authority (CA) to sign your certificate. +To do this use the command: +.Bd -literal -offset indent +# openssl req -key /etc/ssl/private/eccert.key -new \e + -out /etc/ssl/private/eccert.csr +.Ed +.Pp +This +.Pa eccert.csr +file can then be given to a CA who will sign the key. +.Pp +You can also sign the key yourself, using the command: +.Bd -literal -offset indent +# openssl x509 -sha256 -req -days 365 \e + -in /etc/ssl/private/eccert.csr \e + -signkey /etc/ssl/private/eccert.key \e + -out /etc/ssl/eccert.crt +.Ed +.Sh SEE ALSO +.Xr acme-client 1 , +.Xr openssl 1 , +.Xr ssh 1 , +.Xr ssl 3 , +.Xr httpd 8 , +.Xr isakmpd 8 , +.Xr rc 8 , +.Xr smtpd 8 , +.Xr sshd 8 , +.Xr starttls 8 diff --git a/static/openbsd/man8/starttls.8 b/static/openbsd/man8/starttls.8 new file mode 100644 index 00000000..8d1a1618 --- /dev/null +++ b/static/openbsd/man8/starttls.8 @@ -0,0 +1,208 @@ +.\" $OpenBSD: starttls.8,v 1.29 2025/05/05 20:50:03 tedu Exp $ +.\" +.\" Copyright (c) 2001 Jose Nazario <jose@monkey.org> +.\" 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 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, +.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY +.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL +.\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; +.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR +.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd $Mdocdate: May 5 2025 $ +.Dt STARTTLS 8 +.Os +.Sh NAME +.Nm starttls +.Nd ESMTP over TLS/SSL +.Sh DESCRIPTION +STARTTLS is an ESMTP option, defined in RFC 3207, which is used to conduct +ESMTP transactions over TLS circuits. +This is used to increase the security of mail server transactions. +.Pp +STARTTLS allows for the combination of several security solutions for MTA +(mail transport agent) level services through the TLS suite. +These security features include: +.Bl -tag -width Ds +.It Confidentiality +Encryption is used to protect data from passive monitoring. +.It Integrity +Hash algorithms are used to ensure the integrity of the +transmitted data. +This protects data from modification in transit. +.It Authentication +The use of public key encryption allows for the strong authentication of +either, or both, communicating parties. +This can be used to allow for select features, such as relaying, +to be controlled more securely. +.El +.Pp +A new ESMTP option, STARTTLS, has been added. +This is presented by the server when an ESMTP session is initiated. +The client then begins the TLS portion of the ESMTP session by issuing +the command +.Dq STARTTLS . +The remaining portion of the ESMTP session occurs over a TLS channel. +.Ss Creating a private key and certificate for an MTA +This example assumes you are creating your own self-signed certificates +for use with +.Xr smtpd 8 +and STARTTLS. +If you have an existing private key and you simply wish to generate +a new certificate (for example, if your old certificate has expired), +see the section entitled +.Sx Creating a certificate with an existing private key . +.Pp +For the purposes of this example the certificates will be stored in +.Pa /etc/ssl , +though it is possible to use a different directory if needed. +.Pp +Next, you must generate an +.Ar RSA +private key: +.Pp +.Dl # openssl genrsa -out /etc/ssl/private/mail.example.com.key 4096 +.Pp +This would generate a 4096-bit +.Ar RSA +key stored in the file +.Pa mail.example.com.key . +.Pp +Once you have generated the +.Ar RSA +key, you can generate a self-signed certificate from it using the command: +.Bd -literal -offset indent +# openssl req -x509 -new -key /etc/ssl/private/mail.example.com.key \e + -out /etc/ssl/mail.example.com.crt -days 365 +.Ed +.Pp +You may adjust the lifetime of the certificate via the +.Fl days +parameter (one year in this example). +.Pp +You can verify that the newly-generated certificate has correct information +with the following command: +.Pp +.Dl # openssl x509 -in /etc/ssl/mail.example.com.crt -text +.Pp +It is better to configure and use +.Xr acme-client 1 +to obtain a signed certificate. +.Pp +Because the private key files are unencrypted, +MTAs can be picky about using tight permissions on those files. +The certificate directory and the files therein should be +readable and writable only by the owner (root). +A simple way to ensure this is to run the following: +.Pp +.Dl # chmod -R go-rwx /etc/ssl/private +.Ss Creating a certificate with an existing private key +This example assumes you already have an existing private key, +.Pa /etc/ssl/private/mail.example.com.key . +You can generate a new certificate based on this key using the command: +.Bd -literal -offset indent +# openssl req -x509 -new -key /etc/ssl/private/mail.example.com.key \e + -out /etc/ssl/mail.example.com.crt -days 365 +# chmod 600 /etc/ssl/mail.example.com.crt +.Ed +.Pp +You may adjust the lifetime of the certificate via the +.Fl days +parameter (one year in this example). +.Pp +After having installed the certificates, +the mail server needs to be configured to accept TLS sessions +and use the key and certificate. +For +.Xr smtpd 8 , +it's as simple as adding pki configuration to +.Xr smtpd.conf 5 : +.Bd -literal -offset indent +pki mail.example.com cert "/etc/ssl/mail.example.com.crt" +pki mail.example.com key "/etc/ssl/private/mail.example.com.key" + +listen on [...] tls pki mail.example.com auth +.Ed +.Pp +After restarting the mail server, a new option should be presented for ESMTP +transactions, STARTTLS. +You can test this by connecting to the local host and issuing the +.Dq EHLO +command. +.Bd -literal -offset indent +# telnet localhost 25 +Trying 127.0.0.1... +Connected to localhost. +Escape character is '^]'. +220 localhost ESMTP OpenSMTPD +EHLO localhost +.Ed +.Pp +After typing +.Em EHLO localhost , +you should receive something like the following back. +.Bd -literal -offset indent +250-localhost Hello localhost [127.0.0.1], pleased to meet you +250-8BITMIME +250-ENHANCEDSTATUSCODES +250-SIZE 36700160 +250-DSN +250-STARTTLS +250 HELP +.Ed +.Pp +You should see +.Dq STARTTLS +listed along with the other options. +If so, congratulations, the MTA will now use TLS to encrypt your mail +traffic when the remote server supports it. +If not, check +.Pa /var/log/maillog +to see whether the MTA has reported any security problems or other errors. +.Ss Uses for TLS equipped MTAs +The most obvious use of a cryptographically enabled MTA +is for confidentiality of the electronic mail transaction and the +integrity checking provided by the cipher suite. +All traffic between the two mail servers is encrypted, including the +sender and recipient addresses. +TLS also allows for authentication of either or both systems in the transaction. +.Pp +One use of public key cryptography is for strong authentication. +We can use this authentication to selectively relay clients, including +other mail servers and mobile clients like laptops. +However, there have been some problems getting some mail clients to work using +certificate-based authentication. +Clients will have to generate certificates and have them +signed (for trust validation) by a trusted CA (certificate authority). +.Sh SEE ALSO +.Xr mail 1 , +.Xr openssl 1 , +.Xr smtpd 8 , +.Xr ssl 8 +.Sh STANDARDS +.Rs +.%A P. Hoffman +.%D February 2002 +.%R RFC 3207 +.%T SMTP Service Extension for Secure SMTP over Transport Layer Security +.Re +.Sh CAVEATS +Because TLS can only authenticate at the server level, true +end-to-end authentication of the mail message cannot be performed with +only the use of STARTTLS on the server. +The use of S/MIME or PGP email and trustworthy key hierarchies can guarantee +full confidentiality and integrity of the entire message path. diff --git a/static/openbsd/man8/sticky.8 b/static/openbsd/man8/sticky.8 new file mode 100644 index 00000000..bb046a05 --- /dev/null +++ b/static/openbsd/man8/sticky.8 @@ -0,0 +1,90 @@ +.\" $OpenBSD: sticky.8,v 1.11 2023/05/24 15:48:11 op Exp $ +.\" $NetBSD: sticky.8,v 1.3 1994/11/30 19:36:27 jtc Exp $ +.\" +.\" Copyright (c) 1980, 1991, 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. +.\" +.\" @(#)sticky.8 8.1 (Berkeley) 6/5/93 +.\" +.Dd $Mdocdate: May 24 2023 $ +.Dt STICKY 8 +.Os +.Sh NAME +.Nm sticky +.Nd sticky text and append-only directories +.Sh DESCRIPTION +A special file mode, called the +.Em sticky bit +.Pq mode Dv S_ISVTX , +is used to indicate special treatment for files and directories. +See +.Xr chmod 2 +or +the file +.Pa /usr/include/sys/stat.h +for an explanation of file modes. +.Sh STICKY FILES +Historically, an executable shareable file which had the sticky bit set +was not immediately discarded from swap space after execution. +The kernel hoarded the text segment of the file for future reuse, +thus avoiding having to reload the program. +This is no longer true on modern systems; +the current virtual memory system keeps track of recently used executables, +making the sticky bit for files redundant. +The sticky bit can still be set on files, but without any effect. +.Pp +Only the superuser can set the sticky bit on a file, +though the owner of the file may clear the sticky bit. +.Sh STICKY DIRECTORIES +A directory with the +.Sq sticky bit +set places restrictions on file deletion: +a file in a sticky directory may only be removed or renamed +by a user if the user has write permission for the directory and +the user is the owner of the file, the owner of the directory, +or the superuser. +This feature is usefully applied to directories such as +.Pa /tmp +which must be publicly writable but +should deny users the license to arbitrarily +delete or rename each others' files. +.Pp +Any user may create a sticky directory. +See +.Xr chmod 1 +for details about modifying file modes. +.Sh HISTORY +A +.Nm +command appeared in +.At 32v . +.Sh BUGS +Neither +.Xr open 2 +nor +.Xr mkdir 2 +will create a file with the sticky bit set. diff --git a/static/openbsd/man8/yp.8 b/static/openbsd/man8/yp.8 new file mode 100644 index 00000000..7590e142 --- /dev/null +++ b/static/openbsd/man8/yp.8 @@ -0,0 +1,230 @@ +.\" $OpenBSD: yp.8,v 1.34 2022/09/27 13:30:36 kn Exp $ +.\" $NetBSD: yp.8,v 1.9 1995/08/11 01:16:52 thorpej Exp $ +.\" +.\" Copyright (c) 1992, 1993, 1996 Theo de Raadt <deraadt@theos.com> +.\" 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. +.\" +.Dd $Mdocdate: September 27 2022 $ +.Dt YP 8 +.Os +.Sh NAME +.Nm yp +.Nd description of the YP subsystem +.Sh SYNOPSIS +.Nm ypinit +.Fl m Op Ar domainname +.Nm ypinit +.Fl s Ar master_server Op Ar domainname +.Nm ypinit +.Fl u Op Ar domainname +.Pp +.Nm ypbind +.Op Fl insecure +.Op Fl ypset +.Op Fl ypsetme +.Pp +.Nm ypset +.Op Fl d Ar domain +.Op Fl h Ar host +.Ar server +.Pp +.Nm yppoll +.Op Fl d Ar domain +.Op Fl h Ar host +.Ar mapname +.Pp +.Nm ypcat +.Op Fl kt +.Op Fl d Ar domainname +.Ar mapname +.Nm ypcat +.Fl x +.Pp +.Nm ypmatch +.Op Fl kt +.Op Fl d Ar domainname +.Ar key ... mapname +.Nm ypmatch +.Fl x +.Pp +.Nm ypwhich +.Op Fl t +.Op Fl d Ar domain +.Oo +.Op Fl h +.Ar host +.Oc +.Nm ypwhich +.Op Fl t +.Op Fl d Ar domain +.Op Fl h Ar host +.Fl m Op Ar mname +.Nm ypwhich +.Fl x +.Pp +.Nm ypserv +.Op Fl 1dx +.Op Fl a Ar aclfile +.Pp +.Nm ypxfr +.Op Fl cf +.Op Fl C Ar tid prog ipadd port +.Op Fl d Ar domain +.Op Fl h Ar host +.Op Fl s Ar domain +.Ar mapname +.Pp +.Nm yppush +.Op Fl v +.Op Fl d Ar domainname +.Op Fl h Ar hostname +.\" .Op Fl p Ar paralleljobs +.\" .Op Fl t Ar timeout +.Ar mapname +.Sh DESCRIPTION +The +.Nm YP +subsystem allows network management of passwd, group, and +hosts file entries through the functions +.Xr getpwent 3 , +.Xr getgrent 3 +and +.Xr gethostbyname 3 . +A number of other databases can be network-managed as well, +and have their respective functions. +.Nm YP +also provides hooks for numerous other client programs +such as +.Xr amd 8 +and +.Xr rpc.bootparamd 8 +to access distributed and shareable versions +of their maps through +.Nm YP . +The YP subsystem requires that +.Xr portmap 8 +be running, since the entire subsystem uses the RPC subsystem. +.Pp +.Nm ypinit +is used to initialize +.Nm YP +as a master or a slave. +This creates various files in +.Pa /var/yp . +After running +.Nm ypinit Fl m , +optionally edit +.Pa /var/yp/DOMAINNAME/Makefile +to change settings, for example to switch from the default +backwards compatible mode to secure mode. +Finally, always run +.Xr make 1 +in +.Pa /var/yp . +See +.Xr Makefile.yp 8 +for details. +.Pp +If set up as a slave, the required databases are automatically copied +from the specified server. +.Pp +The +.Nm YP +client subsystem is started automatically in +.Pa /etc/rc +if the directory +.Pa /var/yp/binding +exists. +The client subsystem can be turned on and off by creating or +deleting that directory. +.Xr ypbind 8 +will create that directory if run by hand. +.Pp +The +.Nm YP +server subsystem is started automatically in +.Pa /etc/rc +if the directory +.Pa /var/yp/DOMAINNAME +exists. +This directory is automatically created by +.Xr ypinit 8 +(which initializes the machine as a +.Nm YP +server). +.Pp +If +.Nm ypbind +cannot find a server, the system behaves the same way as Sun's code +does: it hangs. +.Sh FILES +.Bl -tag -width /var/yp/Makefile.main -compact +.It Pa /var/yp/Makefile.main +Top level YP Makefile +.It Pa /var/yp/Makefile.yp +YP maps Makefile +.El +.Sh SEE ALSO +.Xr domainname 1 , +.Xr ypcat 1 , +.Xr ypmatch 1 , +.Xr ypwhich 1 , +.Xr yp_bind 3 , +.Xr defaultdomain 5 , +.Xr group 5 , +.Xr passwd 5 , +.Xr resolv.conf 5 , +.Xr Makefile.yp 8 , +.Xr portmap 8 , +.Xr ypbind 8 , +.Xr ypinit 8 , +.Xr yppoll 8 , +.Xr yppush 8 , +.Xr ypserv 8 , +.Xr ypset 8 , +.Xr ypxfr 8 +.Sh HISTORY +This free +.Nm YP +subsystem is thought to be compatible with Sun's implementation. +It is, of course, not compatible with +.Nm NIS+ +or any other +.Dq secure +.Nm YP +subsystem other than the native one. +.Pp +The name +.Nm YP +stands for Yellow Pee. +.Pp +The ypbind, most library components, and userland programs were implemented +by +.An Theo de Raadt Aq Mt deraadt@theos.com . +The current +.Xr getpwent 3 +implementation was done by +.An Jason Downs Aq Mt downsj@downsj.com . +The server component was implemented by +.An Mats O Jansson Aq Mt moj@stacken.kth.se . |
