diff options
Diffstat (limited to 'static/netbsd/man5')
66 files changed, 15839 insertions, 0 deletions
diff --git a/static/netbsd/man5/Makefile b/static/netbsd/man5/Makefile new file mode 100644 index 00000000..d0df20aa --- /dev/null +++ b/static/netbsd/man5/Makefile @@ -0,0 +1,4 @@ +MAN = $(wildcard *.5) + +include ../../mandoc.mk + diff --git a/static/netbsd/man5/a.out.5 b/static/netbsd/man5/a.out.5 new file mode 100644 index 00000000..13706b84 --- /dev/null +++ b/static/netbsd/man5/a.out.5 @@ -0,0 +1,452 @@ +.\" $NetBSD: a.out.5,v 1.20 2010/03/22 18:58:32 joerg Exp $ +.\" +.\" Copyright (c) 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" This man page is derived from documentation contributed to Berkeley by +.\" Donn Seeley at UUNET Technologies, Inc. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)a.out.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd June 5, 1993 +.Dt A.OUT 5 +.Os +.Sh NAME +.Nm a.out +.Nd format of executable binary files +.Sh SYNOPSIS +.In sys/types.h +.In a.out.h +.Sh DESCRIPTION +The include file +.In a.out.h +declares three structures and several macros. +The structures describe the format of +executable machine code files +.Pq Sq binaries +on the system. +.Pp +A binary file consists of up to 7 sections. +In order, these sections are: +.Bl -tag -width "text relocations" +.It exec header +Contains parameters used by the kernel +to load a binary file into memory and execute it, +and by the link editor +.Xr ld 1 +to combine a binary file with other binary files. +This section is the only mandatory one. +.It text segment +Contains machine code and related data +that are loaded into memory when a program executes. +May be loaded read-only. +.It data segment +Contains initialized data; always loaded into writable memory. +.It text relocations +Contains records used by the link editor +to update pointers in the text segment when combining binary files. +.It data relocations +Like the text relocation section, but for data segment pointers. +.It symbol table +Contains records used by the link editor +to cross reference the addresses of named variables and functions +.Pq Sq symbols +between binary files. +.It string table +Contains the character strings corresponding to the symbol names. +.El +.Pp +Every binary file begins with an +.Fa exec +structure: +.Bd -literal -offset indent +struct exec { + unsigned long a_midmag; + unsigned long a_text; + unsigned long a_data; + unsigned long a_bss; + unsigned long a_syms; + unsigned long a_entry; + unsigned long a_trsize; + unsigned long a_drsize; +}; +.Ed +.Pp +The fields have the following functions: +.Bl -tag -width a_trsize +.It Fa a_midmag +This field is stored in network byte-order so that binaries for +machines with alternative byte orders can be distinguished. +It has a number of sub-components accessed by the macros +.Dv N_GETFLAG() , +.Dv N_GETMID() , and +.Dv N_GETMAGIC() , +and set by the macro +.Dv N_SETMAGIC() . +.Pp +The macro +.Dv N_GETFLAG() +returns a few flags: +.Bl -tag -width EX_DYNAMIC +.It Dv EX_DYNAMIC +indicates that the executable requires the services of the run-time link editor. +.It Dv EX_PIC +indicates that the object contains position independent code. This flag is +set by +.Xr as 1 +when given the +.Sq -k +flag and is preserved by +.Xr ld 1 +if necessary. +.El +.Pp +If both EX_DYNAMIC and EX_PIC are set, the object file is a position independent +executable image (e.g. a shared library), which is to be loaded into the +process address space by the run-time link editor. +.Pp +The macro +.Dv N_GETMID() +returns the machine-id. +This indicates which machine(s) the binary is intended to run on. +.Pp +.Dv N_GETMAGIC() +specifies the magic number, which uniquely identifies binary files +and distinguishes different loading conventions. +The field must contain one of the following values: +.Bl -tag -width ZMAGIC +.It Dv OMAGIC +The text and data segments immediately follow the header +and are contiguous. +The kernel loads both text and data segments into writable memory. +.It Dv NMAGIC +As with +.Dv OMAGIC , +text and data segments immediately follow the header and are contiguous. +However, the kernel loads the text into read-only memory +and loads the data into writable memory at the next +page boundary after the text. +.It Dv ZMAGIC +The kernel loads individual pages on demand from the binary. +The header, text segment and data segment are all +padded by the link editor to a multiple of the page size. +Pages that the kernel loads from the text segment are read-only, +while pages from the data segment are writable. +.El +.It Fa a_text +Contains the size of the text segment in bytes. +.It Fa a_data +Contains the size of the data segment in bytes. +.It Fa a_bss +Contains the number of bytes in the +.Sq bss segment +and is used by the kernel to set the initial break +.Pq Xr brk 2 +after the data segment. +The kernel loads the program so that this amount of writable memory +appears to follow the data segment and initially reads as zeroes. +.It Fa a_syms +Contains the size in bytes of the symbol table section. +.It Fa a_entry +Contains the address in memory of the entry point +of the program after the kernel has loaded it; +the kernel starts the execution of the program +from the machine instruction at this address. +.It Fa a_trsize +Contains the size in bytes of the text relocation table. +.It Fa a_drsize +Contains the size in bytes of the data relocation table. +.El +.Pp +The +.Pa a.out.h +include file defines several macros which use an +.Fa exec +structure to test consistency or to locate section offsets in the binary file. +.Bl -tag -width N_BADMAG(exec) +.It Fn N_BADMAG exec +Nonzero if the +.Fa a_magic +field does not contain a recognized value. +.It Fn N_TXTOFF exec +The byte offset in the binary file of the beginning of the text segment. +.It Fn N_SYMOFF exec +The byte offset of the beginning of the symbol table. +.It Fn N_STROFF exec +The byte offset of the beginning of the string table. +.El +.Pp +Relocation records have a standard format which +is described by the +.Fa relocation_info +structure: +.Bd -literal -offset indent +struct relocation_info { + int r_address; + unsigned int r_symbolnum : 24, + r_pcrel : 1, + r_length : 2, + r_extern : 1, + r_baserel : 1, + r_jmptable : 1, + r_relative : 1, + r_copy : 1; +}; +.Ed +.Pp +The +.Fa relocation_info +fields are used as follows: +.Bl -tag -width r_symbolnum +.It Fa r_address +Contains the byte offset of a pointer that needs to be link-edited. +Text relocation offsets are reckoned from the start of the text segment, +and data relocation offsets from the start of the data segment. +The link editor adds the value that is already stored at this offset +into the new value that it computes using this relocation record. +.It Fa r_symbolnum +Contains the ordinal number of a symbol structure +in the symbol table (it is +.Em not +a byte offset). +After the link editor resolves the absolute address for this symbol, +it adds that address to the pointer that is undergoing relocation. +(If the +.Fa r_extern +bit is clear, the situation is different; see below.) +.It Fa r_pcrel +If this is set, +the link editor assumes that it is updating a pointer +that is part of a machine code instruction using pc-relative addressing. +The address of the relocated pointer is implicitly added +to its value when the running program uses it. +.It Fa r_length +Contains the log base 2 of the length of the pointer in bytes; +0 for 1-byte displacements, 1 for 2-byte displacements, +2 for 4-byte displacements. +.It Fa r_extern +Set if this relocation requires an external reference; +the link editor must use a symbol address to update the pointer. +When the +.Fa r_extern +bit is clear, the relocation is +.Sq local ; +the link editor updates the pointer to reflect +changes in the load addresses of the various segments, +rather than changes in the value of a symbol (except when +.Fa r_baserel +is also set, see below). +In this case, the content of the +.Fa r_symbolnum +field is an +.Fa n_type +value (see below); +this type field tells the link editor +what segment the relocated pointer points into. +.It Fa r_baserel +If set, the symbol, as identified by the +.Fa r_symbolnum +field, is to be relocated to an offset into the Global Offset Table. +At run-time, the entry in the Global Offset Table at this offset is set to +be the address of the symbol. +.It Fa r_jmptable +If set, the symbol, as identified by the +.Fa r_symbolnum +field, is to be relocated to an offset into the Procedure Linkage Table. +.It Fa r_relative +If set, this relocation is relative to the (run-time) load address of the +image this object file is going to be a part of. This type of relocation +only occurs in shared objects. +.It Fa r_copy +If set, this relocation record identifies a symbol whose contents should +be copied to the location given in +.Fa r_address . +The copying is done by the run-time link-editor from a suitable data +item in a shared object. +.El +.Pp +Symbols map names to addresses (or more generally, strings to values). +Since the link-editor adjusts addresses, +a symbol's name must be used to stand for its address +until an absolute value has been assigned. +Symbols consist of a fixed-length record in the symbol table +and a variable-length name in the string table. +The symbol table is an array of +.Fa nlist +structures: +.Bd -literal -offset indent +struct nlist { + union { + char *n_name; + long n_strx; + } n_un; + unsigned char n_type; + char n_other; + short n_desc; + unsigned long n_value; +}; +.Ed +.Pp +The fields are used as follows: +.Bl -tag -width n_un.n_strx +.It Fa n_un.n_strx +Contains a byte offset into the string table +for the name of this symbol. +When a program accesses a symbol table with the +.Xr nlist 3 +function, +this field is replaced with the +.Fa n_un.n_name +field, which is a pointer to the string in memory. +.It Fa n_type +Used by the link editor to determine +how to update the symbol's value. +The +.Fa n_type +field is broken down into three sub-fields using bitmasks. +The link editor treats symbols with the +.Dv N_EXT +type bit set as +.Sq external +symbols and permits references to them from other binary files. +The +.Dv N_TYPE +mask selects bits of interest to the link editor: +.Bl -tag -width N_TEXT +.It Dv N_UNDF +An undefined symbol. +The link editor must locate an external symbol with the same name +in another binary file to determine the absolute value of this symbol. +As a special case, if the +.Fa n_value +field is nonzero and no binary file in the link-edit defines this symbol, +the link-editor will resolve this symbol to an address +in the bss segment, +reserving an amount of bytes equal to +.Fa n_value . +If this symbol is undefined in more than one binary file +and the binary files do not agree on the size, +the link editor chooses the greatest size found across all binaries. +.It Dv N_ABS +An absolute symbol. +The link editor does not update an absolute symbol. +.It Dv N_TEXT +A text symbol. +This symbol's value is a text address and +the link editor will update it when it merges binary files. +.It Dv N_DATA +A data symbol; similar to +.Dv N_TEXT +but for data addresses. +The values for text and data symbols are not file offsets but +addresses; to recover the file offsets, it is necessary +to identify the loaded address of the beginning of the corresponding +section and subtract it, then add the offset of the section. +.It Dv N_BSS +A bss symbol; like text or data symbols but +has no corresponding offset in the binary file. +.It Dv N_FN +A filename symbol. +The link editor inserts this symbol before +the other symbols from a binary file when +merging binary files. +The name of the symbol is the filename given to the link editor, +and its value is the first text address from that binary file. +Filename symbols are not needed for link-editing or loading, +but are useful for debuggers. +.El +.Pp +The +.Dv N_STAB +mask selects bits of interest to symbolic debuggers +such as +.Xr gdb 1 ; +the values are described in +.Xr stab 5 . +.It Fa n_other +This field provides information on the nature of the symbol independent of +the symbol's location in terms of segments as determined by the +.Fa n_type +field. Currently, the lower 4 bits of the +.Fa n_other +field hold one of two values: +.Dv AUX_FUNC +and +.Dv AUX_OBJECT +.Po +see +.In link.h +for their definitions +.Pc . +.Dv AUX_FUNC +associates the symbol with a callable function, while +.Dv AUX_OBJECT +associates the symbol with data, irrespective of their locations in +either the text or the data segment. +This field is intended to be used by +.Xr ld 1 +for the construction of dynamic executables. +.It Fa n_desc +Reserved for use by debuggers; passed untouched by the link editor. +Different debuggers use this field for different purposes. +.It Fa n_value +Contains the value of the symbol. +For text, data and bss symbols, this is an address; +for other symbols (such as debugger symbols), +the value may be arbitrary. +.El +.Pp +The string table consists of an +.Em unsigned long +length followed by null-terminated symbol strings. +The length represents the size of the entire table in bytes, +so its minimum value (or the offset of the first string) +is always 4 on 32-bit machines. +.Sh SEE ALSO +.Xr as 1 , +.Xr gdb 1 , +.Xr ld 1 , +.Xr brk 2 , +.Xr execve 2 , +.Xr nlist 3 , +.Xr core 5 , +.Xr elf 5 , +.Xr link 5 , +.Xr stab 5 +.Sh HISTORY +The +.Pa a.out.h +include file appeared in +.At v7 . +.Sh BUGS +Nobody seems to agree on what +.Em bss +stands for. +.Pp +New binary file formats may be supported in the future, +and they probably will not be compatible at any level +with this ancient format. diff --git a/static/netbsd/man5/acct.5 b/static/netbsd/man5/acct.5 new file mode 100644 index 00000000..1811947d --- /dev/null +++ b/static/netbsd/man5/acct.5 @@ -0,0 +1,137 @@ +.\" $NetBSD: acct.5,v 1.12 2024/08/05 13:04:14 christos Exp $ +.\" +.\" Copyright (c) 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. +.\" +.\" @(#)acct.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd August 5, 2024 +.Dt ACCT 5 +.Os +.Sh NAME +.Nm acct +.Nd execution accounting file +.Sh SYNOPSIS +.In sys/acct.h +.Sh DESCRIPTION +The kernel maintains the following +.Fa acct +information structure for all +processes. If a process terminates, and accounting is enabled, +the kernel calls the +.Xr acct_process 9 +function call to prepare and append the record +to the accounting file. +.Bd -literal +/* + * Accounting structures; these use a comp_t type which is a 3 bits base 8 + * exponent, 13 bit fraction ``floating point'' number. Units are 1/AHZ + * seconds. + */ +typedef uint16_t comp_t; + +struct acct { + char ac_comm[16]; /* name of command */ + comp_t ac_utime; /* user time */ + comp_t ac_stime; /* system time */ + comp_t ac_etime; /* elapsed time */ + time_t ac_btime; /* starting time */ + uid_t ac_uid; /* user id */ + gid_t ac_gid; /* group id */ + uint16_t ac_mem; /* memory usage average */ + comp_t ac_io; /* count of IO blocks */ + dev_t ac_tty; /* controlling tty */ +#define AFORK 0x01 /* fork'd but not exec'd */ +#define ASU 0x02 /* used super-user permissions */ +#define ACOMPAT 0x04 /* used compatibility mode */ +#define ACORE 0x08 /* dumped core */ +#define AXSIG 0x10 /* killed by a signal */ + uint8_t ac_flag; /* accounting flags */ +}; + +/* + * 1/AHZ is the granularity of the data encoded in the comp_t fields. + * This is not necessarily equal to hz. + */ +#define AHZ 64 + +#ifdef _KERNEL +void acct_init(void); +int acct_process(struct lwp *); +endif +.Ed +.Pp +If a terminated process was created by an +.Xr execve 2 , +the name of the executed file (at most ten characters of it) +is saved in the field +.Fa ac_comm +and its status is saved by setting one of more of the following flags in +.Fa ac_flag : +.Dv AFORK , +.Dv ACORE , +and +.Dv AXSIG . +.Pp +The +.Dv ASU +flag is not recorded anymore because with the switch to +.Xr kauth 9 , +the superuser model is optional and passing the affected process to every +authorization call in order to record +.Dv ASU +in +.Fa p_acflag , +would require many source changes and would not reflect reality because +the authorization decision might not have been done based on the +.Xr secmodel_suser 9 +model. +.Pp +The +.Dv ACOMPAT +flag was never recorded in +.Nx ; +we could consider setting when the a process is running under emulation, +but this is not currently done. +.Pp +Both the +.Dv ASU +and the +.Dv ACOMPAT +flags are retained for source compatibility. +.Sh SEE ALSO +.Xr lastcomm 1 , +.Xr acct 2 , +.Xr execve 2 , +.Xr accton 8 , +.Xr sa 8 , +.Xr acct_process 9 +.Sh HISTORY +A +.Nm +file format appeared in +.At v7 . diff --git a/static/netbsd/man5/ar.5 b/static/netbsd/man5/ar.5 new file mode 100644 index 00000000..4b58dc01 --- /dev/null +++ b/static/netbsd/man5/ar.5 @@ -0,0 +1,160 @@ +.\" $NetBSD: ar.5,v 1.9 2017/07/03 21:30:59 wiz Exp $ +.\" +.\" Copyright (c) 1990, 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. +.\" +.\" @(#)ar.5.5 8.2 (Berkeley) 6/1/94 +.\" +.Dd June 1, 1994 +.Dt AR 5 +.Os +.Sh NAME +.Nm ar +.Nd a.out archive (library) file format +.Sh SYNOPSIS +.In ar.h +.Sh DESCRIPTION +The archive command +.Nm +combines several files into one. +Archives are mainly used as libraries of object files intended to be +loaded using the link-editor +.Xr ld 1 . +.Pp +A file created with +.Nm +begins with the +.Dq magic +string +.Dq Li "!<arch>\en" . +The rest of the archive is made up of objects, each of which is composed +of a header for a file, a possible file name, and the file contents. +The header is portable between machine architectures, and, if the file +contents are printable, the archive is itself printable. +.Pp +The header is made up of six variable length +.Tn ASCII +fields, followed by a +two character trailer. +The fields are the object name (16 characters), the file last modification +time (12 characters), the user and group id's (each 6 characters), the file +mode (8 characters) and the file size (10 characters). +All numeric fields are in decimal, except for the file mode which is in +octal. +.Pp +The modification time is the file +.Fa st_mtime +field, i.e., +.Dv CUT +seconds since +the epoch. +The user and group id's are the file +.Fa st_uid +and +.Fa st_gid +fields. +The file mode is the file +.Fa st_mode +field. +The file size is the file +.Fa st_size +field. +The two-byte trailer is the string "\`\en". +.Pp +Only the name field has any provision for overflow. +If any file name is more than 16 characters in length or contains an +embedded space, the string "#1/" followed by the +.Tn ASCII +length of the +name is written in the name field. +The file size (stored in the archive header) is incremented by the length +of the name. +The name is then written immediately following the archive header. +.Pp +Any unused characters in any of these fields are written as space +characters. +If any fields are their particular maximum number of characters in +length, there will be no separation between the fields. +.Pp +Objects in the archive are always an even number of bytes long; files +which are an odd number of bytes long are padded with a newline +.Pq Dq \en +character, although the size in the header does not reflect this. +.Sh COMPATIBILITY +The current a.out archive format is not specified by any standard. +.Pp +ELF systems use the +.Nm +format specified by the +.At V.4 +ABI, with the same headers but different long file name handling. +.Sh SEE ALSO +.Xr ar 1 , +.Xr stat 2 +.Sh HISTORY +There have been at least four +.Nm +formats. +The first was denoted by the leading +.Dq magic +number 0177555 (stored as type int). +These archives were almost certainly created on a 16-bit machine, and +contain headers made up of five fields. +The fields are the object name (8 characters), the file last modification +time (type long), the user id (type char), the file mode (type char) and +the file size (type unsigned int). +Files were padded to an even number of bytes. +.Pp +The second was denoted by the leading +.Dq magic +number 0177545 (stored as type int). +These archives may have been created on either 16 or 32-bit machines, and +contain headers made up of six fields. +The fields are the object name (14 characters), the file last modification +time (type long), the user and group id's (each type char), the file mode +(type int), and the file size (type long). +Files were padded to an even number of bytes. +.Pp +Both of these historical formats may be read with +.Xr ar 1 . +.Pp +The current archive format (without support for long character names and +names with embedded spaces) was introduced in +.Bx 4.0 . +The headers were the same as the current format, with the exception that +names longer than 16 characters were truncated, and names with embedded +spaces (and often trailing spaces) were not supported. +It has been extended for these reasons, +as described above. +This format first appeared in +.Bx 4.4 . +.Sh BUGS +The +.Tn <ar.h> +header file, and the +.Nm +manual page, do not currently describe the ELF archive format. diff --git a/static/netbsd/man5/autofs.5 b/static/netbsd/man5/autofs.5 new file mode 100644 index 00000000..9be7acbd --- /dev/null +++ b/static/netbsd/man5/autofs.5 @@ -0,0 +1,125 @@ +.\" $NetBSD: autofs.5,v 1.5 2019/11/21 15:24:17 tkusumi Exp $ +.\" +.\" Copyright (c) 2017 The NetBSD Foundation, Inc. +.\" Copyright (c) 2016 The DragonFly Project +.\" Copyright (c) 2014 The FreeBSD Foundation +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Tomohiro Kusumi. +.\" +.\" This software was developed by Edward Tomasz Napierala under sponsorship +.\" from the FreeBSD Foundation. +.\" +.\" 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 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 AUTHORS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd November 25, 2017 +.Dt AUTOFS 5 +.Os +.Sh NAME +.Nm autofs +.Nd "automounter filesystem" +.Sh SYNOPSIS +.\"To compile this driver into the kernel, +.\"place the following line in the +.\"kernel configuration file: +.\".Bd -ragged -offset indent +.Cd "options AUTOFS" +.\".Ed +.\".Pp +.\"Alternatively, to load the driver as a +.\"module at boot time, place the following line in +.\".Xr loader.conf 5 : +.\".Bd -literal -offset indent +.\"autofs_load="YES" +.\".Ed +.Sh DESCRIPTION +The +.Nm +driver is the kernel component of the automounter infrastructure. +Its job is to pass mount requests to the +.Xr automountd 8 +daemon, and pause the processes trying to access the automounted filesystem +until the mount is completed. +It is mounted by the +.Xr automount 8 . +.Sh OPTIONS +These options are available when +mounting +.Nm +file systems: +.Bl -tag -width indent +.It Cm master_options +Mount options for all filesystems specified in the map entry. +.It Cm master_prefix +Filesystem mountpoint prefix. +.El +.Sh EXAMPLES +To unmount all mounted +.Nm +filesystems: +.Pp +.Dl "umount -At autofs" +.Pp +To mount +.Nm +filesystems specified in +.Xr auto_master 5 : +.Pp +.Dl "automount" +.Sh SEE ALSO +.Xr auto_master 5 , +.Xr automount 8 , +.Xr automountd 8 , +.Xr autounmountd 8 , +.Xr mount_autofs 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 10.1 . +The +.Nm +driver first appeared in +.Dx 4.5 . +The +.Nm +driver first appeared in +.Nx 9.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +was developed by +.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org +under sponsorship from the FreeBSD Foundation. +.Pp +The +.Nm +was ported to +.Dx +and +.Nx +by +.An Tomohiro Kusumi Aq Mt tkusumi@netbsd.org . diff --git a/static/netbsd/man5/boot.cfg.5 b/static/netbsd/man5/boot.cfg.5 new file mode 100644 index 00000000..e768cbe6 --- /dev/null +++ b/static/netbsd/man5/boot.cfg.5 @@ -0,0 +1,255 @@ +.\" $NetBSD: boot.cfg.5,v 1.32 2022/04/15 16:30:09 fcambus Exp $ +.\" +.\" Copyright (c) 2007 Stephen Borrill +.\" 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 November 24, 2020 +.Dt BOOT.CFG 5 +.Os +.Sh NAME +.Nm boot.cfg +.Nd configuration file for /boot +.Sh DESCRIPTION +The file +.Pa /boot.cfg +is used to alter the behaviour of the standard boot loader described in +.Xr boot 8 . +Configuration changes include setting the timeout, choosing a console device, +altering the banner text and displaying a menu allowing boot commands to be +easily chosen. +If a +.Nm +file is not present, the system will boot as normal. +.Ss FILE FORMAT +The format of the file is a series of lines containing keyword/value pairs +separated by an equals sign +.Pq Sq = . +There should be no whitespace surrounding the equals sign. +Lines beginning with a hash +.Pq Sq # +are comments and will be ignored. +.Pp +The +.Dq Ic banner , +.Dq Ic load , +.Dq Ic menu , +and +.Dq Ic userconf +keywords can be present multiple times in the file to define additional +items. +See the description for each keyword for guidance and limitations on +using multiple entries. +.Bl -tag -width timeout +.It Sy banner +The text from banner lines is displayed instead of the standard welcome text +by the boot loader. +Up to 12 lines can be defined. +No special character sequences are recognised, so to specify a blank line, a +banner line with no value should be given. +.It Sy clear +If nonzero, clear the screen before printing the banner. +If zero, do not clear the screen (the default). +.It Sy consdev +Changes the console device to that specified in the value. +Valid values are any of those that could be specified at the normal boot +prompt with the consdev command. +.It Sy default +Used to specify the default menu item which will be chosen in the case of +Return being pressed or the timeout timer reaching zero. +The value is the number of the menu item as displayed. +As described above, the menu items are counted from 1 in the order listed in +.Nm . +If not specified, the default value will be option 1, i.e. the first item. +.It Sy format +Changes how the menu options are displayed. +Should be set to one of +.Sq a +for automatic, +.Sq l +for letters and +.Sq n +for numbers. +If set to automatic (the default), menu options will be displayed numerically +unless there are more than 9 options and the timeout is greater than zero. +If there are more than 9 options with a timeout greater than zero and +the format is set to number, only the first 9 options will be available. +.It Sy load +Used to load kernel modules, which will be passed on to the kernel for +initialization during early boot. +The argument is either the complete path and file name of the module to be +loaded, or a symbolic module name. +When the argument is not an absolute path, the boot loader will first +attempt to load +.Pa /stand/<machine>/<kernel_version>/modules/<name>/<name>.kmod . +If that file does not exist, it will then attempt to load +.Pa /<name> . +May be used as many times as needed. +.It Sy menu +Used to define a menu item to be displayed to the end-user at boot time +which allows a series of boot commands to be run without further typing. +The value consists of the required menu text, followed by a colon +.Pq Sq \&: +and then the desired command(s). +Multiple commands can be specified separated by a semi-colon. +If the specified menu text is empty +(the colon appears immediately after the equals sign), +then the displayed menu text is the same as the command. +For example: +.Bd -literal +menu=Boot normally:boot +menu=Boot single-user:boot -s +menu=Boot with module foo:load /foo.kmod;boot +menu=Boot with serial console:consdev com0;boot +menu=:boot hd1a:netbsd -as +.Ed +.Pp +Each menu item will be prefixed by an ascending number when displayed, +i.e. the order in the +.Nm +file is important. +.Pp +Each command is executed just as though the user had typed it in +and so can be any valid command that would be accepted at the +normal boot prompt. +In addition, +.Dq Ic prompt +can be used to drop to the normal boot prompt. +.It Sy rndseed +Takes the path to a random-seed file as written by the +.Fl S +flag to +.Xr rndctl 8 +as an argument. +This file is used to seed the kernel entropy pool +.Xr rnd 9 +very early in kernel startup, so that high quality randomness is +available to all kernel modules. +This argument should be supplied +before any +.Dq Ic load +commands that may load executable modules. +.It Sy timeout +If the value is greater than zero, this specifies the time in seconds +that the boot loader will wait for the end-user to choose a menu item. +During the countdown period, they may press Return to choose the default +option or press a number key corresponding to a menu option. +If any other key is pressed, the countdown will stop and the user will be +prompted to choose a menu option with no further time limit. +If the timeout value is set to zero, the default option will be booted +immediately. +If the timeout value is negative or is not a number, there will be no +time limit for the user to choose an option. +.It Sy userconf +Passes a +.Xr userconf 4 +command to the kernel at boot time. +May be used as many times as needed. +.El +.Sh EXAMPLES +Here is an example +.Nm +file: +.Bd -literal -offset indent +banner=Welcome to NetBSD +banner================== +banner= +banner=Please choose an option from the following menu: +menu=Boot normally:boot +menu=Boot single-user:boot -s +menu=Boot from second disk:boot hd1a: +menu=Boot with module foo:load /foo.kmod;boot +menu=Boot with modules foo and bar:load /foo.kmod;load /bar.kmod;boot +menu=Boot Xen with 256MB for dom0:load /netbsd-XEN3_DOM0 console=pc;multiboot /usr/pkg/xen3-kernel/xen.gz dom0_mem=256M +menu=Boot Xen with 256MB for dom0 (serial):load /netbsd-XEN3_DOM0 console=com0;multiboot /usr/pkg/xen3-kernel/xen.gz dom0_mem=256M console=com1 com1=115200,8n1 +menu=Boot Xen with dom0 in single-user mode:load /netbsd-XEN3_DOM0 -s;multiboot /usr/pkg/xen3-kernel/xen.gz dom0_mem=256M +menu=Go to command line (advanced users only):prompt +clear=1 +timeout=-1 +default=1 +# Disable Direct Rendering Manager (DRM) drivers +userconf=disable i915drmkms* +userconf=disable nouveau* +userconf=disable radeon* +# Always load ramdisk module +load=/miniroot.kmod +.Ed +.Pp +N.B. Xen counts serial ports from com1 upwards, but +.Nx +counts from com0, so the appropriate device name must be used. +Please see the Xen with serial console example above. +.Pp +This will clear the screen and display: +.Bd -literal -offset indent +Welcome to NetBSD +================= + +Please choose an option from the following menu: + + 1. Boot normally + 2. Boot single-user + 3. Boot from second disk + 4. Boot with module foo + 5. Boot with modules foo and bar + 6. Boot Xen with 256 MB for dom0 + 7. Boot Xen with 256 MB for dom0 (serial) + 8. Boot Xen with dom0 in single-user mode + 9. Go to command line (advanced users only) + +Option [1]: +.Ed +.Pp +It will then wait for the user to type 1, 2, 3, 4, 5, 6, 7, 8 or 9 followed by +Return. +Pressing Return by itself will run option 1. +There will be no timeout. +.Sh SEE ALSO +.Xr boot 8 , +.Xr boothowto 9 +.Sh HISTORY +The +.Nm +file appeared in +.Nx 5.0 . +.Sh AUTHORS +The +.Nm +extensions to +.Xr boot 8 +were written by +.An Stephen Borrill +.Aq sborrill@NetBSD.org . +.Sh BUGS +Support for +.Nm +is currently for +.Nx Ns /i386 +and +.Nx Ns /amd64 +only. +It is hoped that its use will be extended to other appropriate ports that +use the +.Xr boot 8 +interface. diff --git a/static/netbsd/man5/capfile.5 b/static/netbsd/man5/capfile.5 new file mode 100644 index 00000000..f9778d6c --- /dev/null +++ b/static/netbsd/man5/capfile.5 @@ -0,0 +1,191 @@ +.\" $NetBSD: capfile.5,v 1.5 2020/08/23 20:23:56 tpaul Exp $ +.\" +.\" Copyright (c) 2012 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Roy Marples. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 March 27, 2012 +.Dt CAPFILE 5 +.Os +.Sh NAME +.Nm capfile +.Nd capability database files +.Sh DESCRIPTION +.Nm +describes the format of capability database files, +made popular by +.Nm termcap . +.Nm termcap +itself has been superseded by +.Xr terminfo 5 , +which contains equivalent +.Nm termcap +capabilities, +and this page exists solely to document the +.Nm termcap +format as it is still used by other programs such as +.Xr rtadvd.conf 5 . +.Pp +Entries in +.Nm +consist of a number of `:'-separated fields. +The first entry for each record gives the names that are known for the +record, separated by `|' characters. +By convention, the last name is usually a comment and is not intended as a +lookup tag. +The entry must be terminated by the `:' character. +.Ss A Sample Entry +The following entry describes the Teletype model 33. +.Pp +.Bd -literal +T3\||\|tty33\||\|33\||\|tty\||\|Teletype model 33:\e + :bl=^G:co#72:.cr=9^M:cr=^M:do=^J:hc:os:am@: +.Ed +.Pp +Entries may continue onto multiple lines by giving a \e as the last +character of a line, and empty fields +may be included for readability (here between the last field on a line +and the first field on the next). +Comments may be included on lines beginning with +.Dq # . +.Ss Types of Capabilities +Capabilities in +.Nm +are of three types: Boolean capabilities, +numeric capabilities, +and string capabilities. +.Pp +Boolean capabilities are just the name, to indicate the ability is present. +.Pp +Numeric capabilities are followed by the character `#' then the value. +In the example above +.Sy \&co +gives the value `72'. +.Pp +String capabilities are followed by the character `=' and then the string. +In the example above +.Sy \&bl +gives the value `^G'. +.Pp +Sometimes individual capabilities must be commented out. +To do this, put a period (`.') before the capability name. +For example, see the first +.Sy \&cr +in the example above. +.Pp +Sometimes individual capabilities must be marked as absent. +To do this, put a @ after the capability name. +For example, see the last +.Sy \&am +in the example above. +This is only useful when merging entries. +See the tc=name discussion below for more details. +.Ss Encoding +Numeric capability values may be given in one of three numeric bases. +If the number starts with either +.Ql 0x +or +.Ql 0X +it is interpreted as a hexadecimal number (both upper and lower case a-f +may be used to denote the extended hexadecimal digits). +Otherwise, if the number starts with a +.Ql 0 +it is interpreted as an octal number. +Otherwise the number is interpreted as a decimal number. +.Pp +String capability values may contain any character. +Non-printable +.Dv ASCII +codes, new lines, and colons may be conveniently represented by the use +of escape sequences: +.Bl -column "\eX,X\eX" "(ASCII octal nnn)" +.It ^X ('\fIX\fP' & 037) control-\fIX\fP +.It \eb, \eB (ASCII 010) backspace +.It \et, \eT (ASCII 011) tab +.It \en, \eN (ASCII 012) line feed (newline) +.It \ef, \eF (ASCII 014) form feed +.It \er, \eR (ASCII 015) carriage return +.It \ee, \eE (ASCII 027) escape +.It \ec, \eC (:) colon +.It \e\e (\e\|) back slash +.It \e^ (^) caret +.It \e\fInnn\fP (ASCII octal \fInnn\fP) +.El +.Pp +A +.Sq \e +followed by up to three octal digits directly specifies +the numeric code for a character. +The use of +.Tn ASCII +.Dv NUL Ns s , +while easily +encoded, causes all sorts of problems and must be used with care since +.Dv NUL Ns s +are typically used to denote the end of strings; many applications +use +.Sq \e200 +to represent a +.Dv NUL . +.Pp +A special capability, +.Qq tc=name , +is used to indicate that the record specified by +.Fa name +should be substituted for the +.Qq tc +capability. +.Qq tc +capabilities may interpolate records which also contain +.Qq tc +capabilities and more than one +.Qq tc +capability may be used in a record. +A +.Qq tc +expansion scope (i.e. where the argument is searched for) contains the +file in which the +.Qq tc +is declared and all subsequent files in the file array. +.Sh SEE ALSO +.Xr cgetcap 3 , +.Xr termcap 3 , +.Xr terminfo 5 +.Sh HISTORY +.Nm termcap +described the capabilities of terminals, used by programs such as +.Xr vi 1 +and +.Xr hack 6 . +These programs still use +.Nm termcap +today, but their capability requests are mapped onto +.Xr terminfo 5 +ones instead. +As such, the termcap database file is no longer shipped with +.Nx . +.Sh AUTHORS +.An Roy Marples Aq Mt roy@NetBSD.org diff --git a/static/netbsd/man5/changelist.5 b/static/netbsd/man5/changelist.5 new file mode 100644 index 00000000..042fa3bf --- /dev/null +++ b/static/netbsd/man5/changelist.5 @@ -0,0 +1,52 @@ +.\" $NetBSD: changelist.5,v 1.1 2020/07/13 09:10:35 jruoho Exp $ +.\" +.\" Copyright (c) 2020 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Jukka Ruohonen. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 July 13, 2020 +.Dt CHANGELIST 5 +.Os +.Sh NAME +.Nm changelist +.Nd local files processed by maintenance scripts +.Sh DESCRIPTION +The +.Pa /etc/changelist +file contains locally added files that are processed by the +.Pa /etc/security +script as a part of the +.Xr daily 5 +routines. +.Sh FILES +.Bl -tag -width /etc/pkgpath.conf -compact +.It Pa /etc/changelist +local files processed by maintenance scripts +.El +.Sh SEE ALSO +.Xr daily 5 , +.Xr security.conf 5 , +.Xr cron 8 diff --git a/static/netbsd/man5/core.5 b/static/netbsd/man5/core.5 new file mode 100644 index 00000000..adce3e19 --- /dev/null +++ b/static/netbsd/man5/core.5 @@ -0,0 +1,416 @@ +.\" $NetBSD: core.5,v 1.33 2019/12/06 18:03:49 kamil Exp $ +.\" +.\" Copyright (c) 2002 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Jason R. Thorpe. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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. +.\" +.\" 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. +.\" +.\" @(#)core.5 8.3 (Berkeley) 12/11/93 +.\" +.Dd December 6, 2019 +.Dt CORE 5 +.Os +.Sh NAME +.Nm core +.Nd memory image file format +.Sh SYNOPSIS +.In sys/param.h +.Pp +For a.out-format core files: +.Pp +.In sys/core.h +.Pp +For ELF-format core files: +.Pp +.In sys/exec.h +.In sys/exec_elf.h +.Sh DESCRIPTION +A small number of signals which cause abnormal termination of a process +also cause a record of the process's in-core state to be written +to disk for later examination by one of the available debuggers +(see +.Xr signal 7 ) . +.Pp +This memory image is written to a file named from a per-process template; +provided the terminated process had write permission, and provided the +abnormality did not cause a system crash. +(In this event, the decision to save the core file is arbitrary, see +.Xr savecore 8 . ) +The file is named from a per-process template, mapped to the sysctl +variable +.Em proc.<pid>.corename +(where <pid> has to be replaced by the pid in decimal format of the +process). +This template is either an absolute or relative path name, in which format +characters can be used, preceded by the percent character +.Pq Dq \&% . +The following characters are recognized as format and substituted: +.Bl -tag -width 4n -offset indent -compact +.It Sy n +The process's name +.It Sy p +The PID of the process (in decimal) +.It Sy t +The process's creation date (a la +.Xr time 3 , +in decimal) +.It Sy u +The login name, as returned by +.Xr getlogin 2 +.El +.Pp +By default, the per-process template string points to the default core name +template, which is mapped to the sysctl variable +.Em kern.defcorename . +Changing this value on a live system will change the core name template for +all processes which didn't have a per-process template set. +The default value of the default core name template is +.Nm %n.core +and can be changed at compile-time with the kernel configuration option +.Cd options DEFCORENAME +(see +.Xr options 4 ) +.Pp +The per-process template string is inherited on process creation, but is reset +to point to the default core name template on execution of a set-id binary. +.Pp +The maximum size of a core file is limited by +.Xr setrlimit 2 . +Files which would be larger than the limit are not created. +.Ss ELF CORE FORMAT +ELF-format core files are described by a standard ELF exec header and +a series of ELF program headers. +Each program header describes a range +of the virtual address space of the process. +.Pp +In addition, +.Nx +ELF core files include an ELF note section which provides additional +information about the process. +The first note in the note section has a note name of +.Dq NetBSD-CORE +and a note type of +.Dv ELF_NOTE_NETBSD_CORE_PROCINFO ( 1 ) , +and contains the following +structure: +.Bd -literal +struct netbsd_elfcore_procinfo { + uint32_t cpi_version; /* netbsd_elfcore_procinfo version */ + uint32_t cpi_cpisize; /* sizeof(netbsd_elfcore_procinfo) */ + uint32_t cpi_signo; /* killing signal */ + uint32_t cpi_sigcode; /* signal code */ + uint32_t cpi_sigpend[4]; /* pending signals */ + uint32_t cpi_sigmask[4]; /* blocked signals */ + uint32_t cpi_sigignore[4]; /* blocked signals */ + uint32_t cpi_sigcatch[4]; /* blocked signals */ + int32_t cpi_pid; /* process ID */ + int32_t cpi_ppid; /* parent process ID */ + int32_t cpi_pgrp; /* process group ID */ + int32_t cpi_sid; /* session ID */ + uint32_t cpi_ruid; /* real user ID */ + uint32_t cpi_euid; /* effective user ID */ + uint32_t cpi_svuid; /* saved user ID */ + uint32_t cpi_rgid; /* real group ID */ + uint32_t cpi_egid; /* effective group ID */ + uint32_t cpi_svgid; /* saved group ID */ + uint32_t cpi_nlwps; /* number of LWPs */ + int8_t cpi_name[32]; /* copy of p->p_comm */ + int32_t cpi_siglwp; /* LWP target of killing signal */ +}; +.Ed +.Pp +The fields of +.Fa struct netbsd_elfcore_procinfo +are as follows: +.Bl -tag -width cpi_sigignoreXX +.It cpi_version +The version of this structure. +The current version is defined by the +.Dv NETBSD_ELFCORE_PROCINFO_VERSION +constant. +.It cpi_cpisize +The size of this structure. +.It cpi_signo +Signal that caused the process to dump core. +.It cpi_sigcode +Signal-specific code, if any, corresponding to +.Va cpi_signo . +.It cpi_sigpend +A mask of signals pending delivery to the process. +This may be examined by copying it to a +.Fa sigset_t . +.It cpi_sigmask +The set of signals currently blocked by the process. +This may be examined by copying it to a +.Fa sigset_t . +.It cpi_sigignore +The set of signals currently being ignored by the process. +This may be examined by copying it to a +.Fa sigset_t . +.It cpi_sigcatch +The set of signals with registers signals handlers for the process. +This may be examined by copying it to a +.Fa sigset_t . +.It cpi_pid +Process ID of the process. +.It cpi_ppid +Process ID of the parent process. +.It cpi_pgrp +Process group ID of the process. +.It cpi_sid +Session ID of the process. +.It cpi_ruid +Real user ID of the process. +.It cpi_euid +Effective user ID of the process. +.It cpi_svuid +Saved user ID of the process. +.It cpi_rgid +Real group ID of the process. +.It cpi_egid +Effective group ID of the process. +.It cpi_svgid +Saved group ID of the process. +.It cpi_nlwps +Number of kernel-visible execution contexts (LWPs) of the process. +.It cpi_name +Process name, copied from the p_comm field of +.Fa struct proc . +.It cpi_siglwp +LWP target of killing signal. +.El +.Pp +The second note with name +.Dq NetBSD-CORE +is a note type of +.Dv ELF_NOTE_NETBSD_CORE_AUXV ( 2 ) , +and contains an array of AuxInfo structures. +.Pp +The note section also contains additional notes for each +kernel-visible execution context of the process (LWP). +These notes have names of the form +.Dq NetBSD-CORE@nn +where +.Dq nn +is the LWP ID of the execution context, for example: +.Dq NetBSD-CORE@1 . +These notes contain register and other per-execution context +data in the same format as is used by the +.Xr ptrace 2 +system call. +The note types correspond to the +.Xr ptrace 2 +request numbers that return the same data. +For example, +a note with a note type of PT_GETREGS would contain a +.Fa struct reg +with the register contents of the execution context. +For a complete list of available +.Xr ptrace 2 +request types for a given architecture, refer to that architecture's +.Aq Pa machine/ptrace.h +header file. +.Ss A.OUT CORE FORMAT +The core file consists of a core header followed by a number of +segments. +Each segment is preceded by a core segment header. +Both the core header and core segment header are defined in +.In sys/core.h . +.Pp +The core header, +.Fa struct core , +specifies the lengths of the core header itself and +each of the following core segment headers to allow for any machine +dependent alignment requirements. +.Bd -literal +struct core { + uint32_t c_midmag; /* magic, id, flags */ + uint16_t c_hdrsize; /* Size of this header (machdep algn) */ + uint16_t c_seghdrsize; /* Size of a segment header */ + uint32_t c_nseg; /* # of core segments */ + char c_name[MAXCOMLEN+1]; /* Copy of p->p_comm */ + uint32_t c_signo; /* Killing signal */ + u_long c_ucode; /* Signal code */ + u_long c_cpusize; /* Size of machine dependent segment */ + u_long c_tsize; /* Size of traditional text segment */ + u_long c_dsize; /* Size of traditional data segment */ + u_long c_ssize; /* Size of traditional stack segment */ +}; +.Ed +.Pp +The fields of +.Fa struct core +are as follows: +.Bl -tag -width XXXc_seghdrsize +.It c_midmag +Core file machine ID, magic value, and flags. +These values may be extracted with the +.Fn CORE_GETMID , +.Fn CORE_GETMAGIC , +and +.Fn CORE_GETFLAG +macros. +The machine ID values are listed in +.In sys/exec_aout.h . +For a valid core file, the magic value in the header must be +.Dv COREMAGIC . +No flags are defined for the core header. +.It c_hdrsize +Size of this data structure. +.It c_seghdrsize +Size of a segment header. +.It c_nseg +Number of segments that follow this header. +.It c_name +Process name, copied from the p_comm field of +.Fa struct proc . +.It c_signo +Signal that caused the process to dump core. +.It c_ucode +Code associated with the signal. +.It c_cpusize +Size of the segment containing CPU-specific information. +This segment will have the +.Dv CORE_CPU +flag set. +.It c_tsize +Size of the segment containing the program text. +.It c_dsize +Size of the segment containing the program's traditional data area. +.It c_ssize +Size of the segment containing the program's traditional stack area. +This segment will have the +.Dv CORE_STACK +flag set. +.El +The header is followed by +.Fa c_nseg +segments, each of which is preceded with a segment header, +.Fa struct coreseg : +.Bd -literal +struct coreseg { + uint32_t c_midmag; /* magic, id, flags */ + u_long c_addr; /* Virtual address of segment */ + u_long c_size; /* Size of this segment */ +}; +.Ed +.Pp +The fields of +.Fa struct coreseg +are as follows: +.Bl -tag -width XXXc_midmag +.It c_midmag +Core segment magic value and flags. +These values may be extracted with the +.Fn CORE_GETMAGIC +and +.Fn CORE_GETFLAG +macros. +The magic value in the segment header must be +.Dv CORESEGMAGIC . +Exactly one of the flags +.Dv CORE_CPU , +.Dv CORE_DATA , +or +.Dv CORE_STACK +will be set to indicate the segment type. +.It c_addr +Virtual address of the segment in the program image. +Meaningless if the segment type is +.Dv CORE_CPU . +.It c_size +Size of the segment, not including this header. +.El +.Sh SEE ALSO +.Xr gdb 1 , +.Xr setrlimit 2 , +.Xr sysctl 3 , +.Xr a.out 5 , +.Xr elf 5 , +.Xr signal 7 , +.Xr sysctl 8 +.Sh HISTORY +A +.Nm core +file format appeared in +.At v1 . +The +.Nx +a.out core file format was introduced in +.Nx 1.0 . +The +.Nx +ELF core file format was introduced in +.Nx 1.6 . +.Pp +In releases previous to +.Nx 1.6 , +ELF program images produced a.out-format core files. +.Pp +The +.Dv cpi_siglwp +member of the +.Dv netbsd_elfcore_procinfo +structure first appeared in +.Nx 2.0 . +However it retained the procinfo version 1, +stored in +.Dv cpi_version . +.Pp +.Dv ELF_NOTE_NETBSD_CORE_AUXV +was added in +.Nx 8.0 . +.Sh BUGS +There is no standard location or name for the +CPU-dependent data structure stored in the +.Dv CORE_CPU +segment. diff --git a/static/netbsd/man5/daily.5 b/static/netbsd/man5/daily.5 new file mode 100644 index 00000000..7e6eb78b --- /dev/null +++ b/static/netbsd/man5/daily.5 @@ -0,0 +1,225 @@ +.\" $NetBSD: daily.5,v 1.7 2020/12/02 14:18:13 wiz Exp $ +.\" +.\" Copyright (c) 1996 Matthew R. Green +.\" 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 December 2, 2020 +.Dt DAILY 5 +.Os +.Sh NAME +.Nm daily , +.Nm daily.conf +.Nd daily maintenance +.Sh DESCRIPTION +The +.Pa /etc/daily +script is run, by default, every night on a +.Nx +system. +The +.Pa /etc/daily.conf +file specifies which of the standard +.Nm +services are performed. +.Pp +The variables described below can be set to +.Dq YES +or +.Dq NO +in the +.Pa /etc/daily.conf +file. +Most default to +.Dq YES , +but not all. +Check the +.Pa /etc/defaults/daily.conf +file if you are in doubt. +(Note that you should never edit +.Pa /etc/defaults/daily.conf +directly, as it is often replaced during system upgrades.) +.Bl -tag -width fetch_pkg_vulnerabilities +.It Sy find_core +This runs +.Xr find 1 +over the entire local filesystem, looking for core files. +.It Sy run_msgs +This runs +.Xr msgs 1 +with the +.Fl c +argument. +.It Sy expire_news +This runs the +.Pa /etc/expire.news +script. +.It Sy purge_accounting +This ages accounting files in +.Pa /var/account . +.It Sy run_calendar +This runs +.Xr calendar 1 +with the +.Fl a +argument. +.It Sy check_disks +This uses the +.Xr df 1 +and +.Xr dump 8 +to give disk status, and also reports failed +.Xr raid 4 +components. +.It Sy show_remote_fs +In check_disks, show remote file systems, which are not reported on by +default. +.It Sy check_mailq +This runs +.Xr mailq 1 . +.It Sy check_network +This runs +.Xr netstat 1 +with the +.Fl i +argument, and also checks the +.Xr rwhod 8 +database, and runs +.Xr ruptime 1 +if there are hosts in +.Pa /var/rwho . +.It Sy full_netstat +By default, +.Sy check_network +outputs a summarized version of the +.Xr netstat 1 +report. +If a full version of the output run with the +.Fl inv +options is desired, set this variable. +.It Sy run_fsck +This runs +.Xr fsck 8 +with the +.Fl n +option. +.It Sy run_rdist +This runs +.Xr rdist 1 +with +.Pa /etc/Distfile . +.It Sy run_security +This runs the +.Pa /etc/security +script looking for possible security problems with the system. +.It Sy run_skeyaudit +Runs the +.Xr skeyaudit 1 +program to check the S/Key database and informs users of S/Keys that +are about to expire. +.It Sy run_makemandb +If the +.Pa /etc/man.conf +file exists, runs the +.Xr makemandb 8 +utility to update the +.Pa man.db +database for use by +.Xr apropos 1 . +.It Sy fetch_pkg_vulnerabilities +Refreshes the local database of package vulnerabilities. +See the settings in +.Xr security.conf 5 +for details on the actual package checks. +.El +.Pp +The variables described below can be set to modify the tests: +.Bl -tag -width fetch_pkg_vulnerabilities +.It Sy find_core_ignore_fstypes +Lists filesystem types to ignore during the +.Sy find_core +phase. +Prefixing the type with a +.Sq \&! +inverts the match. +For example, +.Ql procfs !local +will ignore +.Ql procfs +type filesystems and filesystems that are not +.Ql local . +.It Sy find_core_ignore_paths +Lists paths to ignore during the +.Sy find_core +phase. +For example, +.Ql Pa /export +will not descend into any directories under the +.Ql Pa /export +hierarchy. +This, on a file server, allows to skip +user data while still scanning system files. +.It Sy run_fsck_flags +Extra options to be passed to +.Xr fsck 8 +if +.Sy run_fsck +is enabled. +.It Sy send_empty_security +If set, the report generated by the +.Sy run_security +phase will always be sent, even if it is empty. +.It Sy pkgdb_dir +.Em DEPRECATED . +Please set +.Dv PKGDB_DIR +in +.Xr pkg_install.conf 5 +instead. +.Pp +If defined, points to the location of the packages database. +Defaults to +.Pa /usr/pkg/pkgdb . +.El +.Sh FILES +.Bl -tag -width /etc/defaults/daily.conf -compact +.It Pa /etc/daily +daily maintenance script +.It Pa /etc/daily.conf +daily maintenance configuration +.It Pa /etc/defaults/daily.conf +default settings, overridden by +.Pa /etc/daily.conf +.It Pa /etc/daily.local +local site additions to +.Pa /etc/daily +.El +.Sh SEE ALSO +.Xr monthly 5 , +.Xr security.conf 5 , +.Xr weekly 5 +.Sh HISTORY +The +.Pa /etc/daily.conf +file appeared in +.Nx 1.3 . diff --git a/static/netbsd/man5/disktab.5 b/static/netbsd/man5/disktab.5 new file mode 100644 index 00000000..bce9e9ec --- /dev/null +++ b/static/netbsd/man5/disktab.5 @@ -0,0 +1,139 @@ +.\" $NetBSD: disktab.5,v 1.13 2012/04/22 10:19:15 wiz 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. +.\" +.\" @(#)disktab.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd April 5, 2012 +.Dt DISKTAB 5 +.Os +.Sh NAME +.Nm disktab +.Nd disk description file +.Sh SYNOPSIS +.In disktab.h +.Sh DESCRIPTION +.Nm +is a simple database which describes disk geometries and +disk partition characteristics. +It is used +.\"by the formatter(\c +.\"IR.Xr format 8 ) +.\"to determine how to format the disk, and +to initialize the disk label on the disk. +The format is described in +.Xr capfile 5 . +Entries in +.Nm +consist of a number of `:' separated fields. +The first entry for each disk gives the names which are known for +the disk, separated by `|' characters. +The last name given should be a long name fully identifying the disk. +.Pp +The following list indicates the normal values +stored for each disk entry. +.Bl -column "indent" "boolx" +.It Sy Name Type Description +.It "\&ty str Type of disk (e.g. removable, winchester)" +.It "\&dt str Type of controller (e.g." +.Tn SMD , ESDI , +floppy) +.It "\&ns num Number of sectors per track" +.It "\&nt num Number of tracks per cylinder" +.It "\&nc num Total number of cylinders on the disk" +.It "\&sc num Number of sectors per cylinder, ns*nt default" +.It "\&su num Number of sectors per unit, sc*nc default" +.It "\&se num Sector size in bytes," +.Dv DEV_BSIZE +default +.It "\&sf bool Controller supports bad144-style bad sector forwarding" +.It "\&rm num Rotation speed, rpm, 3600 default" +.It "\&sk num Sector skew per track, default 0" +.It "\&cs num Sector skew per cylinder, default 0" +.It "\&hs num Headswitch time, usec, default 0" +.It "\&ts num One-cylinder seek time, usec, default 0" +.It "\&il num Sector interleave (n:1), 1 default" +.It "\&d[0-4] num Drive-type-dependent parameters" +.It "\&bs num Boot block size, default" +.Dv BBSIZE +.It "\&sb num Superblock size, default" +.Dv SBSIZE +.It "\&ba num Block size for partition `a' (bytes)" +.It "\&bd num Block size for partition `d' (bytes)" +.It "\&be num Block size for partition `e' (bytes)" +.It "\&bf num Block size for partition `f' (bytes)" +.It "\&bg num Block size for partition `g' (bytes)" +.It "\&bh num Block size for partition `h' (bytes)" +.It "\&fa num Fragment size for partition `a' (bytes)" +.It "\&fd num Fragment size for partition `d' (bytes)" +.It "\&fe num Fragment size for partition `e' (bytes)" +.It "\&ff num Fragment size for partition `f' (bytes)" +.It "\&fg num Fragment size for partition `g' (bytes)" +.It "\&fh num Fragment size for partition `h' (bytes)" +.It "\&oa num Offset of partition `a' in sectors" +.It "\&ob num Offset of partition `b' in sectors" +.It "\&oc num Offset of partition `c' in sectors" +.It "\&od num Offset of partition `d' in sectors" +.It "\&oe num Offset of partition `e' in sectors" +.It "\&of num Offset of partition `f' in sectors" +.It "\&og num Offset of partition `g' in sectors" +.It "\&oh num Offset of partition `h' in sectors" +.It "\&pa num Size of partition `a' in sectors" +.It "\&pb num Size of partition `b' in sectors" +.It "\&pc num Size of partition `c' in sectors" +.It "\&pd num Size of partition `d' in sectors" +.It "\&pe num Size of partition `e' in sectors" +.It "\&pf num Size of partition `f' in sectors" +.It "\&pg num Size of partition `g' in sectors" +.It "\&ph num Size of partition `h' in sectors" +.It "\&ta str Partition type of partition `a'" +.Pf ( Bx 4.2 +filesystem, swap, etc) +.It "\&tb str Partition type of partition `b'" +.It "\&tc str Partition type of partition `c'" +.It "\&td str Partition type of partition `d'" +.It "\&te str Partition type of partition `e'" +.It "\&tf str Partition type of partition `f'" +.It "\&tg str Partition type of partition `g'" +.It "\&th str Partition type of partition `h'" +.El +.Sh FILES +.Bl -tag -width /etc/disktab -compact +.It Pa /etc/disktab +.El +.Sh SEE ALSO +.Xr getdiskbyname 3 , +.Xr capfile 5 , +.Xr disklabel 5 , +.Xr disklabel 8 , +.Xr newfs 8 +.Sh HISTORY +The +.Nm +description file appeared in +.Bx 4.2 . diff --git a/static/netbsd/man5/elf.5 b/static/netbsd/man5/elf.5 new file mode 100644 index 00000000..0f316f8d --- /dev/null +++ b/static/netbsd/man5/elf.5 @@ -0,0 +1,528 @@ +.\" $NetBSD: elf.5,v 1.19 2025/12/09 22:21:28 uwe Exp $ +.\" +.\" Copyright (c) 2001, 2002 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This document is derived from work contributed to The NetBSD Foundation +.\" by Antti Kantee. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 December 9, 2025 +.Dt ELF 5 +.Os +.Sh NAME +.Nm ELF +.Nd executable and linking format +.Sh SYNOPSIS +.In elf.h +.Sh DESCRIPTION +Because of the flexible nature of ELF, the structures describing it are +available both as 32bit and 64bit versions. +This document uses the 32bit versions, refer to +.In elf.h +for the corresponding 64bit versions. +.Pp +The four main types of an ELF object file are: +. +.Bl -tag -offset indent -width ".Em relocatable" +. +.It Em executable +A file suitable for execution. +It contains the information required for creating a new process image. +. +.It Em shared +The shared object contains necessary information which can be used by +either the link editor +.Xr ld 1 +at link time or by the dynamic loader +.Xr ld.elf_so 1 +at run time. +. +.It Em relocatable +Contains the necessary information to be run through the link editor +.Xr ld 1 +to create an executable or a shared library. +. +.It Em core +A file which describes the virtual address space and register state of +a process. +Core files are typically used in conjunction with debuggers such as +.Xr gdb 1 . +.El +.Pp +ELF files have a dual nature. +The toolchain, including tools such as the +.Xr as 1 +and linker +.Xr ld 1 , +treats them as a set of +.Em sections +described by their section headers. +The system loader treats them as a set of +.Em segments +described by the program headers. +.Pp +The general format of an ELF file is the following: The file starts with an +ELF header. +This is followed by a table of program headers +.Pq optional for relocatable and shared files . +After this come the sections/segments. +The file ends with a table of section headers +.Pq optional for executable files . +.Pp +A segment can be considered to consist of several sections. +For example, all executable sections are typically packed into one +loadable segment which is read-only and executable +.Po +see +.Fa p_flags +in the program header +.Pc . +This enables the system to map the entire file with just a few +operations, one for each loadable segment, instead of doing numerous +map operations for each section separately. +. +. +.Ss ELF Header +. +Each file is described by the ELF header: +.Bd -literal -offset indent +typedef struct { + unsigned char e_ident[EI_NIDENT]; + Elf32_Half e_type; + Elf32_Half e_machine; + Elf32_Word e_version; + Elf32_Addr e_entry; + Elf32_Off e_phoff; + Elf32_Off e_shoff; + Elf32_Word e_flags; + Elf32_Half e_ehsize; + Elf32_Half e_phentsize; + Elf32_Half e_phnum; + Elf32_Half e_shentsize; + Elf32_Half e_shnum; + Elf32_Half e_shstrndx; +} Elf32_Ehdr; +.Ed +. +.Bl -tag -width Fa +. +.It Fa e_ident Ns Li [] +The array contains the following information in the indicated locations: +.Bl -tag -width Dv +. +.It Dv EI_MAG0 +The elements ranging from +.Dv EI_MAG0 +to +.Dv EI_MAG3 +contain the ELF magic number: +.Ql \e0177ELF . +. +.It Dv EI_CLASS +Contains the address size of the binary, either 32 or 64bit. +. +.It Dv EI_DATA +byte order. +. +.It Dv EI_VERSION +Contains the ELF header version. +This is currently always set to 1. +. +.It Dv EI_OSABI +Contains the operating system ABI identification. +Note that even though the definition +.Dv ELFOSABI_NETBSD +exists, +.Nx +uses +.Dv ELFOSABI_SYSV +here, since the +.Nx +ABI does not deviate from the standard. +. +.It Dv EI_ABIVERSION +ABI version. +.El +. +.It Fa e_type +Contains the file type identification. +It can be either +.Dv ET_REL , +.Dv ET_EXEC , +.Dv ET_DYN , +or +.Dv ET_CORE +for relocatable, executable, shared, or core, respectively. +. +.It Fa e_machine +Contains the machine type, e.g.\& +.Tn SPARC , +Alpha, +.Tn MIPS , +\&... +. +.It Fa e_entry +The program entry point if the file is executable. +. +.It Fa e_phoff +The position of the program header table in the file or 0 if it doesn't exist. +. +.It Fa e_shoff +The position of the section header table in the file or 0 if it doesn't exist. +. +.It Fa e_flags +Contains processor-specific flags. +For example, the +.Tn SPARC +port uses this space to specify what kind of memory store ordering is +required. +. +.It Fa e_ehsize +The size of the ELF header. +. +.It Fa e_phentsize +The size of an entry in the program header table. +All entries are the same size. +. +.It Fa e_phnum +The number of entries in the program header table, or 0 if none exists. +. +.It Fa e_shentsize +The size of an entry in the section header table. +All entries are the same size. +. +.It Fa e_shnum +The number of entries in the section header table, or 0 if none exists. +. +.It Fa e_shstrndx +Contains the index number of the section which contains the section +name strings. +.El +. +. +.Ss Section Headers +. +Each ELF section in turn is described by a section header: +.Bd -literal -offset indent +typedef struct { + Elf32_Word sh_name; + Elf32_Word sh_type; + Elf32_Word sh_flags; + Elf32_Addr sh_addr; + Elf32_Off sh_offset; + Elf32_Word sh_size; + Elf32_Word sh_link; + Elf32_Word sh_info; + Elf32_Word sh_addralign; + Elf32_Word sh_entsize; +} Elf32_Shdr; +.Ed +. +.Bl -tag -width Fa +. +.It Fa sh_name +Contains an index to the position in the section header string section +where the name of the current section can be found. +. +.It Fa sh_type +Contains the section type indicator. +The more important possible values are: +.Bl -tag -width Dv \" "SHT_PROGBITS" +. +.It Dv SHT_NULL +Section is inactive. +The other fields contain undefined values. +. +.It Dv SHT_PROGBITS +Section contains program information. +It can be for example code, data, or debugger information. +. +.It Dv SHT_SYMTAB +Section contains a symbol table. +This section usually contains all the symbols and is intended for the +regular link editor +.Xr ld 1 . +. +.It Dv SHT_STRTAB +Section contains a string table. +. +.It Dv SHT_RELA +Section contains relocation information with an explicit addend. +. +.It Dv SHT_HASH +Section contains a symbol hash table. +. +.It Dv SHT_DYNAMIC +Section contains dynamic linking information. +. +.It Dv SHT_NOTE +Section contains some special information. +The format can be e.g. vendor-specific. +. +.It Dv SHT_NOBITS +Sections contains information similar to +.Dv SHT_PROGBITS , +but takes up no space in the file. +This can be used for e.g. bss. +. +.It Dv SHT_REL +Section contains relocation information without an explicit addend. +. +.It Dv SHT_SHLIB +This section type is reserved but has unspecified semantics. +. +.It Dv SHT_DYNSYM +Section contains a symbol table. +This symbol table is intended for the dynamic linker, and is kept as +small as possible to conserve space, since it must be loaded to memory +at run time. +.El +. +.It Fa sh_flags +Contains the section flags, which can have the following values or any +combination of them: +.Bl -tag -width Dv +. +.It Dv SHF_WRITE +Section is writable after it has been loaded. +. +.It Dv SHF_ALLOC +Section will occupy memory at run time. +. +.It Dv SHF_EXECINSTR +Section contains executable machine instructions. +. +.El +. +.It Fa sh_addr +Address to where the section will be loaded, or 0 if this section does +not reside in memory at run time. +. +.It Fa sh_offset +The byte offset from the beginning of the file to the beginning of +this section. +If the section is of type +.Dv SHT_NOBITS , +this field specifies the conceptual placement in the file. +. +.It Fa sh_size +The size of the section in the file for all types except +.Dv SHT_NOBITS . +For that type the value may differ from zero, but the section will +still always take up no space from the file. +. +.It Fa sh_link +Contains an index to the section header table. +The interpretation depends on the section type as follows: +.Pp +.Bl -tag -compact -width SHT_DYNAMIC +. +.It Dv SHT_REL +.It Dv SHT_RELA +Section index of the associated symbol table. +. +.Pp +.It Dv SHT_SYMTAB +.It Dv SHT_DYNSYM +Section index of the associated string table. +. +.Pp +.It Dv SHT_HASH +Section index of the symbol table to which the hash table applies. +. +.Pp +.It Dv SHT_DYNAMIC +Section index of the string table by which entries in this section are used. +.El +. +.It Fa sh_info +Contains extra information. +The interpretation depends on the type as follows: +.Pp +.Bl -tag -compact -width SHT_DYNSYM +.It Dv SHT_REL +.It Dv SHT_RELA +Section index of the section to which the relocation information applies. +.Pp +.It Dv SHT_SYMTAB +.It Dv SHT_DYNSYM +Contains a value one greater that the last local symbol table index. +.El +. +.It Fa sh_addralign +Marks the section alignment requirement. +If, for example, the section contains a doubleword, +the entire section must be doubleword aligned to ensure proper alignment. +Only 0 and integral powers of two are allowed. +Values 0 and 1 denote that the section has no alignment. +. +.It Fa sh_entsize +Contains the entry size of an element for sections which are constructed +of a table of fixed-size entries. +If the section does not hold a table of fixed-size entries, this value +is 0. +.El +. +.Ss Program Headers +. +Every executable object must contain program headers. +Program headers contain information necessary in constructing a +process image. +.Bd -literal -offset indent +typedef struct { + Elf32_Word p_type; + Elf32_Off p_offset; + Elf32_Addr p_vaddr; + Elf32_Addr p_paddr; + Elf32_Word p_filesz; + Elf32_Word p_memsz; + Elf32_Word p_flags; + Elf32_Word p_align; +} Elf32_Phdr; +.Ed +. +.Bl -tag -width Fa +. +.It Fa p_type +Contains the segment type indicator. +The possible values are: +.Bl -tag -width Dv +. +.It Dv PT_NULL +Segment is inactive. +The other fields contain undefined values. +. +.It Dv PT_LOAD +Segment is loadable. +It is loaded to the address described by +.Fa p_vaddr . +If +.Fa p_memsz +is greater than +.Fa p_filesz , +the memory range from +.Po Fa p_vaddr ++ +.Fa p_filesz Pc +to +.Po Fa p_vaddr ++ +.Fa p_memsz Pc +is zero-filled when the segment is loaded. +.Fa p_filesz +can not be greater than +.Fa p_memsz . +Segments of this type are sorted in the header table by +.Fa p_vaddr +in ascending order. +. +.It Dv PT_DYNAMIC +Segment contains dynamic linking information. +. +.It Dv PT_INTERP +Segment contains a null-terminated path name to the interpreter. +This segment may be present only once in a file, and it must appear +before any loadable segments. +This field will most likely contain the ELF dynamic loader: +.Pa /libexec/ld.elf_so +. +.It Dv PT_NOTE +Segment contains some special information. +Format can be e.g. vendor-specific. +. +.It Dv PT_SHLIB +This segment type is reserved but has unspecified semantics. +Programs which contain a segment of this type do not conform to the +ABI, and must indicate this by setting the appropriate ABI in the ELF +header +.Dv EI_OSABI +field. +.It Dv PT_PHDR +The values in a program header of this type specify the characteristics +of the program header table itself. +For example, the +.Fa p_vaddr +field specifies the program header table location in memory once the +program is loaded. +This field may not occur more than once, may occur only if the program +header table is part of the file memory image, and must come before +any loadable segments. +.El +. +.It Fa p_offset +Contains the byte offset from the beginning of the file to the beginning +of this segment. +. +.It Fa p_vaddr +Contains the virtual memory address to which this segment is loaded. +. +.It Fa p_paddr +Contains the physical address to which this segment is loaded. +This value is usually ignored, but may be used while bootstrapping or +in embedded systems. +. +.It Fa p_filesz +Contains the number of bytes this segment occupies in the file image. +. +.It Fa p_memsz +Contains the number of bytes this segment occupies in the memory image. +. +.It Fa p_flags +Contains the segment flags, which specify the permissions for the segment +after it has been loaded. +The following values or any combination of them is acceptable: +.Pp +.Bl -tag -width Dv -compact +.It Dv PF_R +Segment can be read. +.It Dv PF_W +Segment can be written. +.It Dv PF_X +Segment is executable. +.El +. +.It Fa p_align +Contains the segment alignment. +Acceptable values are 0 and 1 for no alignment, and integral powers of two. +.Fa p_vaddr +should equal +.Fa p_offset +modulo +.Fa p_align . +.El +. +.Sh SEE ALSO +.Xr as 1 , +.Xr gdb 1 , +.Xr ld 1 , +.Xr ld.elf_so 1 , +.Xr execve 2 , +.Xr nlist 3 , +.Xr a.out 5 , +.Xr core 5 , +.Xr link 5 , +.Xr stab 5 +.Sh HISTORY +The ELF object file format first appeared in +.At V . diff --git a/static/netbsd/man5/ethers.5 b/static/netbsd/man5/ethers.5 new file mode 100644 index 00000000..5a04df30 --- /dev/null +++ b/static/netbsd/man5/ethers.5 @@ -0,0 +1,63 @@ +.\" $NetBSD: ethers.5,v 1.9 2001/09/11 01:01:57 wiz Exp $ +.\" +.\" Written by Roland McGrath <roland@frob.com>. Public domain. +.\" +.Dd November 7, 2000 +.Dt ETHERS 5 +.Os +.Sh NAME +.Nm ethers +.Nd Ethernet host name data base +.Sh DESCRIPTION +The +.Nm +file maps Ethernet MAC addresses to host names. +Lines consist of an address and a host name, separated by any number +of blanks and/or tab characters. +A +.Sq \&# +character indicates the beginning of a comment; +characters up to the end of +the line are not interpreted by routines which search the file. +.Pp +Each line in +.Nm +has the format: +.Dl ethernet-MAC-address hostname-or-IP +.Pp +Ethernet MAC addresses are expressed as six hexadecimal numbers separated +by colons, e.g. "08:00:20:00:5a:bc". +The functions described in +.Xr ethers 3 +and +.Xr ether_aton 3 +can read and produce this format. +.Pp +The traditional use of +.Nm +involved using hostnames for the second argument. +This may not be suitable for machines that don't have a common MAC +address for all interfaces (i.e., just about every non +.Tn Sun +machine). +There should be no problem in using an IP address as the second field +if you wish to differentiate between different interfaces on a system. +.Sh FILES +.Bl -tag -width /etc/ethers -compact +.It Pa /etc/ethers +The +.Nm +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr ethers 3 +.Sh HISTORY +The +.Nm ethers +file format was adopted from +.Tn SunOS +and appeared in +.Nx 1.0 . +.Sh BUGS +A name server should be used instead of a static file. diff --git a/static/netbsd/man5/floppytab.5 b/static/netbsd/man5/floppytab.5 new file mode 100644 index 00000000..9107a400 --- /dev/null +++ b/static/netbsd/man5/floppytab.5 @@ -0,0 +1,55 @@ +.\" $NetBSD: floppytab.5,v 1.4 2013/03/15 19:32:31 njoly Exp $ +.\" +.\" Copyright (c) 2011 Jukka Ruohonen +.\" 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 June 4, 2011 +.Dt FLOPPYTAB 5 +.Os +.Sh NAME +.Nm floppytab +.Nd parameters for floppy diskettes +.Sh DESCRIPTION +The +.Nm +file defines parameters for +.Dq floppy +diskettes. +The format of the file matches the arguments passed to the +.Xr fdformat 1 +utility. +When invoked with the +.Fl t +flag, +.Xr fdformat 1 +can use the known floppy formats from +.Pa /etc/floppytab +directly. +.Sh FILES +.Bl -tag -width /etc/floppytab -compact +.It Pa /etc/floppytab +.El +.Sh SEE ALSO +.Xr eject 1 , +.Xr fdformat 1 diff --git a/static/netbsd/man5/forward.5 b/static/netbsd/man5/forward.5 new file mode 100644 index 00000000..c5a14603 --- /dev/null +++ b/static/netbsd/man5/forward.5 @@ -0,0 +1,99 @@ +.\" $NetBSD: forward.5,v 1.3 2013/07/09 09:41:30 njoly Exp $ +.\" +.\" Copyright (c) 1996 +.\" Mike Pritchard <mpp@FreeBSD.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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by Mike Pritchard and +.\" contributors. +.\" 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 AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD: /repoman/r/ncvs/src/share/man/man5/forward.5,v 1.8 2004/07/03 18:29:22 ru Exp $ +.\" +.Dd July 2, 1996 +.Dt FORWARD 5 +.Os +.Sh NAME +.Nm forward +.Nd mail forwarding instructions +.Sh DESCRIPTION +The +.Nm .forward +file contains a list of mail addresses or programs +that the user's mail should be redirected to. +If the +file is not present, then no mail forwarding will be done. +Mail may also be forwarded as the standard input to a program +by prefixing the line +with the normal shell pipe symbol (|). +If arguments +are to be passed to the command, then the entire line +should be enclosed in quotes. +For security reasons, the +.Nm .forward +file must be owned by the user the mail is being sent to, +or by root, and the user's shell must be listed in +.Pa /etc/shells . +.Pp +For example, if a +.Nm .forward +file contained the following lines: +.Bd -literal -offset indent +nobody@NetBSD.org +"|/usr/bin/vacation nobody" +.Ed +.Pp +Mail would be forwarded to +.Aq nobody@NetBSD.org +and to the program +.Pa /usr/bin/vacation +with the single argument +.Ar nobody . +.Pp +If a local user address is prefixed with a backslash +character, mail is delivered directly to the user's +mail spool file, bypassing further redirection. +.Pp +For example, if user chris had a +.Nm .forward +file containing the following lines: +.Bd -literal -offset indent +chris@otherhost +\echris +.Ed +.Pp +One copy of mail would be forwarded to +.Ar chris@otherhost +and another copy would be retained as mail for local user chris. +.Sh FILES +.Bl -tag -width $HOME/.forward -compact +.It Pa $HOME/.forward +The user's forwarding instructions. +.El +.Sh SEE ALSO +.Xr sendmail 1 , +.Xr aliases 5 , +.Xr mailaddr 7 diff --git a/static/netbsd/man5/fs.5 b/static/netbsd/man5/fs.5 new file mode 100644 index 00000000..03fe519a --- /dev/null +++ b/static/netbsd/man5/fs.5 @@ -0,0 +1,371 @@ +.\" $NetBSD: fs.5,v 1.18 2010/03/22 18:58:32 joerg 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. +.\" +.\" @(#)fs.5 8.2 (Berkeley) 4/19/94 +.\" +.Dd July 27, 2001 +.Dt FS 5 +.Os +.Sh NAME +.Nm fs , +.Nm inode +.Nd format of file system volume +.Sh SYNOPSIS +.In sys/param.h +.In ufs/ffs/fs.h +.In ufs/ufs/inode.h +.Sh DESCRIPTION +The files +.In ufs/ffs/fs.h +and +.In ufs/ufs/inode.h +declare several structures and define variables and macros +which are used to create and manage the underlying format of +file system objects on random access devices (disks). +.Pp +The block size and number of blocks which +comprise a file system are parameters of the file system. +Sectors beginning at +.Dv BBLOCK +and continuing for +.Dv BBSIZE +are used +for a disklabel and for some hardware primary +and secondary bootstrapping programs. +.Pp +The actual file system begins at sector +.Dv SBLOCK +with the +.Em super-block +that is of size +.Dv SBSIZE . +The following structure described the super-block and is +from the file +.In ufs/ffs/fs.h : +.Bd -literal +#define FS_MAGIC 0x011954 +struct fs { + int32_t fs_firstfield; /* historic file system linked list, */ + int32_t fs_unused_1; /* used for incore super blocks */ + int32_t fs_sblkno; /* addr of super-block in filesys */ + int32_t fs_cblkno; /* offset of cyl-block in filesys */ + int32_t fs_iblkno; /* offset of inode-blocks in filesys */ + int32_t fs_dblkno; /* offset of first data after cg */ + int32_t fs_old_cgoffset; /* cylinder group offset in cylinder */ + int32_t fs_old_cgmask; /* used to calc mod fs_ntrak */ + int32_t fs_old_time; /* last time written */ + int32_t fs_old_size; /* number of blocks in fs */ + int32_t fs_old_dsize; /* number of data blocks in fs */ + int32_t fs_ncg; /* number of cylinder groups */ + int32_t fs_bsize; /* size of basic blocks in fs */ + int32_t fs_fsize; /* size of frag blocks in fs */ + int32_t fs_frag; /* number of frags in a block in fs */ +/* these are configuration parameters */ + int32_t fs_minfree; /* minimum percentage of free blocks */ + int32_t fs_old_rotdelay; /* num of ms for optimal next block */ + int32_t fs_old_rps; /* disk revolutions per second */ +/* these fields can be computed from the others */ + int32_t fs_bmask; /* ``blkoff'' calc of blk offsets */ + int32_t fs_fmask; /* ``fragoff'' calc of frag offsets */ + int32_t fs_bshift; /* ``lblkno'' calc of logical blkno */ + int32_t fs_fshift; /* ``numfrags'' calc number of frags */ +/* these are configuration parameters */ + int32_t fs_maxcontig; /* max number of contiguous blks */ + int32_t fs_maxbpg; /* max number of blks per cyl group */ +/* these fields can be computed from the others */ + int32_t fs_fragshift; /* block to frag shift */ + int32_t fs_fsbtodb; /* fsbtodb and dbtofsb shift constant */ + int32_t fs_sbsize; /* actual size of super block */ + int32_t fs_spare1[2]; /* old fs_csmask */ + /* old fs_csshift */ + int32_t fs_nindir; /* value of NINDIR */ + int32_t fs_inopb; /* value of INOPB */ + int32_t fs_old_nspf; /* value of NSPF */ +/* yet another configuration parameter */ + int32_t fs_optim; /* optimization preference, see below */ +/* these fields are derived from the hardware */ + int32_t fs_old_npsect; /* # sectors/track including spares */ + int32_t fs_old_interleave; /* hardware sector interleave */ + int32_t fs_old_trackskew; /* sector 0 skew, per track */ +/* fs_id takes the space of unused fs_headswitch and fs_trkseek fields */ + int32_t fs_id[2]; /* unique file system id */ +/* sizes determined by number of cylinder groups and their sizes */ + int32_t fs_old_csaddr; /* blk addr of cyl grp summary area */ + int32_t fs_cssize; /* size of cyl grp summary area */ + int32_t fs_cgsize; /* cylinder group size */ +/* these fields are derived from the hardware */ + int32_t fs_spare2; /* old fs_ntrak */ + int32_t fs_old_nsect; /* sectors per track */ + int32_t fs_old_spc; /* sectors per cylinder */ + int32_t fs_old_ncyl; /* cylinders in file system */ + int32_t fs_old_cpg; /* cylinders per group */ + int32_t fs_ipg; /* inodes per group */ + int32_t fs_fpg; /* blocks per group * fs_frag */ +/* this data must be re-computed after crashes */ + struct csum fs_old_cstotal; /* cylinder summary information */ +/* these fields are cleared at mount time */ + int8_t fs_fmod; /* super block modified flag */ + int8_t fs_clean; /* file system is clean flag */ + int8_t fs_ronly; /* mounted read-only flag */ + uint8_t fs_old_flags; /* see FS_ flags below */ + u_char fs_fsmnt[MAXMNTLEN]; /* name mounted on */ + u_char fs_volname[MAXVOLLEN]; /* volume name */ + uint64_t fs_swuid; /* system-wide uid */ + int32_t fs_pad; +/* these fields retain the current block allocation info */ + int32_t fs_cgrotor; /* last cg searched (UNUSED) */ + void *fs_ocsp[NOCSPTRS];/* padding; was list of fs_cs buffers */ + uint8_t *fs_contigdirs; /* # of contiguously allocated dirs */ + struct csum *fs_csp; /* cg summary info buffer for fs_cs */ + int32_t *fs_maxcluster; /* max cluster in each cyl group */ + u_char *fs_active; /* used by snapshots to track fs */ + int32_t fs_old_cpc; /* cyl per cycle in postbl */ +/* this area is otherwise allocated unless fs_old_flags & FS_FLAGS_UPDATED */ + int32_t fs_maxbsize; /* maximum blocking factor permitted */ + int64_t fs_sparecon64[17]; /* old rotation block list head */ + int64_t fs_sblockloc; /* byte offset of standard superblock */ + struct csum_total fs_cstotal; /* cylinder summary information */ + int64_t fs_time; /* last time written */ + int64_t fs_size; /* number of blocks in fs */ + int64_t fs_dsize; /* number of data blocks in fs */ + int64_t fs_csaddr; /* blk addr of cyl grp summary area */ + int64_t fs_pendingblocks; /* blocks in process of being freed */ + int32_t fs_pendinginodes; /* inodes in process of being freed */ + int32_t fs_snapinum[FSMAXSNAP]; /* list of snapshot inode numbers */ +/* back to stuff that has been around a while */ + int32_t fs_avgfilesize; /* expected average file size */ + int32_t fs_avgfpdir; /* expected # of files per directory */ + int32_t fs_save_cgsize; /* save real cg size to use fs_bsize */ + int32_t fs_sparecon32[26]; /* reserved for future constants */ + uint32_t fs_flags; /* see FS_ flags below */ +/* back to stuff that has been around a while (again) */ + int32_t fs_contigsumsize; /* size of cluster summary array */ + int32_t fs_maxsymlinklen; /* max length of an internal symlink */ + int32_t fs_old_inodefmt; /* format of on-disk inodes */ + uint64_t fs_maxfilesize; /* maximum representable file size */ + int64_t fs_qbmask; /* ~fs_bmask for use with 64-bit size */ + int64_t fs_qfmask; /* ~fs_fmask for use with 64-bit size */ + int32_t fs_state; /* validate fs_clean field (UNUSED) */ + int32_t fs_old_postblformat; /* format of positional layout tables */ + int32_t fs_old_nrpos; /* number of rotational positions */ + int32_t fs_spare5[2]; /* old fs_postbloff */ + /* old fs_rotbloff */ + int32_t fs_magic; /* magic number */ +}; +.Ed +.Pp +Each disk drive contains some number of file systems. +A file system consists of a number of cylinder groups. +Each cylinder group has inodes and data. +.Pp +A file system is described by its super-block, which in turn +describes the cylinder groups. +The super-block is critical data and is replicated in each cylinder +group to protect against catastrophic loss. +This is done at file system creation time and the critical super-block +data does not change, so the copies need not be referenced further +unless disaster strikes. +.Pp +Addresses stored in inodes are capable of addressing fragments +of `blocks'. +File system blocks of at most size +.Dv MAXBSIZE +can +be optionally broken into 2, 4, or 8 pieces, each of which is +addressable; these pieces may be +.Dv DEV_BSIZE , +or some multiple of +a +.Dv DEV_BSIZE +unit. +.Pp +Large files consist of exclusively large data blocks. +To avoid undue wasted disk space, the last data block of a small +file is allocated as only as many fragments of a large block as +are necessary. +The file system format retains only a single pointer to such a +fragment, which is a piece of a single large block that has been divided. +The size of such a fragment is determinable from +information in the inode, using the +.Fn blksize fs ip lbn +macro. +.Pp +The file system records space availability at the fragment level; +to determine block availability, aligned fragments are examined. +.Pp +The root inode is the root of the file system. +Inode 0 can't be used for normal purposes and +historically bad blocks were linked to inode 1, +thus the root inode is 2 (inode 1 is no longer used for +this purpose, however numerous dump tapes make this +assumption, so we are stuck with it). +.Pp +The +.Fa fs_minfree +element gives the minimum acceptable percentage of file system +blocks that may be free. +If the freelist drops below this level +only the super-user may continue to allocate blocks. +The +.Fa fs_minfree +element +may be set to 0 if no reserve of free blocks is deemed necessary, +however severe performance degradations will be observed if the +file system is run at greater than 90% full; thus the default +value of +.Fa fs_minfree +is 10%. +.Pp +Empirically the best trade-off between block fragmentation and +overall disk utilization at a loading of 90% comes with a +fragmentation of 8, thus the default fragment size is an eighth +of the block size. +.Pp +The element +.Fa fs_optim +specifies whether the file system should try to minimize the time spent +allocating blocks, or if it should attempt to minimize the space +fragmentation on the disk. +If the value of fs_minfree (see above) is less than 10%, +then the file system defaults to optimizing for space to avoid +running out of full sized blocks. +If the value of minfree is greater than or equal to 10%, +fragmentation is unlikely to be problematical, and +the file system defaults to optimizing for time. +.Pp +.Em Cylinder group related limits : +Each cylinder keeps track of the availability of blocks at different +rotational positions, so that sequential blocks can be laid out +with minimum rotational latency. +With the default of 8 distinguished +rotational positions, the resolution of the +summary information is 2ms for a typical 3600 rpm drive. +.Pp +The element +.Fa fs_rotdelay +gives the minimum number of milliseconds to initiate +another disk transfer on the same cylinder. +It is used in determining the rotationally optimal +layout for disk blocks within a file; +the default value for +.Fa fs_rotdelay +is 2ms. +.Pp +Each file system has a statically allocated number of inodes, +determined by its size and the desired number of file data bytes per +inode at the time it was created. See +.Xr newfs 8 +for details on how to set this (and other) filesystem parameters. +By default, the inode allocation strategy is extremely conservative. +.Pp +.Dv MINBSIZE +is the smallest allowable block size. +With a +.Dv MINBSIZE +of 4096 +it is possible to create files of size +2^32 with only two levels of indirection. +.Dv MINBSIZE +must be big enough to hold a cylinder group block, +thus changes to +.Pq Fa struct cg +must keep its size within +.Dv MINBSIZE . +Note that super-blocks are never more than size +.Dv SBSIZE . +.Pp +The path name on which the file system is mounted is maintained in +.Fa fs_fsmnt . +.Dv MAXMNTLEN +defines the amount of space allocated in +the super-block for this name. +The limit on the amount of summary information per file system +is defined by +.Dv MAXCSBUFS . +For a 4096 byte block size, it is currently parameterized for a +maximum of two million cylinders. +.Pp +Per cylinder group information is summarized in blocks allocated +from the first cylinder group's data blocks. +These blocks are read in from +.Fa fs_csaddr +(size +.Fa fs_cssize ) +in addition to the super-block. +.Pp +.Sy N.B.: +.Fn sizeof "struct csum" +must be a power of two in order for +the +.Fn fs_cs +macro to work. +.Pp +The +.Em "Super-block for a file system" : +The size of the rotational layout tables +is limited by the fact that the super-block is of size +.Dv SBSIZE . +The size of these tables is +.Em inversely +proportional to the block size of the file system. +The size of the tables is increased when sector sizes are not powers +of two, as this increases the number of cylinders included before +the rotational pattern repeats +.Pq Fa fs_cpc . +The size of the rotational layout +tables is derived from the number of bytes remaining in +.Pq Fa struct fs . +.Pp +The number of blocks of data per cylinder group +is limited because cylinder groups are at most one block. +The inode and free block tables +must fit into a single block after deducting space for +the cylinder group structure +.Pq Fa struct cg . +.Pp +The +.Em Inode : +The inode is the focus of all file activity in the +.Ux +file system. +There is a unique inode allocated +for each active file, +each current directory, each mounted-on file, +text file, and the root. +An inode is `named' by its device/i-number pair. +For further information, see the include file +.In ufs/ufs/inode.h . +.Sh SEE ALSO +.Xr newfs 8 +.Sh HISTORY +A super-block structure named filsys appeared in +.At v6 . +The file system described in this manual appeared +in +.Bx 4.2 . diff --git a/static/netbsd/man5/fstab.5 b/static/netbsd/man5/fstab.5 new file mode 100644 index 00000000..2fac489f --- /dev/null +++ b/static/netbsd/man5/fstab.5 @@ -0,0 +1,381 @@ +.\" $NetBSD: fstab.5,v 1.47 2020/04/19 19:20:32 gutteridge Exp $ +.\" +.\" Copyright (c) 1980, 1989, 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. +.\" +.\" @(#)fstab.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd April 19, 2020 +.Dt FSTAB 5 +.Os +.Sh NAME +.Nm fstab +.Nd file system table for devices, types, and mount points +.Sh SYNOPSIS +.In fstab.h +.Sh DESCRIPTION +The file +.Nm +contains descriptive information about the various file systems. +.Nm +is only read by programs, and not written; +it is the duty of the system administrator to properly create +and maintain this file. +Each file system is described on a separate line; +fields on each line are separated by tabs or spaces. +Lines beginning +with +.Dq # +are comments. +The order of records in +.Nm +is important because +.Xr fsck 8 , +.Xr mount 8 , +and +.Xr umount 8 +sequentially iterate through +.Nm +doing their respective tasks. +.Pp +Each configuration line/record in +.Nm +has the format: +.Dl fs_spec fs_file fs_vfstype fs_mntops fs_freq fs_passno +.Pp +The first field, +.Pq Fa fs_spec , +describes the block special device or +remote file system to be mounted. +For file systems of type +.Em ffs , +the special file name is the block special file name, +and not the character special file name. +If a program needs the character special file name, +the program must create it by appending a +.Dq r +after the last +.Dq / +in the special file name. +(Note that for some file systems, e.g., +.Em kernfs , +.Em procfs , +and +.Em tmpfs , +this field has no applicable use, and any string may be supplied as a +placeholder. +It is present simply for consistency of argument number and order.) +.Pp +If the first field is of the form +.Dq NAME=<value> +then all the +.Xr dk 4 +wedge partitions are searched for one that has a wedge name equal to +.Ar <value> +and the device corresponding to it is selected. +.Pp +If the first field starts with the prefix +.Dq ROOT. +the prefix is replaced with +.Dq /dev/[root_device] , +where +.Bq root_device +is the value of the +.Dq kern.root_device +sysctl. +.Pp +The second field, +.Pq Fa fs_file , +describes the mount point for the file system. +For swap and dump partitions, this field should be specified as +.Dq none . +.Pp +The third field, +.Pq Fa fs_vfstype , +describes the type of the file system. +The system currently supports these file systems: +.Bl -tag -width filecore -offset indent +.It Em adosfs +an +.Tn AmigaDOS +file system. +.It Em cd9660 +an +.Tn ISO +9660 CD-ROM file system. +.It Em ext2fs +an implementation of the Linux +.Dq Second Extended File-system . +.It Em fdesc +an implementation of +.Pa /dev/fd . +.It Em ffs +a local +.Ux +file system. +.It Em filecore +a file system for +.Tn RISC\ OS . +.It Em kernfs +various and sundry kernel statistics. +.It Em lfs +a log-structured file-system. +.It Em mfs +a local memory-based +.Ux +file system. +.It Em msdos +an +.Tn MS-DOS +.Dq FAT file system . +.It Em nfs +a Sun Microsystems compatible +.Dq Network File System . +.It Em ntfs +a file system used by +.Tn Windows NT . +Still experimental. +.It Em null +a loop-back file system, allowing parts of the system to be viewed +elsewhere. +.It Em overlay +a demonstration of layered file systems. +.It Em portal +a general file system interface, currently supports TCP and FS mounts. +.It Em procfs +a local file system of process information. +.It Em ptyfs +a pseudo-terminal device file system. +.It Em swap +a disk partition to be used for swapping and paging. +.It Em tmpfs +an efficient memory file system. +.It Em umap +a user and group re-mapping file system. +.It Em union +a translucent file system. +.It Em zfs +a ZFS file system. +.El +.Pp +The fourth field, +.Pq Fa fs_mntops , +describes the mount options associated with the file system. +It is formatted as a comma separated list of options. +It contains at least the type of mount (see +.Fa fs_type +below) plus any additional options +appropriate to the file system type. +.Pp +The option +.Dq auto +can be used in the +.Dq noauto +form to cause +a file system not to be mounted automatically (with +.Dq mount -a +, +or system boot time). +.Pp +If the options +.Dq userquota +and/or +.Dq groupquota +are specified, +the file system is automatically processed by the +.Xr quotacheck 8 +command, and legacy user and/or group disk quotas are enabled with +.Xr quotaon 8 . +By default, +file system quotas are maintained in files named +.Pa quota.user +and +.Pa quota.group +which are located at the root of the associated file system. +These defaults may be overridden by putting an equal sign +and an alternative absolute pathname following the quota option. +Thus, if the user quota file for +.Pa /tmp +is stored in +.Pa /var/quotas/tmp.user , +this location can be specified as: +.Bd -literal -offset indent +userquota=/var/quotas/tmp.user +.Ed +.Pp +It is recommended to turn on the new, in-file system quota with +.Xr tunefs 8 +or at +.Xr newfs 8 +time, and to not use the +.Dq userquota +or +.Dq groupquota +options. +Migration of limits to the new in-file system quota can be handled +via +.Xr quotadump 8 +and +.Xr quotarestore 8 . +.Pp +The option +.Dq rump +is used to mount the file system using a +.Xr rump 3 +userspace server instead of the kernel server. +.Pp +The type of the mount is extracted from the +.Fa fs_mntops +field and stored separately in the +.Fa fs_type +field (it is not deleted from the +.Fa fs_mntops +field). +If +.Fa fs_type +is +.Dq rw +or +.Dq ro +then the file system whose name is given in the +.Fa fs_file +field is normally mounted read-write or read-only on the +specified special file. +If +.Fa fs_type +is +.Dq sw +or +.Dq dp +then the special file is made available as a piece of swap +or dump +space by the +.Xr swapctl 8 +command towards the beginning of the system reboot procedure. +See +.Xr swapctl 8 +for more information on configuring swap and dump devices. +The fields other than +.Fa fs_spec +and +.Fa fs_type +are unused. +If +.Fa fs_type +is specified as +.Dq xx +the entry is ignored. +This is useful to show disk partitions which are currently unused. +.Pp +The fifth field, +.Pq Fa fs_freq , +is used for these file systems by the +.Xr dump 8 +command to determine which file systems need to be dumped. +If the fifth field is not present, a value of zero is returned and +.Xr dump 8 +will assume that the file system does not need to be dumped. +.Pp +The sixth field, +.Pq Fa fs_passno , +is used by the +.Xr fsck 8 +program to determine the order in which file system checks are done +at reboot time. +The root file system should be specified with a +.Fa fs_passno +of 1, and other file systems should have a +.Fa fs_passno +of 2. +Filesystems within a drive will be checked sequentially, +but file systems on different drives will be checked at the +same time to use parallelism available in the hardware. +If the sixth field is not present or zero, +a value of zero is returned and +.Xr fsck 8 +will assume that the file system does not need to be checked. +.Bd -literal +#define FSTAB_RW "rw" /* read-write device */ +#define FSTAB_RQ "rq" /* read/write with quotas */ +#define FSTAB_RO "ro" /* read-only device */ +#define FSTAB_SW "sw" /* swap device */ +#define FSTAB_DP "dp" /* dump device */ +#define FSTAB_XX "xx" /* ignore totally */ + +struct fstab { + char *fs_spec; /* block special device name */ + char *fs_file; /* file system path prefix */ + char *fs_vfstype; /* type of file system */ + char *fs_mntops; /* comma separated mount options */ + char *fs_type; /* rw, ro, sw, or xx */ + int fs_freq; /* dump frequency, in days */ + int fs_passno; /* pass number on parallel fsck */ +}; +.Ed +.Pp +The proper way to read records from +.Pa fstab +is to use the routines +.Xr getfsent 3 , +.Xr getfsspec 3 , +and +.Xr getfsfile 3 . +.Sh FILES +.Bl -tag -width /etc/fstab +.It Pa /etc/fstab +The location of +.Nm +configuration file. +.It Pa /usr/share/examples/fstab/ +Some useful configuration examples. +.El +.Sh EXAMPLES +To use +.Dq NAME +on a non-GPT disk, use: +.Bd -literal +NAME=sb2k5Root/a / ffs rw,log 1 1 +NAME=sb2k5Root/b none swap sw,dp 0 0 +.Ed +.Pp +For a +.Xr gpt 8 +disk, use: +.Bd -literal +NAME=firstpartition / ffs rw,log 1 1 +NAME=secondpartition none swap sw,dp 0 0 +.Ed +.Sh SEE ALSO +.Xr getfsent 3 , +.Xr getfsspecname 3 , +.Xr mount 8 , +.Xr swapctl 8 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.0 . diff --git a/static/netbsd/man5/genassym.cf.5 b/static/netbsd/man5/genassym.cf.5 new file mode 100644 index 00000000..f58e01ab --- /dev/null +++ b/static/netbsd/man5/genassym.cf.5 @@ -0,0 +1,87 @@ +.\" $NetBSD: genassym.cf.5,v 1.13 2017/07/03 21:30:59 wiz 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 August 18, 2005 +.Dt GENASSYM.CF 5 +.Os +.Sh NAME +.Nm genassym.cf +.Nd assym.h definition file +.Sh DESCRIPTION +The +.Nm +file is used by +.Xr genassym 1 +to make constant C expressions known to assembler source files. +Lines starting with '#' are discarded by +.Xr genassym 1 . +Lines starting with +.Em include , +.Em ifdef , +.Em if , +.Em else +or +.Em endif +are preceded with '#' and passed otherwise unmodified to the C compiler. +Lines starting with +.Em quote +get passed on with the +.Em quote +command removed. +The first word after a +.Em define +command is taken as a CPP identifier and the rest of the line has to be +a constant C expression. The output of +.Xr genassym 1 +will assign the numerical value of this expression to the CPP identifier. +.Em "export X" +is a shorthand for +.Em "define X X" . +.Em "struct X" +remembers X for the +.Em member +command and does a +.Em "define X_SIZEOF sizeof(X)" . +.Em "member X" +does a +.Em "define X offsetof(<last struct>, X)" . +.Em "config <ctype> <gcc constraint> <asm print modifier>" +can be used to customize the output of +.Xr genassym 1 . +When producing C output, values are casted to <ctype> (default: long) +before they get handed to printf. <gcc constraint> (default: n) is the +constraint used in the __asm__ statements. <asm print modifier> (default: +empty) can be used to force gcc to output operands in different ways +then normal. The "a" modifier e.g. stops gcc from emitting immediate +prefixes in front of constants for the i386 and m68k port. +.Sh FILES +.Pa /usr/src/sys/arch/${MACHINE}/${MACHINE}/genassym.cf +.Sh SEE ALSO +.Xr genassym 1 +.Sh HISTORY +The +.Nm +file appeared in +.Nx 1.3 . diff --git a/static/netbsd/man5/gpio.conf.5 b/static/netbsd/man5/gpio.conf.5 new file mode 100644 index 00000000..94008eaf --- /dev/null +++ b/static/netbsd/man5/gpio.conf.5 @@ -0,0 +1,72 @@ +.\" $NetBSD: gpio.conf.5,v 1.3 2022/04/30 13:48:09 brad Exp $ +.\" +.\" Copyright (c) 2009 Marc Balmer <marc@msys.ch> +.\" 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 August 1, 2009 +.Dt GPIO.CONF 5 +.Os +.Sh NAME +.Nm gpio.conf +.Nd GPIO config file +.Sh DESCRIPTION +The +.Nm +file is read by the +.Pa gpio +rc.d script during system start-up and shutdown, +and is intended for configuring GPIO pins. +.Ss FILE FORMAT +Lines starting with a hash +.Pq Sq # +and empty lines are ignored. +If a line starts with +.Sq \&! , +the rest of line will get evaluated as shell script fragment. +All other lines are passed to +.Xr gpioctl 8 . +.Sh FILES +.Bl -tag -width XXetcXgpioXconfXX +.It Pa /etc/gpio.conf +The +.Nm +configuration file resides in +.Pa /etc . +.It Pa /etc/rc.d/gpio +.Xr rc.d 8 +script that parses +.Nm . +.El +.Sh EXAMPLES +In this example, if the +.Pa /etc/gpio.conf +config file is present pin 1 of +.Pa /dev/gpio0 +is set as output and named "error_led". +.Bd -literal -offset indent +# Program pin 1 of /dev/gpio0 as output and name it "error_led" +gpio0 1 set out error_led +.Ed +.Sh SEE ALSO +.Xr gpioctl 8 , +.Xr rc 8 diff --git a/static/netbsd/man5/group.5 b/static/netbsd/man5/group.5 new file mode 100644 index 00000000..da4afc06 --- /dev/null +++ b/static/netbsd/man5/group.5 @@ -0,0 +1,263 @@ +.\" $NetBSD: group.5,v 1.19 2009/05/13 22:33:59 wiz 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. +.\" +.\" Portions Copyright(c) 1994, Jason Downs. 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(S) ``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(S) 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. +.\" +.\" @(#)group.5 8.3 (Berkeley) 4/19/94 +.\" +.Dd June 21, 2007 +.Dt GROUP 5 +.Os +.Sh NAME +.Nm group +.Nd format of the group permissions file +.Sh DESCRIPTION +The +.Nm +file +.Pa /etc/group +is the local source of group information. +It can be used in conjunction with the Hesiod domain +.Sq group , +and the +.Tn NIS +maps +.Sq group.byname +and +.Sq group.bygid , +as controlled by +.Xr nsswitch.conf 5 . +.Pp +The +.Nm +file consists of newline separated +.Tn ASCII +records, usually one per group, containing four colon +.Ql \&: +separated fields. +Each line has the form: +.Dl group:passwd:gid:[member[,member]...] +.Pp +These fields are as follows: +.Bl -tag -width password -offset indent -compact +.It Em group +Name of the group. +.It Em passwd +Group's +.Em encrypted +password. +.It Em gid +The group's decimal ID. +.It Em member +Group members. +.El +.Pp +The +.Em group +field is the group name used for granting file access to users +who are members of the group. +.Pp +The +.Em gid +field is the number associated with the group name. +They should both be unique across the system (and often +across a group of systems) since they control file access. +.Pp +The +.Em passwd +field +is an optional +.Em encrypted +password. +This field is rarely used +and an asterisk is normally placed in it rather than leaving it blank. +.Pp +The +.Em member +field contains the names of users granted the privileges of +.Em group . +The member names are separated by commas without spaces or newlines. +A user is automatically in a group if that group was specified +in their +.Pa /etc/passwd +entry and does not need to be added to that group in the +.Pa /etc/group +file. +.Pp +Very large groups can be accommodated over multiple lines by specifying the +same group name in all of them; other than this, each line has an identical +format to that described above. +This can be necessary to avoid the record's length limit, which is currently +set to 1024 characters. +Note that the limit can be queried through +.Xr sysconf 3 +by using the +.Li _SC_GETGR_R_SIZE_MAX +parameter. +For example: +.Bd -literal -offset indent +biggrp:*:1000:user001,user002,user003,...,user099,user100 +biggrp:*:1000:user101,user102,user103,... +.Ed +.Pp +The group with the name +.Dq wheel +has a special meaning to the +.Xr su 1 +command: if it exists and has any members, only users listed in that group +are allowed to +.Nm su +to +.Dq root . +.Sh HESIOD SUPPORT +If +.Sq dns +is specified for the +.Sq group +database in +.Xr nsswitch.conf 5 , +then +.Nm +lookups occur from the +.Sq group +Hesiod domain. +.Sh NIS SUPPORT +If +.Sq nis +is specified for the +.Sq group +database in +.Xr nsswitch.conf 5 , +then +.Nm +lookups occur from the +.Sq group.byname +and +.Sq group.bygid +.Tn NIS +map. +.Sh COMPAT SUPPORT +If +.Sq compat +is specified for the +.Sq group +database, and either +.Sq dns +or +.Sq nis +is specified for the +.Sq group_compat +database in +.Xr nsswitch.conf 5 , +then the +.Nm +file may also contain lines of the format +.Pp ++name:*:: +.Pp +which causes the specified group to be included from the +.Sq group +Hesiod domain +or the +.Sq group.byname +.Tn NIS +map (respectively). +.Pp +If no group name is specified, or the plus sign +.Pq Dq \&+ +appears alone +on line, all groups are included from the +Hesiod domain or the +.Tn NIS +map. +.Pp +Hesiod or +.Tn NIS +compat references may appear anywhere in the file, but the single +plus sign +.Pq Dq \&+ +form should be on the last line, for historical reasons. +Only the first group with a specific name encountered, whether in the +.Nm +file itself, or included via Hesiod or +.Tn NIS , +will be used. +.Sh FILES +.Bl -tag -width /etc/group -compact +.It Pa /etc/group +.El +.Sh SEE ALSO +.Xr newgrp 1 , +.Xr passwd 1 , +.Xr su 1 , +.Xr setgroups 2 , +.Xr crypt 3 , +.Xr initgroups 3 , +.Xr nsswitch.conf 5 , +.Xr passwd 5 , +.Xr yp 8 +.Sh HISTORY +A +.Nm +file format appeared in +.At v6 . +.Pp +The +.Tn NIS +file format first appeared in SunOS. +.Pp +The Hesiod support first appeared in +.Nx 1.4 . +.Sh BUGS +The +.Xr passwd 1 +command does not change the +.Nm group +passwords. diff --git a/static/netbsd/man5/hesiod.conf.5 b/static/netbsd/man5/hesiod.conf.5 new file mode 100644 index 00000000..01cd4368 --- /dev/null +++ b/static/netbsd/man5/hesiod.conf.5 @@ -0,0 +1,71 @@ +.\" $NetBSD: hesiod.conf.5,v 1.4 2001/09/08 01:29:05 wiz Exp $ +.\" +.\" from: #Id: hesiod.conf.5,v 1.1 1996/12/08 21:36:38 ghudson Exp # +.\" +.\" Copyright 1996 by the Massachusetts Institute of Technology. +.\" +.\" Permission to use, copy, modify, and distribute this +.\" software and its documentation for any purpose and without +.\" fee is hereby granted, provided that the above copyright +.\" notice appear in all copies and that both that copyright +.\" notice and this permission notice appear in supporting +.\" documentation, and that the name of M.I.T. not be used in +.\" advertising or publicity pertaining to distribution of the +.\" software without specific, written prior permission. +.\" M.I.T. makes no representations about the suitability of +.\" this software for any purpose. It is provided "as is" +.\" without express or implied warranty. +.\" +.Dd November 30, 1996 +.Dt HESIOD.CONF 5 +.Os +.Sh NAME +.Nm hesiod.conf +.Nd configuration file for the Hesiod library +.Sh DESCRIPTION +The file +.Nm +determines the behavior of the Hesiod library. +Blank lines and lines beginning with a +.Sq # +character are ignored. All other lines should be of the form +.Em variable += +.Ar value , +where the value should be a single word. Possible variables and +values are: +.Bl -tag -width classes +.It Em lhs +Specifies the domain prefix used for Hesiod queries. In almost all +cases, you should specify +.Dq Em lhs Ns = Ns Ar .ns . +The default value if you do +not specify an lhs value is no domain prefix, which is not compatible +with most Hesiod domains. +.It Em rhs +Specifies the default Hesiod domain; this value may be overridden by +the +.Ev HES_DOMAIN +environment variable. You must specify an +.Em rhs +line for the Hesiod +library to work properly. +.It Em classes +Specifies which DNS classes Hesiod should do lookups in. Possible +values are +.Ar IN +(the preferred class) and +.Ar HS +(the deprecated class, +still used by some sites). You may specify both classes separated by +a comma to try one class first and then the other if no entry is +available in the first class. The default value of the classes +variable is +.Dq Ar IN,HS . +.El +.Sh SEE ALSO +.Xr hesiod 3 +.Sh BUGS +There default value for +.Dq lhs +should probably be more reasonable. diff --git a/static/netbsd/man5/hosts.5 b/static/netbsd/man5/hosts.5 new file mode 100644 index 00000000..de09b287 --- /dev/null +++ b/static/netbsd/man5/hosts.5 @@ -0,0 +1,116 @@ +.\" $NetBSD: hosts.5,v 1.14 2021/03/12 10:00:32 uwe 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. +.\" +.\" @(#)hosts.5 8.2 (Berkeley) 12/11/93 +.\" +.Dd November 17, 2000 +.Dt HOSTS 5 +.Os +.Sh NAME +.Nm hosts +.Nd host name data base +.Sh DESCRIPTION +The +.Nm hosts +file contains information regarding the known hosts on the network. +It can be used in conjunction with the DNS, and the +.Tn NIS +maps +.Sq hosts.byaddr , +and +.Sq hosts.byname , +as controlled by +.Xr nsswitch.conf 5 . +.Pp +For each host a single line should be present +with the following information: +.Dl address hostname [alias ...] +.Pp +These are: +.Bl -tag -width hostname -compact -offset indent +.It Em address +Internet address +.It Em hostname +Official host name +.It Em alias +Alias host name +.El +.Pp +Items are separated by any number of blanks and/or +tab characters. A hash sign +.Pq Dq \&# +indicates the beginning of +a comment; characters up to the end of the line are +not interpreted by routines which search the file. +.Pp +When using the name server +.Xr named 8 , +or +.Xr ypserv 8 , +this file provides a backup when the name server +is not running. +For the name server, it is suggested that only a few addresses +be included in this file. +These include address for the local interfaces that +.Xr ifconfig 8 +needs at boot time and a few machines on the local network. +.Pp +As network addresses, both IPv4 and IPv6 addresses are allowed. +IPv4 addresses are specified in the conventional dot +.Pq Dq \&. +notation using the +.Xr inet_pton 3 +routine +from the Internet address manipulation library, +.Xr inet 3 . +IPv6 addresses are specified in the standard hex-and-colon notation. +Host names may contain any printable +character other than a field delimiter, newline, +or comment character. +.Sh FILES +.Bl -tag -width /etc/hosts -compact +.It Pa /etc/hosts +The +.Nm hosts +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr gethostbyname 3 , +.Xr nsswitch.conf 5 , +.Xr ifconfig 8 , +.Xr named 8 +.Rs +.%T "Name Server Operations Guide for BIND" +.Re +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/static/netbsd/man5/hosts.equiv.5 b/static/netbsd/man5/hosts.equiv.5 new file mode 100644 index 00000000..76a81ed5 --- /dev/null +++ b/static/netbsd/man5/hosts.equiv.5 @@ -0,0 +1,179 @@ +.\" $NetBSD: hosts.equiv.5,v 1.9 2014/09/19 16:02:58 wiz Exp $ +.\" +.\" Copyright (c) 1997 The NetBSD Foundation, Inc. +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 November 26, 1997 +.Dt HOSTS.EQUIV 5 +.Os +.Sh NAME +.Nm hosts.equiv , +.Nm .rhosts +.Nd trusted remote hosts and host-user pairs +.Sh DESCRIPTION +The +.Nm hosts.equiv +and +.Nm .rhosts +files list hosts and users which are +.Dq trusted +by the local host when a connection is made via +.Xr rlogind 8 , +.Xr rshd 8 , +or any other server that uses +.Xr ruserok 3 . +This mechanism bypasses password checks, and is required for access via +.Xr rsh 1 . +.Pp +Each line of these files has the format: +.Pp +.Bd -unfilled -offset indent -compact +hostname [username] +.Ed +.Pp +The +.Em hostname +may be specified as a host name (typically a fully qualified host +name in a DNS environment) or address, +.Dq Li +@netgroup +(from which only the host names are checked), +or a +.Dq Li \&+ +wildcard (allow all hosts). +.Pp +The +.Em username , +if specified, may be given as a user name on the remote host, +.Dq Li +@netgroup +(from which only the user names are checked), +or a +.Dq Li \&+ +wildcard (allow all remote users). +.Pp +If a +.Em username +is specified, only that user from the specified host may login to the +local machine. +If a +.Em username +is not specified, any user may login with the same user name. +.Sh FILES +.Bl -tag -width /etc/hosts.equiv -compact +.It Pa /etc/hosts.equiv +Global trusted host-user pairs list +.It Pa ~/.rhosts +Per-user trusted host-user pairs list +.El +.Sh EXAMPLES +.Li somehost +.Bd -filled -offset indent -compact +A common usage: users on +.Em somehost +may login to the local host as the same user name. +.Ed +.Li somehost username +.Bd -filled -offset indent -compact +The user +.Em username +on +.Em somehost +may login to the local host. +If specified in +.Pa /etc/hosts.equiv , +the user may login with only the same user name. +.Ed +.Li +@anetgroup username +.Bd -filled -offset indent -compact +The user +.Em username +may login to the local host from any machine listed in the netgroup +.Em anetgroup . +.Ed +.Bd -literal -compact ++ ++ + +.Ed +.Bd -filled -offset indent -compact +Two severe security hazards. +In the first case, allows a user on any +machine to login to the local host as the same user name. +In the second case, allows any user on any +machine to login to the local host (as any user, if in +.Pa /etc/hosts.equiv ) . +.Ed +.Sh WARNINGS +The username checks provided by this mechanism are +.Em not +secure, as the remote user name is received by the server unchecked +for validity. +Therefore this mechanism should only be used +in an environment where all hosts are completely trusted. +.Pp +A numeric host address instead of a host name can help security +considerations somewhat; the address is then used directly by +.Xr iruserok 3 . +.Pp +When a username (or netgroup, or +) is specified in +.Pa /etc/hosts.equiv , +that user (or group of users, or all users, respectively) may login to +the local host as +.Em any local user . +Usernames in +.Pa /etc/hosts.equiv +should therefore be used with extreme caution, or not at all. +.Pp +A +.Pa .rhosts +file must be owned by the user whose home directory it resides in, and +must be writable only by that user. +.Pp +Logins as root only check root's +.Pa .rhosts +file; the +.Pa /etc/hosts.equiv +file is not checked for security. +Access permitted through root's +.Pa .rhosts +file is typically only for +.Xr rsh 1 , +as root must still login on the console for an interactive login such as +.Xr rlogin 1 . +.Sh SEE ALSO +.Xr rcp 1 , +.Xr rlogin 1 , +.Xr rsh 1 , +.Xr rcmd 3 , +.Xr ruserok 3 , +.Xr netgroup 5 +.Sh HISTORY +The +.Nm .rhosts +file format appeared in +.Bx 4.2 . +.Sh BUGS +The +.Xr ruserok 3 +implementation currently skips negative entries (preceded with a +.Dq Li \&- +sign) and does not treat them as ``short-circuit'' negative entries. diff --git a/static/netbsd/man5/ifaliases.5 b/static/netbsd/man5/ifaliases.5 new file mode 100644 index 00000000..1540ff7b --- /dev/null +++ b/static/netbsd/man5/ifaliases.5 @@ -0,0 +1,77 @@ +.\" $NetBSD: ifaliases.5,v 1.14 2008/05/29 14:51:25 mrg Exp $ +.\" +.\" Copyright (c) 1996 Matthew R. Green +.\" 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 November 17, 2000 +.Dt IFALIASES 5 +.Os +.Sh NAME +.Nm ifaliases +.Nd interface aliases file +.Sh DESCRIPTION +The +.Nm +file specifies the additional addresses (aliases) that each interface +has. +.Nm +is processed by +.Pa /etc/rc.d/network +at system boot time. +.Pp +Each line of the file is of the form: +.D1 address interface [netmask] +.Pp +The +.Em address +is a network address of the alias. +This must be a number, or must be in +.Pa /etc/hosts , +since the nameserver is not running at this point. +.Pp +The +.Em interface +is the network interface the alias will be configured on. +.Pp +The +.Em netmask +is the netmask of the alias' network address. +Although this is optional, omitting the netmask is discouraged. +Omission results in the use of the classful netmask associated with +.Em address . +.Sh FILES +.Pa /etc/ifaliases , +.Pa /etc/rc.d/network +.Sh HISTORY +The +.Nm +file appeared in +.Nx 1.2 . +.Sh BUGS +.Nm +assumes IPv4, and does not support other protocol families. +Please check +.Xr rc.conf 5 +for alternatives like +.Pa /etc/ifconfig.xxN . diff --git a/static/netbsd/man5/ifconfig.if.5 b/static/netbsd/man5/ifconfig.if.5 new file mode 100644 index 00000000..b00dc35a --- /dev/null +++ b/static/netbsd/man5/ifconfig.if.5 @@ -0,0 +1,180 @@ +.\" $NetBSD: ifconfig.if.5,v 1.22 2020/10/11 22:46:24 kim Exp $ +.\" +.\" Copyright (c) 1996 Matthew R. Green +.\" 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 October 12, 2020 +.Dt IFCONFIG.IF 5 +.Os +.Sh NAME +.Nm ifconfig.if +.Nd interface-specific configuration files or variables +.Sh DESCRIPTION +The +.Nm +files or variables contain information regarding the configuration +of each network interface. +.Nm +is processed by +.Pa /etc/rc.d/network +at system boot time. +.Pp +For each interface +.Pq Ar nnX +that is to be configured, there should be either an +.Sy ifconfig_nnX +variable in +.Xr rc.conf 5 , +or an +.Pa /etc/ifconfig.nnX +file +(such as the +.Sy ifconfig_fxp0 +variable or the +.Pa /etc/ifconfig.fxp0 +file for the +.Sy fxp0 +interface). +Only characters allowed in +.Xr sh 1 +variables names should be used for +.Ar nnX +.Po Xr ascii 7 +uppercase and lowercase letters, digits, and underscore +.Pc . +.Pp +The variable or file will get evaluated only if the interface exists on +the system. +Multiple lines can be placed in a variable or file, and will be +evaluated sequentially. +In the case of a variable, semicolons may be used instead of +newlines, as described in +.Xr rc.conf 5 . +.Ao backslash Ac Ns Ao newline Ac +sequences in files are ignored, so long logical lines may be +made up of several shorter physical lines. +.Pp +Normally, a line will be evaluated as command line arguments to +.Xr ifconfig 8 . +.Dq Li ifconfig Ar nnX +will be prepended on evaluation. +Arguments with embedded shell metacharacters should be quoted in +.Xr sh 1 +style. +.Pp +If the line is equal to +.Dq dhcp , +.Xr dhcpcd 8 +will be started for the interface. +However, it is instead recommended that +.Sy dhcpcd +is set to true in +.Xr rc.conf 5 +and any per interface configuration or restriction is done in +.Xr dhcpcd.conf 5 . +.Pp +If the line is equal to +.Dq rtsol , +a dedicated +.Xr dhcpcd 8 +process will be started for processing received router advertisements +and sending out IPv6 router solicitation messages on the interface. +This is useful on networks where default routes can best be learned +from router advertisements. +However, if +.Sy dhcpcd +has been set to true in +.Xr rc.conf 5 , +it is assumed that that +.Xr dhcpcd 8 +process will take care of sending any necessary router solicitation +messages and processing received router advertisements on all +interfaces, and therefore no per-interface process is started. +.Pp +If a line is empty, or starts with +.Sq # , +the line will be ignored as comment. +.Pp +If a line starts with +.Sq \&! , +the rest of line will get evaluated as shell script fragment. +Shell variables declared in +.Pa /etc/rc.d/network +are accessible but may not be modified. +The most useful variable is +.Li $int , +as it will be bound to the interface being configured with the file. +.Pp +For example, the following illustrates static interface configuration: +.Bd -literal -offset indent +# IPv4, with an alias +inet 10.0.1.12 netmask 255.255.255.0 media 100baseTX +inet 10.0.1.13 netmask 255.255.255.255 alias +# let us have IPv6 address on this interface +inet6 2001:db8::1 prefixlen 64 alias +# have subnet router anycast address too +inet6 2001:db8:: prefixlen 64 alias anycast +.Ed +.Pp +For networks that do not use a virtual address for the default gateway +that could be set using a single address in +.Sy defaultroute6 , +static IPv6 address configuration could use the +.Dq rtsol +keyword instead to solicit router advertisements for learning a default +route and even achieving route redundancy given multiple responding +routers: +.Bd -literal -offset indent +inet6 2001:db8::100 prefixlen 64 alias +rtsol +.Ed +.Pp +The following example sets a network name for a wireless interface +(using quotes to protect special characters in the name), +and starts +.Xr dhcpcd 8 : +.Bd -literal -offset indent +ssid 'my network' +dhcp +.Ed +.Pp +The following example is for dynamically-created pseudo interfaces like +.Xr gif 4 . +Earlier versions of +.Pa /etc/rc.d/network +required an explicit +.Sq create +command for such interfaces, +but creation is now handled automatically. +.Bd -literal -offset indent +up +# configure IPv6 default route toward the interface +!route add -inet6 default ::1 +!route change -inet6 default -ifp $int +.Ed +.Sh FILES +.Pa /etc/rc.d/network +.Sh SEE ALSO +.Xr rc.conf 5 , +.Xr ifconfig 8 diff --git a/static/netbsd/man5/intro.5 b/static/netbsd/man5/intro.5 new file mode 100644 index 00000000..5b7a7f4b --- /dev/null +++ b/static/netbsd/man5/intro.5 @@ -0,0 +1,39 @@ +.\" $NetBSD: intro.5,v 1.5 2009/03/11 13:50:39 joerg Exp $ +.\" +.\" Copyright (c) 1998 The NetBSD Foundation, Inc. +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 April 21, 1998 +.Dt INTRO 5 +.Os +.Sh NAME +.Nm intro +.Nd introduction to file formats +.Sh DESCRIPTION +This section contains documentation on binary and configuration +file formats. +.Sh HISTORY +.Nm intro +appeared in +.Nx 1.4 . diff --git a/static/netbsd/man5/ipsec.conf.5 b/static/netbsd/man5/ipsec.conf.5 new file mode 100644 index 00000000..2c40e465 --- /dev/null +++ b/static/netbsd/man5/ipsec.conf.5 @@ -0,0 +1,72 @@ +.\" $NetBSD: ipsec.conf.5,v 1.3 2001/09/11 01:01:57 wiz Exp $ +.\" +.\" Copyright (c) 2001 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This document is derived from works contributed to The NetBSD Foundation +.\" by Hubert Feyrer. +.\" +.\" 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 February 19, 2001 +.Dt IPSEC.CONF 5 +.Os +.Sh NAME +.Nm ipsec.conf +.Nd static IPsec configuration read at system startup +.Sh DESCRIPTION +The +.Nm +file is read at system startup time if +.Sy ipsec +is set to +.Dq yes +in +.Xr rc.conf 5 . +.Xr setkey 8 +is run with the +.Fl f +option to load in IPsec manual keys and policies from +.Pa /etc/ipsec.conf +at boot time, before any interfaces are configured. +.Pp +Please see the +.Xr setkey 8 +manpage for all the commands available. +.Sh FILES +.Bl -tag -width /etc/ipsec.conf -compact +.It Pa /etc/ipsec.conf +The file +.Nm +resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr ipsec 4 , +.Xr setkey 8 +.Sh HISTORY +The +.Nm +file appeared in +.Nx 1.5 . diff --git a/static/netbsd/man5/ld.so.conf.5 b/static/netbsd/man5/ld.so.conf.5 new file mode 100644 index 00000000..c33742b3 --- /dev/null +++ b/static/netbsd/man5/ld.so.conf.5 @@ -0,0 +1,103 @@ +.\" $NetBSD: ld.so.conf.5,v 1.21 2017/07/03 21:30:59 wiz Exp $ +.\" +.\" Copyright (c) 1996 Matthew R. Green +.\" 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 July 21, 2004 +.Dt LD.SO.CONF 5 +.Os +.Sh NAME +.Nm ld.so.conf +.Nd run-time link-editor configuration file +.Sh DESCRIPTION +The +.Nm +file specifies additional default directories (beyond the standard set, +normally +.Dq Pa /usr/lib ) . +.Pp +On +.Xr a.out 5 +systems, this file is scanned by +.Xr ldconfig 8 +to create the hints files used by the run-time linker +.Pa /usr/libexec/ld.so +to locate shared libraries. +.Pp +On +.Xr elf 5 +systems, this file is scanned directly by the run-time linker +.Pa /usr/libexec/ld.elf_so . +.Pp +Lines beginning with +.Sq # +are treated as comments and ignored. +Any other non-blank lines beginning +with +.Sq / +are stripped of leading whitespace and trailing comments +(introduced with +.Sq # ) +together with any preceding whitespace, then treated as directories to be +scanned for shared libraries to add to the hints. +.Pp +On +.Xr elf 5 +lines that do not begin with a +.Sq / +are parsed as hardware dependent per +library directives: +.Bd -literal +<library> <sysctl> <variable>[,...]:<library>[,...] ... +.Ed +.Pp +If there is no match, the standard action is taken. +.Sh FILES +.Pa /etc/ld.so.conf +.Sh EXAMPLES +.Bd -literal +libm.so.0 machdep.fpu_present 1:libm387.so.0,libm.so.0 +.Ed +.Pp +The above line loads both libm387 and libm when the +.Xr sysctl 3 +variable fpu_present has the value 1. +.Sh SEE ALSO +.Xr ld.aout_so 1 , +.Xr ld.elf_so 1 , +.Xr a.out 5 , +.Xr elf 5 , +.Xr ldconfig 8 +.Sh HISTORY +The +.Nm +file appeared in +.Nx 1.3 . +The ELF support for it was added in +.Nx 1.5 . +.Sh BUGS +Directory names containing the comment character +.Pq Sq # +and/or leading or trailing whitespace cannot be included. +(Embedded blanks are allowed, however.) diff --git a/static/netbsd/man5/link.5 b/static/netbsd/man5/link.5 new file mode 100644 index 00000000..b809bdc2 --- /dev/null +++ b/static/netbsd/man5/link.5 @@ -0,0 +1,609 @@ +.\" $NetBSD: link.5,v 1.25 2022/12/29 22:41:36 gutteridge Exp $ +.\" +.\" Copyright (c) 1996 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Paul Kranenburg. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 October 23, 1993 +.Dt LINK 5 +.Os +.Sh NAME +.Nm link +.Nd dynamic loader and link editor interface +.Sh SYNOPSIS +.In link.h +.Sh DESCRIPTION +The include file +.In link.h +declares several structures that are present in dynamically linked +programs and libraries. +The structures define the interface between several components of the +link-editor and loader mechanism. +The layout of a number of these structures within the binaries resembles the +.Xr a.out 5 +format in many places as it serves such similar functions as symbol +definitions (including the accompanying string table) and relocation records +needed to resolve references to external entities. +.Pp +It also records a number of data structures +unique to the dynamic loading and linking process. +These include references to other objects that are required to +complete the link-editing process and indirection tables to facilitate +.Em Position Independent Code +(PIC) to improve sharing of code pages among different processes. +.Pp +The collection of data structures described here will be referred to as the +.Em Run-time Relocation Section +(RRS) and is embedded in the standard text and data segments of +the dynamically linked program or shared object image as the existing +.Xr a.out 5 +format offers no room for it elsewhere. +.Pp +Several utilities cooperate to ensure that the task of getting a program +ready to run can complete successfully in a way that optimizes the use +of system resources. +The compiler emits PIC code from which shared libraries can be built by +.Xr ld 1 . +The compiler also includes size information of any initialized data items +through the .size assembler directive. +.Pp +PIC code differs from conventional code in that it accesses data +variables through an indirection table, the Global Offset Table, +by convention accessible by the reserved name +.Em _GLOBAL_OFFSET_TABLE_ . +The exact mechanism used for this is machine dependent, usually a machine +register is reserved for the purpose. +The rationale behind this construct is to generate code that is +independent of the actual load address. +Only the values contained in the Global Offset Table may need +updating at run-time depending on the load addresses of the various +shared objects in the address space. +.Pp +Likewise, procedure calls to globally defined functions are redirected +through the Procedure Linkage Table (PLT) residing in the data +segment of the core image. +Again, this is done to avoid run-time modifications to the text segment. +.Pp +The linker-editor allocates the Global Offset Table and Procedure +Linkage Table when combining PIC object files into an image suitable +for mapping into the process address space. +It also collects all symbols that may be needed by the run-time +link-editor and stores these along with the image's text and data bits. +Another reserved symbol, +.Em _DYNAMIC +is used to indicate the presence of the run-time linker structures. +Whenever +.Em _DYNAMIC +is relocated to 0, there is no need to invoke the run-time link-editor. +If this symbol is non-zero, it points at a data structure from +which the location of the necessary relocation and symbol information +can be derived. +This is most notably used by the start-up module, +.Em crt0 . +The _DYNAMIC structure is conventionally located at the start of the data +segment of the image to which it pertains. +.Sh DATA STRUCTURES +The data structures supporting dynamic linking and run-time relocation +reside both in the text and data segments of the image they apply to. +The text segments contain read-only data such as symbols descriptions and +names, while the data segments contain the tables that need to be modified by +during the relocation process. +.Pp +The _DYNAMIC symbol references a +.Fa _dynamic +structure: +.Bd -literal -offset indent +struct _dynamic { + int d_version; + struct so_debug *d_debug; + union { + struct section_dispatch_table *d_sdt; + } d_un; + struct ld_entry *d_entry; +}; +.Ed +.Bl -tag -width d_version +.It Fa d_version +This field provides for different versions of the dynamic linking +implementation. +The current version numbers understood by ld and ld.so are +.Em LD_VERSION_SUN (3) , +which is used by the +.Tn "SunOS 4.x" +releases, and +.Em LD_VERSION_BSD (8) , +which is currently in use by +.Nx . +.It Fa d_un +Refers to a +.Em d_version +dependent data structure. +.It Fa d_debug +this field provides debuggers with a hook to access symbol tables of shared +objects loaded as a result of the actions of the run-time link-editor. +.It Fa d_entry +this field is obsoleted by CRT interface version CRT_VERSION_BSD4, and is +replaced by the crt_ldentry in +.Fa crt_ldso . +.El +.Pp +The +.Fa section_dispatch_table +structure is the main +.Dq dispatcher +table, containing offsets into the image's segments where various symbol +and relocation information is located. +.Bd -literal -offset indent +struct section_dispatch_table { + struct so_map *sdt_loaded; + long sdt_sods; + long sdt_paths; + long sdt_got; + long sdt_plt; + long sdt_rel; + long sdt_hash; + long sdt_nzlist; + long sdt_filler2; + long sdt_buckets; + long sdt_strings; + long sdt_str_sz; + long sdt_text_sz; + long sdt_plt_sz; +}; +.Ed +.Pp +.Bl -tag -width sdt_loaded +.It Fa sdt_loaded +A pointer to the first link map loaded (see below). +This field is set by +.Xr ld.so 1 +for the benefit of debuggers that may use it to load a shared object's +symbol table. +.It Fa sdt_sods +The start of a (linked) list of shared object descriptors needed by +.Em this +object. +.It Fa sdt_paths +Library search rules. +A colon separated list of directories corresponding to the +.Fl R +option of +.Xr ld 1 . +.It Fa sdt_got +The location of the Global Offset Table within this image. +.It Fa sdt_plt +The location of the Procedure Linkage Table within this image. +.It Fa sdt_rel +The location of an array of +.Fa relocation_info +structures +.Po +see +.Xr a.out 5 +.Pc +specifying run-time relocations. +.It Fa sdt_hash +The location of the hash table for fast symbol lookup in this object's +symbol table. +.It Fa sdt_nzlist +The location of the symbol table. +.It Fa sdt_filler2 +Currently unused. +.It Fa sdt_buckets +The number of buckets in +.Fa sdt_hash +.It Fa sdt_strings +The location of the symbol string table that goes with +.Fa sdt_nzlist . +.It Fa sdt_str_sz +The size of the string table. +.It Fa sdt_text_sz +The size of the object's text segment. +.It Fa sdt_plt_sz +The size of the Procedure Linkage Table. +.El +.Pp +A +.Fa sod +structure describes a shared object that is needed +to complete the link edit process of the object containing it. +A list of such objects +.Po +chained through +.Fa sod_next +.Pc +is pointed at +by the +.Fa sdt_sods +in the section_dispatch_table structure. +.Bd -literal -offset indent +struct sod { + long sod_name; + u_int sod_library : 1, + sod_unused : 31; + short sod_major; + short sod_minor; + long sod_next; +}; +.Ed +.Pp +.Bl -tag -width sod_library +.It Fa sod_name +The offset in the text segment of a string describing this link object. +.It Fa sod_library +If set, +.Fa sod_name +specifies a library that is to be searched for by ld.so. +The path name is obtained by searching a set of directories +.Po +see also +.Xr ldconfig 8 +.Pc +for a shared object matching +.Em lib\&<sod_name>\&.so.n.m . +If not set, +.Fa sod_name +should point at a full path name for the desired shared object. +.It Fa sod_major +Specifies the major version number of the shared object to load. +.It Fa sod_minor +Specifies the preferred minor version number of the shared object to load. +.El +.Pp +The run-time link-editor maintains a list of structures called +.Em link maps +to keep track of all shared objects loaded into a process' address space. +These structures are only used at run-time and do not occur within +the text or data segment of an executable or shared library. +.Bd -literal -offset indent +struct so_map { + void *som_addr; + char *som_path; + struct so_map *som_next; + struct sod *som_sod; + void *som_sodbase; + u_int som_write : 1; + struct _dynamic *som_dynamic; + void *som_spd; +}; +.Ed +.Bl -tag -width som_dynamic +.It Fa som_addr +The address at which the shared object associated with this link map has +been loaded. +.It Fa som_path +The full path name of the loaded object. +.It Fa som_next +Pointer to the next link map. +.It Fa som_sod +The +.Fa sod +structure that was responsible for loading this shared object. +.It Fa som_sodbase +Tossed in later versions the run-time linker. +.It Fa som_write +Set if (some portion of) this object's text segment is currently writable. +.It Fa som_dynamic +Pointer to this object's +.Fa _dynamic +structure. +.It Fa som_spd +Hook for attaching private data maintained by the run-time link-editor. +.El +.Pp +Symbol description with size. +This is simply an +.Fa nlist +structure with one field +.Pq Fa nz_size +added. +Used to convey size information on items in the data segment of +shared objects. +An array of these lives in the shared object's text segment and is +addressed by the +.Fa sdt_nzlist +field of +.Fa section_dispatch_table . +.Bd -literal -offset indent +struct nzlist { + struct nlist nlist; + u_long nz_size; +#define nz_un nlist.n_un +#define nz_strx nlist.n_un.n_strx +#define nz_name nlist.n_un.n_name +#define nz_type nlist.n_type +#define nz_value nlist.n_value +#define nz_desc nlist.n_desc +#define nz_other nlist.n_other +}; +.Ed +.Bl -tag -width nz_size +.It Fa nlist +.Po +see +.Xr nlist 3 +.Pc . +.It Fa nz_size +The size of the data represented by this symbol. +.El +.Pp +A hash table is included within the text segment of shared object +to facilitate quick lookup of symbols during run-time link-editing. +The +.Fa sdt_hash +field of the +.Fa section_dispatch_table +structure points at an array of +.Fa rrs_hash +structures: +.Bd -literal -offset indent +struct rrs_hash { + int rh_symbolnum; /* symbol number */ + int rh_next; /* next hash entry */ +}; +.Ed +.Pp +.Bl -tag -width rh_symbolnum +.It Fa rh_symbolnum +The index of the symbol in the shared object's symbol table (as given by the +.Fa ld_symbols +field). +.It Fa rh_next +In case of collisions, this field is the offset of the next entry in this +hash table bucket. +It is zero for the last bucket element. +.El +The +.Fa rt_symbol +structure is used to keep track of run-time allocated commons +and data items copied from shared objects. +These items are kept in a linked list which is exported through the +.Fa dd_cc +field in the +.Fa so_debug +structure (see below) for use by debuggers. +.Bd -literal -offset indent +struct rt_symbol { + struct nzlist *rt_sp; + struct rt_symbol *rt_next; + struct rt_symbol *rt_link; + void *rt_srcaddr; + struct so_map *rt_smp; +}; +.Ed +.Pp +.Bl -tag -width rt_scraddr +.It Fa rt_sp +The symbol description. +.It Fa rt_next +Virtual address of next rt_symbol. +.It Fa rt_link +Next in hash bucket. +Used by internally by ld.so. +.It Fa rt_srcaddr +Location of the source of initialized data within a shared object. +.It Fa rt_smp +The shared object which is the original source of the data that this +run-time symbol describes. +.El +.Pp +The +.Fa so_debug +structure is used by debuggers to gain knowledge of any shared objects +that have been loaded in the process's address space as a result of run-time +link-editing. +Since the run-time link-editor runs as a part of process initialization, +a debugger that wishes to access symbols from shared objects can +only do so after the link-editor has been called from crt0. +A dynamically linked binary contains a +.Fa so_debug +structure which can be located by means of the +.Fa d_debug +field in +.Fa _dynamic . +.Bd -literal -offset indent +struct so_debug { + int dd_version; + int dd_in_debugger; + int dd_sym_loaded; + char *dd_bpt_addr; + int dd_bpt_shadow; + struct rt_symbol *dd_cc; +}; +.Ed +.Pp +.Bl -tag -width dd_in_debugger +.It Fa dd_version +Version number of this interface. +.It Fa dd_in_debugger +Set by the debugger to indicate to the run-time linker that the program is +run under control of a debugger. +.It Fa dd_sym_loaded +Set by the run-time linker whenever it adds symbols by loading shared objects. +.It Fa dd_bpt_addr +The address were a breakpoint will be set by the run-time linker to +divert control to the debugger. +This address is determined by the start-up module, +.Em crt0.o , +to be some convenient place before the call to _main. +.It Fa dd_bpt_shadow +Contains the original instruction that was at +.Fa dd_bpt_addr . +The debugger is expected to put this instruction back before continuing the +program. +.It Fa dd_cc +A pointer to the linked list of run-time allocated symbols that the debugger +may be interested in. +.El +.Pp +The +.Em ld_entry +structure defines a set of service routines within ld.so. +See +.Xr dlfcn 3 +for more information. +.Bd -literal -offset indent +struct ld_entry { + void *(*dlopen)(char *, int); + int (*dlclose)(void *); + void *(*dlsym)(void *, char *); + int (*dlctl)(void *, int, void *); + void (*dlexit)(void); +}; +.Ed +.Pp +The +.Fa crt_ldso +structure defines the interface between ld.so and the start-up code in crt0. +.Bd -literal -offset indent +struct crt_ldso { + int crt_ba; + int crt_dzfd; + int crt_ldfd; + struct _dynamic *crt_dp; + char **crt_ep; + void *crt_bp; + char *crt_prog; + char *crt_ldso; + char *crt_ldentry; +}; +#define CRT_VERSION_SUN 1 +#define CRT_VERSION_BSD2 2 +#define CRT_VERSION_BSD3 3 +#define CRT_VERSION_BSD4 4 +.Ed +.Bl -tag -width crt_dzfd +.It Fa crt_ba +The virtual address at which ld.so was loaded by crt0. +.It Fa crt_dzfd +On +.Tn SunOS +systems, this field contains an open file descriptor to +.Dq /dev/zero +used to get demand paged zeroed pages. +On +.Nx +systems it contains -1. +.It Fa crt_ldfd +Contains an open file descriptor that was used by crt0 to load ld.so. +.It Fa crt_dp +A pointer to main's +.Fa _dynamic +structure. +.It Fa crt_ep +A pointer to the environment strings. +.It Fa crt_bp +The address at which a breakpoint will be placed by the run-time linker +if the main program is run by a debugger. +See +.Fa so_debug +.It Fa crt_prog +The name of the main program as determined by crt0 (CRT_VERSION_BSD3 only). +.It Fa crt_ldso +The path of the run-time linker as mapped by crt0 (CRT_VERSION_BSD4 only). +.It Fa crt_ldentry +The +.Xr dlfcn 3 +entry points provided by the run-time linker (CRT_VERSION_BSD4 only). +.El +.Pp +The +.Fa hints_header +and +.Fa hints_bucket +structures define the layout of the library hints, normally found in +.Dq /var/run/ld.so.hints , +which is used by ld.so to quickly locate the shared object images in the +file system. +The organization of the hints file is not unlike that of an +.Xr a.out 5 +object file, in that it contains a header determining the offset and size +of a table of fixed sized hash buckets and a common string pool. +.Bd -literal -offset indent +struct hints_header { + long hh_magic; +#define HH_MAGIC 011421044151 + long hh_version; +#define LD_HINTS_VERSION_1 1 +#define LD_HINTS_VERSION_2 2 + long hh_hashtab; + long hh_nbucket; + long hh_strtab; + long hh_strtab_sz; + long hh_ehints; + long hh_dirlist; +}; +.Ed +.Bl -tag -width hh_strtab_sz +.It Fa hh_magic +Hints file magic number. +.It Fa hh_version +Interface version number. +.It Fa hh_hashtab +Offset of hash table. +.It Fa hh_strtab +Offset of string table. +.It Fa hh_strtab_sz +Size of strings. +.It Fa hh_ehints +Maximum usable offset in hints file. +.It Fa hh_dirlist +Offset in string table of a colon-separated list of directories that was +used in constructing the hints file. +See also +.Xr ldconfig 8 . +This field is only available with interface version number +.Dv LD_HINTS_VERSION_2 +and higher. +.El +.Pp +.Bd -literal -offset indent +/* + * Hash table element in hints file. + */ +struct hints_bucket { + int hi_namex; + int hi_pathx; + int hi_dewey[MAXDEWEY]; + int hi_ndewey; +#define hi_major hi_dewey[0] +#define hi_minor hi_dewey[1] + int hi_next; +}; +.Ed +.Bl -tag -width hi_ndewey +.It Fa hi_namex +Index of the string identifying the library. +.It Fa hi_pathx +Index of the string representing the full path name of the library. +.It Fa hi_dewey +The version numbers of the shared library. +.It Fa hi_ndewey +The number of valid entries in +.Fa hi_dewey . +.It Fa hi_next +Next bucket in case of hashing collisions. +.El diff --git a/static/netbsd/man5/locale.alias.5 b/static/netbsd/man5/locale.alias.5 new file mode 100644 index 00000000..018b03fb --- /dev/null +++ b/static/netbsd/man5/locale.alias.5 @@ -0,0 +1,84 @@ +.\" $NetBSD: locale.alias.5,v 1.3 2017/07/03 21:30:59 wiz Exp $ +.\" +.\" Copyright (c)2004 Citrus Project, +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd July 22, 2004 +.Dt LOCALE.ALIAS 5 +.Os +.Sh NAME +.Nm locale.alias +.Nd locale alias file +.Sh SYNOPSIS +.Nm locale.alias +.Sh DESCRIPTION +The +.Nm locale.alias +file describes locale aliases. +Each line of this file can be described as the following BNF: +.Bd -literal -offset indent +line := src ws dst +src := locale_name + | locale_category_name +ws := <white spaces> +dst := locale_name + | "/FORCE" +locale_category_name := locale_name '/' category_name +category_name := "LC_CTYPE" + | "LC_COLLATE" + | "LC_TIME" + | "LC_NUMERIC" + | "LC_MONETARY" + | "LC_MESSAGES" +locale_name := <locale name> +.Ed +.Sh FILES +.Bl -tag -width /usr/share/locale/locale.alias -compact +.It Pa /usr/share/locale/locale.alias +This file. +.El +.Sh EXAMPLES +.Bd -literal -offset indent +ja_JP.UTF-8/LC_CTYPE en_US.UTF-8 +.Ed +This means that +.Dq Dv ja_JP.UTF-8 +for +.Dv LC_CTYPE +category is redirected to +.Dq Dv en_US.UTF-8 . +.Bd -literal -offset indent +Pig /FORCE +.Ed +This means that +.Dq Dv Pig +for all categories is forcibly enabled. +.Sh SEE ALSO +.Xr locale 1 , +.Xr nls 7 +.Sh HISTORY +The +.Nm +file appeared in +.Nx 3.0 . diff --git a/static/netbsd/man5/locate.conf.5 b/static/netbsd/man5/locate.conf.5 new file mode 100644 index 00000000..7915f82a --- /dev/null +++ b/static/netbsd/man5/locate.conf.5 @@ -0,0 +1,167 @@ +.\" $NetBSD: locate.conf.5,v 1.12 2020/04/26 00:40:10 simonb Exp $ +.\" +.\" Copyright (c) 2004 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by ITOH Yasufumi. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 April 25, 2020 +.Dt LOCATE.CONF 5 +.Os +.Sh NAME +.Nm locate.conf +.Nd locate database configuration file +.Sh DESCRIPTION +The +.Nm locate.conf +file specifies the behavior of +.Xr locate.updatedb 8 , +which creates the +.Xr locate 1 +database. +.Pp +The +.Nm +file contains a list of newline separated records, +each of which is composed of a keyword and arguments, +which are separated by white space. +Arguments with embedded shell metacharacters must be quoted in +.Xr sh 1 +style. +Lines beginning with +.Dq # +are treated as comments and ignored. +However, a +.Dq # +in the middle of a line does not start a comment. +.Pp +The configuration options are as follows: +.Bl -tag -width XXXXXX +.It Sy database Ar filename +Specify the location of the +.Xr locate 1 +database to be created. +.Pp +Default: +.Pa /var/db/locate.database +.It Sy ignore Ar pattern ... +Ignore files or directories. +When building the database, +do not descend into files or directories +which match one of the specified patterns. +The matched files or directories are not stored to the database. +.Pp +Default: Not specified. +.It Sy ignorecontents Ar pattern ... +Ignore contents of directories. +When building the database, +do not descend into files or directories +which match one of the specified patterns. +The matched files or directories themselves are stored to the database. +.Pp +Default: Not specified. +.It Sy ignorefs Ar type ... +Ignore file system by type, +adding +.Ar type +to the default list. +When building the database, +do not descend into file systems which are of the specified +.Ar type . +The mount points are not stored to the database. +If a +.Dq \&! +is prepended to +.Ar type , +the meaning is negated, +that is, ignore file systems which do not have the type. +As a special case, if +.Dq none +is specified for +.Ar type , +the +.Sy ignorefs +list is cleared and all file systems are traversed. +.Pp +.Ar type +is used as an argument to +.Xr find 1 +.Fl fstype . +The +.Xr sysctl 8 +command can be used to find out the types of file systems +that are available on the system: +.Bd -literal -offset indent +sysctl vfs.generic.fstypes +.Ed +.Pp +Default: !local cd9660 fdesc kernfs procfs +.It Sy searchpath Ar directory ... +Specify base directories to be put in the database. +.Pp +Default: +.Pa / +.It Sy workdir Ar directory +Specify the working directory of locate.updatedb, +in which a temporary file is placed. +The temporary file is a list of all files, +and you should specify a directory that has enough space to hold it. +.Pp +Default: +.Pa /tmp +.El +.Pp +Refer to +.Xr find 1 +for the details of +.Ar pattern +(see +.Fl path +expression) +and +.Ar type +(see +.Fl fstype +expression). +.Sh FILES +.Bl -tag -width /usr/libexec/locate.updatedb -compact +.It Pa /etc/locate.conf +The file +.Nm +resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr find 1 , +.Xr locate 1 , +.Xr locate.updatedb 8 , +.Xr sysctl 8 +.Sh HISTORY +The +.Nm +file format first appeared in +.Nx 2.0 . +.Sh AUTHORS +.An ITOH Yasufumi diff --git a/static/netbsd/man5/login.conf.5 b/static/netbsd/man5/login.conf.5 new file mode 100644 index 00000000..516e203b --- /dev/null +++ b/static/netbsd/man5/login.conf.5 @@ -0,0 +1,424 @@ +.\" $NetBSD: login.conf.5,v 1.32 2025/05/19 19:44:20 bad Exp $ +.\" +.\" Copyright (c) 1995,1996,1997 Berkeley Software Design, Inc. +.\" 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 Berkeley Software Design, +.\" Inc. +.\" 4. The name of Berkeley Software Design, Inc. may not be used to endorse +.\" or promote products derived from this software without specific prior +.\" written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN, INC. ``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 BERKELEY SOFTWARE DESIGN, INC. 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. +.\" +.\" BSDI login.conf.5,v 2.19 1998/02/19 23:39:39 prb Exp +.\" +.Dd July 11, 2015 +.Dt LOGIN.CONF 5 +.Os +.Sh NAME +.Nm login.conf +.Nd login class capability data base +.Sh SYNOPSIS +.Nm login.conf +.Sh DESCRIPTION +The +.Nm login.conf +file describes the various attributes of login classes. +A login class determines what styles of authentication are available +as well as session resource limits and environment setup. +While designed primarily for the +.Xr login 1 +program, +it is also used by other programs, e.g., +.Xr sshd 8 and +.Xr rexecd 8 , +which need to set up a user environment. +.Pp +The class to be used is normally determined by the +.Li class +field in the password file (see +.Xr passwd 5 ) . +The class is used to look up a corresponding entry in the +.Pa login.conf +file. +A special class called +.Dq default +will be used (if it exists) if the field in the password file is empty. +.Sh CAPABILITIES +Refer to +.Xr capfile 5 +for a description of the file layout. +An example entry is: +.Bd -literal -offset indent +classname|Description entry:\\ + :capability=value:\\ + :booleancapability:\\ + \&.\&.\&. + :lastcapability=value: +.Ed +.Pp +All entries in the +.Nm login.conf +file are either boolean or use a `=' to separate the capability +from the value. +The types are described after the capability table. +.Bl -column minpasswordlen program default +.It Sy Name Type Default Description +.\" +.sp +.It Sy copyright Ta file Ta "" Ta +File containing additional copyright information. +(If the file exists, +.Xr login 1 +displays it before the welcome message.) +.\" +.sp +.It Sy coredumpsize Ta size Ta "" Ta +Maximum coredump size. +.\" +.sp +.It Sy cputime Ta time Ta "" Ta +CPU usage limit. +.\" +.sp +.It Sy datasize Ta size Ta "" Ta +Maximum data size. +.\" +.sp +.It Sy filesize Ta size Ta "" Ta +Maximum file size. +.\" +.sp +.It Sy host.allow Ta string Ta "" Ta +A comma-separated list of host name or IP address patterns +from which a class is allowed access. +Access is instead denied from any hosts preceded +by +.Sq Li \&! . +Patterns can contain the +.Xr sh 1 Ns -style +.Sq Li * +and +.Sq Li \&? +wildcards. +The +.Sy host.deny +entry is checked before +.Sy host.allow . +(Currently used only by +.Xr sshd 8 . ) +.\" +.sp +.It Sy host.deny Ta string Ta "" Ta +A comma-separated list of host name or IP address patterns +from which a class is denied access. +Patterns as per +.Sy host.allow , +although a matched pattern that has been negated with +.Sq Li \&! +is ignored. +(Currently used only by +.Xr sshd 8 . ) +.\" +.sp +.It Sy hushlogin Ta bool Ta Li false Ta +Same as having a +.Pa $HOME/.hushlogin +file. +See +.Xr login 1 . +.\" +.sp +.It Sy ignorenologin Ta bool Ta Li false Ta +Not affected by +.Pa nologin +files. +.\" +.sp +.It Sy login-retries Ta number Ta 10 Ta +Maximum number of login attempts allowed. +.\" +.sp +.It Sy login-backoff Ta number Ta 3 Ta +Number of login attempts after which to start random back-off. +.\" +.sp +.It Sy maxproc Ta number Ta "" Ta +Maximum number of processes. +.\" +.sp +.It Sy maxthread Ta number Ta "" Ta +Maximum number of threads. +The first thread of each process is not counted against this. +.\" +.sp +.It Sy memorylocked Ta size Ta "" Ta +Maximum locked in core memory size. +.\" +.sp +.It Sy memoryuse Ta size Ta "" Ta +Maximum in core memoryuse size. +.\" +.sp +.It Sy minpasswordlen Ta number Ta "" Ta +The minimum length a local password may be. +Used by the +.Xr passwd 1 +utility. +.\" +.sp +.It Sy nologin Ta file Ta "" Ta +If the file exists it will be displayed +and the login session will be terminated. +.\" +.sp +.It Sy openfiles Ta number Ta "" Ta +Maximum number of open file descriptors per process. +.\" +.\"XX .sp +.\"XX .It Sy password-dead Ta time Ta Li 0 Ta +.\"XX Length of time a password may be expired but not quite dead yet. +.\"XX When set (for both the client and remote server machine when doing +.\"XX remote authentication), a user is allowed to log in just one more +.\"XX time after their password (but not account) has expired. +.\"XX This allows a grace period for updating their password. +.\" +.sp +.It Sy passwordtime Ta time Ta "" Ta +Used by +.Xr passwd 1 +to set next password expiry date. +.\" +.sp +.It Sy password-warn Ta time Ta Li 2w Ta +If the user's password will expire within this length of time then +warn the user of this. +.\" +.sp +.It Sy path Ta path Ta Li "/bin /usr/bin" Ta +.br +Default search path. +.\" +.sp +.It Sy priority Ta number Ta "" Ta +Initial priority (nice) level. +.\" +.sp +.It Sy requirehome Ta bool Ta Li false Ta +Require home directory to login. +.\" +.sp +.It Sy sbsize Ta size Ta "" Ta +Maximum socket buffer size. +.\" +.sp +.It Sy setenv Ta list Ta "" Ta +Comma or whitespace separated list +of environment variables and values to be set. +Commas and whitespace can be escaped using \e. +.\" +.sp +.It Sy shell Ta program Ta "" Ta +Session shell to execute rather than the shell specified in the password file. +The +.Ev SHELL +environment variable will contain the shell specified in the password file. +.\" +.sp +.It Sy stacksize Ta size Ta "" Ta +Maximum stack size. +.\" +.sp +.It Sy tc Ta string Ta "" Ta +A "continuation" entry, which must be the last capability provided. +More capabilities are read from the named entry. +The capabilities given before +.Sy tc +override those in the entry invoked by +.Sy tc . +.\" +.sp +.It Sy term Ta string Ta Li su Ta +Default terminal type if not able to determine from other means. +.\" +.sp +.It Sy umask Ta number Ta Li 022 Ta +Initial umask. +Should always have a leading +.Li 0 +to assure octal interpretation. +See +.Xr umask 2 . +.\" +.sp +.It Sy vmemoryuse Ta size Ta "" Ta +Maximum virtual address space size. +.\" +.sp +.It Sy welcome Ta file Ta Li /etc/motd Ta +File containing welcome message. +.Xr login 1 +displays this and +.Xr sshd 8 +sends this. +.El +.Pp +The resource limit entries +.Sy ( coredumpsize , +.Sy cputime , +.Sy datasize , +.Sy filesize , +.Sy maxproc , +.Sy memorylocked , +.Sy memoryuse , +.Sy openfiles , +.Sy sbsize , +.Sy stacksize +and +.Sy vmemoryuse ) +actually specify both the maximum and current limits (see +.Xr getrlimit 2 ) . +The current limit is the one normally used, +although the user is permitted to increase the current limit to the +maximum limit. +The maximum and current limits may be specified individually by appending +a +.Sq Sy \-max +or +.Sq Sy \-cur +to the capability name (e.g., +.Sy openfiles-max +and +.Sy openfiles-cur Ns No ) . +.Pp +.Nx +will never define capabilities which start with +.Li x- +or +.Li X- ; +these are reserved for external use (unless included through contributed +software). +.Pp +The argument types are defined as: +.Bl -tag -width programxx +.\" +.It Sy bool +If the name is present, then the boolean value is true; +otherwise, it is false. +.\" +.It Sy file +Path name to a text file. +.\" +.It Sy list +A comma or whitespace separated list of values. +.\" +.It Sy number +A number. +Optionally preceded by a +.Sq Li + +or +.Sq Li - +sign. +A leading +.Li 0x +implies the number is expressed in hexadecimal. +A leading +.Li 0 +implies the number is expressed in octal. +Any other number is treated as decimal. +.\" +.It Sy path +A space separated list of path names. +If a +.Sq Li ~ +is the first character in a path name, the +.Sq Li ~ +is expanded to the user's home directory. +.\" +.It Sy program +A path name to program. +.\" +.It Sy size +A number which expresses a size in bytes. +It may have a trailing +.Li b +to multiply the value by 512, a +.Li k +to multiply the value by 1 K (1024), and a +.Li m +to multiply the value by 1 M (1048576). +.\" +.It Sy time +A time in seconds. +A time may be expressed as a series of numbers +which are added together. +Each number may have a trailing character to +represent time units: +.Bl -tag -width xxx +.\" +.It Sy y +Indicates a number of 365 day years. +.\" +.It Sy w +Indicates a number of 7 day weeks. +.\" +.It Sy d +Indicates a number of 24 hour days. +.\" +.It Sy h +Indicates a number of 60 minute hours. +.\" +.It Sy m +Indicates a number of 60 second minutes. +.\" +.It Sy s +Indicates a number of seconds. +.El +.Pp +For example, to indicate 1 and 1/2 hours, the following string +could be used: +.Li 1h30m . +.El +.\" +.Sh FILES +.Bl -tag -width /etc/login.conf.db -compact +.It Pa /etc/login.conf +login class capability database +.It Pa /etc/login.conf.db +hashed database built with +.Xr cap_mkdb 1 +.El +.Sh SEE ALSO +.Xr cap_mkdb 1 , +.Xr login 1 , +.Xr login_cap 3 , +.Xr capfile 5 , +.Xr ttys 5 , +.Xr ftpd 8 , +.Xr sshd 8 +.Sh HISTORY +The +.Nm +configuration file appeared in +.Nx 1.5 . diff --git a/static/netbsd/man5/mixerctl.conf.5 b/static/netbsd/man5/mixerctl.conf.5 new file mode 100644 index 00000000..9b847b4d --- /dev/null +++ b/static/netbsd/man5/mixerctl.conf.5 @@ -0,0 +1,114 @@ +.\" $NetBSD: mixerctl.conf.5,v 1.7 2017/07/03 21:30:59 wiz Exp $ +.\" +.\" Copyright 2002 Jared D. McNeill <jmcneill@NetBSD.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 April 5, 2003 +.Dt MIXERCTL.CONF 5 +.Os +.Sh NAME +.Nm mixerctl.conf +.Nd audio mixer configuration file +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +The +.Pa /etc/mixerctl.conf +file consists of +.Xr mixerctl 1 +variables to set at boot time. +Each line of +.Nm +has the following format: +.Dl variable=value +.Pp +To generate a +.Nm +from the current mixer settings, execute: +.Dl Ic mixerctl -a > /etc/mixerctl.conf +.Pp +Set +.Sy mixerctl +to YES in +.Xr rc.conf 5 +to have the variables set at boot time. +Additionally, you can have the settings saved +and restored for the devices of your choice by listing them in +.Sy mixerctl_mixers +in +.Xr rc.conf 5 . +.Sh FILES +.Bl -tag -width /etc/mixerctl.conf -compact +.It Pa /etc/mixerctl.conf +.El +.Sh EXAMPLES +Example mixer settings for an +.Xr esa 4 +audio adapter: +.Bd -literal +outputs.master=255,255 +outputs.master.mute=off +outputs.mono=255 +outputs.mono.mute=on +outputs.mono.source=mixerout +outputs.headphones=255,255 +outputs.headphones.mute=off +outputs.tone=255,255 +inputs.speaker=255 +inputs.speaker.mute=off +inputs.phone=191 +inputs.phone.mute=on +inputs.mic=191 +inputs.mic.mute=on +inputs.mic.preamp=off +inputs.mic.source=mic0 +inputs.line=191,191 +inputs.line.mute=on +inputs.cd=191,191 +inputs.cd.mute=on +inputs.video=255,255 +inputs.video.mute=off +inputs.aux=255,255 +inputs.aux.mute=off +inputs.dac=191,191 +inputs.dac.mute=off +record.source=mic +record.volume=255,255 +record.volume.mute=off +record.mic=0 +record.mic.mute=off +outputs.loudness=off +outputs.spatial=off +outputs.spatial.center=0 +outputs.spatial.depth=0 +.Ed +.Sh SEE ALSO +.Xr mixerctl 1 , +.Xr rc.conf 5 +.Sh HISTORY +The +.Nm +configuration file first appeared in +.Nx 2.0 . diff --git a/static/netbsd/man5/mk.conf.5 b/static/netbsd/man5/mk.conf.5 new file mode 100644 index 00000000..43088309 --- /dev/null +++ b/static/netbsd/man5/mk.conf.5 @@ -0,0 +1,3107 @@ +.\" $NetBSD: mk.conf.5,v 1.122 2026/04/08 05:19:05 lukem Exp $ +.\" +.\" Copyright (c) 1999-2026 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Luke Mewburn. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 April 8, 2026 +.Dt MK.CONF 5 +.Os +.\" turn off hyphenation +.hym 999 +. +.Sh NAME +.Nm mk.conf +.Nd make configuration file +. +.Sh DESCRIPTION +The +.Nm +file overrides various parameters used during the build of the system. +. +.Sh NETBSD SYSTEM VARIABLES +. +Listed below are the +.Nm +variables that may be set that affect the +.Nx +system build, +the values to which each may be set, +a brief description of what each variable does, +references to relevant manual pages, +notes (including any interaction with +.Sy build.sh ) , +and the default value of each variable. +. +.de DFLT +.Pp +.Em Default : +.. +.de DFLTn +.DFLT +.Dq no . +.. +.de DFLTu +.DFLT +Unset. +.. +.de DFLTy +.DFLT +.Dq yes . +.. +.de NODEF +.Pp +Forced to +.Dq no +if +.Sy \\$* +is defined, +usually in the Makefile before any +.Xr make 1 +.Cm \&.include +directives. +.. +.de NOVAR +.Pp +Forced to +.Dq no +if +.Sy \\$* . +.. +.de YorN +Can be set to +.Dq yes +or +.Dq no . +.. +. +.Bl -tag -width 14n +. +.\" These entries are sorted alphabetically. +. +.It Sy BSDOBJDIR +The real path to the object directory tree for the +.Nx +source tree. +.DFLT +.Dq Pa /usr/obj . +. +.It Sy BSDSRCDIR +The real path to the +.Nx +source tree, if +.Sy NETBSDSRCDIR +isn't defined. +.DFLT +.Dq Pa /usr/src . +. +.It Sy BUILD +If defined, +.Sq "make install" +checks that the +.Xr make 1 +targets in the source directories are up-to-date and +re-makes them if they are out of date, instead of blindly trying to install +out of date or non-existent +.Xr make 1 +targets. +.DFLTu +. +.It Sy BUILDID +Identifier for the build. +If set, this should be a short string that is suitable for use as +part of a file or directory name. +The identifier will be appended to object directory names; if +.Sy OBJMACHINE +is also set, then +.Pa \&. Ns Sy BUILDID +is appended after +.Pa \&. Ns Sy MACHINE . +The identifier will also be used as part of the kernel version string, +which can be shown by +.Dq Li uname \-v . +.DFLTu +. +.It Sy BUILDINFO +Optional multi-line string containing information about the build. +This will appear in +.Sy DESTDIR Ns Pa /etc/release , +and it will be stored in the +.Va buildinfo +variable in any kernels that are built. +When such kernels are booted, the +.Xr sysctl 7 +.Va kern.buildinfo +variable will report this value. +The string may contain backslash escape sequences, such as +.Dq "\e\e" +(representing a backslash character) +and +.Dq "\en" +(representing a newline). +.DFLTu +. +.It Sy BUILDSEED +.Xr g++ 1 +uses random numbers when compiling C++ code. +This variable seeds the +.Xr g++ 1 +random number generator using +.Fl frandom-seed +with this value. +By default, it is set to +.Do NetBSD-( Ns Em majorversion ) Dc . +Using a fixed value causes C++ binaries to be the same when +built from the same sources, resulting in identical (reproducible) builds. +Additional information is available in the +.Xr g++ 1 +documentation of +.Fl frandom-seed . +.DFLTu +. +.It Sy CDEXTRA +A space-separated list of files or directories that will be +added to the CD-ROM image that may be created by the +.Sy build.sh +.Dq iso-image +or +.Dq iso-image-source +operations. +Files will be added to the root of the CD-ROM image, +whereas directories will be copied recursively. +If relative paths are specified, they will be converted to +absolute paths before being used. +.Em Note : +If using +.Sy build.sh , +multiple paths may be specified via multiple +.Fl C +options, or via a single option whose argument contains multiple +space-separated paths. +.DFLTu +. +.It Sy CONFIGOPTS +Additional options to +.Xr config 1 +when building kernels. +.DFLTu +. +.It Sy COPTS +Extra options for the C compiler. +Should be appended to (e.g., +.Sy COPTS+=-g ) , +rather than explicitly set. +.Pp +.Em Note : +.Sy CPUFLAGS , +not +.Sy COPTS , +should be used for +compiler options that select CPU-related options. +.Pp +.Em Note : +.Sy CFLAGS +should never be set in +.Nm . +. +.It Sy CPUFLAGS +Additional options passed to the compiler/assembler to select +CPU instruction set options, CPU tuning options, etc. +.Pp +.Em Note : +Such options should not be specified in +.Sy COPTS , +because some parts of the build process need to override +CPU-related compiler options. +.DFLTu +. +.It Sy DESTDIR +Directory to contain the built +.Nx +system. +If set, special options are passed to the compilation tools to +prevent their default use of the host system's +.Sy /usr/include , /usr/lib , +and so forth. +This pathname must be an absolute path, and should +.Em not +end with a slash +.Pq / +character. +(For installation into the system's root directory, set +.Sy DESTDIR +to an empty string, not to +.Dq / ) . +The directory must reside on a file system which supports long file +names and hard links. +.Pp +.Em Note : +.Sy build.sh +will provide a default of +.Dq Pa destdir . Ns Sy MACHINE +(in the top-level +.Sy .OBJDIR ) +unless run in +.Sq expert +mode with the +.Fl E +option. +.DFLT +Empty string if +.Sy USETOOLS=yes ; +otherwise unset. +. +.It Sy EXTERNAL_TOOLCHAIN +If defined, this variable indicates the root directory of +an external toolchain which will be used to build the tree. +For example, if a platform is a +.Sy TOOLCHAIN_MISSING +platform, +.Sy EXTERNAL_TOOLCHAIN +can be used to re-enable the cross-compile framework. +.Pp +If +.Sy EXTERNAL_TOOLCHAIN +is defined, act as +.Sy MKGCC=no , +since the external version of the compiler may not be +able to build the library components of the in-tree compiler. +.Pp +This variable should be used in conjunction with an appropriate +.Sy HAVE_GCC +or +.Sy HAVE_LLVM +setting to control the compiler options. +.Pp +.Em Note : +This variable is not yet used in as many places as it should be. +Expect the exact semantics of this variable to change in the short +term as parts of the cross-compile framework continue to be cleaned up. +.DFLTu +. +.It Sy INSTALLBOOT_BOARDS +A list of +.Sy evbarm +boards for which to create bootable images. +If corresponding U-Boot packages are installed, +bootable images are created as part of a release. +See the +.Bk -words +.Fl o Sy board= Ns Ar name +.Ek +option of +.Xr installboot 8 . +.DFLTu +. +.It Sy INSTALLWORLDDIR +Directory for the top-level +.Xr make 1 +.Dq installworld +target to install to. +If specified, must be an absolute path. +.DFLT +.Dq Pa / . +. +.It Sy KERNARCHDIR +Directory under +.Sy KERNSRCDIR +containing the machine dependent kernel sources. +.DFLT +.Dq Pa arch/ Ns Sy MACHINE . +. +.It Sy KERNCONFDIR +Directory containing the kernel configuration files. +.DFLT +.Dq Sy KERNSRCDIR Ns Pa / Ns Sy KERNARCHDIR Ns Pa /conf . +. +.It Sy KERNEL_DIR Pq No experimental +.YorN +Indicates if a top-level directory +.Sy /netbsd/ +is created. +If +.Dq yes , +the directory will contain a kernel file +.Pa /netbsd/kernel +and a corresponding modules directory +.Pa /netbsd/modules/ . +System bootstrap procedures will be modified to search for the kernel +and modules in the +.Pa /netbsd/ +directory. +This is intended to simplify system upgrade and rollback procedures by +keeping the kernel and its associated modules together in one place. +.Pp +If +.Dq no , +the kernel file will be stored in +.Pa /netbsd +and the modules will be stored within the +.Pa /stand/${ARCH}/ +directory hierarchy. +.Pp +The +.Sy KERNEL_DIR +option is currently available only for amd64 and i386 platforms. +It is a work-in-progress, and is highly experimental. +It is also subject to change without notice. +.DFLTn +. +.It Sy KERNOBJDIR +Directory for kernel builds. +For example, the kernel +.Sy GENERIC +will be compiled in +.Sy KERNOBJDIR Ns Pa /GENERIC . +.DFLT +.Dq Sy MAKEOBJDIRPREFIX Ns Pa / Ns Sy KERNSRCDIR Ns Pa / Ns Sy KERNARCHDIR Ns Pa /compile +if it exists or the +.Xr make 1 +.Dq obj +target is being made; +otherwise +.Dq Sy KERNSRCDIR Ns Pa / Ns Sy KERNARCHDIR Ns Pa /compile . +. +.It Sy KERNSRCDIR +Directory at the top of the kernel source. +.DFLT +.Dq Sy NETBSDSRCDIR Ns Pa /sys . +. +.It Sy LOCALTIME +The name of the +.Xr tzfile 5 +timezone file in the directory +.Pa /usr/share/zoneinfo +to symbolically link +.Sy DESTDIR Ns Pa /etc/localtime +to. +.DFLT +.Dq UTC . +. +.It Sy MAKEVERBOSE +Level of verbosity of status messages. +Supported values: +.Bl -tag -width 2n +.It 0 +No descriptive messages or commands executed by +.Xr make 1 +are shown. +.It 1 +Brief messages are shown describing what is being done, +but the actual commands executed by +.Xr make 1 +are not shown. +.It 2 +Descriptive messages are shown as above (prefixed with a +.Sq # ) , +and ordinary commands performed by +.Xr make 1 +are shown. +.It 3 +In addition to the above, all commands performed by +.Xr make 1 +are shown, even if they would ordinarily have been hidden +through use of the +.Dq \&@ +prefix in the relevant makefile. +.It 4 +In addition to the above, commands executed by +.Xr make 1 +are traced through use of the +.Xr sh 1 +.Dq Fl x +flag. +.El +.DFLT +.Sy 2 . +. +.It Sy MKADOSFS +.YorN +Indicates whether support for the AmigaDOS file system +will be build and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKAMDGPUFIRMWARE +.YorN +Indicates whether to install the +.Pa /libdata/firmware/amdgpu +directory, which is necessary for the +.Xr amdgpu 4 +AMD RADEON GPU video driver. +.DFLT +.Dq yes +on +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKARGON2 +.YorN +Indicates whether the Argon2 hash is enabled in libcrypt. +.DFLTy +. +.It Sy MKARZERO +.YorN +Indicates whether +.Xr ar 1 +should zero the timestamp, uid, and gid in the archive +for reproducible builds. +.DFLT +The value of +.Sy MKREPRO +(if defined), otherwise +.Dq no . +. +.It Sy MKATF +.YorN +Indicates whether the Automated Testing Framework (ATF) +will be built and installed. +This also controls whether the +.Nx +test suite will be built and installed, +as the tests rely on ATF and cannot be built without it. +.NOVAR MKCXX=no +.DFLTy +. +.It Sy MKAUDIO +.YorN +Indicates whether audio-related programs +.Po +.Xr aiomixer 1 , +.Xr audiocfg 1 , +.Xr audioctl 1 , +.Xr audioplay 1 , +.Xr audiorecord 1 , +.Xr hdaudioctl 8 +.Pc +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKAUTOFS +.YorN +Indicates whether support for the automounter file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKBIND +.YorN +Indicates whether the BIND Internet domain name server +.Pq Xr named 8 +and associated tools or libraries will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKBINUTILS +.YorN +Indicates whether any of the binutils tools or libraries +will be built and installed. +That is, the libraries +.Sy libbfd , +.Sy libiberty , +or any of the things that depend upon them, e.g. +.Xr as 1 , +.Xr ld 1 , +.Xr dbsym 8 , +or +.Xr mdsetimage 8 . +.NOVAR TOOLCHAIN_MISSING!=no +.DFLTy +. +.It Sy MKBLUETOOTH +.YorN +Indicates whether support for Bluetooth tools and libraries +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKBSDDIFF +.YorN +Determines which implementation of +.Xr diff 1 +will be built and installed. +If +.Dq yes , +use the BSD implementation. +If +.Dq no , +use the GNU implementation. +.DFLTn +. +.It Sy MKBSDGREP +.YorN +Determines which implementation of +.Xr grep 1 +will be built and installed. +If +.Dq yes , +use the BSD implementation. +If +.Dq no , +use the GNU implementation. +.DFLTn +. +.It Sy MKBSDTAR +.YorN +Determines which implementation of +.Xr cpio 1 +and +.Xr tar 1 +will be built and installed. +If +.Dq yes , +use the +.Sy libarchive Ns - Ns +based implementations. +If +.Dq no , +use the +.Xr pax 1 +based implementations. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKCATPAGES +.YorN +Indicates whether preformatted plaintext manual pages will be created +and installed. +.NOVAR MKMAN=no No or Sy MKSHARE=no +.DFLTn +. +.It Sy MKCD9660FS +.YorN +Indicates whether support for the ISO-9660 file system +will be build and installed. +.DFLTy +. +.It Sy MKCHFS +.YorN +Indicates whether support for the CHFS flash file system +will be build and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKCLEANSRC +.YorN +Indicates whether +.Sq "make clean" +and +.Sq "make cleandir" +will delete file names in +.Sy CLEANFILES +or +.Sy CLEANDIRFILES +from both the object directory, +.Sy .OBJDIR , +and the source directory, +.Sy .SRCDIR . +.Pp +If +.Dq yes , +then these file names will be deleted relative to both +.Sy .OBJDIR +and +.Sy .CURDIR . +If +.Dq no , +then the deletion will be performed relative to +.Sy .OBJDIR +only. +.DFLTy +. +.It Sy MKCLEANVERIFY +.YorN +Controls whether +.Sq "make clean" +and +.Sq "make cleandir" +will verify that files have been deleted. +If +.Dq yes , +then file deletions will be verified using +.Xr ls 1 . +If +.Dq no , +then file deletions will not be verified. +.DFLTy +. +.It Sy MKCOMPAT +.YorN +Indicates whether support for multiple ABIs is to be built and +installed. +.NODEF NOCOMPAT +.DFLT +.Dq yes +on +.Sy aarch64 +(without gcc), +.Sy earm* +(to support compatibility between OABI and EABI binaries), +.Sy mips64 , +.Sy powerpc64 , +.Sy riscv64 , +.Sy sparc64 , +and +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKCOMPATMODULES +.YorN +Indicates whether the compat kernel modules will be built and installed. +.NOVAR MKCOMPAT=no +.DFLT +.Dq yes +on +.Sy evbppc-powerpc +and +.Sy mips64 ; +.Dq no +on other platforms. +. +.It Sy MKCOMPATTESTS +.YorN +Indicates whether the +.Nx +test suite for +.Pa src/compat +will be built and installed. +.NOVAR MKCOMPAT=no +.DFLTn +. +.It Sy MKCOMPATX11 +.YorN +Indicates whether the X11 libraries will be built and installed. +.NOVAR MKCOMPAT=no +.DFLTn +. +.It Sy MKCOMPLEX +.YorN +Indicates whether the +.Lb libm +is compiled with support for +.In complex.h . +.DFLTy +. +.It Sy MKCROSSGDB +.YorN +Create a cross-gdb as a host tool. +.DFLTn +. +.It Sy MKCTF +.YorN +Indicates whether CTF tools are to be built and installed. +If +.Dq yes , +the tools will be used to generate and manipulate +CTF data of ELF binaries during build. +.NODEF NOCTF +.Pp +This is disabled internally for standalone programs in +.Pa /usr/mdec . +.DFLT +.Dq yes +on +.Sy aarch64 , +.Sy earm* , +.Sy i386 , +and +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKCVS +.YorN +Indicates whether +.Xr cvs 1 +will be built and installed. +.DFLTy +. +.It Sy MKCXX +.YorN +Indicates whether C++ support is enabled. +.Pp +If +.Dq no , +C++ compilers and software will not be built, +and acts as +.Sy MKATF=no MKGCCCMDS=no MKGDB=no MKGROFF=no MKKYUA=no . +.DFLTy +. +.It Sy MKDEBUG +.YorN +Indicates whether debug information should be generated for +all userland binaries. +The result is collected as an additional +.Sy debug +and +.Sy xdebug +set and installed in +.Sy DESTDIR Ns Pa /usr/libdata/debug . +.NODEF NODEBUG +.Pp +If +.Dq yes , +acts as +.Sy MKSTRIPSYM=no . +. +.DFLTn +. +.It Sy MKDEBUGKERNEL +.YorN +Indicates whether debugging symbols will be built for kernels +by default; pretend as if +.Em makeoptions DEBUG="-g" +is specified in kernel configuration files. +This will also put the debug kernel +.Pa netbsd.gdb +in the kernel sets. +See +.Xr options 4 +for details. +This is useful if a cross-gdb is built as well (see +.Sy MKCROSSGDB ) . +.DFLTn +. +.It Sy MKDEBUGLIB +.YorN +Indicates whether debug libraries +.Sy ( lib*_g.a ) +will be built and installed. +Debug libraries are compiled with +.Dq Li -g -DDEBUG . +.NODEF NODEBUGLIB +.DFLTn +. +.It Sy MKDEBUGTOOLS +.YorN +Indicates whether debug information +.Sy ( lib*_g.a ) +will be included in the build toolchain. +.DFLTn +. +.It Sy MKDEPINCLUDES +.YorN +Indicates whether to add +.Cm \&.include +statements in the +.Pa .depend +files instead of inlining the contents of the +.Pa *.d +files. +This is useful when stale dependencies are present, +to list the exact files that need refreshing, but +it is possibly slower than inlining. +.DFLTn +. +.It Sy MKDOC +.YorN +Indicates whether system documentation destined for +.Sy DESTDIR Ns Pa /usr/share/doc +will be installed. +.NODEF NODOC +.NOVAR MKSHARE=no +.DFLTy +. +.It Sy MKDTB +.YorN +Indicates whether the devicetree blobs will be built and installed. +.DFLT +.Dq yes +on +.Sy aarch64 , +.Sy aarch64eb , +.Sy earmv5* , +.Sy earmv6* , +.Sy earmv7* , +.Sy riscv32 , +and +.Sy riscv64 ; +.Dq no +on other platforms. +. +.It Sy MKDTC +.YorN +Indicates whether the Device Tree Compiler (dtc) will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKDTRACE +.YorN +Indicates whether the kernel modules, utilities, and libraries for +.Xr dtrace 1 +support are to be built and installed. +.DFLT +.Dq yes +on +.Sy aarch64 , +.Sy i386 , +and +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKDYNAMICROOT +.YorN +Indicates whether all programs should be dynamically linked, +and to install shared libraries required by +.Pa /bin +and +.Pa /sbin +and the shared linker +.Xr ld.elf_so 1 +into +.Pa /lib . +If +.Dq no , +link programs in +.Pa /bin +and +.Pa /sbin +statically. +.DFLT +.Dq no +on +.Sy ia64 ; +.Dq yes +on other platforms. +. +.It Sy MKEFS +.YorN +Indicates whether support for the SGI EFS file system +will be build and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKEXT2FS +.YorN +Indicates whether support for the EXT2 file system +will be build and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKFDESCFS +.YorN +Indicates whether support for the file descriptor file system +will be build and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKFIDO2 +.YorN +Indicates whether support for the Fast Identity Online 2 +.Pq FIDO2 +libraries and tools will be built and installed. +.Pp +.Em Note : +If +.Dq yes , +requires +.Sy MKUSB=yes . +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKFILECOREFS +.YorN +Indicates whether support for the Acorn FILECORE file system +will be build and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKFIRMWARE +.YorN +Indicates whether to install the +.Pa /libdata/firmware +directory, which is necessary for various drivers, including: +.Xr athn 4 , +.Xr bcm43xx 4 , +.Xr bwfm 4 , +.Xr ipw 4 , +.Xr iwi 4 , +.Xr iwm 4 , +.Xr iwn 4 , +.Xr otus 4 , +.Xr ral 4 , +.Xr rtwn 4 , +.Xr rum 4 , +.Xr run 4 , +.Xr urtwn 4 , +.Xr wpi 4 , +.Xr zyd 4 , +and the Tegra 124 SoC. +.DFLT +.Dq yes +on +.Sy amd64 , +.Sy cobalt , +.Sy evbarm , +.Sy evbmips , +.Sy evbppc , +.Sy hpcarm , +.Sy hppa , +.Sy i386 , +.Sy mac68k , +.Sy macppc , +.Sy riscv , +.Sy sandpoint , +and +.Sy sparc64 ; +.Dq no +on other platforms. +. +.It Sy MKGCC +.YorN +Indicates whether +.Xr gcc 1 +or any related libraries +.Pq Sy libg2c , libgcc , libobjc , libstdc++ +will be built and installed. +.NOVAR TOOLCHAIN_MISSING!=no No or Sy EXTERNAL_TOOLCHAIN No is defined +.DFLTy +. +.It Sy MKGCCCMDS +.YorN +Indicates whether +.Xr gcc 1 +will be built and installed. +If +.Dq no , +then +.Sy MKGCC +controls if the +GCC libraries will be built and installed. +.NOVAR MKCXX=no +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKGDB +.YorN +Indicates whether +.Xr gdb 1 +will be built and installed. +.NOVAR MKCXX=no No or Sy TOOLCHAIN_MISSING!=no +.DFLT +.Dq no +on +.Sy ia64 +and +.Sy or1k ; +.Dq yes +on other platforms. +. +.It Sy MKGDBSERVER +.YorN +Indicates whether +.Xr gdbserver 1 +will be built and installed. +.Pp +Only used if +.Sy MKGDB=yes . +.DFLT +.Dq yes +on +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKGROFF +.YorN +Indicates whether +.Xr groff 1 +will be built, installed, +and used to format some of the PostScript and PDF +documentation. +.NOVAR MKCXX=no +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKGROFFHTMLDOC +.YorN +Indicates whether to use +.Xr groff 1 +to generate HTML for miscellaneous articles which +sometimes requires software not in the base installation. +Does not affect the generation of HTML man pages. +.DFLTn +. +.It Sy MKHESIOD +.YorN +Indicates whether the Hesiod infrastructure +(libraries and support programs) will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKHFS +.YorN +Indicates whether support for the Apple HFS+ file system +will be build and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKHOSTOBJ +.YorN +If +.Dq yes , +then for programs intended to be run on the compile host, +the name, release, and architecture of the host operating system +will be suffixed to the name of the object directory created by +.Dq make obj . +(This allows multiple host systems to compile +.Nx +for a single target architecture.) +If +.Dq no , +then programs built to be run on the compile host will use the same +object directory names as programs built to be run on the target +architecture. +.DFLTn +. +.It Sy MKHTML +.YorN +Indicates whether the HTML manual pages are created and installed. +.NODEF NOHTML +.NOVAR MKMAN=no No or Sy MKSHARE=no +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKIEEEFP +.YorN +Indicates whether code for IEEE754/IEC60559 conformance +will be built and installed. +Has no effect on most platforms. +.DFLTy +. +.It Sy MKINET6 +.YorN +Indicates whether INET6 (IPv6) infrastructure +(libraries and support programs) will be built and installed. +.Pp +.Em Note : +.Sy MKINET6 +must not be set to +.Dq no +if +.Sy MKX11!=no . +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKINFO +.YorN +Indicates whether GNU Info files, used for the documentation for +most of the compilation tools, will be built and installed. +.NODEF NOINFO +.NOVAR MKSHARE=no +.DFLTy +. +.It Sy MKIPFILTER +.YorN +Indicates whether the +.Xr ipf 4 +programs, headers, and other components will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKIPSEC +.YorN +Indicated whether support for IP Security +.Pq Xr ipsec 4 +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKISCSI +.YorN +Indicates whether the iSCSI library and applications are +built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKKERBEROS +.YorN +Indicates whether the Kerberos v5 infrastructure +(libraries and support programs) will be built and installed. +Caution: the default +.Xr pam 8 +configuration requires that Kerberos be present even if not used. +Do not install a userland without Kerberos without also either +updating the +.Xr pam.conf 5 +files or disabling PAM via +.Sy MKPAM . +Otherwise all logins will fail. +.DFLTy +. +.It Sy MKKERNFS +.YorN +Indicates whether support for the kernel data +.Pq Pa /kern +file system will be build and installed. +.DFLTy +. +.It Sy MKKMOD +.YorN +Indicates whether kernel modules will be built and installed. +.DFLT +.Dq no +on +.Sy or1k ; +.Dq yes +on other platforms. +. +.It Sy MKKYUA +.YorN +Indicates whether Kyua (the testing infrastructure used by +.Nx ) +will be built and installed. +.NOVAR MKCXX=no +.Pp +.Em Note : +This does not control the installation of the tests themselves. +The tests rely on the ATF libraries and therefore their build is controlled +by the +.Sy MKATF +variable. +.DFLT +.Dq no +until the import of Kyua is done and validated. +. +.It Sy MKLDAP +.YorN +Indicates whether the Lightweight Directory Access Protocol (LDAP) +infrastructure +(libraries and support programs) will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKLFS +.YorN +Indicates whether support for the BSD log-structured file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKLIBCSANITIZER +.YorN +Indicates whether to use the sanitizer for libc, +using the sanitizer defined by +.Sy USE_LIBCSANITIZER . +.NODEF NOLIBCSANITIZER +.DFLTn +. +.It Sy MKLIBCXX +.YorN +Indicates if libc++ will be built and installed +(usually for +.Xr clang++ 1 ) . +.DFLT +.Dq yes +if +.Sy MKLLVM=yes +and on +.Sy aarch64* , +.Sy earm* , +.Sy i386 , +.Sy powerpc , +.Sy powerpc64 , +.Sy sparc , +.Sy sparc64 , +or +.Sy x86_64 ; +otherwise +.Dq no . +. +.It Sy MKLIBSTDCXX +.YorN +Indicates if libstdc++ will be built and installed +(usually for +.Xr g++ 1 ) . +.DFLTy +. +.It Sy MKLINKLIB +.YorN +Indicates whether all of the shared library infrastructure +will be built and installed. +.Pp +If +.Dq no , +prevents: +.Bl -dash -compact +.It +installation of the +.Sy *.a +libraries +.It +installation of the +.Sy *_pic.a +libraries on PIC systems +.It +building of +.Sy *.a +libraries on PIC systems +.It +installation of +.Sy .so +symlinks on ELF systems +.El +.Pp +I.e, only install the shared library (and the +.Pa .so.major +symlink on ELF). +.NODEF NOLINKLIB +.Pp +If +.Dq no , +acts as +.Sy MKLINT=no MKPICINSTALL=no MKPROFILE=no . +.DFLTy +. +.It Sy MKLINT +.YorN +Indicates whether +.Xr lint 1 +will be run against portions of the +.Nx +source code during the build, and whether lint libraries will be +installed into +.Sy DESTDIR Ns Pa /usr/libdata/lint . +.NODEF NOLINT +.NOVAR MKLINKLIB=no +.DFLTn +. +.It Sy MKLLVM +.YorN +Indicates whether +.Xr clang 1 +is installed as a host tool and target compiler. +.Pp +If +.Dq yes , +acts as +.Sy MKLIBCXX=yes +on various platforms. +.Pp +.Em Note : +Use of +.Xr clang 1 +as the system compiler is controlled by +.Sy HAVE_LLVM . +.DFLTn +. +.It Sy MKLLVMRT +.YorN +Indicates whether to build the LLVM PIC libraries necessary +for the various Mesa backend and the native JIT of the target +architecture, if supported. +(Radeon R300 and newer, LLVMPIPE for most.) +.DFLT +If +.Sy MKX11=yes +and +.Sy HAVE_MESA_VER>=19 , +.Dq yes +on +.Sy aarch64 , +.Sy amd64 , +and +.Sy i386 ; +otherwise +.Dq no . +. +.It Sy MKLVM +.YorN +If not +.Dq no , +build and install the logical volume manager. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKMAKEMANDB +.YorN +Indicates if the whatis tools +.Xr ( apropos 1 , +.Xr whatis 1 , +.Xr getNAME 8 , +.Xr makemandb 8 , +and +.Xr makewhatis 8 ) , +should be built, installed, and used to +create and install the +.Pa whatis.db . +.DFLTy +. +.It Sy MKMAN +.YorN +Indicates whether manual pages will be installed. +.NODEF NOMAN +.NOVAR MKSHARE=no +.Pp +If +.Dq no , +acts as +.Sy MKCATPAGES=no MKHTML=no . +.DFLTy +. +.It Sy MKMANDOC +.YorN +Indicates whether +.Xr mandoc 1 +will be built and installed, and used to create and install +catman and HTML pages. +.Pp +If +.Dq no , +use +.Xr groff 1 +instead of +.Xr mandoc 1 . +.NODEF NOMANDOC No or Sy NOMANDOC . Ns Ar target No (for a given Xr make 1 target Ar target ) +.Pp +Only used if +.Sy MKMAN=yes . +.DFLTy +. +.It Sy MKMANZ +.YorN +Indicates whether manual pages should be compressed with +.Xr gzip 1 +at installation time. +.Pp +Only used if +.Sy MKMAN=yes . +.DFLTn +. +.It Sy MKMDNS +.YorN +Indicates whether the mDNS (Multicast DNS) infrastructure +(libraries and support programs) will be built and installed. +.DFLTy +. +.It Sy MKMSDOSFS +.YorN +Indicates whether support for the MS-DOS FAT file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKNFS +.YorN +Indicates whether support for the NFS network file system +will be built and installed. +.DFLTy +. +.It Sy MKNILFS +.YorN +Indicates whether support for the NILFS log-structured file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKNLS +.YorN +Indicates whether Native Language System (NLS) locale zone files will be +built and installed. +.NODEF NONLS +.NOVAR MKSHARE=no +.DFLTy +. +.It Sy MKNOUVEAUFIRMWARE +.YorN +Indicates whether to install the +.Pa /libdata/firmware/nouveau +directory, which is necessary for the +.Xr nouveau 4 +NVIDIA video driver. +.DFLT +.Dq yes +on +.Sy aarch64 , +.Sy i386 , +and +.Sy x86_64 , +.Dq no +on other platforms. +. +.It Sy MKNPF +.YorN +Indicates whether the +.Xr npf 7 +packet filter is to be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKNSD +.YorN +Indicates whether the Name Server Daemon (NSD) is to be built and installed. +.DFLTn +. +.It Sy MKNTFS +.YorN +Indicates whether support for the NTFS file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKNULLFS +.YorN +Indicates whether support for the NULLFS loopback file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKOBJ +.YorN +Indicates whether object directories will be created when running +.Dq make obj . +If +.Dq no , +then all built files will be located inside the regular source tree. +.NODEF NOOBJ +.Pp +If +.Dq no , +acts as +.Sy MKOBJDIRS=no . +.Pp +.Em Note : +Setting +.Sy MKOBJ +to +.Dq no +is not recommended and may cause problems when updating the tree with +.Xr cvs 1 . +.DFLTy +. +.It Sy MKOBJDIRS +.YorN +Indicates whether object directories will be created automatically +(via a +.Dq make obj +pass) at the start of a build. +.NOVAR MKOBJ=no +.Pp +.Em Note : +If using +.Sy build.sh , +the default is +.Dq yes . +This may be set to +.Dq no +by giving +.Sy build.sh +the +.Fl o +option. +.DFLTn +. +.It Sy MKOVERLAYFS +.YorN +Indicates whether support for the overlay file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKPAM +.YorN +Indicates whether the +.Xr pam 8 +framework (libraries and support files) will be built and installed. +The pre-PAM code is not supported and may be removed in the future. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKPCC +.YorN +Indicates whether +.Xr pcc 1 +or any related libraries +.Pq Sy libpcc , libpccsoftfloat +will be built and installed. +.DFLTn +. +.It Sy MKPF +.YorN +Indicates whether the +.Xr pf 4 +programs, headers, and LKM will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKPIC +.YorN +Indicates whether shared objects and libraries will be created and +installed. +If +.Dq no , +the entire built system will be statically linked. +.NODEF NOPIC +.Pp +If +.Dq no , +acts as +.Sy MKPICLIB=no . +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKPICINSTALL +.YorN +Indicates whether the +.Xr ar 1 +format libraries +.Sy ( lib*_pic.a ) , +used to generate shared libraries, are installed. +.NODEF NOPICINSTALL +.NOVAR MKLINKLIB=no +.DFLTn +. +.It Sy MKPICLIB +.YorN +Indicates whether the +.Xr ar 1 +format libraries +.Sy ( lib*_pic.a ) , +used to generate shared libraries. +.NOVAR MKPIC=no +.DFLT +.Dq no +on +.Sy vax ; +.Dq yes +on other platforms. +. +.It Sy MKPIE +.YorN +Indicates whether Position Independent Executables (PIE) +will be built and installed. +.NODEF NOPIE +.NOVAR COVERITY_TOP_CONFIG No is defined +.Pp +This is disabled internally for standalone programs in +.Pa /usr/mdec . +.DFLT +.Dq yes +on +.Sy aarch64 , +.Sy arm , +.Sy i386 , +.Sy m68k , +.Sy macppc , +.Sy mips , +.Sy sh3 , +.Sy sparc64 , +and +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKPIGZGZIP +.YorN +If +.Dq no , +the +.Xr pigz 1 +utility is not installed as +.Xr gzip 1 . +.DFLTn +. +.It Sy MKPOSTFIX +.YorN +Indicates whether Postfix will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKPROCFS +.YorN +Indicates whether support for the process +.Pq Pa /proc +file system will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKPROFILE +.YorN +Indicates whether profiled libraries +.Sy ( lib*_p.a ) +will be built and installed. +.NODEF NOPROFILE +.NOVAR MKLINKLIB=no +.DFLT +.Dq no +on +.Sy or1k +(due to toolchain problems with profiled code); +.Dq yes +on other platforms. +. +.It Sy MKPTYFS +.YorN +Indicates whether support for the +.Pa /dev/pts +file system will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKQEMUFWCFG +.YorN +Indicates whether support for the QEMU fw_cfg file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKRADEONFIRMWARE +.YorN +Indicates whether to install the +.Pa /libdata/firmware/radeon +directory, which is necessary for the +.Xr radeon 4 +AMD RADEON GPU video driver. +.DFLT +.Dq yes +on +.Sy aarch64 , +.Sy i386 , +and +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKRELRO +Indicates whether to enable support for Relocation Read-Only (RELRO). +Supported values: +.Bl -tag -width partial +.It partial +Set the non-PLT GOT to read-only. +.It full +Set the non-PLT GOT to read-only and +also force immediate symbol binding, +unless +.Sy NOFULLRELRO +is defined and not +.Dq no +(usually in the Makefile before any +.Xr make 1 +.Cm \&.include +directives). +.It no +Disable RELRO. +.El +.NODEF NORELRO +.DFLT +.Dq partial +on +.Sy aarch64 , +.Sy i386 , +.Sy mips64 , +and +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKREPRO +.YorN +Indicates whether builds are to be reproducible. +If +.Dq yes , +two builds from the same source tree will produce the same build +results. +.Pp +Used as the default for +.Sy MKARZERO . +.Pp +.Em Note : +This may be set to +.Dq yes +by giving +.Sy build.sh +the +.Fl P +option. +.DFLTn +. +.It Sy MKREPRO_TIMESTAMP +Unix timestamp. +When +.Sy MKREPRO +is set, the timestamp of all files in the sets will be set +to this value. +.Pp +.Em Note : +This may be set automatically to the latest source tree timestamp +using +.Xr cvslatest 1 +by giving +.Sy build.sh +the +.Fl P +option. +.DFLTu +. +.It Sy MKRUMP +.YorN +Indicates whether the +.Xr rump 3 +headers, libraries, and programs are to be installed. +.NOVAR COVERITY_TOP_CONFIG No is defined +.Pp +See also +variables that start with +.Sy RUMPUSER_ +or +.Sy RUMP_ . +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKSANITIZER +.YorN +Indicates whether to use the sanitizer to compile userland programs, +using the sanitizer defined by +.Sy USE_SANITIZER . +.NODEF NOSANITIZER +.DFLTn +. +.It Sy MKSHARE +.YorN +Indicates whether files destined to reside in +.Sy DESTDIR Ns Pa /usr/share +will be built and installed. +.NODEF NOSHARE +.Pp +If +.Dq no , +acts as +.Sy MKCATPAGES=no MKDOC=no MKINFO=no MKHTML=no MKMAN=no MKNLS=no . +.DFLTy +. +.It Sy MKSKEY +.YorN +Indicates whether the S/key infrastructure +(libraries and support programs) will be built and installed. +.DFLTy +. +.It Sy MKSLJIT +.YorN +Indicates whether to enable support for sljit +(stack-less platform-independent Just in Time (JIT) compiler) +private library and tests. +.DFLT +.Dq yes +on +.Sy aarch64 , +.Sy i386 , +.Sy sparc , +and +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKSOFTFLOAT +.YorN +Indicates whether the compiler generates output containing +library calls for floating point and possibly soft-float library +support. +.Pp +Forced to +.Dq yes +on +.Sy arm +without +.Sq hf , +.Sy coldfire , +.Sy emips , +.Sy m68ksf , +.Sy or1k , +and +.Sy sh3 . +.DFLT +.Dq yes +on +.Sy mips64 ; +.Dq no +on other platforms. +. +.It Sy MKSSH +.YorN +Indicates whether support for the SSH client +.Pq Xr ssh 1 +and server +.Pq Xr sshd 8 +and related utilities will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKSTATICLIB +.YorN +Indicates whether the normal static libraries +.Sy ( lib*_g.a ) +will be built and installed. +.NODEF NOSTATICLIB +.DFLTy +. +.It Sy MKSTATICPIE +.YorN +Indicates whether support for static PIE binaries +will be built and installed. +These binaries use a special support in crt0.o for +resolving relative relocations and require linker support. +.DFLT +.Dq yes +on +.Sy i386 +and +.Sy x86_64 ; +.Dq no +on other platforms. +. +.It Sy MKSTRIPIDENT +.YorN +Indicates whether RCS IDs, for use with +.Xr ident 1 , +should be stripped from program binaries and shared libraries. +.DFLTn +. +.It Sy MKSTRIPSYM +.YorN +Indicates whether all local symbols should be stripped from shared libraries. +If +.Dq yes , +strip all local symbols from shared libraries; +the effect is equivalent to the +.Fl x +option of +.Xr ld 1 . +If +.Dq no , +strip only temporary local symbols; the effect is equivalent +to the +.Fl X +option of +.Xr ld 1 . +Keeping non-temporary local symbols +such as static function names is useful on using DTrace for +userland libraries and getting a backtrace from a +.Xr rumpkernel 7 +kernel +loading shared libraries. +.NOVAR MKDEBUG=yes +.DFLTy +. +.It Sy MKSYSVBFS +.YorN +Indicates whether support for the System V boot file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKTEGRAFIRMWARE +.YorN +Indicates whether to install the +.Pa /libdata/firmware/nvidia +directory, which is necessary for the +NVIDIA Tegra XHCI driver. +.DFLT +.Dq yes +on +.Sy evbarm ; +.Dq no +on other platforms. +. +.It Sy MKTMPFS +.YorN +Indicates whether support for the memory-based temporary file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKTPM +.YorN +Indicates whether to install the Trusted Platform Module (TPM) +infrastructure. +.DFLTn +. +.It Sy MKUDF +.YorN +Indicates whether support for the UDF universal disk file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKUMAPFS +.YorN +Indicates whether support for the user and group ID remapping file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKUNBOUND +.YorN +Indicates whether the +.Xr unbound 8 +DNS resolver will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKUNIONFS +.YorN +Indicates whether support for the union file system +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKUNPRIVED +.YorN +Indicates whether an unprivileged install will occur. +The user, group, permissions, and file flags, will not be set on +the installed items; instead the information will be appended to +a file called +.Pa METALOG +in +.Sy DESTDIR . +The +.Pa METALOG +contents are used during the generation of the distribution +tar files to ensure that the appropriate file ownership is stored. +This allows a non-root +.Sq "make install" . +.DFLTn +. +.It Sy MKUPDATE +.YorN +Indicates whether all install operations intended to write to +.Sy DESTDIR +will compare file timestamps before installing, and skip the install +phase if the destination files are up-to-date. +.Pp +For top-level builds this implies the effects of +.Sy NOCLEANDIR +(i.e., +.Dq make cleandir +is avoided). +.Pp +.Em Note : +This may be set to +.Dq yes +by giving +.Sy build.sh +the +.Fl u +option. +.DFLTn +. +.It Sy MKUSB +.YorN +Indicates whether support for Universal Serial Bus +.Pq USB +libraries and tools will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKV7FS +.YorN +Indicates whether support for the 7th Edition +.Pq V7 +UNIX file system will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKWLAN +.YorN +Indicates whether support for 802.11 networking +.Po +.Xr hostapd 8 , +.Xr hostapd_cli 8 , +.Xr wlanctl 8 , +.Xr wpa_cli 8 , +.Xr wpa_passphrase 8 , +.Xr wpa_supplicant 8 , +.Xr wiconfig 8 , +and 802.11 support in +.Xr ifconfig 8 +.Pc +will be built and installed. +.DFLT +.Dq no +on +.Sy m68000 ; +.Dq yes +on other platforms. +. +.It Sy MKX11 +.YorN +Indicates whether X11 will be built and installed from +.Sy X11SRCDIR , +and whether the X sets will be created. +.Pp +.Em Note : +If +.Dq yes , +requires +.Sy MKINET6=yes . +.DFLTn +. +.It Sy MKX11FONTS +.YorN +If +.Dq no , +do not build and install the X fonts. +The xfont set is still created but will be empty. +.Pp +Only used if +.Sy MKX11=yes . +.DFLTy +. +.It Sy MKX11MOTIF +.YorN +If +.Dq yes , +build the native Xorg libGLw with Motif stubs. +Requires that Motif can be found via +.Sy X11MOTIFPATH . +.DFLTn +. +.It Sy MKXORG_SERVER +.YorN +Indicates whether the +.Xr Xorg 7 +X server and drivers will be built and installed. +.DFLT +.Dq yes +on +.Sy alpha , +.Sy amd64 , +.Sy amiga , +.Sy bebox , +.Sy cats , +.Sy dreamcast , +.Sy evbarm , +.Sy evbmips , +.Sy evbppc , +.Sy ews4800mips , +.Sy hp300 , +.Sy hpcarm , +.Sy hpcmips , +.Sy hpcsh , +.Sy hppa , +.Sy i386 , +.Sy ibmnws , +.Sy iyonix , +.Sy luna68k , +.Sy mac68k , +.Sy macppc , +.Sy netwinder , +.Sy newsmips , +.Sy ofppc , +.Sy pmax , +.Sy prep , +.Sy sgimips , +.Sy shark , +.Sy sparc , +.Sy sparc64 , +.Sy vax , +and +.Sy zaurus ; +.Dq no +on other platforms. +. +.It Sy MKYP +.YorN +Indicates whether the YP (NIS) infrastructure +(libraries and support programs) will be built and installed. +.DFLTy +. +.It Sy MKZFS +.YorN +Indicates whether the ZFS kernel module and the utilities and +libraries used to manage the ZFS system are to be built and installed. +.Pp +.Em Note : +ZFS requires 64-bit atomic operations. +.DFLT +.Dq yes +on +.Sy aarch64 , +.Sy amd64 , +.Sy riscv64 , +and +.Sy sparc64 ; +.Dq no +on other platforms. +. +.It Sy NETBSDSRCDIR +The path to the top level of the +.Nx +sources. +.DFLT +Top level of the +.Nx +source tree (as determined by the presence of +.Pa build.sh +and +.Pa tools/ ) +if +.Xr make 1 +is run from within that tree; +otherwise +.Sy BSDSRCDIR +will be used. +. +.It Sy NETBSD_OFFICIAL_RELEASE +.YorN +Indicates whether the build creates an official +.Nx +release which is going to be available from +.Lk ftp.NetBSD.org +and/or +.Lk cdn.NetBSD.org +locations. +This variable modifies a few default paths in the installer +and also creates different links in the install documentation. +The auto-build cluster uses this variable to distinguish +.Sq daily +builds from real releases. +.DFLTu +.Pq I.e., Dq no . +. +.It Sy NETBSD_REVISIONID +Tree-wide revision identifier, such as a Mercurial or Git commit hash +or similar. +If set, will be included in program notes where +.Xr __RCSID 3 +and +.Xr __KERNEL_RCSID 3 +are used, and will be reported by +.Xr ident 1 . +.DFLTu +.It Sy NOCLEANDIR +If set, avoids the +.Dq make cleandir +phase of a full build. +This has the effect of allowing only changed +files in a source tree to be recompiled. +This can speed up builds when updating only a few files in the tree. +.Pp +See also +.Sy MKUPDATE . +.DFLTu +. +.It Sy NODISTRIBDIRS +If set, avoids the +.Dq make distrib-dirs +phase of a full build. +This skips running +.Xr mtree 8 +on +.Sy DESTDIR , +useful on systems where building as an unprivileged user, or where it is +known that the system-wide +.Xr mtree 8 +files have not changed. +.DFLTu +. +.It Sy NOINCLUDES +If set, avoids the +.Dq make includes +phase of a full build. +This has the effect of preventing +.Xr make 1 +from thinking that some programs are out-of-date simply because the +system include files have changed. +However, this option should not be used when updating the entire +.Nx +source tree arbitrarily; it is suggested to use +.Sy MKUPDATE=yes +instead in that case. +.DFLTu +. +.It Sy OBJMACHINE +If defined, creates objdirs of the form +.Pa obj . Ns Sy MACHINE , +where +.Sy MACHINE +is the current architecture (as per +.Sq "uname -m" ) . +.DFLTu +. +.It Sy RELEASEDIR +If set, specifies the directory to which a +.Xr release 7 +layout will be written at the end of a +.Dq make release . +If specified, must be an absolute path. +.Pp +.Em Note : +.Sy build.sh +will provide a default of +.Dq Pa releasedir +(in the top-level +.Sy .OBJDIR ) +unless run in +.Sq expert +mode with the +.Fl E +option. +.DFLTu +. +.It Sy RUMPUSER_THREADS +Defines the threading implementation used by the +.Xr rumpuser 3 +hypercall implementation. +Supported values: +.Bl -tag -width pthread +.It fiber +Use a fiber interface, with cooperatively scheduled contexts. +.It none +Do not support kernel threads. +.It pthread +Use +.Xr pthread 3 +to implement threads. +.El +.DFLT +.Dq pthread . +. +.It Sy RUMP_CURLWP +Defines how +.Va curlwp +is obtained in the +.Xr rumpkernel 7 +kernel. +.Va curlwp +is +a very frequently accessed thread-local variable, and optimizing +access has a significant performance impact. +Note that all options are not available on hosts/machine architectures. +Supported values: +.Bl -tag -width hypercall +.It hypercall +Use a hypercall to fetch the value. +.It register +Use a dedicated register. +(Implies compiling with +.Fl ffixed- Ns Ar reg ) . +.It __thread +Use the __thread feature to fetch value via +thread local storage (TLS). +.El +.DFLT +.Dq hypercall . +. +.It Sy RUMP_DEBUG +If defined, +indicates whether +.Xr rumpkernel 7 +kernels are built with +.Fl DDEBUG . +.DFLTu +. +.It Sy RUMP_DIAGNOSTIC +.YorN +Indicates whether +.Xr rumpkernel 7 +kernels are built with +.Fl DDIAGNOSTIC . +.DFLTy +. +.It Sy RUMP_KTRACE +.YorN +Indicates whether +.Xr rumpkernel 7 +kernels are built with +.Fl DKTRACE . +.DFLTy +. +.It Sy RUMP_LOCKDEBUG +If defined, +indicates whether +.Xr rumpkernel 7 +kernels are built with +.Fl DLOCKDEBUG . +.DFLTu +. +.It Sy RUMP_LOCKS_UP +.YorN +Indicates whether +.Xr rumpkernel 7 +kernels are built with +uniprocess-optimized locking or not. +.Pp +If +.Dq yes , +build with uniprocess-optimized locking, which requires +.Ev RUMP_NCPU=1 +in the environment at runtime. +.Pp +If +.Dq no , +build with multiprocessor-capable locking. +.DFLTn +. +.It Sy RUMP_NBCOMPAT +Selects which +.Nx +userland binary compatibility +.Dv COMPAT_ Ns Ar ver +kernel options are enabled in the +.Xr rumpkernel 7 +kernels. +This option is useful only when building +.Xr rumpkernel 7 kernels +for +.Nx +userspace, and an empty value may be supplied elsewhere. +Supported (one or more, comma-separated) values: +.Bl -tag -width default +.It all +All supported release versions. +Equivalent to +.Dq 50,60,70,80,90,100,110 . +.It default +Default value. +Equivalent to +.Dq all , +although this default may change in the future. +.It none +No compatibility options are enabled. +.It 50 +.Nx +5.x compatibility, via +.Dv COMPAT_50 +kernel option. +.It 60 +.Nx +6.x compatibility, via +.Dv COMPAT_60 +kernel option. +.It 70 +.Nx +7.x compatibility, via +.Dv COMPAT_70 +kernel option. +.It 80 +.Nx +8.x compatibility, via +.Dv COMPAT_80 +kernel option. +.It 90 +.Nx +9.x compatibility, via +.Dv COMPAT_90 +kernel option. +.It 100 +.Nx +10.x compatibility, via +.Dv COMPAT_100 +kernel option. +.It 110 +.Nx +11.x compatibility, via +.Dv COMPAT_110 +kernel option. +.El +.DFLT +.Dq all . +. +.It Sy RUMP_VIRTIF +.YorN +Indicates whether +.Xr rumpkernel 7 +kernels are built with support for the +.Xr virt 4 +network interface. +.Pp +If +.Dq no , +don't build with +.Xr virt 4 +support, which may be necessary on systems that lack the +necessary headers, such as musl libc based Linux. +.DFLTy +. +.It Sy RUMP_VNODE_LOCKDEBUG +If defined, +indicates whether +.Xr rumpkernel 7 +kernels are built with +.Fl DVNODE_LOCKDEBUG . +.DFLTu +. +.It Sy TOOLCHAIN_MISSING +.YorN +If not +.Dq no , +this indicates that the platform +.Dq Sy MACHINE_ARCH +being built does not have a working in-tree toolchain. +.Pp +If not +.Dq no , +acts as +.Sy MKBINUTILS=no MKGCC=no MKGDB=no . +.\" See MKGCCCMDS for example text if a platform defaults to yes. +.DFLTn +. +.It Sy TOOLDIR +Directory to hold the host tools, once built. +If specified, must be an absolute path. +This directory should be unique to a given host system and +.Nx +source tree. +(However, multiple target architectures may share the same +.Sy TOOLDIR ; +the target-architecture-dependent files have unique names.) +If unset, a default based +on the +.Xr uname 1 +information of the host platform will be created in the +.Sy .OBJDIR +of +.Pa src . +.DFLTu +. +.It Sy USETOOLS +.YorN +Indicates whether the tools specified by +.Sy TOOLDIR +should be used as part of a build in progress. +Must be set to +.Dq yes +if cross-compiling. +Supported values: +.Bl -tag -width never +.It yes +Use the tools from +.Sy TOOLDIR . +.It no +Do not use the tools from +.Sy TOOLDIR , +but refuse to build native compilation tool components that are +version-specific for that tool. +.It never +Do not use the tools from +.Sy TOOLDIR , +even when building native tool components. +This is similar to the traditional +.Nx +build method, but does +.Em not +verify that the compilation tools in use are up-to-date enough in order +to build the tree successfully. +This may cause build or runtime problems when building the whole +.Nx +source tree. +.El +.DFLT +.Dq no +when using +.Aq bsd.*.mk +outside the +.Nx +source tree (detected automatically) or if +.Sy TOOLCHAIN_MISSING=yes ; +otherwise +.Dq yes . +. +.It Sy USE_FORT +.YorN +Indicates whether the so-called +.Dq FORTIFY_SOURCE +.Xr security 7 +extensions are enabled; see +.Xr ssp 3 +for details. +This imposes some performance penalty. +.NODEF NOFORT +.DFLTn +. +.It Sy USE_HESIOD +.YorN +Indicates whether Hesiod support is +enabled in the various applications that support it. +.NOVAR MKHESIOD=no +.DFLTy +. +.It Sy USE_INET6 +.YorN +Indicates whether INET6 (IPv6) support is +enabled in the various applications that support it. +.NOVAR MKINET6=no +.DFLTy +. +.It Sy USE_JEMALLOC +.YorN +Indicates whether the +.Em jemalloc +allocator +.Pq which is designed for improved performance with threaded applications +is used instead of the +.Em phkmalloc +allocator +.Pq that was the default until Nx 5.0 . +.DFLTy +. +.It Sy USE_KERBEROS +.YorN +Indicates whether Kerberos v5 support is +enabled in the various applications that support it. +.NOVAR MKKERBEROS=no +.DFLTy +. +.It Sy USE_LDAP +.YorN +Indicates whether LDAP support is +enabled in the various applications that support it. +.NOVAR MKLDAP=no +.DFLTy +. +.It Sy USE_LIBCSANITIZER +Selects the sanitizer in libc to compile userland programs and libraries. +Supported values: +.Bl -tag -width undefined +.It undefined +Enables the micro-UBSan in the user mode (uUBSan) +undefined behaviour sanitizer. +The code is shared with the kernel mode variation (kUBSan). +The runtime runtime differs from the UBSan available in +.Sy MKSANITIZER . +The runtime is stripped down from C++ features, +and is invoked with +.Li -fsanitize=no-vptr +as that sanitizer is not supported. +The runtime configuration is restricted to the +.Ev LIBC_UBSAN +environment variable, that is designed to be safe for hardening. +.El +.Pp +The value of +.Sy USE_LIBCSANITIZER +is passed to the C and C++ compilers as the argument to +.Li -fsanitize= . +Additional sanitizer arguments can be passed through +.Sy LIBCSANITIZERFLAGS . +.Pp +Disabled if +.Sy MKLIBCSANITIZER=no . +.DFLT +.Dq undefined . +. +.It Sy USE_PAM +.YorN +Indicates whether +.Xr pam 8 +support is enabled in the various applications that support it. +.NOVAR MKPAM=no +.DFLTy +. +.It Sy USE_PIGZGZIP +.YorN +Indicates whether +.Xr pigz 1 +is used instead of +.Xr gzip 1 +for multi-threaded gzip compression of the distribution tar sets. +.DFLTn +. +.It Sy USE_SANITIZER +Selects the sanitizer to compile userland programs and libraries. +Supported (one or more, comma-separated) values: +.Bl -tag -width safe-stack +.It address +A memory error detector. +.It cfi +A control flow detector. +.It dataflow +A general data flow analysis. +.It leak +A memory leak detector. +.It memory +An uninitialized memory read detector. +.It safe-stack +Protect against stack-based corruption. +.It scudo +The Scudo Hardened Allocator. +.It thread +A data race detector. +.It undefined +An undefined behavior detector. +.El +.Pp +The value of +.Sy USE_SANITIZER +is passed to the C and C++ compilers as the argument to +.Li -fsanitize= . +Additional sanitizer arguments can be passed through +.Sy SANITIZERFLAGS . +.Pp +The list of supported features and their valid combinations +depends on the compiler version and target CPU architecture. +.Pp +Disabled if +.Sy MKSANITIZER=no . +.DFLT +.Dq address . +. +.It Sy USE_SKEY +.YorN +Indicates whether S/key support is +enabled in the various applications that support it. +.NOVAR MKSKEY=no +.Pp +.Em Note : +This is mutually exclusive to +.Sy USE_PAM!=no . +.DFLTn +. +.It Sy USE_SSP +.YorN +Indicates whether GCC stack-smashing protection (SSP) support, +which detects stack overflows and aborts the program, +is enabled. +This imposes some performance penalty +(approximately 5%). +.Pp +This is disabled internally for standalone programs in +.Pa /usr/mdec . +.NODEF NOFORT +.NODEF NOSSP +.NOVAR COVERITY_TOP_CONFIG No is defined +.DFLT +.Dq no +on +.Sy alpha , +.Sy hppa , +and +.Sy ia64 ; +.Dq yes +on other platforms if +.Sy USE_FORT=yes ; +otherwise +.Dq no . +. +.It Sy USE_XZ_SETS +.YorN +Indicates whether the distribution tar files are to be compressed +with +.Xr xz 1 +instead of +.Xr gzip 1 +or +.Xr pigz 1 . +.NOVAR USE_PIGZGZIP=yes +.DFLT +.Dq yes +on +.Sy aarch64 , +and +.Sy amd64 ; +.Dq no +on other platforms. +. +.It Sy USE_YP +.YorN +Indicates whether YP (NIS) support is +enabled in the various applications that support it. +.NOVAR MKYP=no +.DFLTy +. +.It Sy X11MOTIFPATH +Path of the Motif installation to use if +.Sy MKX11MOTIF=yes . +.DFLT +.Dq Pa /usr/pkg . +. +.It Sy X11SRCDIR +Directory containing the modular Xorg source. +If specified, must be an absolute path. +The main modular Xorg source is found in +.Sy X11SRCDIR Ns Pa /external/mit . +.DFLT +.Sy NETBSDSRCDIR Ns Pa /../xsrc , +if that exists; otherwise +.Dq Pa /usr/xsrc . +. +.El +. +.Sh PKGSRC SYSTEM VARIABLES +. +Please see the pkgsrc guide at +.Lk https://www.netbsd.org/docs/pkgsrc/ +or +.Pa pkgsrc/doc/pkgsrc.txt +for more variables used internally by the package system and +.Pa ${PKGSRCDIR}/mk/defaults/mk.conf +for package-specific examples. +. +.Sh OBSOLETE VARIABLES +. +These variables are obsolete. +. +.Bl -tag -width 14n +. +.\" These entries are sorted alphabetically. +. +.It Sy EXTSRCSRCDIR +Obsolete. +. +.It Sy MKBFD +Use +.Sy MKBINUTILS . +. +.It Sy MKCRYPTO +Obsolete. +. +.It Sy MKEXTSRC +Obsolete. +. +.It Sy MKKDEBUG +Use +.Sy MKDEBUGKERNEL . +. +.It Sy MKKERBEROS4 +Obsolete. +. +.It Sy MKLLD +Obsolete. +. +.It Sy MKLLDB +Obsolete. +. +.It Sy MKMCLINKER +Obsolete. +. +.It Sy MKPERFUSE +Obsolete. +. +.It Sy MKTOOLSDEBUG +Use +.Sy MKDEBUGTOOLS . +. +.It Sy NBUILDJOBS +Use the +.Nm build.sh +and +.Xr make 1 +option +.Fl j +instead. +. +.It Sy SHAREDSTRINGS +Obsolete. +. +.It Sy USE_COMBINE +Obsolete. +. +.It Sy USE_NEW_TOOLCHAIN +The new toolchain is now the default. +To disable, use +.Sy TOOLCHAIN_MISSING=yes . +. +.El +. +.Sh FILES +.Bl -tag -width /etc/mk.conf +. +.It Pa /etc/mk.conf +The +.Nm +file resides in +.Pa /etc . +. +.It Pa ${PKGSRCDIR}/mk/defaults/mk.conf +Examples for settings regarding the pkgsrc collection. +.El +. +.Sh SEE ALSO +.Xr apropos 1 , +.Xr ar 1 , +.Xr as 1 , +.Xr clang 1 , +.Xr clang++ 1 , +.Xr config 1 , +.Xr cpio 1 , +.Xr cvs 1 , +.Xr cvslatest 1 , +.Xr dtrace 1 , +.Xr g++ 1 , +.Xr gcc 1 , +.Xr gdb 1 , +.Xr groff 1 , +.Xr gzip 1 , +.Xr ident 1 , +.Xr ld 1 , +.Xr ld.elf_so 1 , +.Xr lint 1 , +.Xr ls 1 , +.Xr make 1 , +.Xr mandoc 1 , +.Xr pax 1 , +.Xr pcc 1 , +.Xr pigz 1 , +.Xr sh 1 , +.Xr tar 1 , +.Xr uname 1 , +.Xr whatis 1 , +.Xr xz 1 , +.Xr rump 3 , +.Xr rumpuser 3 , +.Xr ssp 3 , +.Xr amdgpu 4 , +.Xr athn 4 , +.Xr bcm43xx 4 , +.Xr bwfm 4 , +.Xr ipf 4 , +.Xr ipw 4 , +.Xr iwi 4 , +.Xr iwm 4 , +.Xr iwn 4 , +.Xr nouveau 4 , +.Xr options 4 , +.Xr otus 4 , +.Xr pf 4 , +.Xr radeon 4 , +.Xr ral 4 , +.Xr rtwn 4 , +.Xr rum 4 , +.Xr run 4 , +.Xr urtwn 4 , +.Xr virt 4 , +.Xr wpi 4 , +.Xr zyd 4 , +.Xr pam.conf 5 , +.Xr npf 7 +.Xr release 7 , +.Xr rumpkernel 7 , +.Xr security 7 , +.Xr Xorg 7 , +.Xr dbsym 8 , +.Xr getNAME 8 , +.Xr installboot 8 , +.Xr makemandb 8 , +.Xr makewhatis 8 , +.Xr mdsetimage 8 , +.Xr mtree 8 , +.Xr pam 8 , +.Xr unbound 8 , +.Pa /usr/share/mk/bsd.README , +.Pa src/BUILDING , +.Pa pkgsrc/doc/pkgsrc.txt , +.Lk https://www.netbsd.org/docs/pkgsrc/ +.Sh HISTORY +The +.Nm +file appeared in +.Nx 1.2 . diff --git a/static/netbsd/man5/modules.conf.5 b/static/netbsd/man5/modules.conf.5 new file mode 100644 index 00000000..e148ecb3 --- /dev/null +++ b/static/netbsd/man5/modules.conf.5 @@ -0,0 +1,59 @@ +.\" $NetBSD: modules.conf.5,v 1.2 2015/04/20 06:50:13 wiz Exp $ +.\" +.\" Copyright (c) 2015 Jared McNeill <jmcneill@invisible.ca> +.\" 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 March 21, 2015 +.Dt MODULES.CONF 5 +.Os +.Sh NAME +.Nm modules.conf +.Nd Kernel module config file +.Sh DESCRIPTION +The +.Nm +file is read by the +.Pa modules +rc.d script during system start-up to load modules at boot, +before the system security level is raised. +.Ss FILE FORMAT +Lines starting with a hash +.Pq Sq # +and empty lines are ignored. +All other lines are passed to +.Xr modload 8 . +.Sh FILES +.Bl -tag -width XXetcXmodulesXconfXX +.It Pa /etc/modules.conf +The +.Nm +configuration file resides in +.Pa /etc . +.It Pa /etc/rc.d/modules +.Xr rc.d 8 +script that parses +.Nm . +.El +.Sh SEE ALSO +.Xr modload 8 , +.Xr rc 8 diff --git a/static/netbsd/man5/monthly.5 b/static/netbsd/man5/monthly.5 new file mode 100644 index 00000000..8082ea4d --- /dev/null +++ b/static/netbsd/man5/monthly.5 @@ -0,0 +1,67 @@ +.\" $NetBSD: monthly.5,v 1.2 2011/05/03 16:25:19 jruoho Exp $ +.\" +.\" Copyright (c) 1996 Matthew R. Green +.\" 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 May 3, 2011 +.Dt MONTHLY 5 +.Os +.Sh NAME +.Nm monthly , +.Nm monthly.conf +.Nd monthly maintenance +.Sh DESCRIPTION +The +.Pa /etc/monthly +script is normally run in the morning of the 1st of every month, on a +.Nx +system. +Note: this is disabled (commented out) in the default root's +.Xr crontab 5 +file. +The +.Pa /etc/monthly.conf +file specifies which of the standard +.Nm +services are performed. +.Pp +There are currently no monthly tasks. +.Sh FILES +.Bl -tag -width /etc/monthly.local -compact +.It Pa /etc/monthly +monthly maintenance script +.It Pa /etc/monthly.conf +monthly maintenance configuration +.It Pa /etc/monthly.local +local site additions to +.Pa /etc/monthly +.El +.Sh SEE ALSO +.Xr daily 5 , +.Xr weekly 5 +.Sh HISTORY +The +.Pa /etc/monthly.conf +file appeared in +.Nx 1.3 . diff --git a/static/netbsd/man5/motd.5 b/static/netbsd/man5/motd.5 new file mode 100644 index 00000000..3e573922 --- /dev/null +++ b/static/netbsd/man5/motd.5 @@ -0,0 +1,38 @@ +.\" $NetBSD: motd.5,v 1.2 1994/12/28 18:58:53 glass Exp $ +.\" +.\" This file is in the public domain. +.\" +.Dd December 28, 1994 +.Dt MOTD 5 +.Os +.Sh NAME +.Nm motd +.Nd file containing message(s) of the day +.Sh DESCRIPTION +The file +.Pa /etc/motd +is normally displayed by +.Xr login 1 +after a user has logged in but before the shell is run. +It is generally used for important system-wide announcements. +During system startup, a line containing the kernel version string is +prepended to this file. +.Pp +Individual users may suppress the display of this file by +creating a file named +.Dq Pa .hushlogin +in their home directories. +.Sh FILES +.Bl -tag -width /etc/motd -compact +.It Pa /etc/motd +.El +.Sh EXAMPLES +.Bd -literal +NetBSD 1.0 (SUN_LAMP) #9: Sun Nov 20 22:47:57 PST 1994 + +Make sure you have a .forward file... + +4/17 Machine will be down for backups all day Saturday. +.Ed +.Sh SEE ALSO +.Xr login 1 diff --git a/static/netbsd/man5/netconfig.5 b/static/netbsd/man5/netconfig.5 new file mode 100644 index 00000000..e07fcc3e --- /dev/null +++ b/static/netbsd/man5/netconfig.5 @@ -0,0 +1,123 @@ +.\" $NetBSD: netconfig.5,v 1.9 2013/03/15 19:32:31 njoly Exp $ +.Dd November 17, 2000 +.Dt NETCONFIG 5 +.Os +.Sh NAME +.Nm netconfig +.Nd network configuration data base +.Sh SYNOPSIS +.Pa /etc/netconfig +.Sh DESCRIPTION +The +.Nm +file defines a list of +.Dq transport names , +describing their semantics and protocol. +In +.Nx , +this file is only used by the RPC library code. +.Pp +Entries have the following format: +.Dl network_id semantics flags family protoname device libraries +.Pp +Entries consist of the following fields: +.Pp +.Bl -tag -width network_id +.It Em network_id +The name of the transport described. +.It Em semantics +Describes the semantics of the transport. This can be one of: +.Bl -tag -width tpi_cots_ord -offset indent +.It Sy tpi_clts +Connectionless transport. +.It Sy tpi_cots +Connection-oriented transport +.It Sy tpi_cots_ord +Connection-oriented, ordered transport. +.It Sy tpi_raw +A raw connection. +.El +.It Em flags +This field is either blank (specified by +.Dq \&- ) , +or contains a +.Dq v , +meaning visible to the +.Xr getnetconfig 3 +function. +.It Em family +The protocol family of the transport. +This is currently one of: +.Bl -tag -width loopback -offset indent +.It Sy inet6 +The IPv6 +.Pq Dv PF_INET6 +family of protocols. +.It Sy inet +The IPv4 +.Pq Dv PF_INET +family of protocols. +.It Sy loopback +The +.Dv PF_LOCAL +protocol family. +.El +.It Em protoname +The name of the protocol used for this transport. +Can currently be either +.Nm udp , +.Nm tcp , +or empty. +.It Em device +This field is always empty in +.Nx . +.It Em libraries +This field is always empty in +.Nx . +.El +.Pp +The order of entries in this file will determine which transport will +be preferred by the RPC library code, given a match on a specified +network type. +For example, if a sample network config file would +look like this: +.Pp +.Bd -literal -offset indent +udp6 tpi_clts v inet6 udp - - +tcp6 tpi_cots_ord v inet6 tcp - - +udp tpi_clts v inet udp - - +tcp tpi_cots_ord v inet tcp - - +rawip tpi_raw - inet - - - +local tpi_cots_ord - loopback - - - +.Ed +.Pp +then using the network type +.Nm udp +in calls to the RPC library function (see +.Xr rpc 3 ) +will make the code first try +.Nm udp6 , +and then +.Nm udp . +.Pp +.Xr getnetconfig 3 +and associated functions will parse this file and return structures of +the following format: +.Bd -literal +struct netconfig { + char *nc_netid; /* Network ID */ + unsigned long nc_semantics; /* Semantics (see below) */ + unsigned long nc_flag; /* Flags (see below) */ + char *nc_protofmly; /* Protocol family */ + char *nc_proto; /* Protocol name */ + char *nc_device; /* Network device pathname (unused) */ + unsigned long nc_nlookups; /* Number of lookup libs (unused) */ + char **nc_lookups; /* Names of the libraries (unused) */ + unsigned long nc_unused[9]; /* reserved */ +}; +.Ed +.Sh FILES +.Pa /etc/netconfig +.Sh SEE ALSO +.Xr getnetconfig 3 , +.Xr getnetpath 3 diff --git a/static/netbsd/man5/netgroup.5 b/static/netbsd/man5/netgroup.5 new file mode 100644 index 00000000..4e034f76 --- /dev/null +++ b/static/netbsd/man5/netgroup.5 @@ -0,0 +1,125 @@ +.\" $NetBSD: netgroup.5,v 1.9 2014/09/19 16:02:58 wiz 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. +.\" +.\" @(#)netgroup.5 8.2 (Berkeley) 12/11/93 +.\" +.Dd January 16, 1999 +.Dt NETGROUP 5 +.Os +.Sh NAME +.Nm netgroup +.Nd defines network groups +.Sh SYNOPSIS +.Nm netgroup +.Sh DESCRIPTION +The +.Nm netgroup +file +specifies +.Dq netgroups , +which are sets of +.Sy (host, user, domain) +tuples that are to be given similar network access. +.Pp +Each line in the file +consists of a netgroup name followed by a list of the members of the +netgroup. +Each member can be either the name of another netgroup or a specification +of a tuple as follows: +.Bd -literal -offset indent +(host, user, domain) +.Ed +.Pp +where the +.Sy host , +.Sy user , +and +.Sy domain +are character string names for the corresponding component. +Any of the comma separated fields may be empty to specify a +.Dq wildcard +value +or may consist of the string +.Dq Li - +to specify +.Dq no valid value . +The members of the list may be separated by whitespace; +the +.Dq \e +character may be used at the end of a line to specify +line continuation. +The functions specified in +.Xr getnetgrent 3 +should normally be used to access the +.Nm netgroup +database. +.Pp +If +.Sq files +is specified for the +.Sq netgroup +database in +.Xr nsswitch.conf 5 , +(or no +.Sq netgroup +entry is specified), then these functions operate on the +.Xr db 3 +version of the +.Nm netgroup +.Nm (netgroup.db) +file which can be generated using +.Xr netgroup_mkdb 8 . +If +.Sq nis +is specified then the +.Tn NIS +maps +.Sq netgroup , +.Sq netgroup.byhost , +and +.Sq netgroup.byuser +are used. +.Pp +Lines that begin with a # are treated as comments. +.Sh FILES +.Bl -tag -width /etc/netgroup.db -compact +.It Pa /etc/netgroup.db +the netgroup database. +.El +.Sh COMPATIBILITY +The file format is compatible with that of various vendors, however it +appears that not all vendors use an identical format. +.Sh SEE ALSO +.Xr getnetgrent 3 , +.Xr exports 5 , +.Xr nsswitch.conf 5 , +.Xr netgroup_mkdb 8 +.Sh BUGS +The interpretation of access restrictions based on the member tuples of a +netgroup is left up to the various network applications. diff --git a/static/netbsd/man5/networks.5 b/static/netbsd/man5/networks.5 new file mode 100644 index 00000000..0318798f --- /dev/null +++ b/static/netbsd/man5/networks.5 @@ -0,0 +1,171 @@ +.\" $NetBSD: networks.5,v 1.18 2020/01/20 13:08:40 nia 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. +.\" +.\" @(#)networks.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd July 14, 2018 +.Dt NETWORKS 5 +.Os +.Sh NAME +.Nm networks +.Nd Internet Protocol network name data base +.Sh DESCRIPTION +The +.Nm +file is used as a local source to translate between Internet Protocol +.Pq Tn IP +network addresses and network names (and vice versa). +It can be used in conjunction with the DNS, +.\"and the +.\".Tn NIS +.\"maps +.\".Sq networks.byaddr , +.\"and +.\".Sq networks.byname , +as controlled by +.Xr nsswitch.conf 5 . +.Pp +While the +.Nm +file was originally intended to be an exhaustive list of all +.Tn IP +networks that the local host could communicate with, distribution +and update of such a list for the world-wide +.Tn Internet +(or, indeed, for any large "enterprise" network) has proven to be +prohibitive, so the Domain Name System +.Pq Tn DNS +is used instead, except as noted. +.Pp +For each +.Tn IP +network a single line should be present with the following information: +.Dl name network [alias ...] +.Pp +These are: +.Bl -tag -width network -offset indent -compact +.It Em name +Official network name +.It Em network +IP network number +.It Em alias +Network alias +.El +.Pp +Items are separated by any number of blanks and/or tab characters. +A +.Dq \&# +indicates the beginning of a comment; characters up to the end of +the line are not interpreted by routines which search the file. +.Pp +Network number may be specified in the conventional dot +.Pq Dq \&. +notation using the +.Xr inet_network 3 +routine +from the +.Tn IP +address manipulation library, +.Xr inet 3 . +Network names may contain +.Qq a +through +.Qq z , +zero through nine, and dash. +.Pp +.Tn IP +network numbers on the +.Tn Internet +are generally assigned to a site by its Internet Service Provider +.Pq Tn ISP , +who, in turn, get network address space assigned to them by one of +the regional Internet Registries (e.g. ARIN, RIPE NCC, APNIC). +These registries, in turn, answer to the Internet Assigned Numbers +Authority +.Pq Tn IANA . +.Pp +If a site changes its ISP from one to another, it will generally +be required to change all its assigned IP addresses as part of the +conversion; that is, return the previous network numbers to the previous +.Tn ISP , +and assign addresses to its hosts from +.Tn IP +network address space given by the new +.Tn ISP . +Thus, it is best for a savvy network manager to configure their +hosts for easy renumbering, to preserve their ability to easily +change their +.Tn ISP +should the need arise. +.Sh FILES +.Bl -tag -width /etc/networks -compact +.It Pa /etc/networks +The +.Nm +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr getnetent 3 , +.Xr nsswitch.conf 5 , +.Xr resolv.conf 5 , +.Xr hostname 7 , +.Xr dhcpcd 8 , +.Xr dhcpd 8 , +.Xr named 8 +.Rs +.%R RFC 2317 +.%D March 1998 +.%T "Classless IN-ADDR.ARPA delegation" +.Re +.Rs +.%R RFC 1918 +.%D February 1996 +.%T "Address Allocation for Private Internets" +.Re +.Rs +.%R RFC 1627 +.%D July 1994 +.%T "Network 10 Considered Harmful" +.Re +.Rs +.%R RFC 1519 +.%D September 1993 +.%T "Classless Inter-Domain Routing (CIDR): an Address Assignment and Aggregation Strategy" +.Re +.Rs +.%R RFC 1101 +.%D April 1989 +.%T "DNS Encoding of Network Names and Other Types" +.Re +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/static/netbsd/man5/nologin.5 b/static/netbsd/man5/nologin.5 new file mode 100644 index 00000000..3fef5913 --- /dev/null +++ b/static/netbsd/man5/nologin.5 @@ -0,0 +1,85 @@ +.\" $NetBSD: nologin.5,v 1.3 2021/10/30 21:08:58 andvar Exp $ +.\" +.\" Copyright (c) 2005 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This document is derived from works contributed to The NetBSD Foundation +.\" by Brian Ginsbach. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 December 9, 2005 +.Dt NOLOGIN 5 +.Os +.Sh NAME +.Nm nologin +.Nd file disallowing and containing reason for disallowing logins +.Sh DESCRIPTION +The file +.Pa /etc/nologin , +if it exists, causes the login procedure, used by programs such as +.Xr login 1 , +to terminate. +The program may display the contents of +.Pa /etc/nologin +to the user before exiting. +.Pp +This file is a simple mechanism to temporarily prevent incoming logins. +As such, +the file +.Pa /etc/nologin +is created by +.Xr shutdown 8 +five minutes before system shutdown, +or immediately if shutdown is in less than five minutes. +The file +.Pa /etc/nologin +is removed just before +.Xr shutdown 8 +exits. +.Pp +To disable logins on a per-account basis, +see +.Xr nologin 8 . +.Pp +The file +.Pa /etc/nologin +has no effect on the login procedure for the root user. +.Sh FILES +.Bl -tag -width /etc/nologin -compact +.It Pa /etc/nologin +The +.Nm +file resides in +.Pa /etc . +.El +.Sh EXAMPLES +.Bd -literal +NO LOGINS: System going down at 18:22 +.Ed +.Sh SEE ALSO +.Xr login 1 , +.Xr ftpd 8 , +.Xr nologin 8 , +.Xr rshd 8 , +.Xr shutdown 8 , +.Xr sshd 8 diff --git a/static/netbsd/man5/nsswitch.conf.5 b/static/netbsd/man5/nsswitch.conf.5 new file mode 100644 index 00000000..e34d04f2 --- /dev/null +++ b/static/netbsd/man5/nsswitch.conf.5 @@ -0,0 +1,272 @@ +.\" $NetBSD: nsswitch.conf.5,v 1.29 2017/07/03 21:30:59 wiz Exp $ +.\" +.\" Copyright (c) 1997, 1998, 1999 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Luke Mewburn. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 October 25, 2009 +.Dt NSSWITCH.CONF 5 +.Os +.Sh NAME +.Nm nsswitch.conf +.Nd name-service switch configuration file +.Sh DESCRIPTION +The +.Nm +file specifies how the +.Xr nsdispatch 3 +(name-service switch dispatcher) routines in the C library should operate. +.Pp +The configuration file controls how a process looks up various databases +containing information regarding hosts, users (passwords), groups, +netgroups, etc. +Each database comes from a source (such as local files, DNS, and +.Tn NIS ) , +and the order to look up the sources is specified in +.Nm nsswitch.conf . +.Pp +Each entry in +.Nm +consists of a database name, and a space separated list of sources. +Each source can have an optional trailing criterion that determines +whether the next listed source is used, or the search terminates at +the current source. +Each criterion consists of one or more status codes, and actions to +take if that status code occurs. +.Ss Sources +The following sources are implemented: +.Bl -column "multicast_dns" -offset indent -compact +.It Sy Source Description +.It files Local files, such as +.Pa /etc/hosts , +and +.Pa /etc/passwd . +.It dns Internet Domain Name System. +.Dq hosts +and +.Dq networks +use +.Sy IN +class entries, all other databases use +.Sy HS +class (Hesiod) entries. +.It mdnsd Use +.Xr mdnsd 8 +for +.Dq hosts +lookups, acting as both a system-wide cache for normal unicast DNS +as well as providing multicast DNS +.Dq ( zeroconf ) +lookups. +.It multicast_dns Use +.Xr mdnsd 8 +only for multicast DNS +.Dq hosts +lookups. +This would normally be used in conjunction with +.Dq dns , +which would then provide unicast DNS resolver functions. +.It nis NIS (formerly YP) +.It compat support +.Sq +/- +in the +.Dq passwd +and +.Dq group +databases. +If this is present, it must be the only source for that entry. +.El +.Ss Databases +The following databases are used by the following C library functions: +.Bl -column "netgroup" -offset indent -compact +.It Sy Database Used by +.It group Ta Xr getgrent 3 +.It hosts Ta Xr gethostbyname 3 +.It netgroup Ta Xr getnetgrent 3 +.It networks Ta Xr getnetbyname 3 +.It passwd Ta Xr getpwent 3 +.It shells Ta Xr getusershell 3 +.El +.Ss Status codes +The following status codes are available: +.Bl -column "tryagain" -offset indent -compact +.It Sy Status Description +.It success The requested entry was found. +.It notfound The entry is not present at this source. +.It tryagain The source is busy, and may respond to retries. +.It unavail The source is not responding, or entry is corrupt. +.El +.Ss Actions +For each of the status codes, one of two actions is possible: +.Bl -column "continue" -offset indent -compact +.It Sy Action Description +.It continue Try the next source +.It return Return with the current result +.El +.Ss Format of file +A +.Tn BNF +description of the syntax of +.Nm +is: +.Bl -column "<criterion>" -offset indent +.It <entry> ::= +<database> ":" [<source> [<criteria>]]* +.It <criteria> ::= +"[" <criterion>+ "]" +.It <criterion> ::= +<status> "=" <action> +.It <status> ::= +"success" | "notfound" | "unavail" | "tryagain" +.It <action> ::= +"return" | "continue" +.El +.Pp +Each entry starts on a new line in the file. +A +.Sq # +delimits a comment to end of line. +Blank lines are ignored. +A +.Sq \e +at the end of a line escapes the newline, and causes the next line to +be a continuation of the current line. +All entries are case-insensitive. +.Pp +The default criteria is to return on +.Dq success , +and continue on anything else (i.e, +.Li [success=return notfound=continue unavail=continue tryagain=continue] +). +.Ss Compat mode: +/- syntax +In historical multi-source implementations, the +.Sq + +and +.Sq - +characters are used to specify the importing of user password and +group information from +.Tn NIS . +Although +.Nm +provides alternative methods of accessing distributed sources such as +.Tn NIS , +specifying a sole source of +.Dq compat +will provide the historical behaviour. +.Pp +An alternative source for the information accessed via +.Sq +/- +can be used by specifying +.Dq passwd_compat: source . +.Dq source +in this case can be +.Sq dns , +.Sq nis , +or +any other source except for +.Sq files +and +.Sq compat . +.Ss Notes +Historically, many of the databases had enumeration functions, often of +the form +.Fn getXXXent . +These made sense when the databases were in local files, but don't make +sense or have lesser relevance when there are possibly multiple sources, +each of an unknown size. +The interfaces are still provided for compatibility, but the source +may not be able to provide complete entries, or duplicate entries may +be retrieved if multiple sources that contain similar information are +specified. +.Pp +To ensure compatibility with previous and current implementations, the +.Dq compat +source must appear alone for a given database. +.Ss Default source lists +If, for any reason, +.Nm nsswitch.conf +doesn't exist, or it has missing or corrupt entries, +.Xr nsdispatch 3 +will default to an entry of +.Dq files +for the requested database. +Exceptions are: +.Bl -column passwd_compat "files dns" -offset indent +.It Sy Database Default source list +.It group compat +.It group_compat nis +.It hosts files dns +.It netgroup files [notfound=return] nis +.It passwd compat +.It passwd_compat nis +.El +.Sh FILES +.Bl -tag -width /etc/nsswitch.conf -compact +.It Pa /etc/nsswitch.conf +The file +.Nm +resides in +.Pa /etc . +.El +.Sh EXAMPLES +To lookup hosts in +.Pa /etc/hosts +and then from the DNS, and lookup user information from +.Tn NIS +then files, use: +.Bl -column "passwd:" -offset indent +.It hosts: files dns +.It passwd: nis [notfound=return] files +.It group: nis [notfound=return] files +.El +.Pp +The criteria +.Dq [notfound=return] +sets a policy of "if the user is notfound in nis, don't try files." +This treats nis as the authoritative source of information, except +when the server is down. +.Sh SEE ALSO +.Xr getent 1 , +.Xr nsdispatch 3 , +.Xr resolv.conf 5 , +.Xr named 8 , +.Xr ypbind 8 +.Sh HISTORY +The +.Nm +file format first appeared in +.Nx 1.4 . +.Sh AUTHORS +.An Luke Mewburn +.Aq lukem@NetBSD.org +wrote this freely distributable name-service switch implementation, +using ideas from the +.Tn ULTRIX +.Xr svc.conf 5 +and +.Tn Solaris +.Xr nsswitch.conf 4 +manual pages. diff --git a/static/netbsd/man5/passwd.5 b/static/netbsd/man5/passwd.5 new file mode 100644 index 00000000..449eeafe --- /dev/null +++ b/static/netbsd/man5/passwd.5 @@ -0,0 +1,424 @@ +.\" $NetBSD: passwd.5,v 1.34 2019/09/01 18:57:05 sevan Exp $ +.\" +.\" Copyright (c) 1988, 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. +.\" +.\" Portions Copyright (c) 1994, Jason Downs. 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(S) ``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(S) 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. +.\" +.\" @(#)passwd.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd September 1, 2019 +.Dt PASSWD 5 +.Os +.Sh NAME +.Nm passwd , +.Nm master.passwd +.Nd format of the password file +.Sh DESCRIPTION +The +.Nm passwd +files are the local source of password information. +They can be used in conjunction with the Hesiod domain +.Sq passwd +and the +.Tn NIS +maps +.Sq passwd.byname , +.Sq passwd.byuid , +.Sq master.passwd.byname , +and +.Sq master.passwd.byuid , +as controlled by +.Xr nsswitch.conf 5 . +.Pp +The +.Nm master.passwd +file is readable only by root, and consists of newline separated +.Tn ASCII +records, one per user, containing ten colon +.Pq Dq \&: +separated fields. +.Pp +Each line has the form: +.Dl name:password:uid:gid:class:change:expire:gecos:home_dir:shell +.Pp +These fields are as follows: +.Bl -tag -width password -offset indent -compact +.It Em name +User's login name. +.It Em password +User's +.Em encrypted +password. +.It Em uid +User's id. +.It Em gid +User's login group id. +.It Em class +User's login class. +.It Em change +Password change time. +.It Em expire +Account expiration time. +.It Em gecos +General information about the user. +.It Em home_dir +User's home directory. +.It Em shell +User's login shell. +.El +.Pp +Be aware that each line is limited to 1024 characters; longer ones will be +ignored. +This limit can be queried through +.Xr sysconf 3 +by using the +.Li _SC_GETPW_R_SIZE_MAX +parameter. +.Pp +The +.Nm +file is generated from the +.Nm master.passwd +file by +.Xr pwd_mkdb 8 , +has the +.Em class , +.Em change , +and +.Em expire +fields removed, and the +.Em password +field replaced by a +.Dq \&* . +.Pp +The +.Em name +field is the login used to access the computer account, and the +.Em uid +field is the number associated with it. +They should both be unique across the system (and often across a +group of systems) since they control file access. +.Pp +While it is possible to have multiple entries with identical login names +and/or identical user id's, it is usually a mistake to do so. +Routines that manipulate these files will often return only one of +the multiple entries, and that one by random selection. +.Pp +The login name must never begin with a hyphen +.Pq Dq \&- ; +also, it is strongly suggested that neither upper-case characters nor dots +.Pq Dq \&. +be part of the name, as this tends to confuse mailers. +No field may contain a colon +.Pq Dq \&: +as this has been used historically to separate the fields in the user database. +.Pp +The +.Em password +field is the +.Em encrypted +form of the password. +If the +.Em password +field is empty, no password will be required to gain access to the +machine. +This is almost invariably a mistake. +Because these files contain the encrypted user passwords, they should +not be readable by anyone without appropriate privileges. +For the possible ciphers used in this field see +.Xr passwd.conf 5 . +.Pp +The +.Em gid +field is the group that the user will be placed in upon login. +Since this system supports multiple groups (see +.Xr groups 1 ) +this field currently has little special meaning. +.Pp +The +.Em class +field is a key for a user's login class. +Login classes are defined in +.Xr login.conf 5 , +which is a +.Xr capfile 5 +style database of user attributes, accounting, resource and +environment settings. +.Pp +The +.Em change +field is the number of seconds from the epoch, +.Dv UTC , +until the +password for the account must be changed. +This field may be left empty to turn off the password aging feature. +If this is set to +.Dq -1 +then the user will be prompted to change their password at the next +login. +.Pp +The +.Em expire +field is the number of seconds from the epoch, +.Dv UTC , +until the +account expires. +This field may be left empty to turn off the account aging feature. +.Pp +If either of the +.Em change +or +.Em expire +fields are set, the system will remind the user of the impending +change or expiry if they login within a configurable period +(defaulting to 14 days) before the event. +.Pp +The +.Em gecos +field normally contains comma +.Pq Dq \&, +separated subfields as follows: +.Pp +.Bl -tag -width office -offset indent -compact +.It Em name +user's full name +.It Em office +user's office number +.It Em wphone +user's work phone number +.It Em hphone +user's home phone number +.El +.Pp +The full name may contain an ampersand +.Pq Dq \&& +which will be replaced by +the capitalized login name when the gecos field is displayed or used +by various programs such as +.Xr finger 1 , +.Xr sendmail 1 , +etc. +.Pp +The office and phone number subfields are used by the +.Xr finger 1 +program, and possibly other applications. +.Pp +The user's home directory is the full +.Ux +path name where the user +will be placed on login. +.Pp +The shell field is the command interpreter the user prefers. +If there is nothing in the +.Em shell +field, the Bourne shell +.Pq Pa /bin/sh +is assumed. +.Sh HESIOD SUPPORT +If +.Sq dns +is specified for the +.Sq passwd +database in +.Xr nsswitch.conf 5 , +then +.Nm +lookups occur from the +.Sq passwd +Hesiod domain. +.Sh NIS SUPPORT +If +.Sq nis +is specified for the +.Sq passwd +database in +.Xr nsswitch.conf 5 , +then +.Nm +lookups occur from the +.Sq passwd.byname , +.Sq passwd.byuid , +.Sq master.passwd.byname , +and +.Sq master.passwd.byuid +.Tn NIS +maps. +.Sh COMPAT SUPPORT +If +.Sq compat +is specified for the +.Sq passwd +database, and either +.Sq dns +or +.Sq nis +is specified for the +.Sq passwd_compat +database in +.Xr nsswitch.conf 5 , +then the +.Nm +file also supports standard +.Sq +/- +exclusions and inclusions, based on user names and netgroups. +.Pp +Lines beginning with a minus sign +.Pq Dq \&- +are entries marked as being excluded from any following inclusions, +which are marked with a plus sign +.Pq Dq \&+ . +.Pp +If the second character of the line is an at sign +.Pq Dq \&@ , +the operation +involves the user fields of all entries in the netgroup specified by the +remaining characters of the +.Em name +field. +Otherwise, the remainder of the +.Em name +field is assumed to be a specific user name. +.Pp +The +.Dq \&+ +token may also be alone in the +.Em name +field, which causes all users from either the Hesiod domain +.Nm +(with +.Sq passwd_compat: dns ) +or +.Sq passwd.byname +and +.Sq passwd.byuid +.Tn NIS +maps (with +.Sq passwd_compat: nis ) +to be included. +.Pp +If the entry contains non-empty +.Em uid +or +.Em gid +fields, the specified numbers will override the information retrieved +from the Hesiod domain or the +.Tn NIS +maps. +As well, if the +.Em gecos , +.Em home_dir +or +.Em shell +entries contain text, it will override the information included via +Hesiod or +.Tn NIS . +On some systems, the +.Em passwd +field may also be overridden. +.Sh COMPATIBILITY +The password file format has changed since +.Bx 4.3 . +The following awk script can be used to convert your old-style password +file into a new style password file. +The additional fields +.Dq class , +.Dq change +and +.Dq expire +are added, but are turned off by default. +To set them, +use the current day in seconds from the epoch + whatever number of seconds +of offset you want. +.Bd -literal -offset indent +BEGIN { FS = ":"} +{ print $1 ":" $2 ":" $3 ":" $4 "::0:0:" $5 ":" $6 ":" $7 } +.Ed +.Sh SEE ALSO +.Xr chpass 1 , +.Xr login 1 , +.Xr newgrp 1 , +.Xr passwd 1 , +.Xr pwhash 1 , +.Xr getpwent 3 , +.Xr login_getclass 3 , +.Xr login.conf 5 , +.Xr netgroup 5 , +.Xr passwd.conf 5 , +.Xr pwd_mkdb 8 , +.Xr useradd 8 , +.Xr vipw 8 , +.Xr yp 8 +.Pp +.%T "Managing NFS and NIS" +(O'Reilly & Associates) +.Sh HISTORY +A +.Nm +file format appeared in +.At v1 . +.Pp +The +.Tn NIS +.Nm +file format first appeared in SunOS. +.Pp +The Hesiod support first appeared in +.Nx 1.4 . +.Pp +The +.Xr login.conf 5 +capability first appeared in +.Nx 1.5 . +.Sh BUGS +User information should (and eventually will) be stored elsewhere. +.Pp +Placing +.Sq compat +exclusions in the file after any inclusions will have +unexpected results. diff --git a/static/netbsd/man5/passwd.conf.5 b/static/netbsd/man5/passwd.conf.5 new file mode 100644 index 00000000..5365a723 --- /dev/null +++ b/static/netbsd/man5/passwd.conf.5 @@ -0,0 +1,147 @@ +.\" $NetBSD: passwd.conf.5,v 1.14 2025/12/31 13:02:21 nia Exp $ +.\" +.\" Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de> +.\" 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 October 26, 2021 +.Dt PASSWD.CONF 5 +.Os +.Sh NAME +.Nm passwd.conf +.Nd password encryption configuration file +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +The +.Pa /etc/passwd.conf +file, consisting of +.Dq stanzas , +describes the configuration of the password cipher used +to encrypt local or YP passwords. +.Pp +There are default, user and group specific stanzas. +If no user or group +stanza to a specific option is available, the default stanza +is used. +.Pp +To differentiate between user and group stanzas, groups are prefixed +with a single colon +.Pq Sq \&: . +.Pp +Some fields and their possible values that can appear in this file are: +.Bl -tag -width localcipher +.It Sy localcipher +The cipher to use for local passwords. +.Pp +Possible values are: +.Dq argon2d,<t=X,m=Y,p=Z> , +.Dq argon2i,<t=X,m=Y,p=Z> , +.Dq argon2id,<t=X,m=Y,p=Z> , +.Dq old , +.Dq newsalt,<rounds> , +.Dq md5 , +.Dq sha1,<rounds> , +and +.Dq blowfish,<rounds> . +.Pp +For +.Dq argon2d , +.Dq argon2i , +and +.Dq argon2id , +optional hardness parameters can be specified as described in the +manual for +.Xr pwhash 1 . +.Pp +For +.Dq newsalt +the value of rounds is a 24-bit integer with a minimum of 7250 rounds. +.Pp +For +.Dq sha1 +the value of rounds is a 32-bit integer, 0 means use the default +of 24680. +.Pp +For +.Dq blowfish +the value can be between 4 and 31. +It specifies the base 2 logarithm of the number of rounds. +.Pp +If not specified, the default value is +.Dq old . +.It Sy ypcipher +The cipher to use for YP passwords. +.Pp +The possible values are the same as for localcipher. +.Pp +If not specified, the default value is +.Dq old . +.El +.Pp +To retrieve information from this file use +.Xr pw_getconf 3 . +.Sh FILES +.Bl -tag -width /etc/passwd.conf -compact +.It Pa /etc/passwd.conf +.El +.Sh EXAMPLES +Use SHA1 as the local cipher and old-style DES as the YP cipher. +Use blowfish with 2^5 rounds for root: +.Bd -literal + default: + localcipher = sha1 + ypcipher = old + + root: + localcipher = blowfish,5 +.Ed +.Sh SEE ALSO +.Xr passwd 1 , +.Xr pwhash 1 , +.Xr pw_getconf 3 , +.Xr passwd 5 +.Sh HISTORY +The +.Nm +configuration file first appeared in +.Nx 1.6 . +.Pp +The default value of +.Sy localcipher +was set to +.Dq sha1 +in +.Pa /etc/passwd.conf +starting from +.Nx 6.0 . +.Pp +The default value of +.Sy localcipher +was set to +.Dq argon2id +in +.Pa /etc/passwd.conf +starting from +.Nx 10.0 . diff --git a/static/netbsd/man5/phones.5 b/static/netbsd/man5/phones.5 new file mode 100644 index 00000000..243f0de1 --- /dev/null +++ b/static/netbsd/man5/phones.5 @@ -0,0 +1,93 @@ +.\" $NetBSD: phones.5,v 1.8 2011/01/06 16:37:35 njoly 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. +.\" +.\" @(#)phones.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd January 3, 2001 +.Dt PHONES 5 +.Os +.Sh NAME +.Nm phones +.Nd remote host phone number data base +.Sh DESCRIPTION +The file +.Pa /etc/phones +contains the system-wide +private phone numbers for the +.Xr tip 1 +program. This file is normally unreadable, and so may contain +privileged information. +.Pp +The format of the file is a series of lines containing whitespace +separate fields, of the form: +.Dl system-name phone-number +.Pp +The +.Em system-name +is one of those defined in the +.Xr remote 5 +file. +.Pp +The +.Em phone-number +is constructed from any sequence of characters terminated only by a comma +.Pq Dq \&, +or the end of the line. +The equals +.Pq Dq \&= +and asterisk +.Pq Dq \&* +characters are +indicators to the auto call units to pause and wait for a second dial +tone (when going through an exchange). The +.Dq \&= +is required by the +.Tn DF02-AC +and the +.Dq \&* +is required by the +.Tn BIZCOMP +1030. +.Pp +Only one phone number per line is permitted. However, if more than +one line in the file contains the same system name +.Xr tip 1 +will attempt to dial each one in turn, until it establishes a connection. +.Sh FILES +.Bl -tag -width /etc/phones -compact +.It Pa /etc/phones +.El +.Sh SEE ALSO +.Xr tip 1 , +.Xr remote 5 +.Sh HISTORY +The +.Nm +file appeared in +.Bx 4.2 . diff --git a/static/netbsd/man5/pkgpath.conf.5 b/static/netbsd/man5/pkgpath.conf.5 new file mode 100644 index 00000000..bdd5e7f0 --- /dev/null +++ b/static/netbsd/man5/pkgpath.conf.5 @@ -0,0 +1,66 @@ +.\" $NetBSD: pkgpath.conf.5,v 1.1 2020/07/13 09:10:35 jruoho Exp $ +.\" +.\" Copyright (c) 2020 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Jukka Ruohonen. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 July 13, 2020 +.Dt PKGPATH.CONF 5 +.Os +.Sh NAME +.Nm pkgpath.conf +.Nd paths for package utilities +.Sh DESCRIPTION +The +.Pa /etc/pkgpath.conf +file provides definitions of the paths to different +package utilities, including +.Xr pkg_admin 1 +and +.Xr pkg_info 1 +in particular. +These definitions are used by maintenance scripts such as +.Xr daily 5 . +.Pp +The definitions may be altered when using package utilities from +.Xr pkgsrc 7 +instead of the default ones supplied by +.Nx . +.Sh FILES +.Bl -tag -width /etc/pkgpath.conf -compact +.It Pa /etc/pkgpath.conf +paths used by package utilities +.El +.Sh SEE ALSO +.Xr pkg_admin 1 , +.Xr pkg_info 1 , +.Xr daily 5 , +.Xr security.conf 5 +.Sh HISTORY +The +.Pa /etc/pkgpath.conf +file first appeared in +.Nx 7.0 . diff --git a/static/netbsd/man5/printcap.5 b/static/netbsd/man5/printcap.5 new file mode 100644 index 00000000..ccf38739 --- /dev/null +++ b/static/netbsd/man5/printcap.5 @@ -0,0 +1,342 @@ +.\" $NetBSD: printcap.5,v 1.28 2022/10/21 18:21:56 christos 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. +.\" +.\" @(#)printcap.5 8.2 (Berkeley) 12/11/93 +.\" +.Dd October 21, 2022 +.Dt PRINTCAP 5 +.Os +.Sh NAME +.Nm printcap +.Nd printer capability data base +.Sh SYNOPSIS +.Nm printcap +.Sh DESCRIPTION +The +.Nm +data base is used to describe line printers. +The spooling system accesses the +.Nm printcap +file every time it is used, allowing dynamic +addition and deletion of printers. +Each entry in the data base is used to describe one printer. +.Pp +The default printer is normally +.Em lp , +though the environment variable +.Ev PRINTER +may be used to override this. +Each spooling utility supports an option, +.Fl P Ar printer , +to allow explicit naming of a destination printer. +.Pp +Refer to the +.%T "4.3 BSD Line Printer Spooler Manual" +for a complete discussion on how to set up the database for a given printer. +.Sh CAPABILITIES +Refer to +.Xr capfile 5 +for a description of the file layout. +.Bl -column Name Type "/var/spool/output/lpd" +.It Sy Name Type Default Description +.It "af str" Ta Dv NULL Ta No "name of accounting file" +.It "br num none if lp is a tty, set the baud rate" +.Pf ( Xr ioctl 2 +call) +.It "cf str" Ta Dv NULL Ta No "cifplot data filter" +.It "df str" Ta Dv NULL Ta No "tex data filter" +.Pf ( Tn DVI +format) +.It "fc num 0 if lp is a tty, clear flag bits" +.Pq Pa sgtty.h +.It "ff str" Ta So Li \ef Sc Ta No "string to send for a form feed" +.It "fo bool false print a form feed when device is opened" +.It "fs num 0 like `fc' but set bits" +.It "gf str" Ta Dv NULL Ta No "graph data filter" +.Pf ( Xr plot 3 +format +.It "hl bool false print the burst header page last" +.It "ic bool false driver supports (non standard) ioctl to indent printout" +.It "if str" Ta Dv NULL Ta No "name of text filter which does accounting" +.It "lf str" Ta Pa /dev/console Ta No "error logging file name" +.It "lo str" Ta Pa lock Ta No "name of lock file" +.It "lp str" Ta Pa /dev/lp Ta No "device name to open for output to local \ +printer, or port@host for remote printer/printer on print server" +.It "ms str" Ta Dv NULL Ta No "list of terminal modes to set or clear" +.It "mx num 1000 maximum file size (in" +.Dv BUFSIZ +blocks), zero = unlimited +.It "nd str" Ta Dv NULL Ta No "next directory for list of queues (unimplemented)" +.It "nf str" Ta Dv NULL Ta No "ditroff data filter (device independent troff)" +.It "of str" Ta Dv NULL Ta No "name of output filtering program" +.It "pc num 200 price per foot or page in hundredths of cents" +.It "pf str" Ta Dv NULL Ta No "filter for printing" +.Tn PostScript +files +.It "pl num 66 page length (in lines)" +.It "pw num 132 page width (in characters)" +.It "px num 0 page width in pixels (horizontal)" +.It "py num 0 page length in pixels (vertical)" +.It "rf str" Ta Dv NULL Ta No "filter for printing" +.Tn FORTRAN +style text files +.It "rg str" Ta Dv NULL Ta No "restricted group. Only members of group allowed access" +.It "rm str" Ta Dv NULL Ta No "machine name for remote printer or port@host \ +for a remote printer on a port other than the standard port." +.Po +also suppress the burst page, see +.Sx NOTES +.Pc +.It "rp str ``lp'' remote printer name argument" +.It "rs bool false restrict remote users to those with local accounts" +.It "rw bool false open the printer device for reading and writing" +.It "sb bool false short banner (one line only)" +.It "sc bool false suppress multiple copies" +.It "sd str" Ta Pa /var/spool/output/lpd Ta No "spool directory" +.It "sf bool false suppress form feeds" +.It "sh bool false suppress printing of burst page header" +.Po +local only, see +.Sx NOTES +.Pc +.It "st str" Ta Pa status Ta No "status file name" +.It "tf str" Ta Dv NULL Ta No "troff data filter (cat phototypesetter)" +.It "tr str" Ta Dv NULL Ta No "trailer string to print when queue empties" +.It "vf str" Ta Dv NULL Ta No "raster image filter" +.It "xc num 0 if lp is a tty, clear local mode bits" +.Pq Xr tty 4 +.It "xs num 0 like `xc' but set bits" +.El +.Pp +If the local line printer driver supports indentation, the daemon +must understand how to invoke it. +.Sh FILTERS +If a printer is specified via +.Sy lp +(either local or remote), +the +.Xr lpd 8 +daemon creates a pipeline of +.Em filters +to process files for various printer types. +The pipeline is not set up for remote printers specified via +.Sy rm +unless the local host is the same as the remote printer host +given or +.Xr lpd 8 +is run with the +.Fl r +flag. +The filters selected depend on the flags passed to +.Xr lpr 1 . +The pipeline set up is: +.Bd -literal -offset indent +p pr | if regular text + pr(1) +none if regular text +c cf cifplot +d df DVI (tex) +g gf plot(3) +n nf ditroff +o pf PostScript +f rf Fortran +t tf troff +v vf raster image +.Ed +.Pp +The +.Sy if +filter is invoked with arguments: +.Bd -filled -offset indent +.Cm if +.Op Fl c +.Fl w Ns Ar width +.Fl l Ns Ar length +.Fl i Ns Ar indent +.Fl n Ar login +.Op Fl j Ar jobname +.Fl h Ar host acct-file +.Ed +.Pp +The +.Fl c +flag is passed only if the +.Fl l +flag (pass control characters literally) +is specified to +.Xr lpr 1 . +The +.Ar width +and +.Ar length +specify the page width and length +(from +.Cm pw +and +.Cm pl +respectively) in characters. +The +.Fl n +and +.Fl h +parameters specify the login name and host name of the owner +of the job respectively. +The +.Fl j +parameter is optional and specifies the name of the print +job if available. +The +.Ar acct-file +option is passed from the +.Cm af +.Nm printcap +entry. +.Pp +If no +.Cm if +is specified, +.Cm of +is used instead, +with the distinction that +.Cm of +is opened only once, +while +.Cm if +is opened for every individual job. +Thus, +.Cm if +is better suited to performing accounting. +The +.Cm of +is only given the +.Ar width +and +.Ar length +flags. +.Pp +All other filters are called as: +.Bd -filled -offset indent +.Nm filter +.Fl x Ns Ar width +.Fl y Ns Ar length +.Fl n Ar login +.Op Fl j Ar jobname +.Fl h Ar host acct-file +.Ed +.Pp +where +.Ar width +and +.Ar length +are represented in pixels, +specified by the +.Cm px +and +.Cm py +entries respectively. +.Pp +All filters take +.Em stdin +as the file, +.Em stdout +as the printer, +may log either to +.Em stderr +or using +.Xr syslog 3 , +and must not ignore +.Dv SIGINT . +.Pp +Filters can communicate errors to lpd by their exit code and by modifying +the mode of the spool lock file as follows: +.Bl -tag -width Exit-code -compact -offset indent +.It Sy Exit code +.Sy Description +.It 0 +Success. +.It 1 +An attempt is made to reprint the job and mail is sent if it fails. +.It 2 +.Xr lpd 8 +silently discards the job. +.It n +.Xr lpd 8 +discards the job and mail is sent. +.El +.Bl -tag -width lockxmode -compact -offset indent +.It Sy lock code +.Sy Description +.It u+x +Stop printing and leave queue disabled (S_IXUSR). +.It o+x +Rebuild the queue (S_IXOTH). +.El +.Sh LOGGING +Error messages generated by the line printer programs themselves +(that is, the lp* programs) are logged by +.Xr syslog 3 +using the +.Dv LPR +facility. +Messages printed on +.Em stderr +of one of the filters are sent to the corresponding +.Cm lf +file. +The filters may, of course, use +.Xr syslog 3 +themselves. +.Pp +Error messages sent to the console have a carriage return and a line +feed appended to them, rather than just a line feed. +.Sh SEE ALSO +.Xr lpq 1 , +.Xr lpr 1 , +.Xr lprm 1 , +.Xr capfile 5 , +.Xr lpc 8 , +.Xr lpd 8 , +.Xr pac 8 +.Rs +.%T "4.3 BSD Line Printer Spooler Manual" +.Re +.Sh NOTES +The +.Sy sh +flag is a function of the spooler with the locally attached printer, +and so has no effect when used with +.Sy rm . +.Nx +never adds a burst page when used as a remote spooler. +To suppress the burst page for other systems or dedicated devices, +refer to the documentation for those systems or devices. +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/static/netbsd/man5/protocols.5 b/static/netbsd/man5/protocols.5 new file mode 100644 index 00000000..cd8d067d --- /dev/null +++ b/static/netbsd/man5/protocols.5 @@ -0,0 +1,90 @@ +.\" $NetBSD: protocols.5,v 1.8 2022/11/29 14:15:01 jschauma 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. +.\" +.\" @(#)protocols.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd November 27, 2022 +.Dt PROTOCOLS 5 +.Os +.Sh NAME +.Nm protocols +.Nd protocol name data base +.Sh DESCRIPTION +The +.Nm protocols +file contains information regarding the assigned protocol numbers +used by IPv4 and IPv6 to identify the next level protocol. +For each protocol a single line should be present +with the following information: +.Bd -unfilled -offset indent +official protocol name +protocol number +aliases +.Ed +.Pp +Items are separated by any number of blanks and/or +tab characters. A hash +.Pq Dq \&# +indicates the beginning of +a comment; characters up to the end of the line are +not interpreted by routines which search the file. +.Pp +Protocol names may contain any printable +character other than a field delimiter, newline, +or comment character. +.Sh FILES +.Bl -tag -width /etc/protocols -compact +.It Pa /etc/protocols +The +.Nm protocols +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr getprotoent 3 +.Rs +.%R RFC 2780 +.%D March 2000 +.%T "IANA Allocation Guidelines For Values In the \ +Internet Protocol and Related Headers" +.Re +.Rs +.%R RFC 5237 +.%D February 2008 +.%T "IANA Allocation Guidelines for the Protocol Field" +.Re +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 , +describing the "known protocols used in the DARPA +Internet". +.Sh BUGS +A name server should be used instead of a static file. diff --git a/static/netbsd/man5/ranlib.5 b/static/netbsd/man5/ranlib.5 new file mode 100644 index 00000000..18eb84df --- /dev/null +++ b/static/netbsd/man5/ranlib.5 @@ -0,0 +1,81 @@ +.\" $NetBSD: ranlib.5,v 1.7 2017/07/03 21:30:59 wiz Exp $ +.\" +.\" Copyright (c) 1990, 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. +.\" +.\" from: @(#)ranlib.5.5 8.1 (Berkeley) 6/6/93 +.\" +.Dd June 6, 1993 +.Dt RANLIB 5 +.Os +.Sh NAME +.Nm ranlib +.Nd a.out archive (library) table-of-contents format +.Sh SYNOPSIS +.In ranlib.h +.Sh DESCRIPTION +The archive table-of-contents command +.Nm +creates a table of contents for archives, containing object files, to +be used by the link-editor +.Xr ld 1 . +It operates on archives created with the utility +.Xr ar 1 . +.Pp +The +.Nm +function +prepends a new file to the archive which has three separate parts. +The first part is a standard archive header, which has a special name +field, "__.SYMDEF". +.Pp +The second part is a +.Dq long +followed by a list of ranlib structures. +The long is the size, in bytes, of the list of ranlib structures. +Each of the ranlib structures consists of a zero based offset into the +next section (a string table of symbols) and an offset from the beginning +of the archive to the start of the archive file which defines the symbol. +The actual number of ranlib structures is this number divided by the size +of an individual ranlib structure. +.Pp +The third part is a +.Dq long +followed by a string table. +The long is the size, in bytes of the string table. +.Sh SEE ALSO +.Xr ar 1 , +.Xr ranlib 1 +.Sh BUGS +The +.Tn <ranlib.h> +header file, and the +.Nm +manual page, do not describe the table-of-contents used by ELF systems, which +is that from the +.At V.4 +ABI. diff --git a/static/netbsd/man5/rc.conf.5 b/static/netbsd/man5/rc.conf.5 new file mode 100644 index 00000000..679dadea --- /dev/null +++ b/static/netbsd/man5/rc.conf.5 @@ -0,0 +1,1650 @@ +.\" $NetBSD: rc.conf.5,v 1.194 2024/10/02 15:56:37 roy Exp $ +.\" +.\" Copyright (c) 1996 Matthew R. Green +.\" 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. +.\" +.\" Copyright (c) 1997 Curt J. Sampson +.\" Copyright (c) 1997 Michael W. Long +.\" Copyright (c) 1998-2010 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This document is derived from works contributed to The NetBSD Foundation +.\" by Luke Mewburn. +.\" +.\" 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 October 2, 2024 +.Dt RC.CONF 5 +.Os +.Sh NAME +.Nm rc.conf +.Nd system startup configuration file +.Sh DESCRIPTION +The +.Nm +file specifies which services are enabled during system startup by +the startup scripts invoked by +.Pa /etc/rc +(see +.Xr rc 8 ) , +and the shutdown scripts invoked by +.Pa /etc/rc.shutdown . +The +.Nm +file is a shell script that is sourced by +.Xr rc 8 , +meaning that +.Nm +must contain valid shell commands. +.Pp +Listed below are the standard +.Nm +variables that may be set, the values to which each may be set, +a brief description of what each variable does, and a reference to +relevant manual pages. +Third party packages may test for additional variables. +.Pp +By default, +.Nm +reads +.Pa /etc/defaults/rc.conf +(if it is readable) +to obtain default values for various variables, and the end-user +may override these by appending appropriate entries to the end of +.Nm . +.Pp +.Xr rc.d 8 +scripts that use +.Ic load_rc_config +from +.Xr rc.subr 8 +also support sourcing an optional end-user provided per-script override +file +.Pa /etc/rc.conf.d/ Ns Ar service , +(where +.Ar service +is the contents of the +.Sy name +variable in the +.Xr rc.d 8 +script). +This may contain variable overrides, including allowing the end-user +to override various +.Ic run_rc_command +.Xr rc.d 8 +control variables, and thus changing the operation of the script +without requiring editing of the script. +.Ss Variable naming conventions and data types +Most variables are one of two types: enabling variables or flags +variables. +Enabling variables, such as +.Sy inetd , +are generally named after the program or the system they enable, +and have boolean values (specified using +.Ql YES , +.Ql TRUE , +.Ql ON +or +.Ql 1 +for true, and +.Ql NO , +.Ql FALSE , +.Ql OFF +or +.Ql 0 +for false, with the values being case insensitive). +Flags variables, such as +.Sy inetd_flags +have the same name with +.Dq _flags +appended, and determine what +arguments are passed to the program if it is enabled. +.Pp +If a variable that +.Xr rc 8 +expects to be set is not set, or the value is not one of the allowed +values, a warning will be printed. +.Ss Overall control +.Bl -tag -width net_interfaces +.It Sy do_rcshutdown +Boolean value. +If false, +.Xr shutdown 8 +will not run +.Pa /etc/rc.shutdown . +.It Sy rcshutdown_rcorder_flags +A string. +Extra arguments to the +.Xr rcorder 8 +run by +.Pa /etc/rc.shutdown . +.It Sy rcshutdown_timeout +A number. +If non-blank, use this as the number of seconds to run a watchdog timer for +which will terminate +.Pa /etc/rc.shutdown +if the timer expires before the shutdown script completes. +.It Sy rc_configured +Boolean value. +If false then the system will drop into single-user mode during boot. +.It Sy rc_fast_and_loose +If set to a non-empty string, +each script in +.Pa /etc/rc.d +will be executed in the current shell rather than a sub shell. +This may be faster on slow machines that have an expensive +.Xr fork 2 +operation. +.Bl -hang +.It Em Note : +Use this at your own risk! +A rogue command or script may inadvertently prevent boot to multiuser. +.El +.It Sy rc_rcorder_flags +A string. +Extra arguments to the +.Xr rcorder 8 +run by +.Pa /etc/rc . +.It Sy rc_directories +A string. +Space separated list of directories searched for rc scripts. +The default is +.Pa /etc/rc.d . +All directories in +.Ev rc_directories +must be located in the root file system, otherwise they will be silently +skipped. +.It Sy rc_silent +Boolean value. +If true then the usual output is suppressed, and +.Xr rc 8 +invokes the command specified in the +.Va rc_silent_cmd +variable once for each line of suppressed output. +The default value of +.Va rc_silent +is set from the +.Dv AB_SILENT +flag in the kernel's +.Va boothowto +variable (see +.Xr boot 8 , +.Xr reboot 2 ) . +.It Sy rc_silent_cmd +A command to be executed once per line of suppressed output, when +.Va rc_silent +is true. +The default value of +.Va rc_silent_cmd +is +.Ql twiddle , +which will display a spinning symbol instead of each line of output. +Another useful value is +.Ql \&: , +which will display nothing at all. +.El +.Ss Basic network configuration +.Bl -tag -width net_interfaces +.It Sy defaultroute +A string. +Default IPv4 network route. +If empty or not set, then the contents of +.Pa /etc/mygate +(if it exists) are used. +.It Sy defaultroute6 +A string. +Default IPv6 network route. +If empty or not set, then the contents of +.Pa /etc/mygate6 +(if it exists) are used. +.It Sy domainname +A string. +NIS (YP) domain of host. +If empty or not set, then the contents of +.Pa /etc/defaultdomain +(if it exists) are used. +.It Sy force_down_interfaces +A space separated list of interface names. +These interfaces will be configured down when going from multiuser to single-user +mode or on system shutdown. +.It Sy dns_domain +A string. +Sets domain in +.Pa /etc/resolv.conf . +.It Sy dns_search +A string. +Sets search in +.Pa /etc/resolv.conf . +.It Sy dns_nameservers +A string of space separated domain name servers. +Sets nameserver for each value in +.Pa /etc/resolv.conf . +.It Sy dns_sortlist +A string. +Sets sortlist in +.Pa /etc/resolv.conf . +.It Sy dns_options +A string. +Sets options in +.Pa /etc/resolv.conf . +.It Sy dns_metric +An unsigned integer. +Sets the priority of the above DNS to other sources, lowest wins. +Defaults to 0. +.Pp +This is important for some stateful interfaces, for example PPPoE interfaces +which have no direct means of noticing +.Dq disconnect +events. +.Pp +All active +.Xr pppoe 4 +interfaces will be automatically added to this list. +.It Sy hostname +A string. +Name of host. +If empty or not set, then the contents of +.Pa /etc/myname +(if it exists) are used. +.El +.Ss Boottime file-system and swap configuration +.Bl -tag -width net_interfaces +.It Sy critical_filesystems_local +A string. +File systems mounted very early in the system boot before networking +services are available. +Usually +.Pa /var +is part of this, because it is needed by services such as +.Xr dhcpcd 8 +which may be required to get the network operational. +The default is +.Ql "OPTIONAL:" Ns Pa /var , +where the +.Ql "OPTIONAL:" +prefix means that it's not an error if the file system is not +present in +.Xr fstab 5 . +.It Sy critical_filesystems_remote +A string. +File systems such as +.Pa /usr +that may require network services to be available to mount, +that must be available early in the system boot for general services to use. +The default is +.Ql "OPTIONAL:" Ns Pa /usr , +where the +.Ql "OPTIONAL:" +prefix means that it is not an error if the file system is not +present in +.Xr fstab 5 . +.It Sy critical_filesystems_zfs +A string. +Mount non-legacy ZFS file systems right after mounting local +file systems listed in +.Sy critical_filesystems_local +variable. +An entry can be prefixed with +.Ql "OPTIONAL:" +which means that it is not an error if the file system is not present +among available ZFS datasets. +The default is ''. +.It Sy fsck_flags +A string. +A file system is checked with +.Xr fsck 8 +during boot before mounting it. +This option may be used to override the default command-line options +passed to the +.Xr fsck 8 +program. +.Pp +When set to +.Fl y , +.Xr fsck 8 +assumes yes as the answer to all operator questions during file system checks. +This might be important with hosts where the administrator does not have +access to the console and an unsuccessful shutdown must not make the host +unbootable even if the file system checks would fail in preen mode. +.It Sy modules +Boolean value. +If true, loads the modules specified in +.Xr modules.conf 5 . +.It Sy no_swap +Boolean value. +Should be true if you have deliberately configured your system with no swap. +If false and no swap devices are configured, the system will warn you. +.It Sy resize_root +Boolean value. +Set to true to have the system resize the root file system to fill its +partition. +Will only attempt to resize the root file system if it is of type ffs and does +not have logging enabled. +Defaults to false. +.It Sy swapoff +Boolean value. +Remove block-type swap devices at shutdown time. +Useful if swapping onto RAIDframe devices. +.It Sy swapoff_umount +.Dq "auto" +or +.Dq "manual" . +Before removing block-type swap devices, it is wise to unmount tmpfs filesystems to avoid having to swap their contents back into RAM. +By default +.Dq ( "auto" ) +all tmpfs filesystems that contain no device nodes are unmounted. +Set to +.Dq "manual" +to explicitly specify which filesystems to unmount before removing swap. +.It Sy swapoff_umount_fs +A space-separated list of absolute paths to tmpfs mount points. +If +.Sy swapoff_umount +is set to +.Dq "manual" , +these tmpfs filesystems will be forcibly unmounted before removing block-type +swap devices. +.It Sy var_shm_symlink +A path. +If set, names a path that +.Pa /var/shm +will be symlinked to. +.Pp +The path needs to live on a tmpfs file system. +A typical value (assuming +.Pa /tmp +is mounted on tmpfs) would be +.Pa /tmp/.shm . +.El +.Ss Block device subsystems +.Bl -tag -width net_interfaces +.It Sy ccd +Boolean value. +Configures concatenated disk devices according to +.Xr ccd.conf 5 . +.It Sy cgd +Boolean value. +Configures cryptographic disk devices. +Requires +.Pa /etc/cgd/cgd.conf . +See +.Xr cgdconfig 8 +for additional details. +.It Sy lvm +Boolean value. +Configures the logical volume manager. +See +.Xr lvm 8 +for additional details. +.It Sy raidframe +Boolean value. +Configures +.Xr raid 4 , +RAIDframe disk devices. +See +.Xr raidctl 8 +for additional details. +.It Sy zfs +Boolean value. +Configures ZFS storage pools and ZFS file systems. +.El +.Ss One-time actions to perform or programs to run on boot-up +.Bl -tag -width net_interfaces +.It Sy accounting +Boolean value. +Enables process accounting with +.Xr accton 8 . +Requires +.Pa /var/account/acct +to exist. +.It Sy clear_tmp +Boolean value. +Clear +.Pa /tmp +after reboot. +.It Sy dmesg +Boolean value. +Create +.Pa /var/run/dmesg.boot +from the output of +.Xr dmesg 8 . +Passes +.Sy dmesg_flags . +.It Sy entropy +A string, either +.Sq Li check , +.Sq Li wait , +or +.Sq Li "" +(empty). +If set and nonempty, then during boot-up, after +.Sy random_seed +and +.Sy rndctl , +check for or wait until enough entropy before any networking is +enabled. +.Pp +If not enough entropy is available, then: +.Bl -bullet -compact +.It +With +.Sq Li entropy=check , +stop multiuser boot and enter single-user mode instead. +.It +With +.Sq Li entropy=wait , +wait until enough entropy is available. +.El +.Pp +Note that +.Sq Li entropy=wait +may cause the system to hang indefinitely at boot if it has neither a +random seed nor any hardware random number generators \(em use with +care. +.Pp +If empty or not set, the system may come to multiuser without entropy, +which is unsafe to use on the internet; it is the operator's +responsibility to heed warnings from the kernel and the daily +.Xr security.conf 5 +report to remedy the problem \(em see +.Xr entropy 7 . +.It Sy envsys +Boolean value. +Sets preferences for the environmental systems framework, +.Xr envsys 4 . +Requires +.Pa /etc/envsys.conf , +which is described in +.Xr envsys.conf 5 . +.It Sy gpio +Boolean value. +Configure +.Xr gpio 4 +devices. +See +.Xr gpio.conf 5 . +.It Sy ldconfig +Boolean value. +Configures +.Xr a.out 5 +runtime link editor directory cache. +.It Sy mixerctl +Boolean value. +Read +.Xr mixerctl.conf 5 +for how to set mixer values. +List in +.Sy mixerctl_mixers +the devices whose settings are to be saved at shutdown and +restored at start-up. +.It Sy newsyslog +Boolean value. +Run +.Nm newsyslog +to trim log files before syslogd starts. +Intended for laptop users. +Passes +.Sy newsyslog_flags . +.It Sy per_user_tmp +Boolean value. +Enables a per-user +.Pa /tmp +directory. +.Sy per_user_tmp_dir +can be used to override the default location of the +.Dq real +temporary directories, +.Pa /private/tmp . +See +.Xr security 7 +for additional details. +.It Sy quota +Boolean value. +Checks and enables quotas by running +.Xr quotacheck 8 +and +.Xr quotaon 8 . +.It Sy random_seed +Boolean value. +During boot-up, runs the +.Xr rndctl 8 +utility with the +.Fl L +flag to seed the random number subsystem from an entropy file. +During shutdown, runs the +.Xr rndctl 8 +utility with the +.Fl S +flag to save some random information to the entropy file. +The entropy file name is specified by the +.Sy random_file +variable, and defaults to +.Pa /var/db/entropy-file . +The entropy file must be on a local file system that is writable early during +boot-up (just after the file systems specified in +.Sy critical_filesystems_local +have been mounted), and correspondingly late during shutdown. +.It Sy rndctl +Boolean value. +Runs the +.Xr rndctl 8 +utility one or more times according to the specification in +.Sy rndctl_flags . +.Pp +If +.Sy rndctl_flags +does not contain a semicolon +.Pq Ql \&; +then it is expected to contain zero or more flags, +followed by one or more device or type names. +The +.Xr rndctl 8 +command will be executed once for each device or type name. +If the specified flags do not include any of +.Fl c , C , e , +or +.Fl E , +then the flags +.Fl c +and +.Fl e +are added, to specify that entropy from the relevant device or type +should be both collected and estimated. +If the specified flags do not include either of +.Fl d +or +.Fl t , +then the flag +.Fl d +is added, to specify that the non-flag arguments are device names, +not type names. +.Pp +.Sy rndctl_flags +may contain multiple semicolon-separated segments, in which each +segment contains flags and device or type names as described above. +This allows different flags to be associated with different +device or type names. +For example, given +.Li rndctl_flags="wd0 wd1; -t tty; -c -t net" , +the following commands will be executed: +.Li "rndctl -c -e -d wd0" ; +.Li "rndctl -c -e -d wd1" ; +.Li "rndctl -c -e -t tty" ; +.Li "rndctl -c -t net" . +.It Sy rtclocaltime +Boolean value. +Sets the real time clock to local time by adjusting the +.Xr sysctl 7 +value of +.Pa kern.rtc_offset . +The offset from UTC is calculated automatically according +to the time zone information in the file +.Pa /etc/localtime . +.It Sy savecore +Boolean value. +Runs the +.Xr savecore 8 +utility. +Passes +.Sy savecore_flags . +The directory where crash dumps are stored is specified by +.Sy savecore_dir . +The default setting is +.Pa /var/crash . +.It Sy sysdb +Boolean value. +Builds various system databases, including +.Pa /var/run/dev.cdb , +.Pa /etc/spwd.db , +.Pa /var/db/netgroup.db , +.Pa /var/db/services.cdb , +and entries for +.Xr utmp 5 . +.It Sy tpctl +Boolean value. +Run +.Xr tpctl 8 +to calibrate touch panel device. +Passes +.Sy tpctl_flags . +.It Sy update_motd +Boolean value. +Updates the +.Nx +version string in the +.Pa /etc/motd +file to reflect the version of the running kernel. +See +.Xr motd 5 . +.It Sy update_motd_release +Boolean value. +If enabled in addition to +.Sy update_motd , +updates a second +.Nx +version string in the +.Pa /etc/motd +file to reflect the version, architecture, and Build ID of +the installed userland. +An optional prefix can be provided for this version string in +.Sy motd_release_tag . +.It Sy virecover +Boolean value. +Send notification mail to users if any recoverable files exist in +.Pa /var/tmp/vi.recover . +Read +.Xr virecover 8 +for more information. +.It Sy wdogctl +Boolean value. +Configures watchdog timers. +Passes +.Sy wdogctl_flags . +Refer to +.Xr wdogctl 8 +for information on how to configure a timer. +.El +.Ss System security settings +.Bl -tag -width net_interfaces +.It Sy securelevel +A number. +The system securelevel is set to the specified value early +in the boot process, before any external logins, or other programs +that run users job, are started. +If set to nothing, the default action is taken, as described in +.Xr init 8 +and +.Xr secmodel_securelevel 9 , +which contains definitive information about the system securelevel. +Note that setting +.Sy securelevel +to 0 in +.Nm +will actually result in the system booting with securelevel set to 1, as +.Xr init 8 +will raise the level when +.Xr rc 8 +completes. +.It Sy permit_nonalpha +Boolean value. +Allow passwords to include non-alpha characters, usually to allow +NIS/YP netgroups. +.It Sy veriexec +Boolean value. +Load Veriexec fingerprints during startup. +Read +.Xr veriexecctl 8 +for more information. +.It Sy veriexec_strict +A number. +Controls the strict level of Veriexec. +Level 0 is learning mode, used when building the signatures file. +It will only output messages but will not enforce anything. +Level 1 will only prevent access to files with a fingerprint +mismatch. +Level 2 will also deny writing to and removing of +monitored files, as well as enforce access type (as specified in +the signatures file). +Level 3 will take a step further and prevent +access to files that are not monitored. +.It Sy veriexec_verbose +A number. +Controls the verbosity of Veriexec. +Recommended operation is at level 0, verbose output (mostly used when +building the signatures file) is at level 1. +Level 2 is for debugging only and should not be used. +.It Sy veriexec_flags +A string. +Flags to pass to the +.Nm veriexecctl +command. +.It Sy smtoff +Boolean value. +Disables SMT (Simultaneous Multi-Threading). +.El +.Ss Networking startup +.Bl -tag -width net_interfaces +.It Sy altqd +Boolean value. +ALTQ configuration/monitoring daemon. +Passes +.Sy altqd_flags . +.It Sy auto_ifconfig +Boolean value. +Sets the +.Sy net_interfaces +variable (see below) to the output of +.Xr ifconfig 8 +with the +.Fl l +flag and suppresses warnings about interfaces in this list that +do not have an ifconfig file or variable. +.It Sy blocklistd +Boolean value. +Runs +.Xr blocklistd 8 +to dynamically block hosts on a DoS according to configuration set in +.Xr blocklistd.conf 5 +Passes +.Sy blocklistd_flags . +.It Sy dhcpcd +Boolean value. +Set true to configure some or all network interfaces using dhcpcd. +If you set +.Sy dhcpcd +true, then +.Pa /var +must be in +.Sy critical_filesystems_local , +or +.Pa /var +must be on the root file system. +If you need to restrict dhcpcd to one or a number of interfaces, +or need a separate configuration per interface, +then this should be done in the configuration file - see +.Xr dhcpcd.conf 5 +for details. +.It Sy dhcpcd_flags +Passes +.Sy dhcpcd_flags +to dhcpcd. +See +.Xr dhcpcd 8 +for complete documentation. +.It Sy flushroutes +Boolean value. +Flushes the route table on networking startup. +Useful when coming up to multiuser mode after going down to +single-user mode. +.It Sy ftp_proxy +Boolean value. +Runs +.Xr ftp-proxy 8 , +the proxy daemon for the Internet File Transfer Protocol. +.It Sy hostapd +Boolean value. +Runs +.Xr hostapd 8 , +the authenticator for IEEE 802.11 networks. +.It Sy ifaliases_* +A string. +List of +.Sq Em "address netmask" +pairs to configure additional network addresses for the given +configured interface +(e.g. +.Sy ifaliases_le0 ) . +If +.Em netmask +is +.Ql - , +then use the default netmask for the interface. +.Pp +.Sy ifaliases_* +covers limited cases only and is considered unrecommended. +We recommend using +.Sy ifconfig_xxN +variables or +.Pa /etc/ifconfig. Ns Ar xxN +files with multiple lines instead. +.It Sy ifwatchd +Boolean value. +Monitor dynamic interfaces and perform actions upon address changes. +Passes +.Sy ifwatchd_flags . +.It Sy ip6addrctl +Boolean value. +Fine grain control of address and routing priorities. +.It Sy ip6addrctl_policy +A string. +Can be: +.Bl -tag -width "Ql auto" -compact +.It Ql auto +automatically determine from system settings; will read priorities from +.Pa /etc/ip6addrctl.conf +or if that file does not exist it will default to IPv6 first, then IPv4. +.It Ql ipv4_prefer +try IPv4 before IPv6. +.It Ql ipv6_prefer +try IPv6 before IPv4. +.El +.It Sy ip6addrctl_verbose +Boolean value. +If set, print the resulting prefixes and priorities map. +.It Sy ip6mode +A string. +An IPv6 node can be a router +.Pq nodes that forward packet for others +or a host +.Pq nodes that do not forward . +A host can be autoconfigured +based on the information advertised by adjacent IPv6 routers. +By setting +.Sy ip6mode +to +.Ql router , +.Ql host , +or +.Ql autohost , +you can configure your node as a router, +a non-autoconfigured host, or an autoconfigured host. +Invalid values will be ignored, and the node will be configured as +a non-autoconfigured host. +.It Sy ip6uniquelocal +Boolean value. +If +.Sy ip6mode +is equal to +.Ql router , +and +.Sy ip6uniquelocal +is false, +a reject route will be installed on boot to avoid misconfiguration relating +to unique-local addresses. +If +.Sy ip6uniquelocal +is true, the reject route won't be installed. +.It Sy ipfilter +Boolean value. +Runs +.Xr ipf 8 +to load in packet filter specifications from +.Pa /etc/ipf.conf +at network boot time, before any interfaces are configured. +Passes +.Sy ipfilter_flags . +See +.Xr ipf.conf 5 . +.It Sy ipfs +Boolean value. +Runs +.Xr ipfs 8 +to save and restore information for ipnat and ipfilter state tables. +The information is stored in +.Pa /var/db/ipf/ipstate.ipf +and +.Pa /var/db/ipf/ipnat.ipf . +Passes +.Sy ipfs_flags . +.It Sy ipmon +Boolean value. +Runs +.Xr ipmon 8 +to read +.Xr ipf 8 +packet log information and log it to a file or the system log. +Passes +.Sy ipmon_flags . +.It Sy ipmon_flags +A string. +Specifies arguments to supply to +.Xr ipmon 8 . +Defaults to +.Ql -ns . +A typical example would be +.Ql "-nD /var/log/ipflog" +to have +.Xr ipmon 8 +log directly to a file bypassing +.Xr syslogd 8 . +If the +.Fl D +argument is used, remember to modify +.Pa /etc/newsyslog.conf +accordingly; for example: +.Pp +.Dl /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid +.It Sy ipnat +Boolean value. +Runs +.Xr ipnat 8 +to load in the IP network address translation (NAT) rules from +.Pa /etc/ipnat.conf +at network boot time, before any interfaces are configured. +See +.Xr ipnat.conf 5 . +.It Sy ipsec +Boolean value. +Runs +.Xr setkey 8 +to load in IPsec manual keys and policies from +.Pa /etc/ipsec.conf +at network boot time, before any interfaces are configured. +.It Sy npf +Boolean value. +Loads +.Xr npf.conf 5 +at network boot time, and starts +.Xr npf 7 . +.It Sy npfd +Boolean value. +Runs +.Xr npfd 8 , +the NPF packet filter logging and state synchronization daemon. +Passes +.Sy npfd_flags . +.It Sy net_interfaces +A string. +The list of network interfaces to be configured at boot time. +For each interface "xxN", the system first looks for ifconfig +parameters in the variable +.Sy ifconfig_xxN , +and then in the file +.Pa /etc/ifconfig.xxN . +If +.Sy auto_ifconfig +is false, and neither the variable nor the file is found, +a warning is printed. +Information in either the variable or the file is parsed identically, +except that, if an +.Sy ifconfig_xxN +variable contains a single line with embedded semicolons, +then the value is split into multiple lines prior to further parsing, +treating the semicolon as a line separator. +.Pp +One common case it to set the +.Sy ifconfig_xxN +variable to a set of arguments to be passed to an +.Xr ifconfig 8 +command after the interface name. +Refer to +.Xr ifconfig.if 5 +for more details on +.Pa /etc/ifconfig.xxN +files, and note that the information there also applies to +.Sy ifconfig_xxN +variables (after the variables are split into lines). +.It Sy ntpdate +Boolean value. +Runs +.Xr ntpdate 8 +to set the system time from one of the hosts in +.Sy ntpdate_hosts . +If +.Sy ntpdate_hosts +is empty, it will attempt to find a list of hosts in +.Pa /etc/ntp.conf . +Passes +.Sy ntpdate_flags . +.It Sy pf +Boolean value. +Enable +.Xr pf 4 +at network boot time: +Load the initial configuration +.Xr pf.boot.conf 5 +before the network is up. +After the network has been configured, then load the final rule set +.Xr pf.conf 5 . +.It Sy pf_rules +A string. +The path of the +.Xr pf.conf 5 +rule set that will be used when loading the final rule set. +.It Sy pflogd +Boolean value. +Run +.Xr pflogd 8 +for dumping packet filter logging information to a file. +.It Sy ppp +A boolean. +Toggles starting +.Xr pppd 8 +on startup. +See +.Sy ppp_peers +below. +.It Sy ppp_peers +A string. +If +.Sy ppp +is true and +.Sy ppp_peers +is not empty, then +.Pa /etc/rc.d/ppp +will check each word in +.Sy ppp_peers +for a corresponding ppp configuration file in +.Pa /etc/ppp/peers +and will call +.Xr pppd 8 +with the +.Dq Ic call Va peer +option. +.It Sy racoon +Boolean value. +Runs +.Xr racoon 8 , +the IKE (ISAKMP/Oakley) key management daemon. +.It Sy wpa_supplicant +Boolean value. +Run +.Xr wpa_supplicant 8 , +WPA/802.11i Supplicant for wireless network devices. +If you set +.Sy wpa_supplicant +true, then +.Pa /usr +must be in +.Sy critical_filesystems_local , +or +.Pa /usr +must be on the root file system. +dhcpcd ignores this variable, see the +.Sy dhcpcd +variable for details. +.El +.Ss Daemons required by other daemons +.Bl -tag -width net_interfaces +.It Sy inetd +Boolean value. +Runs the +.Xr inetd 8 +daemon to start network server processes (as listed in +.Pa /etc/inetd.conf ) +as necessary. +Passes +.Sy inetd_flags . +The +.Fl l +flag turns on libwrap connection logging. +.It Sy rpcbind +Boolean value. +The +.Xr rpcbind 8 +daemon is required for any +.Xr rpc 3 +services. +These include NFS, NIS, +.Xr rpc.bootparamd 8 , +.Xr rpc.rstatd 8 , +.Xr rpc.rusersd 8 , +and +.Xr rpc.rwalld 8 . +Passes +.Sy rpcbind_flags . +.El +.Ss Commonly used daemons +.Bl -tag -width net_interfaces +.It Sy cron +Boolean value. +Run +.Xr cron 8 . +.It Sy ftpd +Boolean value. +Runs the +.Xr ftpd 8 +daemon and passes +.Sy ftpd_flags . +.It Sy httpd +Boolean value. +Runs the +.Xr httpd 8 +daemon and passes +.Sy httpd_flags . +.It Sy httpd_wwwdir +A string. +The +.Xr httpd 8 +WWW root directory. +Used only if +.Sy httpd +is true. +The default setting is +.Pa /var/www . +.It Sy httpd_wwwuser +A string. +If non-blank and +.Sy httpd +is true, run +.Xr httpd 8 +and cause it to switch to the specified user after initialization. +It is preferred to +.Sy httpd_user +because +.Xr httpd 8 +is requiring extra privileges to start listening on default port 80. +The default setting is +.Ql _httpd . +.It Sy lpd +Boolean value. +Runs +.Xr lpd 8 +and passes +.Sy lpd_flags . +The +.Fl l +flag will turn on extra logging. +.It Sy mdnsd +Boolean value. +Runs +.Xr mdnsd 8 . +.It Sy named +Boolean value. +Runs +.Xr named 8 +and passes +.Sy named_flags . +.It Sy named_chrootdir +A string. +If non-blank and +.Sy named +is true, run +.Xr named 8 +as the unprivileged user and group +.Sq named , +.Xr chroot 2 Ns ed +to +.Sy named_chrootdir . +.Li \&${named_chrootdir} Ns Pa /var/run/log +will be added to the list of log sockets that +.Xr syslogd 8 +listens to. +.It Sy ntpd +Boolean value. +Runs +.Xr ntpd 8 +and passes +.Sy ntpd_flags . +.It Sy ntpd_chrootdir +A string. +If non-blank and +.Sy ntpd +is true, run +.Xr ntpd 8 +as the unprivileged user and group +.Sq ntpd , +.Xr chroot 2 Ns ed +to +.Sy ntpd_chrootdir . +.Li \&${ntpd_chrootdir} Ns Pa /var/run/log +will be added to the list of log sockets that +.Xr syslogd 8 +listens to. +This option requires that the kernel has +.D1 Cd pseudo-device clockctl +compiled in, and that +.Pa /dev/clockctl +is present. +.It Sy postfix +Boolean value. +Starts +.Xr postfix 1 +mail system. +.It Sy sshd +Boolean value. +Runs +.Xr sshd 8 +and passes +.Sy sshd_flags . +.It Sy syslogd +Boolean value. +Runs +.Xr syslogd 8 +and passes +.Sy syslogd_flags . +.It Sy timed +Boolean value. +Runs +.Xr timed 8 +and passes +.Sy timed_flags . +The +.Fl M +option allows +.Xr timed 8 +to be a master time source as well as a slave. +If you are also running +.Xr ntpd 8 , +only one machine running both should have the +.Fl M +flag given to +.Xr timed 8 . +.It Sy unbound +Boolean value. +Runs +.Xr unbound 8 . +.It Sy unbound_chrootdir +A string. +If non-blank and +.Sy unbound +is true, run +.Xr unbound 8 +.Xr chroot 2 Ns ed +to +.Sy unbound_chrootdir . +.El +.Ss Routing daemons +.Bl -tag -width net_interfaces +.It Sy mrouted +Boolean value. +Runs +.Xr mrouted 8 , +the DVMRP multicast routing protocol daemon. +Passes +.Sy mrouted_flags . +.It Sy route6d +Boolean value. +Runs +.Xr route6d 8 , +the RIPng routing protocol daemon for IPv6. +Passes +.Sy route6d_flags . +.It Sy routed +Boolean value. +Runs +.Xr routed 8 , +the RIP routing protocol daemon. +Passes +.Sy routed_flags . +.\" This should be false +.\" if +.\" .Sy gated +.\" is true. +.El +.Ss Daemons used to boot other hosts over a network +.Bl -tag -width net_interfaces +.It Sy bootparamd +Boolean value. +Runs +.Xr bootparamd 8 , +the boot parameter server, with +.Sy bootparamd_flags +as options. +Used to boot +.Nx +and SunOS 4.x systems. +.It Sy dhcpd +Boolean value. +Runs +.Xr dhcpd 8 , +the Dynamic Host Configuration Protocol (DHCP) daemon, +for assigning IP addresses to hosts and passing boot information. +Passes +.Sy dhcpd_flags . +.It Sy dhcrelay +Boolean value. +Runs +.Xr dhcrelay 8 . +Passes +.Sy dhcrelay_flags . +.It Sy mopd +Boolean value. +Runs +.Xr mopd 8 , +the DEC MOP protocol daemon; used for booting VAX and other DEC +machines. +Passes +.Sy mopd_flags . +.It Sy ndbootd +Boolean value. +Runs +.Xr ndbootd 8 , +the Sun Network Disk (ND) Protocol server. +Passes +.Sy ndbootd_flags . +.It Sy rarpd +Boolean value. +Runs +.Xr rarpd 8 , +the reverse ARP daemon, often used to boot +.Nx +and Sun workstations. +Passes +.Sy rarpd_flags . +.It Sy rbootd +Boolean value. +Runs +.Xr rbootd 8 , +the HP boot protocol daemon; used for booting HP workstations. +Passes +.Sy rbootd_flags . +.It Sy rtadvd +Boolean value. +Runs +.Xr rtadvd 8 , +the IPv6 router advertisement daemon, which is used to advertise +information about the subnet to IPv6 end hosts. +Passes +.Sy rtadvd_flags . +This is only for IPv6 routers, so set +.Sy ip6mode +to +.Ql router +if you use it. +.El +.Ss X Window System daemons +.Bl -tag -width net_interfaces +.It Sy xdm +Boolean value. +Runs the +.Xr xdm 1 +X display manager. +These X daemons are available only with the optional X distribution of +.Nx . +.It Sy xfs +Boolean value. +Runs the +.Xr xfs 1 +X11 font server, which supplies local X font files to X terminals. +.El +.Ss NIS (YP) daemons +.Bl -tag -width net_interfaces +.It Sy ypbind +Boolean value. +Runs +.Xr ypbind 8 , +which lets NIS (YP) clients use information from a NIS server. +Passes +.Sy ypbind_flags . +.It Sy yppasswdd +Boolean value. +Runs +.Xr yppasswdd 8 , +which allows remote NIS users to update password on master server. +Passes +.Sy yppasswdd_flags . +.It Sy ypserv +Boolean value. +Runs +.Xr ypserv 8 , +the NIS (YP) server for distributing information from certain files +in +.Pa /etc . +Passes +.Sy ypserv_flags . +The +.Fl d +flag causes it to use DNS for lookups in +.Pa /etc/hosts +that fail. +.El +.Ss NFS daemons and parameters +.Bl -tag -width net_interfaces +.It Sy amd +Boolean value. +Runs +.Xr amd 8 , +the automounter daemon, which automatically mounts NFS file systems +whenever a file or directory within that file system is accessed. +Passes +.Sy amd_flags . +.It Sy amd_dir +A string. +The +.Xr amd 8 +mount directory. +Used only if +.Sy amd +is true. +.It Sy lockd +Boolean value. +Runs +.Xr rpc.lockd 8 +if +.Sy nfs_server +and/or +.Sy nfs_client +are true. +Passes +.Sy lockd_flags . +.It Sy mountd +Boolean value. +Runs +.Xr mountd 8 +and passes +.Sy mountd_flags . +.It Sy nfs_client +Boolean value. +The number of local NFS asynchronous I/O server is now controlled via +.Xr sysctl 8 . +.It Sy nfs_server +Boolean value. +Sets up a host to be a NFS server by running +.Xr nfsd 8 +and passing +.Sy nfsd_flags . +.It Sy statd +Boolean value. +Runs +.Xr rpc.statd 8 , +a status monitoring daemon used when +.Xr rpc.lockd 8 +is running, if +.Sy nfs_server +and/or +.Sy nfs_client +are true. +Passes +.Sy statd_flags . +.El +.Ss Bluetooth support +.Bl -tag -width net_interfaces +.It Sy bluetooth +Boolean value. +Configure Bluetooth support, comprising the following tasks: +.Bl -dash -compact +.It +attach serial Bluetooth controllers as listed in the +.Pa /etc/bluetooth/btattach.conf +configuration file. +.It +enable Bluetooth controllers with useful defaults, plus +additional options as detailed below. +.It +optionally, start +.Xr bthcid 8 , +the Bluetooth Link Key/PIN Code manager, passing +.Sy bthcid_flags . +.It +configure local Bluetooth drivers as listed in the +.Pa /etc/bluetooth/btdevctl.conf +configuration file. +.It +optionally, start +.Xr sdpd 8 , +the Service Discovery server, passing +.Sy sdpd_flags . +.El +.It Sy btconfig_devices +A string. +An optional list of Bluetooth controllers to configure. +.It Sy btconfig_{dev} +A string. +Additional configuration options for specific Bluetooth controllers. +.It Sy btconfig_args +A string. +Additional configuration options for Bluetooth controllers without +specific options as above. +.It Sy bthcid +Boolean value. +If set to false, disable starting the Bluetooth Link Key/PIN Code manager. +.It Sy sdpd +Boolean value. +If set to false, disable starting the Bluetooth Service Discovery server. +.El +.Ss Other daemons +.Bl -tag -width net_interfaces +.It Sy identd +Boolean value. +Runs +.Xr identd 8 , +the daemon for the user identification protocol. +Passes +.Sy identd_flags . +.It Sy iscsi_target +Boolean value. +Runs the server for iSCSI requests, +.Xr iscsi-target 8 . +Passes +.Sy iscsi_target_flags . +.It Sy kdc +Boolean value. +Runs the +.Xr kdc 8 +Kerberos v4 and v5 server. +This should be run on Kerberos master and slave servers. +.It Sy rwhod +Boolean value. +Runs +.Xr rwhod 8 +to support the +.Xr rwho 1 +and +.Xr ruptime 1 +commands. +.It Sy autofs +Boolean value. +If set to +.Ql YES , +start the +.Xr automount 8 +utility and the +.Xr automountd 8 +and +.Xr autounmountd 8 +daemons at boot time. +.It Sy automount_flags +A string. +If +.Sy autofs +is set to +.Ql YES , +these are the flags to pass to the +.Xr automount 8 +program. +By default no flags are passed. +.It Sy automountd_flags +A string. +If +.Sy autofs +is set to +.Ql YES , +these are the flags to pass to the +.Xr automountd 8 +daemon. +By default no flags are passed. +.It Sy autounmountd_flags +A string. +If +.Sy autofs +is set to +.Ql YES , +these are the flags to pass to the +.Xr autounmountd 8 +daemon. +By default no flags are passed. +.El +.Ss Hardware daemons +.Bl -tag -width net_interfaces +.It Sy apmd +Boolean value. +Runs +.Xr apmd 8 +and passes +.Sy apmd_flags . +.It Sy irdaattach +Boolean value. +Runs +.Xr irdaattach 8 +and passes +.Sy irdaattach_flags . +.It Sy moused +Boolean value. +Runs +.Xr moused 8 , +to pass serial mouse data to the wscons mouse mux. +Passes +.Sy moused_flags . +.It Sy screenblank +Boolean value. +Runs +.Xr screenblank 1 +and passes +.Sy screenblank_flags . +.It Sy wscons +Boolean value. +Configures the +.Xr wscons 4 +console driver, from the configuration file +.Pa /etc/wscons.conf . +.It Sy wsmoused +Boolean value. +Runs +.Xr wsmoused 8 , +to provide copy and paste text support in wscons displays. +Passes +.Sy wsmoused_flags . +.El +.Sh FILES +.Bl -tag -width /etc/defaults/rc.conf -compact +.It Pa /etc/rc.conf +The file +.Nm +resides in +.Pa /etc . +.It Pa /etc/defaults/rc.conf +Default settings for +.Nm , +sourced by +.Nm +before the end-user configuration section. +.It Pa /etc/rc.conf.d/ Ns Ar foo +.Ar foo Ns No -specific +.Nm +overrides. +.El +.Sh SEE ALSO +.Xr boot 8 , +.Xr rc 8 , +.Xr rc.d 8 , +.Xr rc.subr 8 , +.Xr rcorder 8 +.Sh HISTORY +The +.Nm +file appeared in +.Nx 1.3 . diff --git a/static/netbsd/man5/remote.5 b/static/netbsd/man5/remote.5 new file mode 100644 index 00000000..58143cc3 --- /dev/null +++ b/static/netbsd/man5/remote.5 @@ -0,0 +1,222 @@ +.\" $NetBSD: remote.5,v 1.13 2020/08/29 13:32:27 fcambus 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. +.\" +.\" @(#)remote.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd April 5, 2012 +.Dt REMOTE 5 +.Os +.Sh NAME +.Nm remote +.Nd remote host description file +.Sh DESCRIPTION +The systems known by +.Xr tip 1 +and their attributes are stored in an +.Tn ASCII +file which +is structured as described by +.Xr capfile 5 . +Each line in the file provides a description for a single +.Em system . +Fields are separated by a colon +.Pq Dq \&: . +Lines ending in a \e character with an immediately following newline are +continued on the next line. +.Pp +The first entry is the name(s) of the host system. +If there is more than one name for a system, the names are separated +by vertical bars. +After the name of the system comes the fields of the description. +A field name followed by an `=' sign indicates a string value follows. +A field name followed by a `#' sign indicates a following numeric value. +.Pp +Entries named +.Dq tip* +and +.Dq cu* +are used as default entries by +.Xr tip 1 , +and the +.Xr cu 1 +interface to +.Xr tip 1 , +as follows. +When +.Xr tip 1 +is invoked with only a phone number, it looks for an entry +of the form +.Dq tip300 , +where 300 is the baud rate with +which the connection is to be made. +When the +.Xr cu 1 +interface is used, entries of the form +.Dq cu300 +are used. +.Sh CAPABILITIES +Capabilities are either strings (str), numbers (num), or boolean flags (bool). +A string capability is specified by +.Em "capability=value" ; +for example, +.Dq Li dv=/dev/harris . +A numeric capability is specified by +.Em "capability#value" ; +for example, +.Dq Li xa#99 . +A boolean capability is specified by simply listing the capability. +.Bl -tag -width indent +.It Cm \&at +(str) +Auto call unit type. +.It Cm \&br +(num) +The baud rate used in establishing +a connection to the remote host. +This is a decimal number. +The default baud rate is 300 baud. +.It Cm \&cm +(str) +An initial connection message to be sent to the remote host. +For example, if a host is reached through a port selector, this might +be set to the appropriate sequence required to switch to the host. +.It Cm \&cu +(str) +Call unit if making a phone call. +Default is the same as the `dv' field. +.It Cm \&dc +(bool) +This host is directly connected, and tip should not expect carrier detect +to be high, nor should it exit if carrier detect drops. +.It Cm \&di +(str) +Disconnect message sent to the host when a +disconnect is requested by the user. +.It Cm \&du +(bool) +This host is on a dial-up line. +.It Cm \&dv +(str) +.Ux +device(s) to open to establish a connection. +If this file refers to a terminal line, +.Xr tip 1 +attempts to perform an exclusive open on the device to ensure only +one user at a time has access to the port. +.It Cm \&el +(str) +Characters marking an end-of-line. +The default is +.Dv NULL . +`~' escapes are only +recognized by +.Xr tip 1 +after one of the characters in `el', +or after a carriage-return. +.It Cm \&fs +(str) +Frame size for transfers. +The default frame size is equal to +.Dv BUFSIZ . +.It Cm \&hd +(bool) +The host uses half-duplex communication, local +echo should be performed. +.It Cm \&hf +(bool) +Use hardware (RTS/CTS) flow control. +.It Cm \&ie +(str) +Input end-of-file marks. +The default is +.Dv NULL . +.It Cm \&oe +(str) +Output end-of-file string. +The default is +.Dv NULL . +When +.Xr tip 1 +is transferring a file, this +string is sent at end-of-file. +.It Cm \&pa +(str) +The type of parity to use when sending data +to the host. +This may be one of +.Sy even , +.Sy odd , +.Sy none , +.Sy zero +(always set bit 8 to zero), +.Sy one +(always set bit 8 to one). +The default is even parity. +.It Cm \&pn +(str) +Telephone number(s) for this host. +If the telephone number field contains an @ sign, +.Xr tip 1 +searches the file +.Pa /etc/phones +file for a list of telephone numbers; +see +.Xr phones 5 . +.It Cm \&tc +(str) +Indicates that the list of capabilities is continued in the named +description. +This is used primarily to share common capability information. +.El +.Pp +Here is a short example showing the use of the capability continuation +feature: +.Bd -literal +UNIX-1200:\e +:dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200: +arpavax|ax:\e +:pn=7654321%:tc=UNIX-1200 +.Ed +.Sh FILES +.Bl -tag -width /etc/remote -compact +.It Pa /etc/remote +The +.Nm remote +host description file +resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr tip 1 , +.Xr phones 5 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/static/netbsd/man5/resolv.conf.5 b/static/netbsd/man5/resolv.conf.5 new file mode 100644 index 00000000..2cb076c8 --- /dev/null +++ b/static/netbsd/man5/resolv.conf.5 @@ -0,0 +1,296 @@ +.\" $NetBSD: resolv.conf.5,v 1.32 2024/09/07 19:13:28 rillig Exp $ +.\" +.\" Copyright (c) 1986, 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. +.\" +.\" @(#)resolver.5 5.12 (Berkeley) 5/10/91 +.\" +.Dd September 7, 2024 +.Dt RESOLV.CONF 5 +.Os +.Sh NAME +.Nm resolv.conf +.Nd resolver configuration file +.Sh DESCRIPTION +The +.Nm resolv.conf +file specifies how the +.Xr resolver 3 +routines in the C library +(which provide access to the Internet Domain Name System) should operate. +The resolver configuration file contains information that is read +by the resolver routines the first time they are invoked by a process. +The file is designed to be human readable and contains a list of +keywords with values that provide various types of resolver information. +.Pp +On a normally configured system this file should not be necessary. +The only name server to be queried will be on the local machine, +the domain name is determined from the host name, +and the domain search path is constructed from the domain name. +.Pp +The different configuration options are: +.Bl -tag -width nameserver +.It Sy nameserver +IPv4 address +.Pq in dot notation +or IPv6 address +.Pq in hex-and-colon notation +of a name server that the resolver should query. +Scoped IPv6 address notation is accepted as well +.Po +see +.Xr inet6 4 +for details +.Pc . +Up to +.Dv MAXNS +(currently 3) name servers may be listed, +one per keyword. +If there are multiple servers, +the resolver library queries them in the order listed. +If no +.Sy nameserver +entries are present, +the default is to use the name server on the local machine. +(The algorithm used is to try a name server, and if the query times out, +try the next, until out of name servers, +then repeat trying all the name servers +until a maximum number of retries are made). +.It Sy domain +Local domain name. +Most queries for names within this domain can use short names +relative to the local domain. +If no +.Sy domain +entry is present, the domain is determined +from the local host name returned by +.Xr gethostname 3 ; +the domain part is taken to be everything after the first +.Sq \&. . +Finally, if the host name does not contain a domain part, the root +domain is assumed. +.It Sy lookup +This keyword is now ignored: its function has been superseded by +features of +.Xr nsswitch.conf 5 . +.Pp +.It Sy search +Search list for host-name lookup. +The search list is normally determined from the local domain name; +by default, it begins with the local domain name, then successive +parent domains that have at least two components in their names. +This may be changed by listing the desired domain search path +following the +.Sy search +keyword with spaces or tabs separating +the names. +Most resolver queries will be attempted using each component +of the search path in turn until a match is found. +Note that this process may be slow and will generate a lot of network +traffic if the servers for the listed domains are not local, +and that queries will time out if no server is available +for one of the domains. +.Pp +The search list is currently limited to six domains +with a total of 1024 characters. +.It Sy sortlist +Sortlist allows addresses returned by gethostbyname to +be sorted. +A sortlist is specified by IP address netmask pairs. +The netmask is optional and defaults to the natural +netmask of the net. +The IP address and optional network pairs are separated by +slashes. +Up to 10 pairs may be specified, ie. +.Pp +.Sy sortlist 130.155.160.0/255.255.240.0 130.155.0.0 +.It Sy options +Options allows certain internal resolver variables to be modified. +The syntax is: +.Pp +.Sy options option ... +.Pp +where option is one of the following: +.Bl -tag -width no-check-names +.It Sy debug +enable debugging information, by setting RES_DEBUG in _res.options +(see +.Xr resolver 3 ) . +.It Sy ndots:n +sets a threshold for the number of dots which +must appear in a name given to res_query (see +.Xr resolver 3 ) +before an initial absolute query will be made. +The default for n is 1, meaning that if there are any +dots in a name, the name will be tried first as an absolute +name before any search list elements are appended to it. +.It Sy timeout:n +sets the amount of time the resolver will wait for a response from a remote +name server before retrying the query via a different name server. +Measured in seconds, the default is +.Dv RES_TIMEOUT +(see +.Aq Pa resolv.h ) . +.It Sy attempts:n +sets the number of times the resolver will send a query to its name servers +before giving up and returning an error to the calling application. +The default is +.Dv RES_DFLRETRY +(see +.Aq Pa resolv.h ) . +.It Sy rotate +sets +.Dv RES_ROTATE +in +.Ft _res.options , +which causes round robin selection of nameservers from among those listed. +This has the effect of spreading the query load among all listed servers, +rather than having all clients try the first listed server first every time. +.It Sy no-check-names +sets +.Dv RES_NOCHECKNAME +in +.Ft _res.options , +which disables the modern BIND checking of incoming host names and mail names +for invalid characters such as underscore +.Pq Sq _ , +non-ASCII, or control characters. +.It Sy check-names +clears +.Dv RES_NOCHECKNAME +in +.Ft _res.options , +which enables the modern BIND checking of incoming host names and mail names +as described above. +This is the default. +.It Sy edns0 +attach OPT pseudo-RR for ENDS0 extension specified in RFC 2671, +to inform DNS server of our receive buffer size. +The option will allow DNS servers to take advantage of non-default receive +buffer size, and to send larger replies. +DNS query packets with EDNS0 extension is not compatible with +non-EDNS0 DNS servers. +The option must be used only when all the DNS servers listed in +.Sy nameserver +lines are able to handle EDNS0 extension. +.It Sy inet6 +enable support for IPv6-only applications, by setting RES_USE_INET6 in +_res.options (see +.Xr resolver 3 ) . +The option is meaningful with certain kernel configuration only and +use of this option is discouraged. +.It Sy insecure1 +Do not require IP source address on the reply packet to be equal to the +servers' address. +.It Sy insecure2 +Do not check if the query section of the reply packet is equal +to that of the query packet. +For testing purposes only. +.It Sy no-tld-query +sets +.Dv RES_NOTLDQUERY +in +.Ft _res.options . +This option causes +.Fn res_nsearch +to not attempt to resolve a unqualified name as if it were a top level +domain (TLD). +This option can cause problems if the site has +.Dq localhost +as a TLD rather +than having localhost on one or more elements of the search list. +This option has no effect if neither +.Dv RES_DEFNAMES +or +.Dv RES_DNSRCH +is set. +.El +.El +.Pp +The +.Sy domain +and +.Sy search +keywords are mutually exclusive. +If more than one instance of these keywords is present, +the last instance will override. +.Pp +The +.Sy search +keyword of a system's +.Pa resolv.conf +file can be overridden on a per-process basis by setting the +environment variable +.Ev LOCALDOMAIN +to a space-separated list of search domains. +.Pp +The +.Sy options +keyword of a system's +.Pa resolv.conf +file can be amended on a per-process basis by setting the +environment variable +.Ev RES_OPTIONS +to a space-separated list of resolver options as explained above. +.Pp +The keyword and value must appear on a single line, and the keyword +(e.g. +.Sy nameserver ) +must start the line. +The value follows the keyword, separated by white space. +.Sh FILES +.Bl -tag -width /etc/resolv.conf -compact +.It Pa /etc/resolv.conf +The file +.Nm resolv.conf +resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr gethostbyname 3 , +.Xr resolver 3 , +.Xr nsswitch.conf 5 , +.Xr hostname 7 , +.Xr named 8 , +.Xr resolvconf 8 +.Rs +.%A Paul Vixie +.%A Kevin J. Dunlap +.%A Michael J. Karels +.%T "Name Server Operations Guide for BIND" +.%N Release 4.9.4 +.%I CSRG , +.%I Department of Electrical Engineering and Computer Sciences , +.%I University of California, Berkeley +.%D July 16, 1996 +.%U https://web.archive.org/web/20100703030125/http://www.dns.net/dnsrd/docs/bog/bog.html +.Re +.Sh HISTORY +The +.Nm resolv.conf +file format appeared in +.Bx 4.3 . diff --git a/static/netbsd/man5/route.conf.5 b/static/netbsd/man5/route.conf.5 new file mode 100644 index 00000000..b48884f2 --- /dev/null +++ b/static/netbsd/man5/route.conf.5 @@ -0,0 +1,96 @@ +.\" $NetBSD: route.conf.5,v 1.5 2012/05/02 22:38:31 wiz Exp $ +.\" +.\" Copyright (c) 2004 Thomas Klausner +.\" 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 May 1, 2012 +.Dt ROUTE.CONF 5 +.Os +.Sh NAME +.Nm route.conf +.Nd static routes config file +.Sh DESCRIPTION +The +.Nm +file is read by the +.Pa staticroute +rc.d script during system start-up and shutdown, +and is intended for adding and removing static routes. +.Ss FILE FORMAT +Lines starting with a hash +.Pq Sq # +are comments and ignored. +Lines starting with a plus sign +.Pq Sq + +are run during start-up, +while lines starting with a minus sign +.Pq Sq \- +are run during system shutdown. +If a line starts with a +.Sq \&! , +the rest of the line will get evaluated as a shell script fragment. +All other lines are passed to +.Xr route 8 . +During start-up, they are passed behind a +.Dq Ic route add \- +command and during shutdown behind a +.Dq Ic route delete \- +command. +.Sh FILES +.Bl -tag -width XXetcXrouteXconfXX +.It Pa /etc/route.conf +The +.Nm +file resides in +.Pa /etc . +.It Pa /etc/rc.d/staticroute +.Xr rc.d 8 +script that parses +.Nm . +.El +.Sh EXAMPLES +In this example, the interface for the desired routing changes is set, +the IP address on that interface is determined, and a route is added +during startup, or deleted during system shutdown. +.Bd -literal -offset indent +# Set interface and determine current IP address for added route. +!ifname=bnx0 +!ipaddr=$(/sbin/ifconfig ${ifname} | awk '$1 == "inet" {print $2}') +net 10.10.1 -interface ${ipaddr} +.Ed +.Pp +In this example, +IP forwarding is turned on during +start-up, and a static route added for 192.168.2.0. +During system shutdown, the route is removed +and IP forwarding turned off. +.Bd -literal -offset indent +# Turn on/off IP forwarding. ++sysctl -w net.inet.ip.forwarding=1 +-sysctl -w net.inet.ip.forwarding=0 +net 192.168.2.0 -netmask 255.255.255.0 192.168.150.2 +.Ed +.Sh SEE ALSO +.Xr rc.conf 5 , +.Xr rc 8 , +.Xr route 8 diff --git a/static/netbsd/man5/rpc.5 b/static/netbsd/man5/rpc.5 new file mode 100644 index 00000000..6211b1a9 --- /dev/null +++ b/static/netbsd/man5/rpc.5 @@ -0,0 +1,54 @@ +.\" $NetBSD: rpc.5,v 1.11 2013/03/15 19:32:31 njoly Exp $ +.\" @(#)rpc.4 1.17 93/08/30 SMI; from SVr4 +.\" Copyright 1989 AT&T +.Dd December 10, 1991 +.Dt RPC 5 +.Os +.Sh NAME +.Nm rpc +.Nd rpc program number data base +.Sh SYNOPSIS +.Pa /etc/rpc +.Sh DESCRIPTION +The +.Nm +file is a local source containing user readable names that +can be used in place of RPC program numbers. +.Pp +The +.Nm +file has one line for each RPC program name. +The line has the following format: +.Pp +.Dl name-of-the-RPC-program RPC-program-number aliases +.Pp +Items are separated by any number of blanks and/or +tab characters. +A hash +.Pq Dq \&# +indicates the beginning of a comment; +characters up to the end of the line are not interpreted +by routines which search the file. +.Sh FILES +.Pa /etc/rpc +.Sh EXAMPLES +Below is an example of an RPC data base: +.Pp +.Bd -literal +# +# rpc +# +rpcbind 100000 portmap sunrpc portmapper +rusersd 100002 rusers +nfs 100003 nfsprog +mountd 100005 mount showmount +walld 100008 rwall shutdown +sprayd 100012 spray +llockmgr 100020 +nlockmgr 100021 +status 100024 +bootparam 100026 +keyserv 100029 keyserver +.Ed +.Sh SEE ALSO +.Xr getrpcent 3 diff --git a/static/netbsd/man5/security.conf.5 b/static/netbsd/man5/security.conf.5 new file mode 100644 index 00000000..9b392663 --- /dev/null +++ b/static/netbsd/man5/security.conf.5 @@ -0,0 +1,332 @@ +.\" $NetBSD: security.conf.5,v 1.44 2024/11/14 19:57:41 plunky Exp $ +.\" +.\" Copyright (c) 1996 Matthew R. Green +.\" 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 December 2, 2020 +.Dt SECURITY.CONF 5 +.Os +.Sh NAME +.Nm security.conf +.Nd daily security check configuration file +.Sh DESCRIPTION +The +.Nm +file specifies which of the standard +.Pa /etc/security +services are performed. +The +.Pa /etc/security +script is run, by default, every night from +.Pa /etc/daily , +on a +.Nx +system, if configured do to so from +.Pa /etc/daily.conf . +.Pp +The variables described below can be set to "NO" to disable the test: +.Bl -tag -width check_pkg_vulnerabilities +.It Sy check_entropy +This checks whether the system has enough entropy +.Pq see Xr entropy 7 . +.It Sy check_passwd +This checks the +.Pa /etc/master.passwd +file for inconsistencies. +.It Sy check_group +This checks the +.Pa /etc/group +file for inconsistencies. +.It Sy check_rootdotfiles +This checks the root users startup files for sane settings of $PATH +and umask. +This test is not fail safe and any warning generated from +this should be checked for correctness. +.It Sy check_ftpusers +This checks that the correct users are in the +.Pa /etc/ftpusers +file. +.It Sy check_aliases +This checks for security problems in the +.Pa /etc/mail/aliases +file. +For backward compatibility, +.Pa /etc/aliases +will be checked as well if exists. +.It Sy check_rhosts +This checks for system and user rhosts files with "+" in them. +.It Sy check_homes +This checks that home directories are owned by the correct user, +and have appropriate permissions. +.It Sy check_varmail +This checks that the correct user owns mail in +.Pa /var/mail , +and that the mail box has the right permissions. +.It Sy check_nfs +This checks that the +.Pa /etc/exports +file does not export filesystems to the world. +.It Sy check_devices +This checks for changes to devices and setuid files. +.It Sy check_mtree +This runs +.Xr mtree 8 +to ensure that the system is installed correctly. +The following configuration files are checked: +.Bl -tag -width 4n +.It Pa /etc/mtree/special +Default files to check. +.It Pa /etc/mtree/special.local +Local site additions and overrides. +.It Pa /etc/mtree/DIR.secure +Specification for the directory +.Pa DIR . +.El +.It Sy check_disklabels +Backup text copies of the disklabels of available disk drives into +.Pa /var/backups/work/disklabel.XXX , +and display any differences in those and the previous copies +as per +.Sy check_changelist +below. +If +.Xr fdisk 8 +is available on the current platform, the output of +.Pa /sbin/fdisk +for each available disk drive is stored in +.Pa /var/backups/work/fdisk.XXX , +and any differences displayed as per the disklabels. +.It Sy check_pkgs +This stores a list of all installed pkgs into +.Pa /var/backups/work/pkgs +and checks it for any changes. +.It Sy check_changelist +This determines a list of files from the contents of +.Pa /etc/changelist , +and the output of +.Ic mtree -D +for +.Pa /etc/mtree/special +and +.Pa /etc/mtree/special.local . +For each file in the list it compares the files with their backups in +.Pa /var/backups/file.current +and +.Pa /var/backups/file.backup , +and displays any differences found. +The following +.Xr mtree 8 +.Sy tags +modify how files are determined from +.Pa /etc/mtree/special +and +.Pa /etc/mtree/special.local : +.Bl -tag -width exclude -offset indent +.It exclude +The entry is ignored; no backups are made and the differences are not +displayed. +This includes dynamic or binary files such as +.Pa /var/run/utmp . +.It nodiff +The entry is backed up but the differences are not displayed because +the contents of the file are sensitive. +This includes files such as +.Pa /etc/master.passwd . +.El +.It Sy check_pkg_vulnerabilities +Checks the currently installed packages against a database of known +vulnerabilities and reports those that are vulnerable. +Check the +.Sy fetch_pkg_vulnerabilities +setting in +.Xr daily.conf 5 +to keep the database up to date. +.It Sy check_pkg_signatures +Checks the digital signature of all files installed by packages against +the expected values stored in the packages database. +.El +.Pp +The variables described below can be set to modify the tests: +.Bl -tag -width check_network +.It Sy check_homes_permit_usergroups +During the +.Sy check_homes +phase, allow the checked files to be group-writable if the group name is +the same as the username. +.It Sy check_homes_permit_other_owner +During the +.Sy check_homes +phase, allow the home directory and files of the listed users to be owned +by a different user. +.It Sy check_devices_ignore_fstypes +Lists filesystem types to ignore during the +.Sy check_devices +phase. +Prefixing the type with a +.Sq \&! +inverts the match. +For example, +.Ql procfs !local +will ignore +.Ql procfs +type filesystems and filesystems that are not +.Ql local . +.It Sy check_devices_ignore_paths +Lists pathnames to ignore during the +.Sy check_devices +phase. +Prefixing the path with a +.Sq \&! +inverts the match. +For example, +.Ql /tftp +will ignore paths under +.Pa /tftp +while +.Ql !/home +will ignore paths that are not under +.Pa /home . +.It Sy check_mtree_follow_symlinks +During the +.Sy check_mtree +phase, instruct mtree to follow symbolic links. +Please note, this may cause the +.Sy check_mtree +phase to report errors for entries for these symbolic links (i.e. of +type=link in the mtree specification) as they will always appear to be plain +files for the purposes of the check. +.Pa /etc/mtree/special.local +may be used to override the checks for the affected links. +.It Sy check_passwd_nowarn_shells +If +.Sy check_passwd +is enabled, most warnings will be suppressed for entries whose shells +are listed in this space-separated list. +This is of particular value when those shells are not in +.Pa /etc/shells . +.It Sy check_passwd_nowarn_users +If +.Sy check_passwd +is enabled, suppress warnings for these users. +.It Sy check_passwd_permit_dups +If +.Sy check_passwd +is enabled, do not warn about duplicate uids for the listed login names. +.It Sy check_passwd_permit_nonalpha +If +.Sy check_passwd +is enabled, do not warn about login names which use non-alphanumeric +characters. +.It Sy check_passwd_permit_star +If +.Sy check_passwd +is enabled, do not warn about password fields set to +.Dq * . +Note that the use of password fields such as +.Dq *ssh +is encouraged, instead. +.It Sy max_grouplen +If +.Sy check_group +is enabled, this determines the maximum permitted length of group names. +.It Sy max_loginlen +If +.Sy check_passwd +is enabled, this determines the maximum permitted length of login names. +.It Sy backup_dir +Change the backup directory from +.Pa /var/backups . +.It Sy diff_options +Specify the options passed to +.Xr diff 1 +when it is invoked to show changes made to system files. +Defaults to +.Dq -u , +for unified-format context-diffs. +.It Sy pkgdb_dir +.Em DEPRECATED . +Please set +.Dv PKGDB_DIR +in +.Xr pkg_install.conf 5 +instead. +.Pp +If defined, points to the location of the packages database. +Defaults to +.Pa /usr/pkg/pkgdb . +.It Sy backup_uses_rcs +Use +.Xr rcs 1 +for maintaining backup copies of files noted in +.Sy check_devices , +.Sy check_disklabels , +.Sy check_pkgs , +and +.Sy check_changelist +instead of just keeping a current copy and a backup copy. +.It Sy random_file +Name of the entropy seed file used at boot. +Default is +.Pa /var/db/entropy-file +as used by +.Pa /etc/rc.d/random_seed . +Set +.Sy random_file +to empty to disable saving a seed every time +.Pa /etc/security +runs. +.El +.Sh FILES +.Bl -tag -width /etc/defaults/security.conf -compact +.It Pa /etc/defaults/security.conf +defaults for /etc/security.conf +.It Pa /etc/security +daily security check script +.It Pa /etc/security.conf +daily security check configuration +.It Pa /etc/security.local +local site additions to +.Pa /etc/security +.El +.Sh SEE ALSO +.Xr daily.conf 5 +.Sh HISTORY +The +.Nm +file appeared in +.Nx 1.3 . +The +.Sy check_disklabels +functionality was added in +.Nx 1.4 . +The +.Sy backup_uses_rcs +and +.Sy check_pkgs +features were added in +.Nx 1.6 . +.Sy diff_options +appeared in +.Nx 2.0 ; +prior to that, traditional-format (context free) diffs were generated. diff --git a/static/netbsd/man5/services.5 b/static/netbsd/man5/services.5 new file mode 100644 index 00000000..9900dcd3 --- /dev/null +++ b/static/netbsd/man5/services.5 @@ -0,0 +1,92 @@ +.\" $NetBSD: services.5,v 1.11 2023/02/12 22:48:02 uwe 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. +.\" +.\" @(#)services.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd February 12, 2023 +.Dt SERVICES 5 +.Os +.Sh NAME +.Nm services +.Nd service name data base +.Sh DESCRIPTION +The +.Nm services +file contains information regarding +the known services available in the +.Tn DARPA +Internet. +For each service a single line should be present +with the following information: +.Bd -unfilled -offset indent +official service name +port number +protocol name +aliases +.Ed +.Pp +Items are separated by any number of blanks and/or +tab characters. +The port number and protocol name are considered a single +.Em item ; +a slash +.Pq Ql / +is used to separate the port and protocol +.Pq e.g. Ql 512/tcp . +A hash +.Pq Ql # +indicates the beginning of +a comment; subsequent characters up to the end of the line are +not interpreted by the routines which search the file. +.Pp +Service names may contain any printable character other than a +field delimiter, newline, or comment character. +.Pp +The database in +.Pa /var/db/services.cdb +needs to be updated with +.Xr services_mkdb 8 +after changes to the services file have been applied. +.Sh FILES +.Bl -tag -width Pa -compact +.It Pa /etc/services +The current services file. +.It Pa /var/db/services.cdb +The current services database. +.El +.Sh SEE ALSO +.Xr getservent 3 , +.Xr services_mkdb 8 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . +.Sh BUGS +A name server should be used instead of a static file. diff --git a/static/netbsd/man5/shells.5 b/static/netbsd/man5/shells.5 new file mode 100644 index 00000000..431dffa1 --- /dev/null +++ b/static/netbsd/man5/shells.5 @@ -0,0 +1,81 @@ +.\" $NetBSD: shells.5,v 1.8 2003/08/07 10:31:17 agc Exp $ +.\" +.\" Copyright (c) 1986, 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. +.\" +.\" @(#)shells.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd January 16, 1999 +.Dt SHELLS 5 +.Os +.Sh NAME +.Nm shells +.Nd shell database +.Sh DESCRIPTION +The +.Nm shells +file contains a list of the shells on the system. +It can be used in conjunction with the Hesiod domain +.Sq shells , +and the +.Tn NIS +map +.Sq shells , +as controlled by +.Xr nsswitch.conf 5 . +.Pp +For each shell a single line should be present, consisting of the +shell's path, relative to root. +.Pp +A hash +.Pq Dq \&# +indicates the beginning of a comment; subsequent +characters up to the end of the line are not interpreted by the +routines which search the file. +Blank lines are also ignored. +.Sh FILES +.Bl -tag -width /etc/shells -compact +.It Pa /etc/shells +The +.Nm shells +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr chsh 1 , +.Xr getusershell 3 , +.Xr nsswitch.conf 5 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.3 tahoe . +.Pp +The Hesiod and +.Tn NIS +support first appeared in +.Nx 1.4 . diff --git a/static/netbsd/man5/stab.5 b/static/netbsd/man5/stab.5 new file mode 100644 index 00000000..b41f65ee --- /dev/null +++ b/static/netbsd/man5/stab.5 @@ -0,0 +1,219 @@ +.\" $NetBSD: stab.5,v 1.15 2017/07/03 21:30:59 wiz 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. +.\" +.\" @(#)stab.5 8.1 (Berkeley) 6/5/93 +.\" +.Dd June 5, 1993 +.Dt STAB 5 +.Os +.Sh NAME +.Nm stab +.Nd symbol table types +.Sh SYNOPSIS +.In stab.h +.Sh DESCRIPTION +The file +.In stab.h +defines some of the symbol table +.Fa n_type +field values for a.out files. +These are the types for permanent symbols (i.e. not local labels, etc.) +used by the old debugger +.Em sdb +and the Berkeley Pascal compiler +.Ic pc . +Symbol table entries can be produced by the +.Pa .stabs +assembler directive. +This allows one to specify a double-quote delimited name, a symbol type, +one char and one short of information about the symbol, and an unsigned +long (usually an address). +To avoid having to produce an explicit label for the address field, +the +.Pa .stabd +directive can be used to implicitly address the current location. +If no name is needed, symbol table entries can be generated using the +.Pa .stabn +directive. +The loader promises to preserve the order of symbol table entries produced +by +.Pa .stab +directives. +As described in +.Xr a.out 5 , +an element of the symbol table +consists of the following structure: +.Bd -literal +/* +* Format of a symbol table entry. +*/ + +struct nlist { + union { + char *n_name; /* for use when in-core */ + long n_strx; /* index into file string table */ + } n_un; + unsigned char n_type; /* type flag */ + char n_other; /* unused */ + short n_desc; /* see struct desc, below */ + unsigned n_value; /* address or offset or line */ +}; +.Ed +.Pp +The low bits of the +.Fa n_type +field are used to place a symbol into +at most one segment, according to +the following masks, defined in +.In a.out.h . +A symbol can be in none of these segments by having none of these segment +bits set. +.Bd -literal +/* +* Simple values for n_type. +*/ + +#define N_UNDF 0x0 /* undefined */ +#define N_ABS 0x2 /* absolute */ +#define N_TEXT 0x4 /* text */ +#define N_DATA 0x6 /* data */ +#define N_BSS 0x8 /* bss */ + +#define N_EXT 01 /* external bit, or'ed in */ +.Ed +.Pp +The +.Fa n_value +field of a symbol is relocated by the linker, +.Xr ld 1 +as an address within the appropriate segment. +.Fa n_value +fields of symbols not in any segment are unchanged by the linker. +In addition, the linker will discard certain symbols, according to rules +of its own, unless the +.Fa n_type +field has one of the following bits set: +.Bd -literal +/* +* Other permanent symbol table entries have some of the N_STAB bits set. +* These are given in <stab.h> +*/ + +#define N_STAB 0xe0 /* if any of these bits set, don't discard */ +.Ed +.Pp +This allows up to 112 (7 \(** 16) symbol types, split between the various +segments. +Some of these have already been claimed. +The old symbolic debugger, +.Em sdb , +uses the following n_type values: +.Bd -literal +#define N_GSYM 0x20 /* global symbol: name,,0,type,0 */ +#define N_FNAME 0x22 /* procedure name (f77 kludge): name,,0 */ +#define N_FUN 0x24 /* procedure: name,,0,linenumber,address */ +#define N_STSYM 0x26 /* static symbol: name,,0,type,address */ +#define N_LCSYM 0x28 /* .lcomm symbol: name,,0,type,address */ +#define N_RSYM 0x40 /* register sym: name,,0,type,register */ +#define N_SLINE 0x44 /* src line: 0,,0,linenumber,address */ +#define N_SSYM 0x60 /* structure elt: name,,0,type,struct_offset */ +#define N_SO 0x64 /* source file name: name,,0,0,address */ +#define N_LSYM 0x80 /* local sym: name,,0,type,offset */ +#define N_SOL 0x84 /* #included file name: name,,0,0,address */ +#define N_PSYM 0xa0 /* parameter: name,,0,type,offset */ +#define N_ENTRY 0xa4 /* alternative entry: name,linenumber,address */ +#define N_LBRAC 0xc0 /* left bracket: 0,,0,nesting level,address */ +#define N_RBRAC 0xe0 /* right bracket: 0,,0,nesting level,address */ +#define N_BCOMM 0xe2 /* begin common: name,, */ +#define N_ECOMM 0xe4 /* end common: name,, */ +#define N_ECOML 0xe8 /* end common (local name): ,,address */ +#define N_LENG 0xfe /* second stab entry with length information */ +.Ed +.Pp +where the comments give +.Em sdb +conventional use for +.Pa .stab +.Fa s +and the +.Fa n_name , +.Fa n_other , +.Fa n_desc , +and +.Fa n_value +fields +of the given +.Fa n_type . +.Em Sdb +uses the +.Fa n_desc +field to hold a type specifier in the form used +by the Portable C Compiler, +.Xr cc 1 ; +see the header file +.Pa pcc.h +for details on the format of these type values. +.Pp +The Berkeley Pascal compiler, +.Ic pc , +uses the following +.Fa n_type +value: +.Bd -literal +#define N_PC 0x30 /* global pascal symbol: name,,0,subtype,line */ +.Ed +.Pp +and uses the following subtypes to do type checking across separately +compiled files: +.Bd -unfilled -offset indent +1 source file name +2 included file name +3 global label +4 global constant +5 global type +6 global variable +7 global function +8 global procedure +9 external function +10 external procedure +11 library variable +12 library routine +.Ed +.Sh SEE ALSO +.Xr as 1 , +.Xr gdb 1 , +.Xr ld 1 , +.Xr a.out 5 +.Sh HISTORY +The +.Nm stab +file appeared in +.Bx 4.0 . +.Sh BUGS +More basic types are needed. diff --git a/static/netbsd/man5/statvfs.5 b/static/netbsd/man5/statvfs.5 new file mode 100644 index 00000000..65f45174 --- /dev/null +++ b/static/netbsd/man5/statvfs.5 @@ -0,0 +1,191 @@ +.\" $NetBSD: statvfs.5,v 1.17 2025/02/13 08:14:53 wiz Exp $ +.\" +.\" Copyright (c) 1989, 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. +.\" +.\" @(#)statfs.2 8.5 (Berkeley) 5/24/95 +.\" +.Dd February 13, 2025 +.Dt STATVFS 5 +.Os +.Sh NAME +.Nm statvfs +.Nd file system statistics +.Sh SYNOPSIS +.In sys/types.h +.In sys/statvfs.h +.Sh DESCRIPTION +The +.In sys/statvfs.h +header defines the structures and functions that +return information about a mounted file system. +The +.Nm statvfs +structure is defined as follows: +.Bd -literal +typedef struct { int32_t val[2]; } fsid_t; /* file system id type */ + +#define VFS_NAMELEN 32 /* length of fs type name, including nul */ +#define VFS_MNAMELEN 1024 /* length of buffer for returned name */ + +struct statvfs { + unsigned long f_flag; /* copy of mount exported flags */ + unsigned long f_bsize; /* system block size */ + unsigned long f_frsize; /* system fragment size */ + unsigned long f_iosize; /* optimal file system block size */ + + /* The following are in units of f_frsize */ + fsblkcnt_t f_blocks; /* number of blocks in file system */ + fsblkcnt_t f_bfree; /* free blocks avail in file system */ + fsblkcnt_t f_bavail; /* free blocks avail to non-root */ + fsblkcnt_t f_bresvd; /* blocks reserved for root */ + + fsfilcnt_t f_files; /* total file nodes in file system */ + fsfilcnt_t f_ffree; /* free file nodes in file system */ + fsfilcnt_t f_favail /* free file nodes avail to non-root */ + fsfilcnt_t f_fresvd; /* file nodes reserved for root */ + + uint64_t f_syncreads; /* count of sync reads since mount */ + uint64_t f_syncwrites; /* count of sync writes since mount */ + + uint64_t f_asyncreads; /* count of async reads since mount */ + uint64_t f_asyncwrites; /* count of async writes since mount */ + + fsid_t f_fsidx; /* NetBSD compatible file system id */ + unsigned long f_fsid; /* POSIX compliant file system id */ + + unsigned long f_namemax; /* maximum filename length */ + uid_t f_owner; /* user that mounted the file system */ + + uint64_t f_spare[4]; /* spare space */ + + char f_fstypename[VFS_NAMELEN]; /* fs type name */ + char f_mntonname[VFS_MNAMELEN]; /* directory on which mounted */ + char f_mntfromname[VFS_MNAMELEN]; /* mounted file system */ + char f_mntfromlabel[_VFS_MNAMELEN]; /* disk label name if avail */ +}; +.Ed +.Pp +The +.Fa f_flag +argument can have the following bits set: +.Bl -tag -width ST_SYNCHRONOUS +.It Dv ST_RDONLY +The filesystem is mounted read-only; +Even the super-user may not write on it. +.It Dv ST_NOEXEC +Files may not be executed from the filesystem. +.It Dv ST_NOSUID +Setuid and setgid bits on files are not honored when they are executed. +.It Dv ST_NODEV +Special files in the filesystem may not be opened. +.It Dv ST_UNION +Union with underlying filesystem instead of obscuring it. +.It Dv ST_SYNCHRONOUS +All I/O to the filesystem is done synchronously. +.It Dv ST_ASYNC +No filesystem I/O is done synchronously. +.It Dv ST_NOCOREDUMP +Don't write core dumps to this file system. +.It Dv ST_NOATIME +Never update access times. +.It Dv ST_SYMPERM +Recognize symbolic link permission. +.It Dv ST_NODEVMTIME +Never update modification times for device files. +.It Dv ST_LOG +Use logging (journaling). +.It Dv ST_LOCAL +The filesystem resides locally. +.It Dv ST_QUOTA +The filesystem has quotas enabled on it. +.It Dv ST_ROOTFS +Identifies the root filesystem. +.It Dv ST_EXRDONLY +The filesystem is exported read-only. +.It Dv ST_EXPORTED +The filesystem is exported for both reading and writing. +.It Dv ST_DEFEXPORTED +The filesystem is exported for both reading and writing to any Internet host. +.It Dv ST_EXPORTANON +The filesystem maps all remote accesses to the anonymous user. +.It Dv ST_EXKERB +The filesystem is exported with Kerberos uid mapping. +.It Dv ST_EXNORESPORT +Don't enforce reserved ports (NFS). +.It Dv ST_EXPUBLIC +Public export (WebNFS). +.El +.Pp +Fields that are undefined for a particular file system are set to \-1. +.Sh NOTES +.Bl -tag -width f_bavail +.It f_flag +The +.Fa f_flag +field is the same as the +.Fa f_flags +field in the +.Bx 4.3 +.Ic statfs +system call. +.It f_fsid +Is defined to be +.Ft unsigned long +by the X/Open standard. +Unfortunately this is not enough space to store our +.Ft fsid_t , +so we define an additional +.Fa f_fsidx +field. +.It f_bavail +Could historically be negative (in the +.Ic statfs +system call) when the used space has exceeded +the non-superuser free space. +In order to comply with the X/Open standard, we have to define +.Ft fsblkcnt_t +as an unsigned type, so in all cases where +.Fa f_bavail +would have been negative, we set it to 0. +In addition we provide +.Fa f_bresvd +which contains the amount of reserved blocks for the superuser, so +the old value of +.Fa f_bavail +can be easily computed as: +.Bd -literal + old_bavail = f_bfree - f_bresvd; +.Ed +.El +.Sh SEE ALSO +.Xr statvfs 2 +.Sh HISTORY +The +.In sys/statvfs.h +header first appeared in +.Nx 3.0 . diff --git a/static/netbsd/man5/sysctl.conf.5 b/static/netbsd/man5/sysctl.conf.5 new file mode 100644 index 00000000..8f3b4eac --- /dev/null +++ b/static/netbsd/man5/sysctl.conf.5 @@ -0,0 +1,101 @@ +.\" $NetBSD: sysctl.conf.5,v 1.3 2009/05/13 22:57:34 wiz Exp $ +.\" +.\" Copyright (c) 2007 The NetBSD Foundation, Inc. +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 October 4, 2007 +.Dt SYSCTL.CONF 5 +.Os +.Sh NAME +.Nm sysctl.conf +.Nd sysctl configuration file +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +The +.Nm +file defines the +.Xr sysctl 7 +kernel state tunables that can be set at boot time using +.Xr sysctl 8 +(using the +.Fl f +switch) +via the +.Pa /etc/rc.d/sysctl +startup script. +.Pp +The state to be set is described using a +.Dq Management Information Base +.Pq Dq MIB +style name. +The MIB and value must be separated by +.Sq = +with no whitespace, for example: +.Pp +.Ar name Ns Li = Ns Ar value +.Pp +Blank lines, lines with just +.Ar name , +and comments (beginning with +.Sq # ) +are ignored. +Line continuations using backslash +.Sq \e +are permitted. +Only integral and string values can be set. +.\" +.Sh FILES +.Bl -tag -width /etc/sysctl.conf -compact +.It Pa /etc/sysctl.conf +The file +.Nm +resides in +.Pa /etc . +.El +.Sh EXAMPLES +The following is an example +.Pa /etc/sysctl.conf +file: +.Pp +.Bd -literal +# Change max open files +kern.maxfiles=1792 + +# Run Veriexec in IDS mode +kern.veriexec.strict=1 + +# Enable IP packet forwarding +net.inet.ip.forwarding=1 +.Ed +.Sh SEE ALSO +.Xr sysctl 3 , +.Xr rc.conf 5 , +.Xr sysctl 7 , +.Xr sysctl 8 +.Sh HISTORY +Support for +.Nm +first appeared in +.Nx 1.5 . diff --git a/static/netbsd/man5/ttyaction.5 b/static/netbsd/man5/ttyaction.5 new file mode 100644 index 00000000..215bdbc5 --- /dev/null +++ b/static/netbsd/man5/ttyaction.5 @@ -0,0 +1,111 @@ +.\" $NetBSD: ttyaction.5,v 1.11 2021/03/22 00:09:06 wiz Exp $ +.\" +.\" Copyright (c) 1996 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Gordon W. Ross. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd August 24, 1996 +.Dt TTYACTION 5 +.Os +.Sh NAME +.Nm ttyaction +.Nd ttyaction file format +.Sh DESCRIPTION +The +.Nm ttyaction +file specifies site-specific commands to run +when a login session begins and ends. +The +.Nm ttyaction +file contains a list of newline separated records, where +each record has the following three fields: +.Bl -tag -width username +.It ttyname +Name of the tty line(s) on which this line should apply. +The name is relative to the +.Pa /dev +directory, similar to how such devices are named in the +.Pa /etc/ttys +file. +.It action +Name of the action for which this line should apply. +The action names currently defined are "login", "getty", +"telnetd" and "rlogind" +which indicate which program is processing this file. +(Note that "login" begins a login session, while the other +three are run after a login session ends.) +.It command +What command to run if this record matches. +.El +.Pp +The first two fields are delimited with blanks or tabs, +and the command field is all text to the end of the line. +Either or both of first two fields may contain wildcard +match patterns as implemented by the +.Xr fnmatch 3 +library function. +.Pp +All command strings are executed by passing them to +.Pa /bin/sh \-c +running as "root," with an environment containing: +.Bd -literal -offset indent +TTY=ttyname +ACT=action +USER=username +PATH=_PATH_STDPATH +.Ed +.Pp +These variables may be used directly in the shell command +part of the record for simple tasks such as changing the +ownership of related devices. +For example: +.Bd -literal -offset indent +console * chown ${USER}:tty /dev/mouse +.Ed +.Pp +will +.Fa chown +the mouse appropriately when the console owner changes. +.Sh EXAMPLES +Here are some more example records: +.Bd -literal -offset indent +tty0 login /somewhere/tty_setup ${TTY} +tty0 getty /somewhere/tty_clean ${TTY} +* * /somewhere/ttyfrob ${TTY} ${ACT} +.Ed +.Sh SEE ALSO +.Xr fnmatch 3 , +.Xr ttyaction 3 +.Sh HISTORY +Support for the +.Pa /etc/ttyaction +file first appeared in +.Nx 1.3 . +The ideas for the +.Pa /etc/ttyaction +file were inspired by the +.Pa /etc/fbtab +file under SunOS. diff --git a/static/netbsd/man5/utmp.5 b/static/netbsd/man5/utmp.5 new file mode 100644 index 00000000..99aba495 --- /dev/null +++ b/static/netbsd/man5/utmp.5 @@ -0,0 +1,222 @@ +.\" $NetBSD: utmp.5,v 1.18 2019/09/09 00:21:03 sevan 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. +.\" +.\" @(#)utmp.5 8.2 (Berkeley) 3/17/94 +.\" +.Dd September 9, 2019 +.Dt UTMP 5 +.Os +.Sh NAME +.Nm utmp , +.Nm wtmp , +.Nm lastlog +.Nd login records +.Sh SYNOPSIS +.In utmp.h +.Sh DESCRIPTION +The file +.In utmp.h +declares the structures used to record information about current +users in the file +.Nm utmp , +logins and logouts in the file +.Nm wtmp , +and last logins in the file +.Nm lastlog . +The time stamps of date changes, shutdowns and reboots are also logged in +the +.Nm wtmp +file. +.Pp +The +.Nm wtmp +file can grow rapidly on busy systems, and is normally rotated with +.Xr newsyslog 8 . +.Pp +These files must be created manually; +if they do not exist, they are not created automatically. +.Bd -literal -offset indent +#define _PATH_UTMP "/var/run/utmp" +#define _PATH_WTMP "/var/log/wtmp" +#define _PATH_LASTLOG "/var/log/lastlog" + +#define UT_NAMESIZE 8 +#define UT_LINESIZE 8 +#define UT_HOSTSIZE 16 + +struct lastlog { + time_t ll_time; + char ll_line[UT_LINESIZE]; + char ll_host[UT_HOSTSIZE]; +}; + +struct utmp { + char ut_line[UT_LINESIZE]; + char ut_name[UT_NAMESIZE]; + char ut_host[UT_HOSTSIZE]; + time_t ut_time; +}; +.Ed +.Pp +Each time a user logs in, the +.Xr login 1 +program looks up the user's +.Tn UID +in the file +.Nm lastlog . +If it is found, the timestamp of the last time the user logged +in, the terminal line and the hostname +are written to the standard output, providing the login is not set +.Em quiet ; +see +.Xr login 1 . +The +.Xr login 1 +program then records the new login time in the file +.Nm lastlog . +.Pp +After the new +.Fa lastlog +record is written, +.\" the +.\" .Xr libutil 3 +.\" routine +the file +.Nm utmp +is opened and the +.Fa utmp +record for the user inserted. +This record remains there until +the user logs out at which time it is deleted (by clearing +the user and host fields, and updating the timestamp field). +The +.Nm utmp +file is used by the programs +.Xr rwho 1 , +.Xr users 1 , +.Xr w 1 , +and +.Xr who 1 . +.Pp +Next, the +.Xr login 1 +program opens the file +.Nm wtmp , +and appends the user's +.Fa utmp +record. +When the user logs out, a +.Fa utmp +record with the tty line, an updated time stamp, and cleared user and host +fields is appended to the file by +.Xr init 8 . +The +.Nm wtmp +file is used by the programs +.Xr last 1 +and +.Xr ac 8 . +.Pp +In the event of a date change, a shutdown or reboot, the +following items are logged in the +.Nm wtmp +file. +.Pp +.Bl -tag -width shutdownxx -compact +.It Li reboot +.It Li shutdown +A system reboot or shutdown has been initiated. +The character +.Ql \&~ +is placed in the field +.Fa ut_line , +and +.Li reboot +or +.Li shutdown +in the field +.Fa ut_name +(see +.Xr shutdown 8 +and +.Xr reboot 8 ) . +.Pp +.It Li date +The system time has been manually or automatically updated by +.Xr date 1 . +The command name +.Em date +is recorded in the field +.Fa ut_name . +In the field +.Fa ut_line , +the character +.Ql \\*(Ba +indicates the time prior to the change, and the character +.Ql \&{ +indicates the new time. +.El +.Sh FILES +.Bl -tag -width /var/log/lastlog -compact +.It Pa /var/run/utmp +The +.Nm utmp +file. +.It Pa /var/log/wtmp +The +.Nm wtmp +file. +.It Pa /var/log/lastlog +The +.Nm lastlog +file. +.El +.Sh SEE ALSO +.Xr last 1 , +.Xr login 1 , +.Xr w 1 , +.Xr who 1 , +.Xr utmpx 5 , +.Xr ac 8 , +.Xr init 8 , +.Xr lastlogin 8 , +.Xr newsyslog 8 +.Sh HISTORY +A +.Nm utmp +file format appeared in +.At v1 . +The +.Nm wtmp +file format appeared in +.At v2 . +The +.Nm lastlog +file format appeared in +.Bx 3.0 . diff --git a/static/netbsd/man5/utmpx.5 b/static/netbsd/man5/utmpx.5 new file mode 100644 index 00000000..d2459681 --- /dev/null +++ b/static/netbsd/man5/utmpx.5 @@ -0,0 +1,140 @@ +.\" $NetBSD: utmpx.5,v 1.8 2010/03/22 18:58:32 joerg Exp $ +.\" +.\" Copyright (c) 2002 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Thomas Klausner. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd January 31, 2007 +.Dt UTMPX 5 +.Os +.Sh NAME +.Nm utmpx , +.Nm wtmpx , +.Nm lastlogx +.Nd user accounting database +.Sh SYNOPSIS +.In utmpx.h +.Sh DESCRIPTION +In contrast to +.Pa utmp +and +.Pa wtmp , +the extended databases in +.Pa utmpx +and +.Pa wtmpx +reserve more space for logging hostnames, and also +information on a process' ID, termination signal and exit status. +.Pp +The +.In utmpx.h +header defines the structures and functions for logging user. +Currently logged in users are tracked in +.Pa /var/run/utmpx , +a list of all logins and logouts, as well as all shutdowns, reboots +and date changes, is kept in +.Pa /var/log/wtmpx , +and the last login of each user is noted in +.Pa /var/log/lastlogx . +.Pp +The interface to the +.Nm utmpx +file is described in +.Xr getutxent 3 . +.Pp +The +.Nm wtmpx +file can grow rapidly on busy systems, and is normally rotated with +.Xr newsyslog 8 . +.Pp +In the event of a date change, a shutdown, or a reboot, the following +items are logged in the +.Nm wtmpx +file: +.Bl -tag -width shutdownxx -compact -offset indent +.It Li date +The system time has been manually or automatically updated by +.Xr date 1 . +The command name +.Em date +is recorded in the field +.Fa ut_name . +In the field +.Fa ut_line , +the character +.Ql \\*(Ba +indicates the time prior to the change, and the character +.Ql \&{ +indicates the new time. +.It Li reboot +.It Li shutdown +A system reboot or shutdown has been initiated. +The character +.Ql \&~ +is placed in the field +.Fa ut_line , +and +.Li reboot +or +.Li shutdown +in the field +.Fa ut_name +(see +.Xr shutdown 8 +and +.Xr reboot 8 ) , +using +.Xr logwtmpx 3 . +.Pp +.El +.Sh FILES +.Bl -tag -width /var/log/lastlogx -compact +.It Pa /var/run/utmpx +The +.Nm utmpx +file. +.It Pa /var/log/wtmpx +The +.Nm wtmpx +file. +.It Pa /var/log/lastlogx +The +.Nm lastlogx +file. +.El +.Sh SEE ALSO +.Xr last 1 , +.Xr login 1 , +.Xr rwho 1 , +.Xr w 1 , +.Xr who 1 , +.Xr endutxent 3 , +.Xr logwtmpx 3 , +.Xr utmp 5 , +.Xr ac 8 , +.Xr init 8 , +.Xr newsyslog 8 , +.Xr reboot 8 diff --git a/static/netbsd/man5/veriexec.5 b/static/netbsd/man5/veriexec.5 new file mode 100644 index 00000000..42450745 --- /dev/null +++ b/static/netbsd/man5/veriexec.5 @@ -0,0 +1,155 @@ +.\" $NetBSD: veriexec.5,v 1.8 2017/07/03 21:30:59 wiz Exp $ +.\" +.\" Copyright (c) 1999 +.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au +.\" +.\" This code is donated to The NetBSD Foundation by the author. +.\" +.\" 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. +.\" +.\" $Id: veriexec.5,v 1.8 2017/07/03 21:30:59 wiz Exp $ +.\" +.Dd March 18, 2011 +.Dt VERIEXEC 5 +.Os +.Sh NAME +.Nm veriexec +.Nd format for the +.Em Veriexec +signatures file +.Sh DESCRIPTION +.Em Veriexec +loads entries to the in-kernel database from a file describing files to be +monitored and the type of monitoring. +This file is often referred to as the +.Sq signatures database +or +.Sq signatures file . +.Pp +The signatures file can be easily created using +.Xr veriexecgen 8 . +.Sh SIGNATURES DATABASE FORMAT +The signatures database has a line based structure, where each line has several +fields separated by white-space (space, tabs, etc.) taking the following form: +.Pp +.Dl path type fingerprint flags +.Pp +The description for each field is as follows: +.Bl -tag -width "fingerprint" +.It Em path +The full path to the file. +White-space characters can be escaped if prefixed with a +.Sq \e . +.It Em type +Type of fingerprinting algorithm used for the file. +.Pp +Requires kernel support for the specified algorithm. +List of fingerprinting algorithms supported by the kernel can be obtained by +using the following command: +.Bd -literal -offset indent +# sysctl kern.veriexec.algorithms +.Ed +.It Em fingerprint +The fingerprint for the file. +Can (usually) be generated using the following command: +.Bd -literal -offset indent +% cksum -a <algorithm> <file> +.Ed +.It Em flags +Optional listing of entry flags, separated by a comma. +These may include: +.Bl -tag -width "untrusted" +.It Em direct +Allow direct execution only. +.Pp +Execution of a program is said to be +.Dq direct +when the program is invoked by the user (either in a script, manually typing it, +etc.) via the +.Xr execve 2 +syscall. +.It Em indirect +Allow indirect execution only. +.Pp +Execution of a program is said to be +.Dq indirect +if it is invoked by the kernel to interpret a script +.Pq Dq hash-bang . +.It Em file +Allow opening the file only, via the +.Xr open 2 +syscall (no execution is allowed). +.It Em untrusted +Indicate that the file is located on untrusted storage and its fingerprint +evaluation status should not be cached, but rather re-calculated each time +it is accessed. +.\"It also enabled per-page fingerprints for the file, causing pages it as +.\"backing store to be verified for their integrity as well. +.Pp +Fingerprints for untrusted files will always be evaluated on load. +.El +.Pp +To improve readability of the signatures file, the following aliases are +provided: +.Bl -tag -width "interpreter" +.It Em program +An alias for +.Dq direct . +.It Em interpreter +An alias for +.Dq indirect +.It Em script +An alias for both +.Dq direct +and +.Dq file . +.It Em library +An alias for both +.Dq file +and +.Dq indirect . +.El +.Pp +If no flags are specified, +.Dq direct +is assumed. +.El +.Pp +Comments begin with a +.Sq \&# +character and span to the end of the line. +.Sh SEE ALSO +.Xr veriexec 4 , +.Xr security 7 , +.Xr veriexec 8 , +.Xr veriexecctl 8 , +.Xr veriexecgen 8 +.Sh HISTORY +.Nm +first appeared in +.Nx 2.0 . +.Sh AUTHORS +.An Brett Lymn Aq Mt blymn@NetBSD.org +.An Elad Efrat Aq Mt elad@NetBSD.org diff --git a/static/netbsd/man5/weekly.5 b/static/netbsd/man5/weekly.5 new file mode 100644 index 00000000..fb40cb56 --- /dev/null +++ b/static/netbsd/man5/weekly.5 @@ -0,0 +1,111 @@ +.\" $NetBSD: weekly.5,v 1.5 2012/03/06 10:26:18 wiz Exp $ +.\" +.\" Copyright (c) 1996 Matthew R. Green +.\" 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 March 6, 2012 +.Dt WEEKLY 5 +.Os +.Sh NAME +.Nm weekly , +.Nm weekly.conf +.Nd weekly maintenance +.Sh DESCRIPTION +The +.Pa /etc/weekly +script is run, by default, every Saturday morning on a +.Nx +system. +The +.Pa /etc/weekly.conf +file specifies which of the standard +.Nm +services are performed. +.Pp +The variables described below can be set to +.Dq YES +or +.Dq NO +in the +.Pa /etc/weekly.conf +file. +The default settings are in the +.Pa /etc/defaults/weekly.conf +file. +(Note that you should never edit +.Pa /etc/defaults/weekly.conf +directly, as it is often replaced during system upgrades.) +.Bl -tag -width rebuild_locatedb +.It Sy rebuild_locatedb +This rebuilds the +.Xr locate 1 +database, +.Pa /var/db/locate.database , +which must also exist, in order to be rebuilt. +.It Sy rebuild_mandb +This rebuilds the +.Xr apropos 1 +database +.Pa /var/db/man.db , +using +.Xr makemandb 8 +with the +.Fl f +option. +.It Sy rebuild_whatisdb +This rebuilds the +.Xr whatis 1 +database(s). +Note that +.Nx +provides a default whatis.db for the system manual pages and +this may not be needed. +(Adjust your +.Pa /etc/man.conf +as necessary; see +.Xr man.conf 5 +for details.) +.El +.Sh FILES +.Bl -tag -width /etc/weekly.local -compact +.It Pa /etc/weekly +weekly maintenance script +.It Pa /etc/weekly.conf +weekly maintenance configuration +.It Pa /etc/weekly.local +local site additions to +.Pa /etc/weekly +.El +.Sh SEE ALSO +.Xr daily.conf 5 , +.Xr monthly.conf 5 +.Sh HISTORY +The +.Pa /etc/weekly +script first appeared in +.Bx 4.3 . +The +.Pa /etc/weekly.conf +configuration file appeared in +.Nx 1.3 . diff --git a/static/netbsd/man5/wscons.conf.5 b/static/netbsd/man5/wscons.conf.5 new file mode 100644 index 00000000..8c46fe3e --- /dev/null +++ b/static/netbsd/man5/wscons.conf.5 @@ -0,0 +1,166 @@ +.\" $NetBSD: wscons.conf.5,v 1.20 2009/03/11 19:38:08 joerg Exp $ +.\" +.\" Copyright (c) 2000-2008 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Hubert Feyrer <hubert@feyrer.de>. +.\" +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 November 22, 2008 +.Dt WSCONS.CONF 5 +.Os +.Sh NAME +.Nm wscons.conf +.Nd workstation console config file +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +The +.Nm +file defines parameters regarding to the workstation console (wscons). +The file consists of lines starting with a keyword, and one or more arguments. +Empty lines and lines starting with a hash +.Pq Dq \&# +are ignored. +.Pp +This configuration file is used by the +.Pa /etc/rc.d/wscons +script which parses +.Pa /etc/wscons.conf +and runs +.Xr wsconscfg 8 , +.Xr wsconsctl 8 , +and/or +.Xr wsfontload 8 +as configured. +See +.Xr rc.conf 5 +for details on enabling the rc.d script. +.Pp +The following keywords and arguments are recognized: +.Bl -tag -width keyboard +.It Sy font Ar name Ar width Ar height Ar enc Ar file +Used to load a font via +.Xr wsfontload 8 . +.Ar name +gives a font name that can be used later, +.Ar width +can be used to specify the width of a font character in pixel, +.Ar height +is the same, just for the font characters' height. +.Ar enc +is used to declare the font's encoding, see the description on +.Xr wsfontload 8 Ns 's +.Fl e +option for more detail. +.Ar file +gives the absolute path to the font file. +See +.Xr wsfontload 8 +for more information. +. +.It Sy screen Ar idx Ar scr Ar emul +Add and configure virtual console number +.Ar idx +using a screen type of +.Ar scr +(e.g. 80x25) and a +.Ar emul +terminal emulation (e.g. vt100). See +.Xr wsconscfg 8 +for further parameter description. +. +.It Sy keyboard Ar kbd +Attach and configure keyboard +.Ar kbd +using +.Dq Li "wsconscfg -k" . +If +.Ar kbd +is +.Sq Li - +or +.Sq Li auto , +the first free keyboard will be used. +See +.Xr wsconscfg 8 +for more information. +. +.It Sy encoding Ar enc +Set the keyboard map to the given language code +.Ar enc , +using +.Dq Li "wsconsctl -w encoding=enc" . +The map must be supported by the keyboard driver in use and must be +compiled into the kernel. +See the keyboard driver's manpage (e.g., +.Xr pckbd 4 , +.Xr ukbd 4 ) +for details. +. +.It Sy mapfile Ar file +Parses the contents of +.Ar file , +which contains a keyboard map per line, and calls +.Dq Li "wsconsctl -w map+=" +for each line. +See +.Xr wsconsctl 8 +for details. +. +.It Sy mux Ar idx +Used to attach and configure keyboard/mouse multiplexors, using +.Dq Li "wsconscfg -m idx" . +See +.Xr wsconscfg 8 +for more information. +. +.It Sy setvar Ar dev Ar var Ar val +Set arbitrary wscons variable +.Ar var +to value +.Ar val +for specified control device +.Ar dev . +Can be used for direct modification of +.Xr wscons 4 +variables, when no other keywords are suitable. +See +.Xr wsconsctl 8 +for more information. +.El +.Pp +Command arguments can be specified as +.Dq - +which makes default values come into effect as described in the +documentation of the utilities. +.Sh FILES +.Bl -tag -width /etc/wscons.conf -compact +.It Pa /etc/wscons.conf +.El +.Sh SEE ALSO +.Xr wscons 4 , +.Xr wsconscfg 8 , +.Xr wsconsctl 8 , +.Xr wsfontload 8 |