diff options
Diffstat (limited to 'share/man/man5')
67 files changed, 17751 insertions, 0 deletions
diff --git a/share/man/man5/Makefile b/share/man/man5/Makefile new file mode 100644 index 0000000..1216fc4 --- /dev/null +++ b/share/man/man5/Makefile @@ -0,0 +1,90 @@ +# @(#)Makefile 8.1 (Berkeley) 6/5/93 +# $FreeBSD$ + +.include <bsd.own.mk> + +#MISSING: dump.5 plot.5 +MAN= acct.5 \ + ar.5 \ + a.out.5 \ + bluetooth.device.conf.5 \ + bluetooth.hosts.5 \ + bluetooth.protocols.5 \ + ${_boot.config.5} \ + core.5 \ + devfs.5 \ + devfs.conf.5 \ + devfs.rules.5 \ + device.hints.5 \ + dir.5 \ + disktab.5 \ + elf.5 \ + ethers.5 \ + eui64.5 \ + ext2fs.5 \ + fbtab.5 \ + fdescfs.5 \ + forward.5 \ + freebsd-update.conf.5 \ + fs.5 \ + fstab.5 \ + group.5 \ + hosts.5 \ + hosts.equiv.5 \ + hosts.lpd.5 \ + intro.5 \ + libmap.conf.5 \ + link.5 \ + linprocfs.5 \ + linsysfs.5 \ + mailer.conf.5 \ + make.conf.5 \ + moduli.5 \ + motd.5 \ + mqueuefs.5 \ + msdosfs.5 \ + networks.5 \ + nsmb.conf.5 \ + nsswitch.conf.5 \ + nullfs.5 \ + passwd.5 \ + pbm.5 \ + periodic.conf.5 \ + phones.5 \ + portindex.5 \ + portsnap.conf.5 \ + procfs.5 \ + protocols.5 \ + quota.user.5 \ + rc.conf.5 \ + regdomain.5 \ + reiserfs.5 \ + remote.5 \ + resolver.5 \ + services.5 \ + shells.5 \ + src.conf.5 \ + stab.5 \ + style.Makefile.5 \ + sysctl.conf.5 \ + tmpfs.5 \ + xfs.5 + +MLINKS= dir.5 dirent.5 +MLINKS+=fs.5 inode.5 +MLINKS+=hosts.equiv.5 rhosts.5 +MLINKS+=msdosfs.5 msdos.5 +MLINKS+=passwd.5 master.passwd.5 +MLINKS+=quota.user.5 quota.group.5 +MLINKS+=rc.conf.5 rc.conf.local.5 +MLINKS+=resolver.5 resolv.conf.5 + +.if ${MK_HESIOD} != "no" +MAN+= hesiod.conf.5 +.endif + +.if ${MACHINE_ARCH} == "amd64" || ${MACHINE_ARCH} == "i386" +_boot.config.5= boot.config.5 +.endif + +.include <bsd.prog.mk> diff --git a/share/man/man5/a.out.5 b/share/man/man5/a.out.5 new file mode 100644 index 0000000..d6318ef --- /dev/null +++ b/share/man/man5/a.out.5 @@ -0,0 +1,460 @@ +.\" Copyright (c) 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" This manual 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd June 10, 2010 +.Dt A.OUT 5 +.Os +.Sh NAME +.Nm a.out +.Nd format of executable binary files +.Sh SYNOPSIS +.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 host byte-order. +It has a number of sub-components accessed by the macros +.Fn N_GETFLAG , +.Fn N_GETMID , +and +.Fn N_GETMAGIC , +and set by the macro +.Fn N_SETMAGIC . +.Pp +The macro +.Fn 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 +.Fn N_GETMID +returns the machine-id. +This indicates which machine(s) the binary is intended to run on. +.Pp +.Fn 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. +.Em ( bss += block started by symbol) +.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 +.In 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 { + const 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 +(see +.In link.h +for their definitions). +.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 +.In a.out.h +include file appeared in +.At v7 . +.Sh BUGS +Since not all of the supported architectures use the +.Fa a_midmag +field, +it can be difficult to determine what +architecture a binary will execute on +without examining its actual machine code. +Even with a machine identifier, +the byte order of the +.Fa exec +header is machine-dependent. diff --git a/share/man/man5/acct.5 b/share/man/man5/acct.5 new file mode 100644 index 0000000..48283a5 --- /dev/null +++ b/share/man/man5/acct.5 @@ -0,0 +1,131 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd May 15, 2007 +.Dt ACCT 5 +.Os +.Sh NAME +.Nm acct +.Nd execution accounting file +.Sh SYNOPSIS +.In sys/types.h +.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 2 +function call to prepare and append the record +to the accounting file. +.Bd -literal +#define AC_COMM_LEN 16 + +/* + * Accounting structure version 2 (current). + * The first byte is always zero. + * Time units are microseconds. + */ + +struct acctv2 { + uint8_t ac_zero; /* zero identifies new version */ + uint8_t ac_version; /* record version number */ + uint16_t ac_len; /* record length */ + + char ac_comm[AC_COMM_LEN]; /* command name */ + float ac_utime; /* user time */ + float ac_stime; /* system time */ + float ac_etime; /* elapsed time */ + time_t ac_btime; /* starting time */ + uid_t ac_uid; /* user id */ + gid_t ac_gid; /* group id */ + float ac_mem; /* average memory usage */ + float ac_io; /* count of IO blocks */ + __dev_t ac_tty; /* controlling tty */ + + uint16_t ac_len2; /* record length */ + union { + __dev_t ac_align; /* force v1 compatible alignment */ + +#define AFORK 0x01 /* forked but not exec'ed */ +/* ASU is no longer supported */ +#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 */ +#define ANVER 0x20 /* new record version */ + + uint8_t ac_flag; /* accounting flags */ + } ac_trailer; + +#define ac_flagx ac_trailer.ac_flag +}; +.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 ACOMPAT , +.Dv ACORE +and +.Dv ASIG . +.Dv ASU +is no longer supported. +.Dv ANVER +is always set in the above structure. +.Sh SEE ALSO +.Xr lastcomm 1 , +.Xr acct 2 , +.Xr execve 2 , +.Xr sa 8 +.Sh HISTORY +A +.Nm +file format appeared in +.At v7 . +The current record format was introduced on May 2007. +It is backwards compatible with the previous format, +which is still documented in +.In sys/acct.h +and supported by +.Xr lastcomm 1 +and +.Xr sa 8 . diff --git a/share/man/man5/ar.5 b/share/man/man5/ar.5 new file mode 100644 index 0000000..dc802ce --- /dev/null +++ b/share/man/man5/ar.5 @@ -0,0 +1,234 @@ +.\" Copyright (c) 2007 Joseph Koshy. 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 Joseph Koshy ``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 Joseph Koshy 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 September 7, 2007 +.Dt AR 5 +.Os +.Sh NAME +.Nm ar +.Nd format of archives managed by ar(1) and ranlib(1) +.Sh SYNOPSIS +.In ar.h +.Sh DESCRIPTION +An archive managed by the +.Xr ar 1 +and +.Xr ranlib 1 +utilities is a single file that stores the individual members of the +archive along with metadata for each member. +There are two major variants of the +.Xr ar 1 +archive format, the BSD variant and the SVR4/GNU variant. +Both variants are described by this manual page. +.Pp +The header file +.In ar.h +defines constants and structures used to describe the layout +of these archives. +.Ss Archive Layout +.Xr ar 1 +archives start with a string of magic bytes +.Qq !<arch>\en +(constant +.Dv ARMAG +in header +.In ar.h ) . +The content of the archive follows the magic bytes. +Each member stored in the archive is preceded by a fixed size +archive header that stores file permissions, last modification +time, the owner, and the group of the archived file. +.Pp +Archive headers start at an even byte offset in the archive +file. +If the length of the preceding archive member was odd, then an extra +newline character +.Dq "\en" +is used as padding. +.Pp +The archive header comprises six fixed-size ASCII strings followed +by a two character trailer (see +.Vt "struct ar_hdr" +in header file +.In ar.h Ns ): +.Bd -literal +struct ar_hdr { + char ar_name[16]; /* name */ + char ar_date[12]; /* modification time */ + char ar_uid[6]; /* user id */ + char ar_gid[6]; /* group id */ + char ar_mode[8]; /* octal file permissions */ + char ar_size[10]; /* size in bytes */ + char ar_fmag[2]; /* consistency check */ +}; +.Ed +.Pp +Unused characters in the header are filled with space (ASCII 20H) +characters. +Each field of the header abuts the next without additional padding. +.Pp +The members of the archive header are as follows: +.Bl -tag -width "Va ar_name" -compact +.It Va ar_date +This field holds the decimal representation of the +modification time, in seconds since the epoch, of the archive +member. +.It Va ar_fmag +This trailer field holds the two characters +.Qq `\en +(constant +.Dv ARFMAG +defined in header file +.In ar.h Ns ), +and is used for consistency checks. +.It Va ar_gid +This field holds the decimal representation of the numeric +user id of the creator of the member. +.It Va ar_mode +This field holds octal representation of the file permissions +for the member. +.It Va ar_name +This field holds the name of an archive member. +The usage of this field depends on the format variant: +.Bl -tag -width "SVR4/GNU" -compact +.It BSD +In the BSD variant, names that are shorter than 16 characters and +without embedded spaces are stored directly in this field. +If a name has an embedded space, or if it is longer than 16 +characters, then the string +.Qq "#1/" +followed by the decimal representation of the length of the file name +is placed in this field. +The actual file name is stored immediately after the archive header. +The content of the archive member follows the file name. +The +.Va ar_size +field of the header (see below) will then hold the sum of the size of +the file name and the size of the member. +.It SVR4/GNU +In the SVR4/GNU variant, names up to 15 characters in length are +stored directly in this field, and are terminated by a +.Qq / +(ASCII 2FH) character. +Names larger than 15 characters in length are stored in a special +archive string table member (see +.Sx "Archive String Table" +below), and the +.Va ar_name +field holds the string +.Qq "/" +followed by the decimal representation of the offset in the archive +string table of the actual name. +.El +.It Va ar_size +In the SVR4/GNU variant, this field holds the decimal representation +of actual size in bytes of the archived file. +In the BSD variant, for member names that use the +.Va ar_name +field directly, this field holds the decimal representation of the +actual size in bytes of the archived member. +For member names that use the extension mechanism described above, the +field will hold the sum of the sizes, in bytes, of the filename and the +archive member. +.It Va ar_uid +This field holds the decimal representation of the numeric +group id of the creator of the member. +.El +.Ss Archive Symbol Table +An archive may additionally contain an archive symbol table +used by the link editor, +.Xr ld 1 . +This symbol table has the member name +.Qq __.SYMDEF +in the BSD variant of the archive format, and the name +.Qq / +in the SVR4/GNU variant. +.Pp +The format of the symbol table depends on the format variant: +.Bl -tag -width "SVR4/GNU" -compact +.It BSD +In the BSD variant, the symbol table has 4 parts encoded in +a machine dependent manner: +.Bl -enum -compact +.It +The first part is a binary value containing size in bytes of the +second part encoded as a C +.Dq long . +.It +The second part is a list of +.Vt struct ranlib +structures (see +.In ranlib.h Ns ). +Each ranlib structure describes one symbol and comprises of +two C +.Dq long +values. +The first +.Dq long +is a zero-based offset into the string table in the fourth part +for the symbol's name. +The second +.Dq long +is an offset from the beginning of the archive to the start +of the archive header for the member that defines the symbol. +.It +The third part is a binary value denoting the length of the +string table contained in the fourth part. +.It +The fourth part is a string table containing NUL-terminated +strings. +.El +.It SVR4/GNU +In the SVR4/GNU variant, the symbol table comprises of three parts +which follow each other without padding: +.Bl -enum -compact +.It +The first part comprises of a count of entries in the symbol table, +stored a 4 byte binary value in MSB first order. +.It +The next part is an array of 4 byte file offsets within the archive +to archive header for members that define the symbol in question. +Each offset in stored in MSB first order. +.It +The third part is a string table, that contains NUL-terminated +strings for the symbols in the symbol table. +.El +.El +.Ss Archive String Table +In the SVR4/GNU variant of the +.Xr ar 1 +archive format, long file names are stored in a separate +archive string table and referenced from the archive header +for each member. +Each file name is terminated by the string +.Qq /\en . +The string table itself has a name of +.Qq // . +.Sh SEE ALSO +.Xr ar 1 , +.Xr ranlib 1 , +.Xr archive 3 , +.Xr elf 3 , +.Xr gelf 3 , +.Xr elf 5 diff --git a/share/man/man5/bluetooth.device.conf.5 b/share/man/man5/bluetooth.device.conf.5 new file mode 100644 index 0000000..d8abb9e --- /dev/null +++ b/share/man/man5/bluetooth.device.conf.5 @@ -0,0 +1,186 @@ +.\" Copyright (c) 2005 Maksim Yevmenkin <m_evmenkin@yahoo.com> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd May 27, 2008 +.Dt BLUETOOTH.DEVICE.CONF 5 +.Os +.Sh NAME +.Nm bluetooth.device.conf +.Nd Bluetooth device configuration file +.Sh DESCRIPTION +Bluetooth device configuration framework provides ability to adjust certain +Bluetooth device parameters on per-device basis. +.Pp +Bluetooth device configuration files are plain text files that should conform +to basic +.Xr sh 1 +syntax. +Even though Bluetooth device are not exactly shell scripts, +they are parsed and passed through shell +.Ic eval +command. +This makes it possible to use various shell tricks in the Bluetooth device +configuration files. +.Pp +The +.Pa /etc/rc.d/bluetooth +script is used to start and stop Bluetooth devices. +This script is not executed by default when system boots. +It is called by +.Xr devd 8 +in response to Bluetooth device arrival and departure events. +It is possible to execute this script by hand if required. +The script accepts Bluetooth device driver name as an extra parameter. +.Pp +The system wide Bluetooth device configuration file is called +.Pa /etc/defaults/\:bluetooth.device.conf . +Configuration parameters set in the system wide Bluetooth device configuration +file apply to every Bluetooth device connected to the system. +.Pp +Configuration parameters overrides for the specific Bluetooth device +should be placed in the +.Pa /etc/bluetooth/ Ns Ar DEVICE_DRIVER_NAME Ns Pa .conf +file. +Where +.Ar DEVICE_DRIVER_NAME +is the device driver name of the Bluetooth device. +.Pp +The following list provides a name and short description for each +variable that can be set in a Bluetooth device configuration file. +.Bl -tag -width indent-two +.It Va authentication_enable +.Pq Vt bool +The +.Va authentication_enable +parameter controls if the device requires to authenticate the remote device +at connection setup. +If set to +.Dq Li YES , +the device will try to authenticate the other device at connection setup. +Bluetooth authentication requests are handled by +.Xr hcsecd 8 +daemon. +.It Va class +.Pq Vt str +The +.Va class +parameter is used to indicate the capabilities of the device to +other devices. +For more details see +.Dq Assigned Numbers - Bluetooth Baseband +document. +.It Va connectable +.Pq Vt bool +The +.Va connectable +parameter controls whether or not the device should periodically scan for +page attempts from other devices. +If set to +.Dq Li YES , +the device will periodically scan for page attempts from other devices. +.It Va discoverable +.Pq Vt bool +The +.Va discoverable +parameter controls whether or not the device should periodically scan for +inquiry requests from other devices. +If set to +.Dq Li YES , +the device will periodically scan for inquiry requests from other devices. +.It Va encryption_mode +.Pq Vt str +The +.Va encryption_mode +parameter controls if the device requires encryption to the remote device +at connection setup. +At connection setup, only the devices with the +.Va authentication_enable +parameter enabled and +.Va encryption_mode +parameter enabled will try to encrypt the connection to the other device. +Possible values are +.Dq Li NONE +encryption disabled, +.Dq Li P2P +encryption for only point-to-point packets, +or +.Dq Li ALL +encryption for both point-to-point and broadcast packets. +.It Va hci_debug_level +.Pq Vt int +HCI node debug level. +Higher values mean more verbose output. +.It Va l2cap_debug_level +.Pq Vt int +L2CAP node debug level. +Higher values mean more verbose output. +.It Va local_name +.Pq Vt str +The +.Va local_name +parameter provides the ability to modify the user friendly name for the device. +.It Va role_switch +.Pq Vt bool +The +.Va role_switch +parameter controls whether the local device should perform role switch. +By default, if role switch is supported, the local device will try to perform +role switch and become Master on incoming connection. +Some devices do not support role switch and thus incoming connections from +such devices will fail. +If +.Va role switch +is disabled then accepting device will remain Slave. +.El +.Sh FILES +.Bl -tag -width ".Pa /etc/defaults/bluetooth.device.conf" -compact +.It Pa /etc/defaults/bluetooth.device.conf +.It Pa /etc/rc.d/bluetooth +.El +.Sh EXAMPLES +The +.Pa /etc/bluetooth/ubt0.conf +file should be used to specify configuration parameters overrides for the +first USB Bluetooth device +(device driver name is +.Li ubt0 ) . +.Pp +The +.Pa /etc/bluetooth/ubt1.conf +file should be used to specify configuration parameters overrides for the +second USB Bluetooth device. +.Sh SEE ALSO +.Xr ng_bt3c 4 , +.Xr ng_h4 4 , +.Xr ng_hci 4 , +.Xr ng_l2cap 4 , +.Xr ng_ubt 4 , +.Xr devd 8 , +.Xr hccontrol 8 , +.Xr hcsecd 8 , +.Xr l2control 8 +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/share/man/man5/bluetooth.hosts.5 b/share/man/man5/bluetooth.hosts.5 new file mode 100644 index 0000000..bda4d92 --- /dev/null +++ b/share/man/man5/bluetooth.hosts.5 @@ -0,0 +1,63 @@ +.\" Copyright (c) 2003 Maksim Yevmenkin <m_evmenkin@yahoo.com> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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. +.\" +.\" $Id: bluetooth.hosts.5,v 1.5 2003/05/20 22:52:39 max Exp $ +.\" $FreeBSD$ +.\" +.Dd May 8, 2003 +.Dt BLUETOOTH.HOSTS 5 +.Os +.Sh NAME +.Nm bluetooth.hosts +.Nd Bluetooth host name database +.Sh DESCRIPTION +The +.Pa /etc/bluetooth/hosts +file contains information regarding the known Bluetooth hosts. +For each Bluetooth host a single line should be present with the +following information: +.Bd -unfilled -offset indent +Bluetooth address +official host name +aliases +.Ed +.Pp +Items are separated by any number of blanks and/or tab characters. +A +.Ql # +indicates the beginning of a comment; characters up to the end of the line are +not interpreted by routines which search the file. +.Pp +Bluetooth addresses are specified as six hex bytes separated by columns +(BD_ADDR). +Host names may contain any printable character other than a field +delimiter, newline, or comment character. +.Sh FILES +.Bl -tag -width ".Pa /etc/bluetooth/hosts" -compact +.It Pa /etc/bluetooth/hosts +.El +.Sh SEE ALSO +.Xr bluetooth 3 +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/share/man/man5/bluetooth.protocols.5 b/share/man/man5/bluetooth.protocols.5 new file mode 100644 index 0000000..64a7dd5 --- /dev/null +++ b/share/man/man5/bluetooth.protocols.5 @@ -0,0 +1,62 @@ +.\" Copyright (c) 2003 Maksim Yevmenkin <m_evmenkin@yahoo.com> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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. +.\" +.\" $Id: bluetooth.protocols.5,v 1.1 2003/05/20 22:52:39 max Exp $ +.\" $FreeBSD$ +.\" +.Dd May 8, 2003 +.Dt BLUETOOTH.PROTOCOLS 5 +.Os +.Sh NAME +.Nm bluetooth.protocols +.Nd Bluetooth Protocol Service Multiplexor database +.Sh DESCRIPTION +The +.Pa /etc/bluetooth/protocols +file contains information regarding the known Bluetooth Protocol Service +Multiplexor values. +For each Bluetooth Protocol Service Multiplexor a single line should be +present with the following information: +.Bd -unfilled -offset indent +official Protocol Service Multiplexor name +official Protocol Service Multiplexor value +aliases +.Ed +.Pp +Items are separated by any number of blanks and/or tab characters. +A +.Ql # +indicates the beginning of a comment; characters up to the end of the line are +not interpreted by routines which search the file. +.Pp +Bluetooth Protocol Service Multiplexor names may contain any printable +character other than a field delimiter, newline, or comment character. +.Sh FILES +.Bl -tag -width ".Pa /etc/bluetooth/hosts" -compact +.It Pa /etc/bluetooth/protocols +.El +.Sh SEE ALSO +.Xr bluetooth 3 +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/share/man/man5/boot.config.5 b/share/man/man5/boot.config.5 new file mode 100644 index 0000000..681fc3a --- /dev/null +++ b/share/man/man5/boot.config.5 @@ -0,0 +1,103 @@ +.\" Copyright (c) 2007 Daniel Gerzo <danger@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. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.Dd May 13, 2007 +.Dt BOOT.CONFIG 5 +.Os +.Sh NAME +.Nm boot.config +.Nd "Configuration file for the boot blocks" +.Sh DESCRIPTION +The +.Nm +file contains options for the +.Fx +boot block code. +.Pp +When the +.Fx +boot loader runs, it searches the +.Dq Li a +slice of the boot partition for a +.Nm +file (as a result, slices which are missing an +.Dq Li a +partition require user intervention during the boot process). +If the +.Nm +file is found, its contents are used as the default configuration +options for the boot block code and are echoed to the system console. +.Pp +A valid format of this file is to put BIOS drive number, a controller +type, a unit number, a partition, a kernel file name, and any other +valid +.Xr boot 8 +option on a single line, as it is done at the +.Dq Li "boot:" +prompt. +.Pp +The options related to the boot image selection described below and all +the other options available for +.Nm +are documented in detail in the +.Xr boot 8 +manual page. +.Sh FILES +.Bl -tag -width /boot.config -compact +.It Pa /boot.config +parameters for the boot blocks (optional) +.El +.Sh EXAMPLES +The command: +.Bd -literal -offset indent +# echo "-P" > /boot.config +.Ed +.Pp +will activate the serial console of +.Fx . +.Pp +The command: +.Bd -literal -offset indent +# echo "1:ad(1,a)/boot/loader" > /boot.config +.Ed +.Pp +will instruct the second stage of +.Xr boot 8 +on the first disk to boot with the third +.Xr boot 8 +stage from the second disk. +.Pp +The command: +.Bd -literal -offset indent +# echo "1:ad(1,a)/boot/loader -P" > /boot.config +.Ed +.Pp +will do both of the above. +.Sh SEE ALSO +.Xr boot 8 , +.Xr loader 8 +.Sh AUTHORS +This manual page was written by +.An Daniel Gerzo Aq danger@FreeBSD.org . diff --git a/share/man/man5/core.5 b/share/man/man5/core.5 new file mode 100644 index 0000000..b2b57f1 --- /dev/null +++ b/share/man/man5/core.5 @@ -0,0 +1,144 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd January 9, 2002 +.Dt CORE 5 +.Os +.Sh NAME +.Nm core +.Nd memory image file format +.Sh SYNOPSIS +.In sys/param.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 sigaction 2 . ) +This memory image is written to a file named by default +.Nm programname.core +in the working directory; +provided the terminated process had write permission in the directory, +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 . ) +.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. +.Pp +The name of the file is controlled via the +.Xr sysctl 8 +variable +.Va kern.corefile . +The contents of this variable describes a filename to store +the core image to. +This filename can be absolute, or relative (which +will resolve to the current working directory of the program +generating it). +.Pp +The following format specifiers may be used in the +.Va kern.corefile +sysctl to insert additional information into the resulting core file +name: +.Bl -tag -width "1234567890" -compact -offset "12345" +.It Em \&%H +Machine hostname. +.It Em \&%I +An index starting at zero until the sysctl +.Em debug.num_cores +is reached. This can be useful for limiting the number of corefiles +generated by a particular process. +.It Em \&%N +process name. +.It Em \&%P +processes PID. +.It Em \&%U +process UID. +.El +.Pp +The name defaults to +.Em \&%N.core , +yielding the traditional +.Fx +behaviour. +.Pp +By default, a process that changes user or group credentials whether +real or effective will not create a corefile. +This behaviour can be +changed to generate a core dump by setting the +.Xr sysctl 8 +variable +.Va kern.sugid_coredump +to 1. +.Pp +Corefiles can be compressed by the kernel if the following items +are included in the kernel configuration file: +.Bl -tag -width "1234567890" -compact -offset "12345" +.It options +COMPRESS_USER_CORES +.It devices +gzio +.El +.Pp +When COMPRESS_USER_CORES is included the following sysctls can control +if core files will be compressed: +.Bl -tag -width "kern.compress_user_cores_gzlevel" -compact -offset "12345" +.It Em kern.compress_user_cores_gzlevel +Gzip compression level. Defaults to -1. +.It Em kern.compress_user_cores +Actually compress user cores. Core files will have the suffix +.Em .gz +appended to them. +.El +.Sh EXAMPLES +In order to store all core images in per-user private areas under +.Pa /var/coredumps , +the following +.Xr sysctl 8 +command can be used: +.Pp +.Dl sysctl kern.corefile="/var/coredumps/\&%U/\&%N.core" +.Sh SEE ALSO +.Xr gdb 1 , +.Xr kgdb 1 , +.Xr setrlimit 2 , +.Xr sigaction 2 , +.Xr sysctl 8 +.Sh HISTORY +A +.Nm +file format appeared in +.At v6 . diff --git a/share/man/man5/devfs.5 b/share/man/man5/devfs.5 new file mode 100644 index 0000000..e27ff74 --- /dev/null +++ b/share/man/man5/devfs.5 @@ -0,0 +1,106 @@ +.\" Copyright (c) 1996 +.\" Mike Pritchard <mpp@FreeBSD.org>. All rights reserved. +.\" +.\" Copyright (c) 1992, 1993, 1994 +.\" The Regents of the University of California. All rights reserved. +.\" All rights reserved. +.\" +.\" This code is derived from software donated to Berkeley by +.\" Jan-Simon Pendry. +.\" +.\" 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 the University of +.\" California, Berkeley and its contributors. +.\" 4. 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. +.\" +.\" $FreeBSD$ +.\" +.Dd May 30, 2010 +.Dt DEVFS 5 +.Os +.Sh NAME +.Nm devfs +.Nd device file system +.Sh SYNOPSIS +.Bd -literal +devfs /dev devfs rw 0 0 +.Ed +.Sh DESCRIPTION +The device file system, or +.Nm , +provides access to kernel's device +namespace in the global file system namespace. +The conventional mount point is +.Pa /dev . +.Pp +The file system includes several directories, links, symbolic links +and devices, some of which can also be written. +In a chroot'ed +environment, +.Nm +can be used to create a new +.Pa /dev +mount point. +.Pp +The +.Xr mknod 8 +tool can be used to recover deleted device entries under +.Nm . +.Sh FILES +.Bl -tag -width /dev/XXXX -compact +.It Pa /dev +The normal +.Nm +mount point. +.El +.Sh EXAMPLES +To mount a +.Nm +volume located on +.Pa /mychroot/dev : +.Pp +.Dl "mount -t devfs devfs /mychroot/dev" +.Sh SEE ALSO +.Xr devfs 8 , +.Xr mount 8 +.Sh HISTORY +The +.Nm +file system first appeared in +.Fx 2.0 . +It became the preferred method for accessing devices in +.Fx 5.0 +and the only method in +.Fx 6.0 . +The +.Nm +manual page first appeared in +.Fx 2.2 . +.Sh AUTHORS +The +.Nm +manual page was written by +.An Mike Pritchard Aq mpp@FreeBSD.org . diff --git a/share/man/man5/devfs.conf.5 b/share/man/man5/devfs.conf.5 new file mode 100644 index 0000000..9d83726 --- /dev/null +++ b/share/man/man5/devfs.conf.5 @@ -0,0 +1,140 @@ +.\" Copyright (c) 2004 Roland Smith <rsmith@xs4all.nl> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd May 17, 2005 +.Dt DEVFS.CONF 5 +.Os +.Sh NAME +.Nm devfs.conf +.Nd boot-time devfs configuration information +.Sh DESCRIPTION +The +.Nm +file provides an easy way to set ownership and permissions, or create +links for devices available at boot. +.Pp +It does not work for devices plugged in and out after the system is up +and running, e.g.\& USB devices. +See +.Xr devfs.rules 5 +for setting ownership and permissions for all device nodes, and +.Xr devd.conf 5 +for actions to be taken when devices are attached or detached. +.Pp +Lines starting with a hash sign +.Pq Ql # +and empty lines are ignored. +The lines that specify +.Nm +rules consist of three parameters separated by whitespace: +.Bl -tag -width indent +.It Ar action +The action to take for the device. +The action names are only significant to the first unique character. +.It Ar devname +The name of the device created by +.Xr devfs 5 . +.It Ar arg +The argument of the +.Ar action . +.El +.Pp +The actions currently supported are: +.Bl -tag -width indent +.It Ic link +This action creates a symbolic link named +.Ar arg +that points to +.Ar devname , +the name of the device created by +.Xr devfs 5 . +.It Ic own +This action changes the ownership of +.Ar devname . +The +.Ar arg +parameter must be in the form of an +.Ar owner Ns : Ns Ar group +pair, in the same format used by +.Xr chown 8 . +.It Ic perm +This action changes the permissions of +.Ar devname . +The +.Ar arg +parameter must be a +.Ar mode +as explained in +.Xr chmod 1 . +.El +.Sh FILES +.Bl -tag -compact +.It Pa /etc/devfs.conf +.It Pa /usr/share/examples/etc/devfs.conf +.El +.Sh EXAMPLES +To create a +.Pa /dev/cdrom +link that points to the first +.Xr SCSI 4 +or +.Xr atapicam 4 +CD-ROM, +the following may be added to +.Nm : +.Bd -literal -offset indent +link cd0 cdrom +.Ed +.Pp +Similarly, to link +.Pa /dev/cdrom +to the first ATAPI CD-ROM device, the following action may be used: +.Bd -literal -offset indent +link acd0 cdrom +.Ed +.Pp +To set the owner of a device, the +.Ic own +action may be specified: +.Bd -literal -offset indent +own cd0 root:cdrom +.Ed +.Pp +To set the permissions of a device, a +.Ic perm +action should be used: +.Bd -literal -offset indent +perm cd0 0660 +.Ed +.Sh SEE ALSO +.Xr chmod 1 , +.Xr devd.conf 5 , +.Xr devfs 5 , +.Xr devfs.rules 5 , +.Xr chown 8 +.Sh AUTHORS +This manual page was written by +.An "Roland Smith" Aq rsmith@xs4all.nl . diff --git a/share/man/man5/devfs.rules.5 b/share/man/man5/devfs.rules.5 new file mode 100644 index 0000000..8a7b3d6 --- /dev/null +++ b/share/man/man5/devfs.rules.5 @@ -0,0 +1,127 @@ +.\" Copyright (c) 2004 Roland Smith <rsmith@xs4all.nl> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd February 21, 2010 +.Dt DEVFS.RULES 5 +.Os +.Sh NAME +.Nm devfs.rules +.Nd devfs configuration information +.Sh DESCRIPTION +The +.Nm +file provides an easy way to create and apply +.Xr devfs 8 +rules, even for devices that are not available at boot. +.Pp +For devices available at boot, see +.Xr devfs.conf 5 . +.Pp +The format of this file is simple. +Empty lines and lines beginning with a hash sign +.Pq Ql # +are ignored. +A line between brackets denotes the start of a ruleset. +In the brackets should be the name of the ruleset and its number, +separated by an equal sign. +.Pp +Other lines are rule specifications as documented in +.Xr devfs 8 , +in the section +.Sx "Rule Specification" . +These lines are prepended with +.Dq Li rule +and are passed to +.Xr devfs 8 +by the startup scripts of the system. +It is important to put path elements that contain +.Xr glob 3 +special characters between quotes. +.Pp +Rulesets should have a unique name and number. +.Pp +All rules that follow a ruleset declaration belong to that ruleset, until a +new ruleset is started. +.Pp +One custom ruleset has to be enabled in +.Pa /etc/rc.conf , +otherwise it will not be applied to the +.Pa /dev +file system by the default system startup process. +For example, to enable a +.Dq Li localrules +ruleset for the +.Pa /dev +file system, you would have to use something like this in your +.Pa rc.conf +file: +.Bd -literal -offset indent +devfs_system_ruleset="localrules" +.Ed +.Sh FILES +.Bl -tag -compact +.It Pa /etc/defaults/devfs.rules +Default +.Nm +configuration file. +.It Pa /etc/devfs.rules +Local +.Nm +configuration file. Rulesets in here override those in +.Pa /etc/defaults/devfs.rules +with the same ruleset number, otherwise the two files are effectively merged. +.El +.Sh EXAMPLES +To make all the partitions of +.Xr da 4 +devices readable and writable by their owner and the +.Dq Li usb +group, the following rule may be used: +.Pp +.Dl "[localrules=10]" +.Dl "add path 'da*s*' mode 0660 group usb" +.Pp +The first line declares and starts a new ruleset, with the name +.Va localrules +and the number 10. +.Pp +To give +.Xr usbconfig 8 +and +.Xr libusb 3 +enabled applications permission to all usb devices for their owner and the +.Dq Li usb +group, a similar rule may be used: +.Pp +.Dl "add path 'usb/*' mode 0660 group usb" +.Sh SEE ALSO +.Xr glob 3 , +.Xr devfs 5 , +.Xr devfs.conf 5 , +.Xr devfs 8 +.Sh AUTHORS +This manual page was written by +.An "Roland Smith" Aq rsmith@xs4all.nl . diff --git a/share/man/man5/device.hints.5 b/share/man/man5/device.hints.5 new file mode 100644 index 0000000..65a6adf --- /dev/null +++ b/share/man/man5/device.hints.5 @@ -0,0 +1,170 @@ +.\" Copyright (c) 2001 +.\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer as +.\" the first lines of this file unmodified. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd September 11, 2009 +.Dt DEVICE.HINTS 5 +.Os +.Sh NAME +.Nm device.hints +.Nd device resource hints +.Sh DESCRIPTION +The +.Nm +file is read in by the boot +.Xr loader 8 +when the system is about to start, and its contents are +passed to the kernel. +It contains various variables to control the boot behavior of +the kernel. +These variables are typically +.Dq device hints . +.\" .Dq device hints , +.\" and other control variables. +.Pp +The file contains one variable per line. +Lines starting with the +.Ql # +character are comments and are ignored by the boot loader. +.Pp +After the file is read by the boot loader, you may examine +the variables with the +.Ic show +command, and may add a new variable, modify an existing one, +or delete a variable with the +.Ic set +and +.Ic unset +commands of the boot loader +(see +.Xr loader 8 ) . +.Pp +After the system has started, you can dump these variables +with the +.Xr kenv 1 +command. +.Sh DEVICE HINTS +Device hint variables are used by device drivers to set up +the device. +They are most often used by ISA device drivers to specify +where the driver will probe for the relevant devices, and what +resources it will attempt to use. +.Pp +A device hint line looks like: +.Pp +.Sm off +.D1 Li hint. Ar driver Li . Ar unit Li . Ar keyword Li = Qq Ar value +.Sm on +.Pp +where +.Ar driver +is the name of a device driver, +.Ar unit +is the unit number, and +.Ar keyword +is the keyword of the hint. +The keyword may be: +.Pp +.Bl -tag -width ".Li disabled" -compact -offset indent +.It Li at +specifies a bus to which the device is attached. +.It Li port +specifies the start address of I/O ports to be used by the device. +.It Li portsize +specifies the number of ports used by the device. +.It Li irq +is the interrupt line number to be used. +.It Li drq +is the DMA channel number. +.It Li maddr +specifies the physical memory address used by the device. +.It Li msize +specifies the physical memory size used by the device. +.It Li flags +sets various flag bits for the device. +.It Li disabled +can be set to +.Qq 1 +to disable the device. +.El +.Pp +A device driver may require one or more hint lines with these keywords, +and may accept other keywords not listed here, through +.Xr resource_int_value 9 . +Consult individual device drivers' manual pages for available +keywords and their possible values. +.\" .Sh CONTROL VARIABLES +.\" Lines not starting with +.\" .Dq hint. +.\" specify other control variables for the kernel. +.\" They look: +.\" .Pp +.\" .Dl <name>="<value>" +.\" XXX +.\" WE SHOULD LIST AVAILABLE VARIABLE NAMES AND THEIR POSSIBLE VALUES HERE! +.\" .Pp +.Sh FILES +.Bl -tag -width ".Pa /sys/ Ns Ar ARCH Ns Pa /conf/GENERIC.hints" -compact +.It Pa /boot/device.hints +Device resource hints file. +.It Pa /sys/ Ns Ar ARCH Ns Pa /conf/GENERIC.hints +Sample resource hints for the +.Pa GENERIC +kernel. +.It Pa /sys/ Ns Ar ARCH Ns Pa /conf/NOTES +Notes on the kernel configuration file and device resource hints. +.El +.Sh EXAMPLES +The following example sets up resources for the +.Xr sio 4 +driver on the ISA bus: +.Bd -literal -offset indent +hint.sio.0.at="isa" +hint.sio.0.port="0x3F8" +hint.sio.0.flags="0x10" +hint.sio.0.irq="4" +.Ed +.Pp +The following example disables the ACPI driver: +.Bd -literal -offset indent +hint.acpi.0.disabled="1" +.Ed +.\" .Pp +.\" A control variable may look like: +.\" .Pp +.\" .Bd -literal -offset indent +.\" debug.acpi.layer="ACPI_RESOURCES" +.\" .Ed +.Sh SEE ALSO +.Xr kenv 1 , +.Xr loader.conf 5 , +.Xr loader 8, +.Xr resource_int_value 9 . +.Sh HISTORY +The +.Nm +file first appeared in +.Fx 5.0 . diff --git a/share/man/man5/dir.5 b/share/man/man5/dir.5 new file mode 100644 index 0000000..c471043 --- /dev/null +++ b/share/man/man5/dir.5 @@ -0,0 +1,160 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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. +.\" +.\" @(#)dir.5 8.3 (Berkeley) 4/19/94 +.\" $FreeBSD$ +.\" +.Dd April 19, 1994 +.Dt DIR 5 +.Os +.Sh NAME +.Nm dir , +.Nm dirent +.Nd directory file format +.Sh SYNOPSIS +.In dirent.h +.Sh DESCRIPTION +Directories provide a convenient hierarchical method of grouping +files while obscuring the underlying details of the storage medium. +A directory file is differentiated from a plain file +by a flag in its +.Xr inode 5 +entry. +It consists of records (directory entries) each of which contains +information about a file and a pointer to the file itself. +Directory entries may contain other directories +as well as plain files; such nested directories are referred to as +subdirectories. +A hierarchy of directories and files is formed in this manner +and is called a file system (or referred to as a file system tree). +.\" An entry in this tree, +.\" nested or not nested, +.\" is a pathname. +.Pp +Each directory file contains two special directory entries; one is a pointer +to the directory itself +called dot +.Ql .\& +and the other a pointer to its parent directory called dot-dot +.Ql \&.. . +Dot and dot-dot +are valid pathnames, however, +the system root directory +.Ql / , +has no parent and dot-dot points to itself like dot. +.Pp +File system nodes are ordinary directory files on which has +been grafted a file system object, such as a physical disk or a +partitioned area of such a disk. +(See +.Xr mount 2 +and +.Xr mount 8 . ) +.Pp +The directory entry format is defined in the file +.In sys/dirent.h +(which should not be included directly by applications): +.Bd -literal +#ifndef _SYS_DIRENT_H_ +#define _SYS_DIRENT_H_ + +#include <machine/ansi.h> + +/* + * The dirent structure defines the format of directory entries returned by + * the getdirentries(2) system call. + * + * A directory entry has a struct dirent at the front of it, containing its + * inode number, the length of the entry, and the length of the name + * contained in the entry. These are followed by the name padded to a 4 + * byte boundary with null bytes. All names are guaranteed null terminated. + * The maximum length of a name in a directory is MAXNAMLEN. + */ + +struct dirent { + __uint32_t d_fileno; /* file number of entry */ + __uint16_t d_reclen; /* length of this record */ + __uint8_t d_type; /* file type, see below */ + __uint8_t d_namlen; /* length of string in d_name */ +#ifdef _POSIX_SOURCE + char d_name[255 + 1]; /* name must be no longer than this */ +#else +#define MAXNAMLEN 255 + char d_name[MAXNAMLEN + 1]; /* name must be no longer than this */ +#endif +}; + +/* + * File types + */ +#define DT_UNKNOWN 0 +#define DT_FIFO 1 +#define DT_CHR 2 +#define DT_DIR 4 +#define DT_BLK 6 +#define DT_REG 8 +#define DT_LNK 10 +#define DT_SOCK 12 +#define DT_WHT 14 + +/* + * Convert between stat structure types and directory types. + */ +#define IFTODT(mode) (((mode) & 0170000) >> 12) +#define DTTOIF(dirtype) ((dirtype) << 12) + +/* + * The _GENERIC_DIRSIZ macro gives the minimum record length which will hold + * the directory entry. This requires the amount of space in struct direct + * without the d_name field, plus enough space for the name with a terminating + * null byte (dp->d_namlen+1), rounded up to a 4 byte boundary. + */ +#define _GENERIC_DIRSIZ(dp) \ + ((sizeof (struct dirent) - (MAXNAMLEN+1)) + (((dp)->d_namlen+1 + 3) &~ 3)) + +#ifdef _KERNEL +#define GENERIC_DIRSIZ(dp) _GENERIC_DIRSIZ(dp) +#endif + +#endif /* !_SYS_DIRENT_H_ */ +.Ed +.Sh SEE ALSO +.Xr fs 5 , +.Xr inode 5 +.Sh HISTORY +A +.Nm +file format appeared in +.At v7 . +.Sh BUGS +The usage of the member d_type of struct dirent is unportable as it is +.Fx Ns -specific . +It also may fail on certain file systems, for example the cd9660 file system. diff --git a/share/man/man5/disktab.5 b/share/man/man5/disktab.5 new file mode 100644 index 0000000..90700bc --- /dev/null +++ b/share/man/man5/disktab.5 @@ -0,0 +1,144 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd October 14, 2006 +.Dt DISKTAB 5 +.Os +.Sh NAME +.Nm disktab +.Nd disk description file +.Sh SYNOPSIS +.In disklabel.h +.Sh DESCRIPTION +.Nm Disktab +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 patterned +after the +.Xr termcap 5 +terminal data base. +Entries in +.Nm +consist of a number of `:'-separated fields. +The +first field for each entry gives the names by which a +disk's entry may be selected, separated by `|' characters. +The +last name given should be a long name fully identifying +the disk. +.Pp +The optional fields for each entry are: +.Bl -column "indent" "boolx" +.It Sy "ID 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 0" +.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 +file system, 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 bsdlabel 5 , +.Xr bsdlabel 8 , +.Xr newfs 8 +.Sh HISTORY +The +.Nm +description file appeared in +.Bx 4.2 . diff --git a/share/man/man5/elf.5 b/share/man/man5/elf.5 new file mode 100644 index 0000000..c534e2e --- /dev/null +++ b/share/man/man5/elf.5 @@ -0,0 +1,1321 @@ +.\" Copyright (c) 1999 Jeroen Ruigrok van der Werven +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd December 18, 2005 +.Dt ELF 5 +.Os +.Sh NAME +.Nm elf +.Nd format of ELF executable binary files +.Sh SYNOPSIS +.In elf.h +.Sh DESCRIPTION +The header file +.In elf.h +defines the format of ELF executable binary files. +Amongst these files are +normal executable files, relocatable object files, core files and shared +libraries. +.Pp +An executable file using the ELF file format consists of an ELF header, +followed by a program header table or a section header table, or both. +The ELF header is always at offset zero of the file. +The program header +table and the section header table's offset in the file are defined in the +ELF header. +The two tables describe the rest of the particularities of +the file. +.Pp +Applications which wish to process ELF binary files for their native +architecture only should include +.In elf.h +in their source code. +These applications should need to refer to +all the types and structures by their generic names +.Dq Elf_xxx +and to the macros by +.Dq ELF_xxx . +Applications written this way can be compiled on any architecture, +regardless whether the host is 32-bit or 64-bit. +.Pp +Should an application need to process ELF files of an unknown +architecture then the application needs to include both +.In sys/elf32.h +and +.In sys/elf64.h +instead of +.In elf.h . +Furthermore, all types and structures need to be identified by either +.Dq Elf32_xxx +or +.Dq Elf64_xxx . +The macros need to be identified by +.Dq ELF32_xxx +or +.Dq ELF64_xxx . +.Pp +Whatever the system's architecture is, it will always include +.In sys/elf_common.h +as well as +.In sys/elf_generic.h . +.Pp +These header files describe the above mentioned headers as C structures +and also include structures for dynamic sections, relocation sections and +symbol tables. +.Pp +The following types are being used for 32-bit architectures: +.Bd -literal -offset indent +Elf32_Addr Unsigned 32-bit program address +Elf32_Half Unsigned 16-bit field +Elf32_Lword Unsigned 64-bit field +Elf32_Off Unsigned 32-bit file offset +Elf32_Sword Signed 32-bit field or integer +Elf32_Word Unsigned 32-bit field or integer +.Ed +.Pp +For 64-bit architectures we have the following types: +.Bd -literal -offset indent +Elf64_Addr Unsigned 64-bit program address +Elf64_Half Unsigned 16-bit field +Elf64_Lword Unsigned 64-bit field +Elf64_Off Unsigned 64-bit file offset +Elf64_Sword Signed 32-bit field +Elf64_Sxword Signed 64-bit field or integer +Elf64_Word Unsigned 32-bit field +Elf64_Xword Unsigned 64-bit field or integer +.Ed +.Pp +All data structures that the file format defines follow the +.Dq natural +size and alignment guidelines for the relevant class. +If necessary, +data structures contain explicit padding to ensure 4-byte alignment +for 4-byte objects, to force structure sizes to a multiple of 4, etc. +.Pp +The ELF header is described by the type Elf32_Ehdr or Elf64_Ehdr: +.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 +.Pp +.Bd -literal -offset indent +typedef struct { + unsigned char e_ident[EI_NIDENT]; + Elf64_Half e_type; + Elf64_Half e_machine; + Elf64_Word e_version; + Elf64_Addr e_entry; + Elf64_Off e_phoff; + Elf64_Off e_shoff; + Elf64_Word e_flags; + Elf64_Half e_ehsize; + Elf64_Half e_phentsize; + Elf64_Half e_phnum; + Elf64_Half e_shentsize; + Elf64_Half e_shnum; + Elf64_Half e_shstrndx; +} Elf64_Ehdr; +.Ed +.Pp +The fields have the following meanings: +.Pp +.Bl -tag -width "e_phentsize" -compact -offset indent +.It Dv e_ident +This array of bytes specifies to interpret the file, +independent of the processor or the file's remaining contents. +Within this array everything is named by macros, which start with +the prefix +.Sy EI_ +and may contain values which start with the prefix +.Sy ELF . +The following macros are defined: +.Pp +.Bl -tag -width "EI_ABIVERSION" -compact +.It Dv EI_MAG0 +The first byte of the magic number. +It must be filled with +.Sy ELFMAG0 . +.It Dv EI_MAG1 +The second byte of the magic number. +It must be filled with +.Sy ELFMAG1 . +.It Dv EI_MAG2 +The third byte of the magic number. +It must be filled with +.Sy ELFMAG2 . +.It Dv EI_MAG3 +The fourth byte of the magic number. +It must be filled with +.Sy ELFMAG3 . +.It Dv EI_CLASS +The fifth byte identifies the architecture for this binary: +.Pp +.Bl -tag -width "ELFCLASSNONE" -compact +.It Dv ELFCLASSNONE +This class is invalid. +.It Dv ELFCLASS32 +This defines the 32-bit architecture. +It supports machines with files +and virtual address spaces up to 4 Gigabytes. +.It Dv ELFCLASS64 +This defines the 64-bit architecture. +.El +.It Dv EI_DATA +The sixth byte specifies the data encoding of the processor-specific +data in the file. +Currently these encodings are supported: +.Pp +.Bl -tag -width "ELFDATA2LSB" -compact +.It Dv ELFDATANONE +Unknown data format. +.It Dv ELFDATA2LSB +Two's complement, little-endian. +.It Dv ELFDATA2MSB +Two's complement, big-endian. +.El +.It Dv EI_VERSION +The version number of the ELF specification: +.Pp +.Bl -tag -width "EV_CURRENT" -compact +.It Dv EV_NONE +Invalid version. +.It Dv EV_CURRENT +Current version. +.El +.It Dv EI_OSABI +This byte identifies the operating system +and ABI to which the object is targeted. +Some fields in other ELF structures have flags +and values that have platform specific meanings; +the interpretation of those fields is determined by the value of this byte. +The following values are currently defined: +.Pp +.Bl -tag -width "ELFOSABI_STANDALONE" -compact +.It Dv ELFOSABI_SYSV +UNIX System V ABI. +.It Dv ELFOSABI_HPUX +HP-UX operating system ABI. +.It Dv ELFOSABI_NETBSD +.Nx +operating system ABI. +.It Dv ELFOSABI_LINUX +GNU/Linux operating system ABI. +.It Dv ELFOSABI_HURD +GNU/Hurd operating system ABI. +.It Dv ELFOSABI_86OPEN +86Open Common IA32 ABI. +.It Dv ELFOSABI_SOLARIS +Solaris operating system ABI. +.It Dv ELFOSABI_MONTEREY +Monterey project ABI. +.It Dv ELFOSABI_IRIX +IRIX operating system ABI. +.It Dv ELFOSABI_FREEBSD +.Fx +operating system ABI. +.It Dv ELFOSABI_TRU64 +TRU64 UNIX operating system ABI. +.It Dv ELFOSABI_ARM +ARM architecture ABI. +.It Dv ELFOSABI_STANDALONE +Standalone (embedded) ABI. +.El +.It Dv EI_ABIVERSION +This byte identifies the version of the ABI +to which the object is targeted. +This field is used to distinguish among incompatible versions of an ABI. +The interpretation of this version number +is dependent on the ABI identified by the EI_OSABI field. +Applications conforming to this specification use the value 0. +.It Dv EI_PAD +Start of padding. +These bytes are reserved and set to zero. +Programs +which read them should ignore them. +The value for EI_PAD will change in +the future if currently unused bytes are given meanings. +.It Dv EI_BRAND +Start of architecture identification. +.It Dv EI_NIDENT +The size of the e_ident array. +.El +.Pp +.It Dv e_type +This member of the structure identifies the object file type: +.Pp +.Bl -tag -width "ET_NONE" -compact +.It Dv ET_NONE +An unknown type. +.It Dv ET_REL +A relocatable file. +.It Dv ET_EXEC +An executable file. +.It Dv ET_DYN +A shared object. +.It Dv ET_CORE +A core file. +.El +.Pp +.It Dv e_machine +This member specifies the required architecture for an individual file: +.Pp +.Bl -tag -width "EM_MIPS_RS4_BE" -compact +.It Dv EM_NONE +An unknown machine. +.It Dv EM_M32 +AT&T WE 32100. +.It Dv EM_SPARC +Sun Microsystems SPARC. +.It Dv EM_386 +Intel 80386. +.It Dv EM_68K +Motorola 68000. +.It Dv EM_88K +Motorola 88000. +.It Dv EM_486 +Intel 80486. +.It Dv EM_860 +Intel 80860. +.It Dv EM_MIPS +MIPS RS3000 (big-endian only). +.It Dv EM_MIPS_RS4_BE +MIPS RS4000 (big-endian only). +.It Dv EM_SPARC64 +SPARC v9 64-bit unofficial. +.It Dv EM_PARISC +HPPA. +.It Dv EM_PPC +PowerPC. +.It Dv EM_ALPHA +Compaq [DEC] Alpha. +.El +.Pp +.It Dv e_version +This member identifies the file version: +.Pp +.Bl -tag -width "EV_CURRENT" -compact +.It Dv EV_NONE +Invalid version +.It Dv EV_CURRENT +Current version +.El +.It Dv e_entry +This member gives the virtual address to which the system first transfers +control, thus starting the process. +If the file has no associated entry +point, this member holds zero. +.It Dv e_phoff +This member holds the program header table's file offset in bytes. +If +the file has no program header table, this member holds zero. +.It Dv e_shoff +This member holds the section header table's file offset in bytes. +If the +file has no section header table this member holds zero. +.It Dv e_flags +This member holds processor-specific flags associated with the file. +Flag +names take the form EF_`machine_flag'. +Currently no flags have been defined. +.It Dv e_ehsize +This member holds the ELF header's size in bytes. +.It Dv e_phentsize +This member holds the size in bytes of one entry in the file's program header +table; all entries are the same size. +.It Dv e_phnum +This member holds the number of entries in the program header +table. +If the file is using extended program header numbering, then the +.Sy e_phnum +member will contain the value +.Dv PN_XNUM +and the actual number of program header table entries will be stored +in the +.Sy sh_info +member of the section header at index +.Dv SHN_UNDEF . +The product of +.Sy e_phentsize +and the number of program header table entries gives the program +header table's size in bytes. +If a file has no program header, +.Sy e_phnum +holds the value zero. +.It Dv e_shentsize +This member holds a sections header's size in bytes. +A section header is one +entry in the section header table; all entries are the same size. +.It Dv e_shnum +This member holds the number of entries in the section header table. +If the file is using extended section numbering, then the +.Sy e_shnum +member will be zero and the actual section number will be stored in the +.Sy sh_size +member of the section header at index +.Dv SHN_UNDEF . +If a file has no section header table, both the +.Sy e_shnum +and the +.Sy e_shoff +fields of the ELF header will be zero. +The product of +.Sy e_shentsize +and the number of sections in the file gives the section header +table's size in bytes. +.It Dv e_shstrndx +This member holds the section header table index of the entry associated +with the section name string table. +If extended section numbering is being used, this field will hold the +value +.Sy SHN_XINDEX , +and the actual section header table index will be present in the +.Sy sh_link +field of the section header entry at index +.Dv SHN_UNDEF . +If the file has no section name string +table, this member holds the value +.Sy SHN_UNDEF . +.El +.Pp +An executable or shared object file's program header table is an array of +structures, each describing a segment or other information the system needs +to prepare the program for execution. +An object file +.Em segment +contains one or more +.Em sections . +Program headers are meaningful only for executable and shared object files. +A file specifies its own program header size with the ELF header's +.Sy e_phentsize +and +.Sy e_phnum +members. +As with the Elf executable header, the program header +also has different versions depending on the architecture: +.Pp +.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 +.Pp +.Bd -literal -offset indent +typedef struct { + Elf64_Word p_type; + Elf64_Word p_flags; + Elf64_Off p_offset; + Elf64_Addr p_vaddr; + Elf64_Addr p_paddr; + Elf64_Xword p_filesz; + Elf64_Xword p_memsz; + Elf64_Xword p_align; +} Elf64_Phdr; +.Ed +.Pp +The main difference between the 32-bit and the 64-bit program header lies +only in the location of a +.Sy p_flags +member in the total struct. +.Pp +.Bl -tag -width "p_offset" -compact -offset indent +.It Dv p_type +This member of the Phdr struct tells what kind of segment this array +element describes or how to interpret the array element's information. +.Bl -tag -width "PT_DYNAMIC" -compact +.Pp +.It Dv PT_NULL +The array element is unused and the other members' values are undefined. +This lets the program header have ignored entries. +.It Dv PT_LOAD +The array element specifies a loadable segment, described by +.Sy p_filesz +and +.Sy p_memsz . +The bytes from the file are mapped to the beginning of the memory +segment. +If the segment's memory size +.Pq Sy p_memsz +is larger than the file size +.Pq Sy p_filesz , +the +.Dq extra +bytes are defined to hold the value 0 and to follow the segment's +initialized area. +The file size may not be larger than the memory size. +Loadable segment entries in the program header table appear in ascending +order, sorted on the +.Sy p_vaddr +member. +.It Dv PT_DYNAMIC +The array element specifies dynamic linking information. +.It Dv PT_INTERP +The array element specifies the location and size of a null-terminated +path name to invoke as an interpreter. +This segment type is meaningful +only for executable files (though it may occur for shared objects). +However +it may not occur more than once in a file. +If it is present it must precede +any loadable segment entry. +.It Dv PT_NOTE +The array element specifies the location and size for auxiliary information. +.It Dv PT_SHLIB +This segment type is reserved but has unspecified semantics. +Programs that +contain an array element of this type do not conform to the ABI. +.It Dv PT_PHDR +The array element, if present, specifies the location and size of the program +header table itself, both in the file and in the memory image of the program. +This segment type may not occur more than once in a file. +Moreover, it may +only occur if the program header table is part of the memory image of the +program. +If it is present it must precede any loadable segment entry. +.It Dv PT_LOPROC +This value up to and including +.Sy PT_HIPROC +are reserved for processor-specific semantics. +.It Dv PT_HIPROC +This value down to and including +.Sy PT_LOPROC +are reserved for processor-specific semantics. +.El +.Pp +.It Dv p_offset +This member holds the offset from the beginning of the file at which +the first byte of the segment resides. +.It Dv p_vaddr +This member holds the virtual address at which the first byte of the +segment resides in memory. +.It Dv p_paddr +On systems for which physical addressing is relevant, this member is +reserved for the segment's physical address. +Under +.Bx +this member is +not used and must be zero. +.It Dv p_filesz +This member holds the number of bytes in the file image of the segment. +It may be zero. +.It Dv p_memsz +This member holds the number of bytes in the memory image of the segment. +It may be zero. +.It Dv p_flags +This member holds flags relevant to the segment: +.Pp +.Bl -tag -width "PF_X" -compact +.It Dv PF_X +An executable segment. +.It Dv PF_W +A writable segment. +.It Dv PF_R +A readable segment. +.El +.Pp +A text segment commonly has the flags +.Sy PF_X +and +.Sy PF_R . +A data segment commonly has +.Sy PF_X , +.Sy PF_W +and +.Sy PF_R . +.It Dv p_align +This member holds the value to which the segments are aligned in memory +and in the file. +Loadable process segments must have congruent values for +.Sy p_vaddr +and +.Sy p_offset , +modulo the page size. +Values of zero and one mean no alignment is required. +Otherwise, +.Sy p_align +should be a positive, integral power of two, and +.Sy p_vaddr +should equal +.Sy p_offset , +modulo +.Sy p_align . +.El +.Pp +An file's section header table lets one locate all the file's sections. +The +section header table is an array of Elf32_Shdr or Elf64_Shdr structures. +The +ELF header's +.Sy e_shoff +member gives the byte offset from the beginning of the file to the section +header table. +.Sy e_shnum +holds the number of entries the section header table contains. +.Sy e_shentsize +holds the size in bytes of each entry. +.Pp +A section header table index is a subscript into this array. +Some section +header table indices are reserved. +An object file does not have sections for +these special indices: +.Pp +.Bl -tag -width "SHN_LORESERVE" -compact +.It Dv SHN_UNDEF +This value marks an undefined, missing, irrelevant, or otherwise meaningless +section reference. +For example, a symbol +.Dq defined +relative to section number +.Sy SHN_UNDEF +is an undefined symbol. +.It Dv SHN_LORESERVE +This value specifies the lower bound of the range of reserved indices. +.It Dv SHN_LOPROC +This value up to and including +.Sy SHN_HIPROC +are reserved for processor-specific semantics. +.It Dv SHN_HIPROC +This value down to and including +.Sy SHN_LOPROC +are reserved for processor-specific semantics. +.It Dv SHN_ABS +This value specifies absolute values for the corresponding reference. +For +example, symbols defined relative to section number +.Sy SHN_ABS +have absolute values and are not affected by relocation. +.It Dv SHN_COMMON +Symbols defined relative to this section are common symbols, such as FORTRAN +COMMON or unallocated C external variables. +.It Dv SHN_HIRESERVE +This value specifies the upper bound of the range of reserved indices. +The +system reserves indices between +.Sy SHN_LORESERVE +and +.Sy SHN_HIRESERVE , +inclusive. +The section header table does not contain entries for the +reserved indices. +.El +.Pp +The section header has the following structure: +.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 +.Pp +.Bd -literal -offset indent +typedef struct { + Elf64_Word sh_name; + Elf64_Word sh_type; + Elf64_Xword sh_flags; + Elf64_Addr sh_addr; + Elf64_Off sh_offset; + Elf64_Xword sh_size; + Elf64_Word sh_link; + Elf64_Word sh_info; + Elf64_Xword sh_addralign; + Elf64_Xword sh_entsize; +} Elf64_Shdr; +.Ed +.Pp +.Bl -tag -width "sh_addralign" -compact +.It Dv sh_name +This member specifies the name of the section. +Its value is an index +into the section header string table section, giving the location of +a null-terminated string. +.It Dv sh_type +This member categorizes the section's contents and semantics. +.Pp +.Bl -tag -width "SHT_PROGBITS" -compact +.It Dv SHT_NULL +This value marks the section header as inactive. +It does not +have an associated section. +Other members of the section header +have undefined values. +.It Dv SHT_PROGBITS +The section holds information defined by the program, whose +format and meaning are determined solely by the program. +.It Dv SHT_SYMTAB +This section holds a symbol table. +Typically, +.Sy SHT_SYMTAB +provides symbols for link editing, though it may also be used +for dynamic linking. +As a complete symbol table, it may contain +many symbols unnecessary for dynamic linking. +An object file can +also contain a +.Sy SHN_DYNSYM +section. +.It Dv SHT_STRTAB +This section holds a string table. +An object file may have multiple +string table sections. +.It Dv SHT_RELA +This section holds relocation entries with explicit addends, such +as type +.Sy Elf32_Rela +for the 32-bit class of object files. +An object may have multiple +relocation sections. +.It Dv SHT_HASH +This section holds a symbol hash table. +All object participating in +dynamic linking must contain a symbol hash table. +An object file may +have only one hash table. +.It Dv SHT_DYNAMIC +This section holds information for dynamic linking. +An object file may +have only one dynamic section. +.It Dv SHT_NOTE +This section holds information that marks the file in some way. +.It Dv SHT_NOBITS +A section of this type occupies no space in the file but otherwise +resembles +.Sy SHN_PROGBITS . +Although this section contains no bytes, the +.Sy sh_offset +member contains the conceptual file offset. +.It Dv SHT_REL +This section holds relocation offsets without explicit addends, such +as type +.Sy Elf32_Rel +for the 32-bit class of object files. +An object file may have multiple +relocation sections. +.It Dv SHT_SHLIB +This section is reserved but has unspecified semantics. +.It Dv SHT_DYNSYM +This section holds a minimal set of dynamic linking symbols. +An +object file can also contain a +.Sy SHN_SYMTAB +section. +.It Dv SHT_LOPROC +This value up to and including +.Sy SHT_HIPROC +are reserved for processor-specific semantics. +.It Dv SHT_HIPROC +This value down to and including +.Sy SHT_LOPROC +are reserved for processor-specific semantics. +.It Dv SHT_LOUSER +This value specifies the lower bound of the range of indices reserved for +application programs. +.It Dv SHT_HIUSER +This value specifies the upper bound of the range of indices reserved for +application programs. +Section types between +.Sy SHT_LOUSER +and +.Sy SHT_HIUSER +may be used by the application, without conflicting with current or future +system-defined section types. +.El +.Pp +.It Dv sh_flags +Sections support one-bit flags that describe miscellaneous attributes. +If a flag bit is set in +.Sy sh_flags , +the attribute is +.Dq on +for the section. +Otherwise, the attribute is +.Dq off +or does not apply. +Undefined attributes are set to zero. +.Pp +.Bl -tag -width "SHF_EXECINSTR" -compact +.It Dv SHF_WRITE +This section contains data that should be writable during process +execution. +.It Dv SHF_ALLOC +The section occupies memory during process execution. +Some control +sections do not reside in the memory image of an object file. +This +attribute is off for those sections. +.It Dv SHF_EXECINSTR +The section contains executable machine instructions. +.It Dv SHF_MASKPROC +All bits included in this mask are reserved for processor-specific +semantics. +.El +.Pp +.It Dv sh_addr +If the section will appear in the memory image of a process, this member +holds the address at which the section's first byte should reside. +Otherwise, the member contains zero. +.It Dv sh_offset +This member's value holds the byte offset from the beginning of the file +to the first byte in the section. +One section type, +.Sy SHT_NOBITS , +occupies no space in the file, and its +.Sy sh_offset +member locates the conceptual placement in the file. +.It Dv sh_size +This member holds the section's size in bytes. +Unless the section type +is +.Sy SHT_NOBITS , +the section occupies +.Sy sh_size +bytes in the file. +A section of type +.Sy SHT_NOBITS +may have a non-zero size, but it occupies no space in the file. +.It Dv sh_link +This member holds a section header table index link, whose interpretation +depends on the section type. +.It Dv sh_info +This member holds extra information, whose interpretation depends on the +section type. +.It Dv sh_addralign +Some sections have address alignment constraints. +If a section holds a +doubleword, the system must ensure doubleword alignment for the entire +section. +That is, the value of +.Sy sh_addr +must be congruent to zero, modulo the value of +.Sy sh_addralign . +Only zero and positive integral powers of two are allowed. +Values of zero +or one mean the section has no alignment constraints. +.It Dv sh_entsize +Some sections hold a table of fixed-sized entries, such as a symbol table. +For such a section, this member gives the size in bytes for each entry. +This member contains zero if the section does not hold a table of +fixed-size entries. +.El +.Pp +Various sections hold program and control information: +.Bl -tag -width ".shstrtab" -compact +.It .bss +(Block Started by Symbol) +This section holds uninitialized data that contributes to the program's +memory image. +By definition, the system initializes the data with zeros +when the program begins to run. +This section is of type +.Sy SHT_NOBITS . +The attributes types are +.Sy SHF_ALLOC +and +.Sy SHF_WRITE . +.It .comment +This section holds version control information. +This section is of type +.Sy SHT_PROGBITS . +No attribute types are used. +.It .data +This section holds initialized data that contribute to the program's +memory image. +This section is of type +.Sy SHT_PROGBITS . +The attribute types are +.Sy SHF_ALLOC +and +.Sy SHF_WRITE . +.It .data1 +This section holds initialized data that contribute to the program's +memory image. +This section is of type +.Sy SHT_PROGBITS . +The attribute types are +.Sy SHF_ALLOC +and +.Sy SHF_WRITE . +.It .debug +This section holds information for symbolic debugging. +The contents +are unspecified. +This section is of type +.Sy SHT_PROGBITS . +No attribute types are used. +.It .dynamic +This section holds dynamic linking information. +The section's attributes +will include the +.Sy SHF_ALLOC +bit. +Whether the +.Sy SHF_WRITE +bit is set is processor-specific. +This section is of type +.Sy SHT_DYNAMIC . +See the attributes above. +.It .dynstr +This section holds strings needed for dynamic linking, most commonly +the strings that represent the names associated with symbol table entries. +This section is of type +.Sy SHT_STRTAB . +The attribute type used is +.Sy SHF_ALLOC . +.It .dynsym +This section holds the dynamic linking symbol table. +This section is of type +.Sy SHT_DYNSYM . +The attribute used is +.Sy SHF_ALLOC . +.It .fini +This section holds executable instructions that contribute to the process +termination code. +When a program exits normally the system arranges to +execute the code in this section. +This section is of type +.Sy SHT_PROGBITS . +The attributes used are +.Sy SHF_ALLOC +and +.Sy SHF_EXECINSTR . +.It .got +This section holds the global offset table. +This section is of type +.Sy SHT_PROGBITS . +The attributes are processor-specific. +.It .hash +This section holds a symbol hash table. +This section is of type +.Sy SHT_HASH . +The attribute used is +.Sy SHF_ALLOC . +.It .init +This section holds executable instructions that contribute to the process +initialization code. +When a program starts to run the system arranges to +execute the code in this section before calling the main program entry point. +This section is of type +.Sy SHT_PROGBITS . +The attributes used are +.Sy SHF_ALLOC +and +.Sy SHF_EXECINSTR . +.It .interp +This section holds the pathname of a program interpreter. +If the file has +a loadable segment that includes the section, the section's attributes will +include the +.Sy SHF_ALLOC +bit. +Otherwise, that bit will be off. +This section is of type +.Sy SHT_PROGBITS . +.It .line +This section holds line number information for symbolic debugging, which +describes the correspondence between the program source and the machine code. +The contents are unspecified. +This section is of type +.Sy SHT_PROGBITS . +No attribute types are used. +.It .note +This section holds information in the +.Dq Note Section +format described below. +This section is of type +.Sy SHT_NOTE . +No attribute types are used. +.It .plt +This section holds the procedure linkage table. +This section is of type +.Sy SHT_PROGBITS . +The attributes are processor-specific. +.It .relNAME +This section holds relocation information as described below. +If the file +has a loadable segment that includes relocation, the section's attributes +will include the +.Sy SHF_ALLOC +bit. +Otherwise the bit will be off. +By convention, +.Dq NAME +is supplied by the section to which the relocations apply. +Thus a relocation +section for +.Sy .text +normally would have the name +.Sy .rel.text . +This section is of type +.Sy SHT_REL . +.It .relaNAME +This section holds relocation information as described below. +If the file +has a loadable segment that includes relocation, the section's attributes +will include the +.Sy SHF_ALLOC +bit. +Otherwise the bit will be off. +By convention, +.Dq NAME +is supplied by the section to which the relocations apply. +Thus a relocation +section for +.Sy .text +normally would have the name +.Sy .rela.text . +This section is of type +.Sy SHT_RELA . +.It .rodata +This section holds read-only data that typically contributes to a +non-writable segment in the process image. +This section is of type +.Sy SHT_PROGBITS . +The attribute used is +.Sy SHF_ALLOC . +.It .rodata1 +This section hold read-only data that typically contributes to a +non-writable segment in the process image. +This section is of type +.Sy SHT_PROGBITS . +The attribute used is +.Sy SHF_ALLOC . +.It .shstrtab +This section holds section names. +This section is of type +.Sy SHT_STRTAB . +No attribute types are used. +.It .strtab +This section holds strings, most commonly the strings that represent the +names associated with symbol table entries. +If the file has a loadable +segment that includes the symbol string table, the section's attributes +will include the +.Sy SHF_ALLOC +bit. +Otherwise the bit will be off. +This section is of type +.Sy SHT_STRTAB . +.It .symtab +This section holds a symbol table. +If the file has a loadable segment +that includes the symbol table, the section's attributes will include +the +.Sy SHF_ALLOC +bit. +Otherwise the bit will be off. +This section is of type +.Sy SHT_SYMTAB . +.It .text +This section holds the +.Dq text , +or executable instructions, of a program. +This section is of type +.Sy SHT_PROGBITS . +The attributes used are +.Sy SHF_ALLOC +and +.Sy SHF_EXECINSTR . +.It .jcr +This section holds information about Java classes that must +be registered. +.It .eh_frame +This section holds information used for C++ exception-handling. +.El +.Pp +String table sections hold null-terminated character sequences, commonly +called strings. +The object file uses these strings to represent symbol +and section names. +One references a string as an index into the string +table section. +The first byte, which is index zero, is defined to hold +a null character. +Similarly, a string table's last byte is defined to +hold a null character, ensuring null termination for all strings. +.Pp +An object file's symbol table holds information needed to locate and +relocate a program's symbolic definitions and references. +A symbol table +index is a subscript into this array. +.Pp +.Bd -literal -offset indent +typedef struct { + Elf32_Word st_name; + Elf32_Addr st_value; + Elf32_Word st_size; + unsigned char st_info; + unsigned char st_other; + Elf32_Half st_shndx; +} Elf32_Sym; +.Ed +.Pp +.Bd -literal -offset indent +typedef struct { + Elf64_Word st_name; + unsigned char st_info; + unsigned char st_other; + Elf64_Half st_shndx; + Elf64_Addr st_value; + Elf64_Xword st_size; +} Elf64_Sym; +.Ed +.Pp +.Bl -tag -width "st_value" -compact +.It Dv st_name +This member holds an index into the object file's symbol string table, +which holds character representations of the symbol names. +If the value +is non-zero, it represents a string table index that gives the symbol +name. +Otherwise, the symbol table has no name. +.It Dv st_value +This member gives the value of the associated symbol. +.It Dv st_size +Many symbols have associated sizes. +This member holds zero if the symbol +has no size or an unknown size. +.It Dv st_info +This member specifies the symbol's type and binding attributes: +.Pp +.Bl -tag -width "STT_SECTION" -compact +.It Dv STT_NOTYPE +The symbol's type is not defined. +.It Dv STT_OBJECT +The symbol is associated with a data object. +.It Dv STT_FUNC +The symbol is associated with a function or other executable code. +.It Dv STT_SECTION +The symbol is associated with a section. +Symbol table entries of +this type exist primarily for relocation and normally have +.Sy STB_LOCAL +bindings. +.It Dv STT_FILE +By convention the symbol's name gives the name of the source file +associated with the object file. +A file symbol has +.Sy STB_LOCAL +bindings, its section index is +.Sy SHN_ABS , +and it precedes the other +.Sy STB_LOCAL +symbols of the file, if it is present. +.It Dv STT_LOPROC +This value up to and including +.Sy STT_HIPROC +are reserved for processor-specific semantics. +.It Dv STT_HIPROC +This value down to and including +.Sy STT_LOPROC +are reserved for processor-specific semantics. +.El +.Pp +.Bl -tag -width "STB_GLOBAL" -compact +.It Dv STB_LOCAL +Local symbols are not visible outside the object file containing their +definition. +Local symbols of the same name may exist in multiple file +without interfering with each other. +.It Dv STB_GLOBAL +Global symbols are visible to all object files being combined. +One file's +definition of a global symbol will satisfy another file's undefined +reference to the same symbol. +.It Dv STB_WEAK +Weak symbols resemble global symbols, but their definitions have lower +precedence. +.It Dv STB_LOPROC +This value up to and including +.Sy STB_HIPROC +are reserved for processor-specific semantics. +.It Dv STB_HIPROC +This value down to and including +.Sy STB_LOPROC +are reserved for processor-specific semantics. +.Pp +There are macros for packing and unpacking the binding and type fields: +.Pp +.Bl -tag -width "ELF32_ST_INFO(bind, type)" -compact +.It Xo +.Fn ELF32_ST_BIND info +.Xc +or +.Fn ELF64_ST_BIND info +extract a binding from an st_info value. +.It Xo +.Fn ELF64_ST_TYPE info +.Xc +or +.Fn ELF32_ST_TYPE info +extract a type from an st_info value. +.It Xo +.Fn ELF32_ST_INFO bind type +.Xc +or +.Fn ELF64_ST_INFO bind type +convert a binding and a type into an st_info value. +.El +.El +.Pp +.It Dv st_other +This member currently holds zero and has no defined meaning. +.It Dv st_shndx +Every symbol table entry is +.Dq defined +in relation to some section. +This member holds the relevant section +header table index. +.El +.Pp +Relocation is the process of connecting symbolic references with +symbolic definitions. +Relocatable files must have information that +describes how to modify their section contents, thus allowing executable +and shared object files to hold the right information for a process' +program image. +Relocation entries are these data. +.Pp +Relocation structures that do not need an addend: +.Pp +.Bd -literal -offset indent +typedef struct { + Elf32_Addr r_offset; + Elf32_Word r_info; +} Elf32_Rel; +.Ed +.Bd -literal -offset indent +typedef struct { + Elf64_Addr r_offset; + Elf64_Xword r_info; +} Elf64_Rel; +.Ed +.Pp +Relocation structures that need an addend: +.Pp +.Bd -literal -offset indent +typedef struct { + Elf32_Addr r_offset; + Elf32_Word r_info; + Elf32_Sword r_addend; +} Elf32_Rela; +.Ed +.Bd -literal -offset indent +typedef struct { + Elf64_Addr r_offset; + Elf64_Xword r_info; + Elf64_Sxword r_addend; +} Elf64_Rela; +.Ed +.Pp +.Bl -tag -width "r_offset" -compact +.It Dv r_offset +This member gives the location at which to apply the relocation action. +For a relocatable file, the value is the byte offset from the beginning +of the section to the storage unit affected by the relocation. +For an +executable file or shared object, the value is the virtual address of +the storage unit affected by the relocation. +.It Dv r_info +This member gives both the symbol table index with respect to which the +relocation must be made and the type of relocation to apply. +Relocation +types are processor-specific. +When the text refers to a relocation +entry's relocation type or symbol table index, it means the result of +applying +.Sy ELF_[32|64]_R_TYPE +or +.Sy ELF[32|64]_R_SYM , +respectively to the entry's +.Sy r_info +member. +.It Dv r_addend +This member specifies a constant addend used to compute the value to be +stored into the relocatable field. +.El +.Sh SEE ALSO +.Xr as 1 , +.Xr gdb 1 , +.Xr ld 1 , +.Xr objdump 1 , +.Xr execve 2 , +.Xr ar 5 , +.Xr core 5 +.Rs +.%A Hewlett Packard +.%B Elf-64 Object File Format +.Re +.Rs +.%A Santa Cruz Operation +.%B System V Application Binary Interface +.Re +.Rs +.%A Unix System Laboratories +.%T Object Files +.%B "Executable and Linking Format (ELF)" +.Re +.Sh HISTORY +The ELF header files made their appearance in +.Fx 2.2.6 . +ELF in itself first appeared in +.At V . +The ELF format is an adopted standard. +.Sh AUTHORS +This manual page was written by +.An Jeroen Ruigrok van der Werven +.Aq asmodai@FreeBSD.org +with inspiration from BSDi's +.Bsx +.Xr elf 5 +manpage. diff --git a/share/man/man5/ethers.5 b/share/man/man5/ethers.5 new file mode 100644 index 0000000..e10bf30 --- /dev/null +++ b/share/man/man5/ethers.5 @@ -0,0 +1,102 @@ +.\" Copyright (c) 1995 +.\" Bill Paul <wpaul@ctr.columbia.edu>. 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 Bill Paul. +.\" 4. Neither the name of the author nor the names of any co-contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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. +.\" +.\" $FreeBSD$ +.\" +.Dd April 12, 1995 +.Dt ETHERS 5 +.Os +.Sh NAME +.Nm ethers +.Nd ethernet address database +.Sh DESCRIPTION +The +.Nm +database contains information regarding known 48-bit ethernet addresses +of hosts on an Internetwork. +The data is stored in a file called +.Pa /etc/ethers +in the following format: +.Pp +.D1 Ar ethernet-address fully-qualified-host-name +.Pp +Items are separated by any number of blanks and/or +tab characters. +A ``#'' at the start of a line indicates the +beginning of a comment that extends to the end of the line. +A ``+'' at +the start of a line will cause the +.Xr ethers 3 +library functions to use data stored in the +.Tn NIS +.Pa ethers.byname +and +.Pa ethers.byaddr +maps in addition to the data in the +.Pa /etc/ethers +file. +.Pp +An ethernet address is expressed in +.Tn ASCII +form as "x:x:x:x:x:x" where +.Ar x +is a hexadecimal value between 0x00 and 0xFF. +The address values +should be in network order. +Hostnames specified in the +.Pa /etc/ethers +database should correspond to entries in the +.Xr hosts 5 +file. +.Pp +The +.Fn ether_line +function in the standard C library can be used to break individual +lines in the +.Pa /etc/ethers +database into their individual components: a binary Ethernet address +stored as an +.Pa ether_addr +structure, and a hostname stored as a character string. +.Sh FILES +.Bl -tag -width /etc/services -compact +.It Pa /etc/ethers +The +.Nm +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr ethers 3 , +.Xr yp 8 +.Sh HISTORY +The +.Nm +format is based on the format used in SunOS 4.1.x. diff --git a/share/man/man5/eui64.5 b/share/man/man5/eui64.5 new file mode 100644 index 0000000..4e2dda6 --- /dev/null +++ b/share/man/man5/eui64.5 @@ -0,0 +1,110 @@ +.\" Copyright (c) 1995 +.\" Bill Paul <wpaul@ctr.columbia.edu>. 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 Bill Paul. +.\" 4. Neither the name of the author nor the names of any co-contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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. +.\" +.\" $FreeBSD$ +.\" +.Dd May 11, 2004 +.Dt EUI64 5 +.Os +.Sh NAME +.Nm eui64 +.Nd IEEE EUI-64 address database +.Sh DESCRIPTION +The +.Nm +database contains information regarding known IEEE EUI-64s of hosts. +The data is stored in a file called +.Pa /etc/eui64 +in the following format: +.Bd -ragged -offset indent +.Em EUI-64 host-name +.Ed +.Pp +Items are separated by any number of blanks and/or +tab characters. +A +.Ql # +at the start of a line indicates the +beginning of a comment that extends to the end of the line. +Valid lines may also contain comments. +A +.Ql + +at the start of a line will cause the +.Xr eui64 3 +library functions to use data stored in the +NIS +.Pa eui64.byname +and +.Pa eui64.byid +maps in addition to the data in the +.Pa /etc/eui64 +file. +.Pp +An EUI-64 is expressed in +.Tn ASCII +form as +.Qq x-x-x-x-x-x-x-x +where +.Ar x +is a hexadecimal value between 0x00 and 0xFF. +The address values +should be in network order. +Hostnames specified in the +.Pa /etc/eui64 +database should correspond to entries in the +.Xr hosts 5 +file. +.\" .Pp +.\" The +.\" .Fn eui64_line +.\" function in the standard C library can be used to break individual +.\" lines in the +.\" .Pa /etc/eui64 +.\" database into their individual components: a binary EUI-64 is +.\" stored as an +.\" .Pa eui64_addr +.\" structure, and a hostname stored as a character string. +.Sh FILES +.Bl -tag -width ".Pa /etc/eui64" -compact +.It Pa /etc/eui64 +The +.Nm +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr eui64 3 , +.Xr yp 8 +.Sh HISTORY +The +.Nm +format is based on the +.Xr ethers 5 +format. diff --git a/share/man/man5/ext2fs.5 b/share/man/man5/ext2fs.5 new file mode 100644 index 0000000..a74e599 --- /dev/null +++ b/share/man/man5/ext2fs.5 @@ -0,0 +1,83 @@ +.\" +.\" Copyright (c) 2006 Craig Rodrigues +.\" 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 DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd May 16, 2006 +.Dt EXT2FS 5 +.Os +.Sh NAME +.Nm ext2fs +.Nd "Ext2fs file system" +.Sh SYNOPSIS +To link into the kernel: +.Bd -ragged -offset indent +.Cd "options EXT2FS" +.Ed +.Pp +To load as a kernel loadable module: +.Pp +.Dl "kldload ext2fs" +.Sh DESCRIPTION +The +.Nm +driver will permit the +.Fx +kernel to access +.Tn Ext2 +file systems. +.Sh EXAMPLES +To mount a +.Nm +volume located on +.Pa /dev/ad1s1 : +.Pp +.Dl "mount -t ext2fs /dev/ad1s1 /mnt" +.Sh SEE ALSO +.Xr nmount 2 , +.Xr unmount 2 , +.Xr fstab 5 , +.Xr mount 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 2.2 . +.Sh AUTHORS +.An -nosplit +The +.Nm +kernel implementation was written by +.An Godmar Back +or modified by him using the CSRG sources. +.Pp +.An John Dyson +and others in the +.Fx +Project made modifications. +.Pp +This manual page was written by +.An Craig Rodrigues Aq rodrigc@FreeBSD.org . diff --git a/share/man/man5/fbtab.5 b/share/man/man5/fbtab.5 new file mode 100644 index 0000000..0598fd1 --- /dev/null +++ b/share/man/man5/fbtab.5 @@ -0,0 +1,47 @@ +.\" +.\" $FreeBSD$ +.\" +.Dd August 22, 1994 +.Dt FBTAB 5 +.Os +.Sh NAME +.Nm fbtab +.Nd change device protection upon login +.Sh DESCRIPTION +The +.Nm +file contains a number of lines specifying a device together with a list +of devices with associated protections. +Comments start with a +.Ql # +and extend to the end of the line. +.Pp +Blank lines or lines with only a comment are ignored. +.Pp +All other lines consist of three fields delimited by +whitespace: a login device +.Pq Pa /dev/ttyv0 , +an octal permission number (0600), and a colon +.Pq Ql \&: +delimited list of device patterns +.Pq Pa /dev/console , /dev/dsp* . +All device patterns are absolute paths. +.Pp +If the tty argument (relative path) matches a login device +name (absolute path), the permissions of the devices in the +colon-delimited list are set as specified in the second +field, and their ownership is changed to that of the UID +and GID arguments. +.Sh FILES +.Bl -tag -width ".Pa /etc/fbtab" -compact +.It Pa /etc/fbtab +The +.Nm +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr login 1 , +.Xr getty 8 +.Sh AUTHORS +.An Guido van Rooij diff --git a/share/man/man5/fdescfs.5 b/share/man/man5/fdescfs.5 new file mode 100644 index 0000000..b844451 --- /dev/null +++ b/share/man/man5/fdescfs.5 @@ -0,0 +1,120 @@ +.\" Copyright (c) 1996 +.\" Mike Pritchard <mpp@FreeBSD.org>. All rights reserved. +.\" +.\" Copyright (c) 1992, 1993, 1994 +.\" The Regents of the University of California. All rights reserved. +.\" All rights reserved. +.\" +.\" This code is derived from software donated to Berkeley by +.\" Jan-Simon Pendry. +.\" +.\" 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 the University of +.\" California, Berkeley and its contributors. +.\" 4. 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. +.\" +.\" $FreeBSD$ +.\" +.Dd December 14, 1996 +.Dt FDESCFS 5 +.Os +.Sh NAME +.Nm fdescfs +.Nd file-descriptor file system +.Sh SYNOPSIS +.Bd -literal +fdescfs /dev/fd fdescfs rw 0 0 +.Ed +.Sh DESCRIPTION +The file-descriptor file system, or +.Nm , +provides access to the per-process file descriptor +namespace in the global file system namespace. +The conventional mount point is +.Pa /dev/fd . +.Pp +The file system's contents +appear as a list of numbered files +which correspond to the open files of the process reading the +directory. +The files +.Pa /dev/fd/0 +through +.Pa /dev/fd/# +refer to file descriptors which can be accessed through the file +system. +If the file descriptor is open and the mode the file is being opened +with is a subset of the mode of the existing descriptor, the call: +.Bd -literal -offset indent +fd = open("/dev/fd/0", mode); +.Ed +.Pp +and the call: +.Bd -literal -offset indent +fd = fcntl(0, F_DUPFD, 0); +.Ed +.Pp +are equivalent. +.Pp +Flags to the +.Xr open 2 +call other than +.Dv O_RDONLY , +.Dv O_WRONLY +and +.Dv O_RDWR +are ignored. +.Sh FILES +.Bl -tag -width /dev/stderr -compact +.It Pa /dev/fd/# +.El +.Sh EXAMPLES +To mount a +.Nm +volume located on +.Pa /dev/fd : +.Pp +.Dl "mount -t fdescfs null /dev/fd" +.Sh SEE ALSO +.Xr mount 8 +.Sh HISTORY +The +.Nm +file system first appeared in +.Bx 4.4 . +The +.Nm +manual page first appeared in +.Fx 2.2 . +.Sh AUTHORS +.An -nosplit +The +.Nm +manual page was written by +.An Mike Pritchard Aq mpp@FreeBSD.org , +and was based on the +manual page written by +.An Jan-Simon Pendry . diff --git a/share/man/man5/forward.5 b/share/man/man5/forward.5 new file mode 100644 index 0000000..2234ff3 --- /dev/null +++ b/share/man/man5/forward.5 @@ -0,0 +1,97 @@ +.\" 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$ +.\" +.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@FreeBSD.org +"|/usr/bin/vacation nobody" +.Ed +.Pp +Mail would be forwarded to +.Aq nobody@FreeBSD.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 aliases 5 , +.Xr mailaddr 7 , +.Xr sendmail 8 diff --git a/share/man/man5/freebsd-update.conf.5 b/share/man/man5/freebsd-update.conf.5 new file mode 100644 index 0000000..d372102 --- /dev/null +++ b/share/man/man5/freebsd-update.conf.5 @@ -0,0 +1,234 @@ +.\"- +.\" Copyright 2006 Colin Percival +.\" All rights reserved +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted providing that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd August 19, 2009 +.Dt FREEBSD-UPDATE.CONF 5 +.Os FreeBSD +.Sh NAME +.Nm freebsd-update.conf +.Nd configuration file for +.Xr freebsd-update 8 +.Sh DESCRIPTION +The +.Nm +file controls the behaviour of the +.Xr freebsd-update 8 +utility. +The file contains lines consisting of a case-sensitive option name and +zero or more parameters. +Empty lines and any part of a line following a +.Ql # +character are ignored. +Unless stated otherwise, specifying an option multiple times is an +error. +.Pp +The possible options and their meanings are as follows: +.Pp +.Bl -tag -width ".Cm BackupKernelSymbolFiles" +.It Cm KeyPrint +The single parameter following this keyword is the SHA256 hash +of the RSA key which will be trusted to sign updates. +.It Cm ServerName +The single parameter following this keyword is the name of the +server or server pool from which updates will be downloaded. +.It Cm Components +The parameters following this keyword are the components or +sub-components of +.Fx +which will be updated. +The components are +.Dq src +(source code), +.Dq world +(non-kernel binaries), and +.Dq kernel ; +the sub-components are the individual distribution sets generated as +part of the release process (e.g., +.Dq src/base , +.Dq src/sys , +.Dq world/base , +.Dq world/catpages , +.Dq kernel/smp ) . +Note that prior to +.Fx 6.1 , +the +.Dq kernel +component was distributed as part of +.Dq world/base . +.Pp +This option can be specified multiple times, and the parameters +accumulate. +.It Cm IgnorePaths +The parameters following this keyword are regular expressions; +updates to paths which start with a string matching one of +these regular expressions will be ignored. +.Pp +This option can be specified multiple times, and the parameters +accumulate. +.It Cm IDSIgnorePaths +The parameters following this keyword are regular expressions; +paths which start with a string matching one of these regular +expressions will be ignored by "freebsd-update IDS". +.Pp +This option can be specified multiple times, and the parameters +accumulate. +.It Cm UpdateIfUnmodified +The parameters following this keyword are regular expressions; +updates to paths which start with a string matching one of +these regular expressions will be ignored if the files have +been modified locally (unless they are merged -- see MergeChanges +below). +.Pp +This option can be specified multiple times, and the parameters +accumulate. +.It Cm MergeChanges +The parameters following this keyword are regular expressions; +updates to paths which start with a string matching one of +these regular expressions will be merged with local modifications. +.Pp +This option can be specified multiple times, and the parameters +accumulate. +.It Cm WorkDir +The single parameter following this keyword is the directory +in which temporary files and downloaded updates will be stored. +.It Cm MailTo +The single parameter following this keyword is the address +to which +.Cm cron +output will be mailed. +.It Cm AllowAdd +The single parameter following this keyword must be +.Dq yes +or +.Dq no +and specifies whether +.Cm freebsd-update +is allowed to create new files, directories, and symlinks if +these are part of updates downloaded. +Note that +.Cm freebsd-update +will not re-add files which have been deleted from a +.Fx +installation unless those files were previously added as part +of an update. +.It Cm AllowDelete +The single parameter following this keyword must be +.Dq yes +or +.Dq no +and specifies whether +.Cm freebsd-update +is allowed to delete files, directories, and symlinks as +part of updates downloaded. +.It Cm KeepModifiedMetadata +The single parameter following this keyword must be +.Dq yes +or +.Dq no +and specifies whether +.Cm freebsd-update +should keep existing file ownership, permissions, and flags +when installing updates if these have been modified locally. +.It Cm StrictComponents +The single parameter following this keyword must be +.Dq yes +or +.Dq no +and specifies whether +.Cm freebsd-update +should interpret the list of components of +.Fx +specified via the +.Cm Components +option strictly as a list of components installed which +should be upgraded when the +.Cm upgrade +command is used ("yes"), or merely as a list of components +which might be installed, of which +.Cm freebsd-update +should identify which in fact are present ("no"). +.It Cm BackupKernel +The single parameter following this keyword must be +.Dq yes +or +.Dq no +and specifies whether +.Cm freebsd-update +will create a backup of the old kernel before installing a new kernel. +This backup kernel can be used to recover a system where the newly +installed kernel somehow did not work. +Note that the backup kernel is not reverted to its original state by +the +.Cm freebsd-update +rollback command. +.It Cm BackupKernelDir +This keyword sets the directory which is used to store a backup +kernel, if the BackupKernel feature is enabled. +If the directory already exist, and it was not created by +.Cm freebsd-update , +the directory is skipped. +In the case of the primary directory name not being usable, a number +starting with +.Sq 1 +is appended to the directory name. +Like with the primary directory name, the constructed directory name is +only used if the path name does not exist, or if the directory was +previously created by +.Cm freebsd-update . +If the constructed directory still exist the appended number is +incremented with 1 and the directory search process restarted. +Should the number increment go above 9, +.Cm freebsd-update +will abort. +.It Cm BackupKernelSymbolFiles +The single parameter following this keyword must be +.Dq yes +or +.Dq no +and specifies whether +.Cm freebsd-update +will also backup kernel symbol files, if they exist. +The kernel symbol files takes up a lot of disk space and are not +needed for recovery purposes. +If the symbol files are needed, after recovering a system using the +backup kernel, the +.Cm freebsd-update +rollback command will recreate the symbol files along with the old +kernel. +.El +.Sh FILES +.Bl -tag -width "/etc/freebsd-update.conf" +.It /etc/freebsd-update.conf +Default location of the +.Cm freebsd-update +configuration file. +.El +.Sh SEE ALSO +.Xr sha256 1 , +.Xr freebsd-update 8 +.Sh AUTHORS +.An Colin Percival Aq cperciva@FreeBSD.org diff --git a/share/man/man5/fs.5 b/share/man/man5/fs.5 new file mode 100644 index 0000000..abb0f47 --- /dev/null +++ b/share/man/man5/fs.5 @@ -0,0 +1,450 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd October 31, 2006 +.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 +.Pp +.In sys/types.h +.In sys/lock.h +.In sys/extattr.h +.In sys/acl.h +.In ufs/ufs/quota.h +.In ufs/ufs/dinode.h +.In ufs/ufs/extattr.h +.Sh DESCRIPTION +The files +.In fs.h +and +.In inode.h +declare several structures, defined 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 SBLOCKSIZE . +The following structure describes the super-block and is +from the file +.In ufs/ffs/fs.h : +.Bd -literal +/* + * Super block for an FFS filesystem. + */ +struct fs { + int32_t fs_firstfield; /* historic filesystem linked list, */ + int32_t fs_unused_1; /* used for incore super blocks */ + int32_t fs_sblkno; /* offset 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 */ + 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 */ + int32_t fs_id[2]; /* unique filesystem 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 */ + 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 filesystem */ + 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; /* filesystem is clean flag */ + int8_t fs_ronly; /* mounted read-only flag */ + int8_t fs_old_flags; /* old FS_ flags */ + u_char fs_fsmnt[MAXMNTLEN]; /* name mounted on */ + u_char fs_volname[MAXVOLLEN]; /* volume name */ + u_int64_t fs_swuid; /* system-wide uid */ + int32_t fs_pad; /* due to alignment of fs_swuid */ +/* these fields retain the current block allocation info */ + int32_t fs_cgrotor; /* last cg searched */ + void *fs_ocsp[NOCSPTRS]; /* padding; was list of fs_cs buffers */ + u_int8_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_int *fs_active; /* used by snapshots to track fs */ + int32_t fs_old_cpc; /* cyl per cycle in postbl */ + int32_t fs_maxbsize; /* maximum blocking factor permitted */ + int64_t fs_unrefs; /* number of unreferenced inodes */ + int64_t fs_sparecon64[16]; /* old rotation block list head */ + int64_t fs_sblockloc; /* byte offset of standard superblock */ + struct csum_total fs_cstotal; /* cylinder summary information */ + ufs_time_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 */ + ufs2_daddr_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 */ + 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 */ + int32_t fs_flags; /* see FS_ flags below */ + 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 */ + u_int64_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 */ + 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 */ +}; + +/* + * Filesystem identification + */ +#define FS_UFS1_MAGIC 0x011954 /* UFS1 fast filesystem magic number */ +#define FS_UFS2_MAGIC 0x19540119 /* UFS2 fast filesystem magic number */ +#define FS_OKAY 0x7c269d38 /* superblock checksum */ +#define FS_42INODEFMT -1 /* 4.2BSD inode format */ +#define FS_44INODEFMT 2 /* 4.4BSD inode format */ + +/* + * Preference for optimization. + */ +#define FS_OPTTIME 0 /* minimize allocation time */ +#define FS_OPTSPACE 1 /* minimize disk fragmentation */ +.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 cannot 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_old_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_old_rotdelay +is 2ms. +.Pp +Each file system has a statically allocated number of inodes. +An inode is allocated for each +.Dv NBPI +bytes of disk space. +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 SBLOCKSIZE . +.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 SBLOCKSIZE . +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 . +.Pp +The format of an external attribute is defined by the extattr structure: +.Bd -literal +struct extattr { + int32_t ea_length; /* length of this attribute */ + int8_t ea_namespace; /* name space of this attribute */ + int8_t ea_contentpadlen; /* padding at end of attribute */ + int8_t ea_namelength; /* length of attribute name */ + char ea_name[1]; /* null-terminated attribute name */ + /* extended attribute content follows */ +}; +.Ed +.Pp +Several macros are defined to manipulate these structures. +Each macro takes a pointer to an extattr structure. +.Bl -tag -width ".Dv EXTATTR_SET_LENGTHS(eap, size)" +.It Dv EXTATTR_NEXT(eap) +Returns a pointer to the next extended attribute following +.Fa eap . +.It Dv EXTATTR_CONTENT(eap) +Returns a pointer to the extended attribute content referenced by +.Fa eap . +.It Dv EXTATTR_CONTENT_SIZE(eap) +Returns the size of the extended attribute content referenced by +.Fa eap . +.It Dv EXTATTR_SET_LENGTHS(eap, size) +Called with the size of the attribute content after initializing +the attribute name to calculate and set the +.Fa ea_length , +.Fa ea_namelength , +and +.Fa ea_contentpadlen +fields of the extended attribute structure. +.El +.Pp +The following code identifies an ACL: +.Bd -literal + if (eap->ea_namespace == EXTATTR_NAMESPACE_SYSTEM && + !strcmp(eap->ea_name, POSIX1E_ACL_ACCESS_EXTATTR_NAME) { + aclp = EXTATTR_CONTENT(eap); + acllen = EXTATTR_CONTENT_SIZE(eap); + ... + } +.Ed +.Pp +The following code creates an extended attribute +containing a copy of a structure +.Fa mygif : +.Bd -literal + eap->ea_namespace = EXTATTR_NAMESPACE_USER; + strcpy(eap->ea_name, "filepic.gif"); + EXTATTR_SET_LENGTHS(eap, sizeof(struct mygif)); + memcpy(EXTATTR_CONTENT(eap), &mygif, sizeof(struct mygif)); +.Ed +.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/share/man/man5/fstab.5 b/share/man/man5/fstab.5 new file mode 100644 index 0000000..1c6f17e --- /dev/null +++ b/share/man/man5/fstab.5 @@ -0,0 +1,323 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd November 23, 2008 +.Dt FSTAB 5 +.Os +.Sh NAME +.Nm fstab +.Nd static information about the file systems +.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. +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 thing. +.Pp +The first field, +.Pq Fa fs_spec , +describes the special device or +remote file system to be mounted. +.Pp +The second field, +.Pq Fa fs_file , +describes the mount point for the file system. +For swap partitions, this field should be specified as ``none''. +.Pp +The third field, +.Pq Fa fs_vfstype , +describes the type of the file system. +The system can support various file system types. +Only the root, /usr, and /tmp file systems need be statically +compiled into the kernel; +everything else will be automatically loaded at mount +time. +(Exception: the FFS cannot currently be demand-loaded.) +Some people still prefer to statically +compile other file systems as well. +.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. +See the options flag +.Pq Fl o +in the +.Xr mount 8 +page and the file system specific page, such as +.Xr mount_nfs 8 , +for additional options that may be specified. +All options that can be given to the file system specific mount commands +can be used in +.Nm +as well. +They just need to be formatted a bit differently. +The arguments of the +.Fl o +option can be used without the preceding +.Fl o +flag. +Other options need both the file system specific flag and its argument, +separated by an equal sign. +For example, mounting an +.Xr msdosfs 5 +filesystem, the options +.Bd -literal -offset indent +-o sync -o noatime -m 644 -M 755 -u foo -g bar +.Ed +.Pp +should be written as +.Bd -literal -offset indent +sync,noatime,-m=644,-M=755,-u=foo,-g=bar +.Ed +.Pp +in the option field of +.Nm . +.Pp +If the options ``userquota'' and/or ``groupquota'' are specified, +the file system is automatically processed by the +.Xr quotacheck 8 +command, and 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 +If the option ``noauto'' is specified, the file system will not be automatically +mounted at system startup. +Note that, for network file systems +of third party types +(i.e., types supported by additional software +not included in the base system) +to be automatically mounted at system startup, +the +.Va extra_netfs_types +.Xr rc.conf 5 +variable must be used to extend the +.Xr rc 8 +startup script's list of network file system types. +.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 ``rw'' or ``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 ``sw'' then the special file is made available as a piece of swap +space by the +.Xr swapon 8 +command at the end of the system reboot procedure. +The fields other than +.Fa fs_spec +and +.Fa fs_type +are unused. +If +.Fa fs_type +is specified as ``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 +.Nm dump +will assume that the file system does not need to be dumped. +If the fifth field is greater than 0, then it specifies the number of days +between dumps for this file system. +.Pp +The sixth field, +.Pq Fa fs_passno , +is used by the +.Xr fsck 8 +and +.Xr quotacheck 8 +programs to determine the order in which file system and quota +checks are done at reboot time. +The +.Fa fs_passno +field can be any value between 0 and +.Ql INT_MAX Ns -1 . +.Pp +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 or greater. +A file system with a +.Fa fs_passno +value of 1 is always checked sequentially and be completed before +another file system is processed, and it will be processed before +all file systems with a larger +.Fa fs_passno . +.Pp +For any given value of +.Fa fs_passno , +file systems within a drive will be checked sequentially, +but file systems on different drives will be checked at the +same time to utilize parallelism available in the hardware. +Once all file system checks are complete for the current +.Fa fs_passno , +the same process will start over for the next +.Fa fs_passno . +.Pp +If the sixth field is not present or is zero, +a value of zero is returned and +.Xr fsck 8 +and +.Xr quotacheck 8 +will assume that the file system does not need to be checked. +.Pp +The +.Fa fs_passno +field can be used to implement finer control when +the system utilities may determine that the file system resides +on a different physical device, when it actually does not, as with a +.Xr ccd 4 +device. +All file systems with a lower +.Fa fs_passno +value will be completed before starting on file systems with a +higher +.Fa fs_passno +value. +E.g. all file systems with a +.Fa fs_passno +of 2 will be completed before any file systems with a +.Fa fs_passno +of 3 or greater are started. +Gaps are allowed between the different +.Fa fs_passno +values. +E.g. file systems listed in +.Pa /etc/fstab +may have +.Fa fs_passno +values such as 0, 1, 2, 15, 100, 200, 300, and may appear in any order +within +.Pa /etc/fstab . +.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_XX "xx" /* ignore totally */ + +struct fstab { + char *fs_spec; /* block special device name */ + char *fs_file; /* file system path prefix */ + char *fs_vfstype; /* File system type, ufs, nfs */ + char *fs_mntops; /* Mount options ala -o */ + char *fs_type; /* FSTAB_* from fs_mntops */ + 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 , +.Xr getfstype 3 , +and +.Xr getfsfile 3 . +.Sh FILES +.Bl -tag -width /etc/fstab -compact +.It Pa /etc/fstab +The file +.Nm +resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr getfsent 3 , +.Xr getvfsbyname 3 , +.Xr ccd 4 , +.Xr dump 8 , +.Xr fsck 8 , +.Xr mount 8 , +.Xr quotacheck 8 , +.Xr quotaon 8 , +.Xr swapon 8 , +.Xr umount 8 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.0 . diff --git a/share/man/man5/group.5 b/share/man/man5/group.5 new file mode 100644 index 0000000..4aa6aff --- /dev/null +++ b/share/man/man5/group.5 @@ -0,0 +1,164 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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: @(#)group.5 8.3 (Berkeley) 4/19/94 +.\" $FreeBSD$ +.\" +.Dd September 29, 1994 +.Dt GROUP 5 +.Os +.Sh NAME +.Nm group +.Nd format of the group permissions file +.Sh DESCRIPTION +The +.Nm +file is the local source of group information. +It can be used in conjunction with the Hesiod domain +`group', and the NIS maps `group.byname' and `group.bygid', +as controlled by +.Xr nsswitch.conf 5 . +.Pp +The file +.Nm +consists of newline separated +.Tn ASCII +records, one per group, containing four colon +.Ql \&: +separated fields. +These fields are as follows: +.Bl -tag -width password -offset indent -compact +.It group +Name of the group. +.It passwd +Group's +.Em encrypted +password. +.It gid +The group's decimal ID. +.It member +Group members. +.El +.Pp +Lines whose first non-whitespace character is a pound-sign (#) +are comments, and are ignored. +Blank lines that consist +only of spaces, tabs or newlines are also ignored. +.Pp +The +.Ar group +field is the group name used for granting file access to users +who are members of the group. +The +.Ar 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. +The +.Ar 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. +The +.Ar member +field contains the names of users granted the privileges of +.Ar 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 +.Nm +file. +.\" .Pp +.\" When the system reads the file +.\" .Pa /etc/group +.\" the fields are read into the structure +.\" .Fa group +.\" declared in +.\" .In grp.h : +.\" .Bd -literal -offset indent +.\" struct group { +.\" char *gr_name; /* group name */ +.\" char *gr_passwd; /* group password */ +.\" int gr_gid; /* group id */ +.\" char **gr_mem; /* group members */ +.\" }; +.\" .Ed +.Sh LIMITS +There are various limitations which are explained in +the function where they occur; see section +.Sx SEE ALSO . +.Pp +In older implementations, +a group cannot have more than 200 members. +The maximum line length of +.Pa /etc/group +is 1024 characters. +Longer lines will be skipped. +This limitation disappeared in +.Fx 3.0 . +Older binaries that are statically linked, depend on old +shared libraries, or +.No non- Ns Fx +binaries in compatibility mode +may still have this limit. +.Sh FILES +.Bl -tag -width /etc/group -compact +.It Pa /etc/group +.El +.Sh SEE ALSO +.Xr passwd 1 , +.Xr setgroups 2 , +.Xr crypt 3 , +.Xr getgrent 3 , +.Xr initgroups 3 , +.Xr nsswitch.conf 5 , +.Xr passwd 5 , +.Xr chkgrp 8 , +.Xr pw 8 , +.Xr yp 8 +.Sh HISTORY +A +.Nm +file format appeared in +.At v6 . +Support for comments first appeared in +.Fx 3.0 . +.Sh BUGS +The +.Xr passwd 1 +command does not change the +.Nm +passwords. diff --git a/share/man/man5/hesiod.conf.5 b/share/man/man5/hesiod.conf.5 new file mode 100644 index 0000000..364ea80 --- /dev/null +++ b/share/man/man5/hesiod.conf.5 @@ -0,0 +1,80 @@ +.\" $NetBSD: hesiod.conf.5,v 1.2 1999/01/25 22:37:06 lukem 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. +.\" +.\" $FreeBSD$ +.\" +.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 +.Ql # +character are ignored. +All +other lines should be of the form +.Ar variable += +.Ar value , +where the +.Ar value +should be a single word. +Possible +.Ar variables +and +.Ar values +are: +.Bl -tag -width classes +.It Ic lhs +Specifies the domain prefix used for Hesiod queries. +In almost all cases, you should specify +.Dq Li lhs=.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 Ic rhs +Specifies the default Hesiod domain; this value may be overridden by +the +.Ev HES_DOMAIN +environment variable. +You must specify an rhs line for the Hesiod +library to work properly. +.It Ic classes +Specifies which DNS classes Hesiod should do lookups in. +Possible values are +.Cm IN +(the preferred class) and +.Cm 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 Li IN,HS . +.El +.Sh SEE ALSO +.Xr hesiod 3 +.Sh BUGS +The default value for +.Ic lhs +should probably be more reasonable. diff --git a/share/man/man5/hosts.5 b/share/man/man5/hosts.5 new file mode 100644 index 0000000..218a4df --- /dev/null +++ b/share/man/man5/hosts.5 @@ -0,0 +1,116 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd December 11, 1993 +.Dt HOSTS 5 +.Os +.Sh NAME +.Nm hosts +.Nd host name data base +.Sh DESCRIPTION +The +.Nm +file contains information regarding +the known hosts on the network. +It can be used in conjunction with DNS, and the NIS +maps `hosts.byaddr' and `hosts.byname', as controlled by +.Xr nsswitch.conf 5 . +For each host a single line should be present +with the following information: +.Bd -unfilled -offset indent +Internet address +official host name +aliases +.Ed +.Pp +Items are separated by any number of blanks and/or +tab characters. +A ``#'' 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 , +this file provides a backup used 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 addresses for the local interfaces that +.Xr ifconfig 8 +needs at boot time and a few machines on the local network. +.Pp +This file may be created from the official host +data base maintained at the Network Information Control +Center +.Pq Tn NIC , +though local changes may be required +to bring it up to date regarding unofficial aliases +and/or unknown hosts. +As the data base maintained at +.Tn NIC +is incomplete, use of the name server is recommended for +sites on the +.Tn DARPA +Internet. +.Pp +Network addresses are specified in the conventional +``.'' (dot) notation using the +.Xr inet_addr 3 +routine +from the Internet address manipulation library, +.Xr inet 3 . +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 +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/share/man/man5/hosts.equiv.5 b/share/man/man5/hosts.equiv.5 new file mode 100644 index 0000000..6bf8e0d --- /dev/null +++ b/share/man/man5/hosts.equiv.5 @@ -0,0 +1,149 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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. +.\" +.\" $FreeBSD$ +.\" +.Dd December 8, 2007 +.Dt HOSTS.EQUIV 5 +.Os +.Sh NAME +.Nm hosts.equiv , +.Nm .rhosts +.Nd trusted remote host and user name data base +.Sh DESCRIPTION +The +.Nm +and +.Nm .rhosts +files contain information regarding +trusted hosts and users on the network. +For each host a single line should be present +with the following information: +.Pp +simple +.Bd -unfilled -offset indent +hostname [username] +.Ed +.Pp +or the more verbose +.Bd -unfilled -offset indent +[+-][hostname|@netgroup] [[+-][username|@netgroup]] +.Ed +.Pp +A +.Dq @ +indicates a host by netgroup or user by netgroup. +A single +.Dq + +matches all hosts or users. +A host name with a leading +.Dq - +will reject +all matching hosts and all their users. +A user name with leading +.Dq - +will reject all matching users from matching hosts. +.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 +Host names are specified in the conventional Internet DNS +dotted-domains +.Dq .\& +(dot) notation using the +.Xr inet_addr 3 +routine +from the Internet address manipulation library, +.Xr inet 3 . +Host names may contain any printable +character other than a field delimiter, newline, +or comment character. +.Pp +For security reasons, a user's +.Nm .rhosts +file will be ignored if it is not a regular file, or if it +is not owned by the user, or +if it is writable by anyone other than the user. +.Sh FILES +.Bl -tag -width /etc/hosts.equivxxx -compact +.It Pa /etc/hosts.equiv +The +.Nm +file resides in +.Pa /etc . +.It Pa $HOME/.rhosts +.Nm .rhosts +file resides in +.Pa $HOME . +.El +.Sh EXAMPLES +.Dl bar.com foo +.Pp +Trust user +.Dq foo +from host +.Dq bar.com . +.Pp +.Dl +@allclient +.Pp +Trust all hosts from netgroup +.Dq allclient . +.Pp +.Dl +@allclient -@dau +.Pp +Trust all hosts from netgroup +.Dq allclient +and their users +except users from netgroup +.Dq dau . +.Sh SEE ALSO +.Xr rcp 1 , +.Xr rlogin 1 , +.Xr rsh 1 , +.Xr gethostbyname 3 , +.Xr inet 3 , +.Xr innetgr 3 , +.Xr ruserok 3 , +.Xr netgroup 5 , +.Xr ifconfig 8 , +.Xr named 8 , +.Xr yp 8 +.Sh BUGS +This manual page is incomplete. +For more information read +the source in +.Pa src/lib/libc/net/rcmd.c +or the SunOS manual page. diff --git a/share/man/man5/hosts.lpd.5 b/share/man/man5/hosts.lpd.5 new file mode 100644 index 0000000..910ac66 --- /dev/null +++ b/share/man/man5/hosts.lpd.5 @@ -0,0 +1,62 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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. +.\" +.\" $FreeBSD$ +.\" +.Dd June 1, 1996 +.Dt HOSTS.LPD 5 +.Os +.Sh NAME +.Nm hosts.lpd +.Nd trusted hosts that may use local print services +.Sh DESCRIPTION +The +.Nm +file contains a list of hostnames or IP addresses +that are allowed to use your local print services. +List every hostname or IP address on a line itself. +.Pp +If you want to allow access for any and all host, +you can usually use the NIS netgroups feature to +do this by adding a line with a single +.Ql + +character. +.Sh FILES +.Bl -tag -width /etc/hosts.lpdxxxxx -compact +.It Pa /etc/hosts.lpd +The +.Nm +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr printcap 5 , +.Xr lpd 8 diff --git a/share/man/man5/intro.5 b/share/man/man5/intro.5 new file mode 100644 index 0000000..764ba4d --- /dev/null +++ b/share/man/man5/intro.5 @@ -0,0 +1,55 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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. +.\" +.\" $FreeBSD$ +.\" +.Dd February 16, 1997 +.Dt INTRO 5 +.Os +.Sh NAME +.Nm intro +.Nd "introduction to file formats" +.Sh DESCRIPTION +This section contains information about file formats. +.Sh FILES +.Bl -tag -width /etc/shells -compact +.It Pa /etc +location of most system configuration files +.El +.Sh SEE ALSO +.Xr apropos 1 , +.Xr intro 1 , +.Xr intro 8 +.Sh HISTORY +The +.Nm +section manual page appeared in +.Fx 2.2 . diff --git a/share/man/man5/libmap.conf.5 b/share/man/man5/libmap.conf.5 new file mode 100644 index 0000000..6959ce2 --- /dev/null +++ b/share/man/man5/libmap.conf.5 @@ -0,0 +1,163 @@ +.\" Copyright (c) 2003 Matthew N. Dodd <winter@jurai.net> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd January 31, 2004 +.Dt LIBMAP.CONF 5 +.Os +.Sh NAME +.Nm libmap.conf +.Nd "configuration file for dynamic object dependency mapping" +.Sh DESCRIPTION +The +.Nm libmap +functionality of +.Xr ld-elf.so.1 1 +allows dynamic object dependencies to be mapped to arbitrary +names. +.Pp +The configuration file consists of two whitespace separated columns; the +left hand side containing the mapping candidate and the right hand +side containing the mapping. +Dependencies are matched against candidates and replaced with the mappings. +.Pp +Constrained mappings may be specified by enclosing the name of the +executable or library in brackets. +All mappings following a constraint will only be evaluated for that constraint. +Constraints can be one of three types: +.Bl -tag -width indent +.It Exact +The constraint is matched literally so that only an executable with an +identical fully qualified pathname will match the constraint. +This means that the executable +.Pa /usr/bin/foo +will not match a constraint for +.Pa /usr/bin/./foo +and vice-versa. +This is the default constraint type. +.It Basename +A constraint with no path is matched against the basename of the +executable. +.Pa foo +will match +.Pa /bin/foo , +.Pa /usr/local/sbin/foo , +or any other executable named +.Pa foo , +no matter what its path is. +.It Directory +A constraint with a trailing slash is prefix-matched against the full +pathname of the executable. +.Pa /usr/bin/ +will match any executable with a path starting with /usr/bin. +.El +.Pp +Note that the executable path matched against is the +.Fa path +parameter in an +.Fn exec* +function call. +The Directory or Exact constraints can only match when the executable +is called with a full pathname. +Most programs executed from a shell are run without a full path, via +.Fn exec*p , +so the Basename constraint type is the most useful. +.Pp +WARNING! +Constrained mappings must never appear first in the configuration file. +While there is a way to specify the +.Dq default +constraint, its use is not recommended. +.Pp +The most common use at the date of writing is for allowing multiple +.Tn POSIX +threading libraries to be used on a system without relinking or +changing symlinks. +.Pp +On 64-bit architectures that provide 32-bit runtime support, +the libmap mechanism is available for 32-bit binaries too. +The mappings has to be written into separate configuration file +.Pa /etc/libmap32.conf . +Currently only supported on amd64. +.Pp +This mechanism has also been used to create shims to allow Linux +shared libraries to be dynamically loaded into +.Fx +binaries. +In this case, an Exact constraint is used for the Linux shared library, +mapping libraries it depends on to a wrapper. +The wrapper then defines any needed symbols for the Linux shared library +and relies on its libraries not being mapped to provide actual +implementations. +It appears that only libraries loaded via +.Xr dlopen 3 +will work correctly. +The symbol version information in shared libraries is checked at +link time, but at run time the version information is currently +ignored. +.Sh FILES +.Bl -tag -width ".Pa /etc/libmap32.conf" -compact +.It Pa /etc/libmap.conf +The libmap configuration file. +.It Pa /etc/libmap32.conf +The libmap configuration file for 32-bit binaries on 64-bit system. +.El +.Sh EXAMPLES +.Bd -literal +# /etc/libmap.conf +# +# candidate mapping +# +libc_r.so.6 libpthread.so.2 # Everything that uses 'libc_r' +libc_r.so libpthread.so # now uses 'libpthread' + +[/tmp/mplayer] # Test version of mplayer uses libc_r +libpthread.so.2 libc_r.so.6 +libpthread.so libc_r.so + +[/usr/local/jdk1.4.1/] # All Java 1.4.1 programs use libthr + # This works because "javavms" executes + # programs with the full pathname +libpthread.so.2 libthr.so.2 +libpthread.so libthr.so + +# Glue for Linux-only EPSON printer .so to be loaded into cups, etc. +[/usr/local/lib/pips/libsc80c.so] +libc.so.6 pluginwrapper/pips.so +libdl.so.2 pluginwrapper/pips.so +.Ed +.Sh SEE ALSO +.Xr ldd 1 , +.Xr rtld 1 +.Sh HISTORY +The +.Nm +manual page and +.Nm libmap +functionality first appeared in +.Fx 5.1 . +.Sh AUTHORS +This manual page was written by +.An Matthew N. Dodd Aq winter@jurai.net . diff --git a/share/man/man5/link.5 b/share/man/man5/link.5 new file mode 100644 index 0000000..73f0a45 --- /dev/null +++ b/share/man/man5/link.5 @@ -0,0 +1,596 @@ +.\" Copyright (c) 1993 Paul Kranenburg +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by Paul Kranenburg. +.\" 3. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd October 23, 1993 +.Dt LINK 5 +.Os +.Sh NAME +.Nm link +.Nd dynamic loader and link editor interface +.Sh SYNOPSIS +.In sys/types.h +.In nlist.h +.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 a.out 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. +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 for short) to improve sharing of code pages among different processes. +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. +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 +.Dv _GLOBAL_OFFSET_TABLE_ . +The exact mechanism used for this is machine dependent, usually a machine +register is reserved for the purpose. +The rational 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 +_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 +.Xr ld 1 +and +.Xr ld.so 1 +are +.Em LD_VERSION_SUN (3) , +which is used by the +.Tn SunOS +4.x releases, and +.Em LD_VERSION_BSD (8) , +which has been in use since +.Fx 1.1 . +.It Fa d_un +Refers to a +.Em d_version +dependent data structure. +.It Fa so_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. +.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_filler1; + 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_filler1 +.It Fa sdt_loaded +A pointer to the first link map loaded (see below). +This field is set by +.Nm ld.so +.It Fa sdt_sods +The start of a (linked) list of shared object descriptors needed by +.Em this +object. +.It Fa sdt_filler1 +Deprecated (used by SunOS to specify library search rules). +.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 +(see +.Xr a.out 5 ) +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 +(chained through +.Fa sod_next ) +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_reserved : 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 +.Nm ld.so . +The path name +is obtained by searching a set of directories +(see also +.Xr ldconfig 8 ) +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 { + caddr_t som_addr; + char *som_path; + struct so_map *som_next; + struct sod *som_sod; + caddr_t som_sodbase; + u_int som_write : 1; + struct _dynamic *som_dynamic; + caddr_t 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 out in later versions of 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 +(see +.Xr nlist 3 ) . +.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 on linked list +and 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; + caddr_t 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 internally by +.Nm 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 where 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, +.Pa 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 +.Nm ld.so . +.\" See +.\" .Xr libdl.a +.\" for more information. +.Bd -literal -offset indent +struct ld_entry { + void *(*dlopen)(char *, int); + int (*dlclose)(void *); + void *(*dlsym)(void *, char *); + char *(*dlerror)(void); +}; +.Ed +.Pp +The +.Fa crt_ldso +structure defines the interface between the start-up code in crt0 and +.Nm ld.so . +.Bd -literal -offset indent +struct crt_ldso { + int crt_ba; + int crt_dzfd; + int crt_ldfd; + struct _dynamic *crt_dp; + char **crt_ep; + caddr_t crt_bp; + char *crt_prog; + char *crt_ldso; + struct ld_entry *crt_ldentry; +}; +#define CRT_VERSION_SUN 1 +#define CRT_VERSION_BSD_2 2 +#define CRT_VERSION_BSD_3 3 +#define CRT_VERSION_BSD_4 4 +.Ed +.Bl -tag -width crt_dzfd +.It Fa crt_ba +The virtual address at which +.Nm ld.so +was loaded by crt0. +.It Fa crt_dzfd +On SunOS systems, this field contains an open file descriptor to +.Dq Pa /dev/zero +used to get demand paged zeroed pages. +On +.Fx +systems it contains -1. +.It Fa crt_ldfd +Contains an open file descriptor that was used by crt0 to load +.Nm 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). +.El +.Pp +The +.Fa hints_header +and +.Fa hints_bucket +structures define the layout of the library hints, normally found in +.Dq Pa /var/run/ld.so.hints , +which is used by +.Nm 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 +.Dq a.out +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 + long hh_hashtab; + long hh_nbucket; + long hh_strtab; + long hh_strtab_sz; + long hh_ehints; +}; +.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. +.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 +.Sh CAVEATS +Only the (GNU) C compiler currently supports the creation of shared libraries. +Other programming languages cannot be used. diff --git a/share/man/man5/linprocfs.5 b/share/man/man5/linprocfs.5 new file mode 100644 index 0000000..a85afe9 --- /dev/null +++ b/share/man/man5/linprocfs.5 @@ -0,0 +1,98 @@ +.\" $FreeBSD$ +.\" Written by Garrett Wollman +.\" This file is in the public domain. +.\" +.Dd August 10, 1994 +.Dt LINPROCFS 5 +.Os +.Sh NAME +.Nm linprocfs +.Nd Linux process file system +.Sh SYNOPSIS +.Bd -literal +linproc /compat/linux/proc linprocfs rw 0 0 +.Ed +.Sh DESCRIPTION +The Linux process file system, or +.Nm , +emulates a subset of Linux' process file system and is required for +the complete operation of some Linux binaries. +.Pp +The +.Nm +provides a two-level view of process space. +At the highest level, processes themselves are named, according to +their process ids in decimal, with no leading zeros. +There is also a special node called +.Pa self +which always refers to the process making the lookup request. +.Pp +Each node is a directory containing several files: +.Bl -tag -width status +.It Pa exe +A reference to the vnode from which the process text was read. +This can be used to gain access to the process' symbol table, +or to start another copy of the process. +.It Pa mem +The complete virtual memory image of the process. +Only those addresses which exist in the process can be accessed. +Reads and writes to this file modify the process. +Writes to the text segment remain private to the process. +.El +.Pp +Each node is owned by the process's user, and belongs to that user's +primary group, except for the +.Pa mem +node, which belongs to the +.Li kmem +group. +.Sh FILES +.Bl -tag -width /compat/linux/proc/self/XXXXXXX -compact +.It Pa /compat/linux/proc +The normal mount point for the +.Nm . +.It Pa /compat/linux/proc/cpuinfo +CPU vendor and model information in human-readable form. +.It Pa /compat/linux/proc/meminfo +System memory information in human-readable form. +.It Pa /compat/linux/proc/pid +A directory containing process information for process +.Pa pid . +.It Pa /compat/linux/proc/self +A directory containing process information for the current process. +.It Pa /compat/linux/proc/self/exe +The executable image for the current process. +.It Pa /compat/linux/proc/self/mem +The complete virtual address space of the current process. +.El +.Sh EXAMPLES +To mount a +.Nm +file system on +.Pa /compat/linux/proc : +.Pp +.Dl "mount -t linprocfs linproc /compat/linux/proc" +.Sh SEE ALSO +.Xr mount 2 , +.Xr unmount 2 , +.Xr procfs 5 , +.Xr pseudofs 9 +.Sh HISTORY +The +.Nm +first appeared in +.Fx 4.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +was derived from +.Nm procfs +by +.An Pierre Beyssac . +This manual page was written by +.An Dag-Erling Sm\(/orgrav , +based on the +.Xr procfs 5 +manual page by +.An Garrett Wollman . diff --git a/share/man/man5/linsysfs.5 b/share/man/man5/linsysfs.5 new file mode 100644 index 0000000..f3ea3cf --- /dev/null +++ b/share/man/man5/linsysfs.5 @@ -0,0 +1,99 @@ +.\" Written by Garrett Wollman +.\" This file is in the public domain. +.\" +.\" $FreeBSD$ +.\" +.Dd February 5, 2007 +.Dt LINSYSFS 5 +.Os +.Sh NAME +.Nm linsysfs +.Nd Linux system file system +.Sh SYNOPSIS +.Bd -literal +linsys /compat/linux/sys linsysfs rw 0 0 +.Ed +.Sh DESCRIPTION +The +.Tn Linux +system file system, or +.Nm , +emulates a subset of the +.Tn Linux +sys file system and is required for +the complete operation of some +.Tn Linux +binaries. +.Pp +The +.Nm +provides a two-level view of devices. +At the highest level, PCI devices themselves are named, according to +their bus, slot and function in the system hierarchy. +PCI storage devices are listed in the +.Pa scsi_host +class with a device symlink +to the PCI directories of the devices. +.Pp +Each device node is a directory containing some files and directories: +.Bl -tag -width ".Pa status" +.It Pa host +A place holder for storage host information. +.It Pa pci_id +A directory for the +.Pa pci_id +that contains either the device information or another directory structure +for a PCI bridge. +.El +.Pp +Each host node of scsi_host is a directory containing some files and directories: +.Bl -tag -width ".Pa proc_name" +.It Pa proc_name +The +.Tn Linux +registered driver name for these devices. +.It Pa device +A symlink to the PCI device directory. +.El +.Sh FILES +.Bl -tag -width ".Pa /compat/linux/sys/devices/pci0000:00" -compact +.It Pa /compat/linux/sys +The normal mount point for +.Nm . +.It Pa /compat/linux/sys/class/scsi_host +The storage host node. +.It Pa /compat/linux/sys/devices/pci0000:00 +The PCI device hierarchy node. +.El +.Sh EXAMPLES +The most common usage follows: +.Pp +.Dl "mount -t linsysfs linsys /compat/linux/sys" +.Pp +where +.Pa /compat/linux/sys +is a mount point. +.Sh SEE ALSO +.Xr nmount 2 , +.Xr unmount 2 , +.Xr linprocfs 5 , +.Xr pseudofs 9 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 6.2 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was derived from +.Nm linprocfs +by +.An Doug Ambrisko . +This manual page was edited by +.An Doug Ambrisko , +based on the +.Xr linprocfs 5 +manual page by +.An Garrett Wollman . diff --git a/share/man/man5/mailer.conf.5 b/share/man/man5/mailer.conf.5 new file mode 100644 index 0000000..f17c44b --- /dev/null +++ b/share/man/man5/mailer.conf.5 @@ -0,0 +1,144 @@ +.\" $NetBSD: mailer.conf.5,v 1.2 1999/05/29 18:18:30 christos Exp $ +.\" +.\" Copyright (c) 1998 +.\" Perry E. Metzger. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgment: +.\" This product includes software developed for the NetBSD Project +.\" by Perry E. Metzger. +.\" 4. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd May 31, 2006 +.Dt MAILER.CONF 5 +.Os +.Sh NAME +.Nm mailer.conf +.Nd configuration file for +.Xr mailwrapper 8 +.Sh DESCRIPTION +The file +.Pa /etc/mail/mailer.conf +contains a series of lines of the form +.Pp +.Ar name +.Ar program +.Op Ar arguments ... +.Pp +The first word of each line is the +.Ar name +of a program invoking +.Xr mailwrapper 8 . +(For example, on a typical system +.Pa /usr/sbin/sendmail +would be a symbolic link to +.Xr mailwrapper 8 , +as would +.Xr newaliases 1 +and +.Xr mailq 1 . +Thus, +.Ar name +might be +.Dq Li sendmail +or +.Dq Li newaliases +etc.) +.Pp +The second word of each line is the name of the +.Ar program +to actually execute when the first name is invoked. +.Pp +The further +.Ar arguments , +if any, are passed to the +.Ar program , +followed by the arguments +.Xr mailwrapper 8 +was called with. +.Pp +The file may also contain comment lines, denoted by a +.Ql # +mark in the first column of any line. +.Sh FILES +/etc/mail/mailer.conf +.Sh EXAMPLES +This example shows how to set up +.Nm +to invoke the traditional +.Xr sendmail 8 +program: +.Bd -literal -offset indent +# Execute the "real" sendmail program located in +# /usr/libexec/sendmail/sendmail +sendmail /usr/libexec/sendmail/sendmail +send-mail /usr/libexec/sendmail/sendmail +mailq /usr/libexec/sendmail/sendmail +newaliases /usr/libexec/sendmail/sendmail +.Ed +.Pp +This example shows how to invoke a sendmail-workalike like Postfix in +place of +.Xr sendmail 8 : +.Bd -literal -offset indent +# Emulate sendmail using postfix +sendmail /usr/local/sbin/sendmail +send-mail /usr/local/sbin/sendmail +mailq /usr/local/sbin/sendmail +newaliases /usr/local/sbin/sendmail +.Ed +.Pp +This example shows the use of the +.Nm mini_sendmail +package from ports in place of +.Xr sendmail 8 . +Note the use of additional arguments. +.Bd -literal -offset indent +# Send outgoing mail to a smart relay using mini_sendmail +sendmail /usr/local/bin/mini_sendmail -srelayhost +send-mail /usr/local/bin/mini_sendmail -srelayhost +.Ed +.Sh SEE ALSO +.Xr mail 1 , +.Xr mailq 1 , +.Xr newaliases 1 , +.Xr mailwrapper 8 , +.Xr sendmail 8 +.Pp +.Xr postfix 1 Pq Pa ports/mail/postfix , +.Xr mini_sendmail 8 Pq Pa ports/mail/mini_sendmail +.Sh HISTORY +.Nm +appeared in +.Nx 1.4 . +.Sh AUTHORS +.An Perry E. Metzger Aq perry@piermont.com +.Sh BUGS +The entire reason this program exists is a crock. +Instead, a command +for how to submit mail should be standardized, and all the "behave +differently if invoked with a different name" behavior of things like +.Xr mailq 1 +should go away. diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5 new file mode 100644 index 0000000..9cc3c1d --- /dev/null +++ b/share/man/man5/make.conf.5 @@ -0,0 +1,770 @@ +.\" Copyright (c) 2000 +.\" Mike W. Meyer +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd December 15, 2009 +.Dt MAKE.CONF 5 +.Os +.Sh NAME +.Nm make.conf +.Nd system build information +.Sh DESCRIPTION +The file +.Nm +contains system-wide settings that will apply to every build using +.Xr make 1 +and the standard +.Pa sys.mk +file. +This is achieved as follows: +.Xr make 1 +processes the system makefile +.Pa sys.mk +before any other file by default, and +.Pa sys.mk +includes +.Nm . +.Pp +The file +.Nm +uses the standard makefile syntax. +However, +.Nm +should not specify any dependencies to +.Xr make 1 . +Instead, +.Nm +is to set +.Xr make 1 +variables that control the actions of other makefiles. +.Pp +The default location of +.Nm +is +.Pa /etc/make.conf , +though an alternative location can be specified in the +.Xr make 1 +variable +.Va __MAKE_CONF . +You may need to override the location of +.Nm +if the system-wide settings are not suitable for a particular build. +For instance, setting +.Va __MAKE_CONF +to +.Pa /dev/null +effectively resets all build controls to their defaults. +.Pp +The primary purpose of +.Nm +is to control the compilation of the +.Fx +sources, documentation, and ported applications, +which are usually found in +.Pa /usr/src , +.Pa /usr/doc , +and +.Pa /usr/ports . +As a rule, the system administrator creates +.Nm +when the values of certain control variables need to be changed +from their defaults. +.Pp +The system build procedures occur in four broad areas: +the world, the kernel, documentation and ports. +Variables set in +.Nm +may be applicable in one, two, or all four of these areas. +In addition, control variables can be specified +for a particular build via the +.Fl D +option of +.Xr make 1 +or in +.Xr environ 7 . +.Pp +The following lists provide a name and short description for each +variable you can use during the indicated builds. +The values of +variables flagged as +.Vt bool +are ignored; the variable being +set at all (even to +.Dq Li FALSE +or +.Dq Li NO ) +causes it to +be treated as if it were set. +.Pp +The following list provides a name and short description for variables +that are used for all builds, or are used by the +.Pa makefiles +for things other than builds. +.Bl -tag -width Ar +.It Va ALWAYS_CHECK_MAKE +.Pq Vt bool +Instructs the top-level makefile in the source tree (normally +.Pa /usr/src ) +to always check if +.Xr make 1 +is up-to-date. +Normally this is only done for the world and buildworld targets to handle +upgrades from older versions of +.Fx . +.It Va CFLAGS +.Pq Vt str +Controls the compiler setting when compiling C code. +Optimization levels other than +.Fl O +and +.Fl O2 +are not supported. +.Va BDECFLAGS +is provided as a set of +.Xr gcc 1 +settings suggested by +.An "Bruce Evans" Aq bde@FreeBSD.org +for developing and testing changes. +They can be used, if set, by: +.Pp +.Bd -literal -offset indent +CFLAGS+=${BDECFLAGS} +.Ed +.It Va CPUTYPE +.Pq Vt str +Controls which processor should be targeted for generated +code. +This controls processor-specific optimizations in +certain code (currently only OpenSSL) as well as modifying +the value of +.Va CFLAGS +and +.Va COPTFLAGS +to contain the appropriate optimization directive to +.Xr gcc 1 . +The automatic setting of +.Va CFLAGS +and +.Va COPTFLAGS +may be overridden using the +.Va NO_CPU_CFLAGS +and +.Va NO_CPU_COPTFLAGS +variables, respectively. +Refer to +.Pa /usr/share/examples/etc/make.conf +for a list of recognized +.Va CPUTYPE +options. +.It Va CVS_UPDATE +.Pq Vt bool +Set this to use +.Xr cvs 1 +to update your ports with +.Dq Li "make update" . +.It Va CXXFLAGS +.Pq Vt str +Controls the compiler settings when compiling C++ code. +.Va CXXFLAGS +is initially set to the value of +.Va CFLAGS . +If you want to +add to the +.Va CXXFLAGS +value, use +.Dq Li += +instead of +.Dq Li = . +.It Va DOCSUPFILE +.Pq Vt str +The documentation +.Ar supfile +to use when doing a +.Dq Li "make update" . +This defaults to +.Pa /usr/share/examples/cvsup/doc\-supfile . +.It Va INSTALL +.Pq Vt str +the default install command. +To install only files for which the target differs or does not exist, use +.Bd -literal -offset indent +INSTALL="install -C" +.Ed +Note that some makefiles (including those in +.Pa /usr/share/mk ) +may hardcode options for the supplied install command. +.It Va LOCAL_DIRS +.Pq Vt str +List any directories that should be entered when doing +make's in +.Pa /usr/src +in this variable. +.It Va MAKE_SHELL +.Pq Vt str +Controls the shell used internally by +.Xr make 1 +to process the command scripts in makefiles. +.Xr sh 1 , +.Xr ksh 1 , +and +.Xr csh 1 +all currently supported. +.Pp +.Dl "MAKE_SHELL?=sh" +.It Va MTREE_FOLLOWS_SYMLINKS +.Pq Vt str +Set this to +.Dq Fl L +to cause +.Xr mtree 8 +to follow symlinks. +.It Va NO_CPU_CFLAGS +.Pq Vt str +Setting this variable will prevent CPU specific compiler flags +from being automatically added to +.Va CFLAGS +during compile time. +.It Va NO_CPU_COPTFLAGS +.Pq Vt str +Setting this variable will prevent CPU specific compiler flags +from being automatically added to +.Va COPTFLAGS +during compile time. +.It Va NO_DOCUPDATE +.Pq Vt bool +Set this to not update the doc tree during +.Dq Li "make update" . +.It Va NO_PORTSUPDATE +.Pq Vt bool +Set this to not update the ports tree during +.Dq Li "make update" . +.It Va PORTSSUPFILE +.Pq Vt str +The ports +.Ar supfile +to use when doing a +.Dq Li "make update" . +This defaults to +.Pa /usr/share/examples/cvsup/ports\-supfile . +.It Va SUP +.Pq Vt str +The location of the +.Xr csup 1 +or +.Xr cvsup 1 +command for +.Dq Li "make update" . +.It Va SUPFILE +.Pq Vt str +The first +.Ar supfile +to use when doing a +.Dq Li "make update" . +This defaults to +.Pa /usr/share/examples/cvsup/standard\-supfile . +.It Va SUPFILE1 +.Pq Vt str +The second +.Ar supfile +to use when doing a +.Dq Li "make update" . +This defaults to +.Pa /usr/share/examples/cvsup/secure\-supfile . +.It Va SUPFILE2 +.Pq Vt str +The third +.Ar supfile +to use when doing a +.Dq Li "make update" . +This defaults to +.Pa /usr/share/examples/cvsup/secure\-supfile . +.It Va SUPFLAGS +.Pq Vt str +The flag for the +.Xr sup 1 +command when doing +.Dq Li "make update" . +This defaults to +.Op Fl g L Ar 2 . +.It Va SUPHOST +.Pq Vt str +The hostname of the sup server to use when doing +.Dq Li "make update" . +.It Va SUP_UPDATE +.Pq Vt bool +Set this to use +.Xr cvsup 1 +to update your ports with +.Dq Li "make update" . +.It Va WWWSUPFILE +.Pq Vt str +The www +.Ar supfile +to use when doing a +.Dq Li "make update" +This defaults to +.Pa /usr/share/examples/cvsup/www\-supfile . +.El +.Ss "BUILDING THE KERNEL" +The following list provides a name and short description for variables +that are only used doing a kernel build: +.Bl -tag -width Ar +.It Va BOOTWAIT +.Pq Vt int +Controls the amount of time the kernel waits for a console keypress +before booting the default kernel. +The value is approximately milliseconds. +Keypresses are accepted by the BIOS before booting from disk, +making it possible to give custom boot parameters even when this is +set to 0. +.It Va COPTFLAGS +.Pq Vt str +Controls the compiler settings when building the +kernel. +Optimization levels above +.Oo Fl O ( O2 , No ...\& ) Oc +are not guaranteed to work. +.It Va KERNCONF +.Pq Vt str +Controls which kernel configurations will be +built by +.Dq Li "${MAKE} buildkernel" +and installed by +.Dq Li "${MAKE} installkernel" . +For example, +.Bd -literal -offset indent +KERNCONF=MINE DEBUG GENERIC OTHERMACHINE +.Ed +.Pp +will build the kernels specified by the config files +.Pa MINE , DEBUG , GENERIC , +and +.Pa OTHERMACHINE , +and install the kernel specified by the config file +.Pa MINE . +It defaults to +.Pa GENERIC . +.It Va MODULES_OVERRIDE +.Pq Vt str +Set to a list of modules to build instead of all of them. +.It Va NO_KERNELCLEAN +.Pq Vt bool +Set this to skip running +.Dq Li "${MAKE} clean" +during +.Dq Li "${MAKE} buildkernel" . +.It Va NO_KERNELCONFIG +.Pq Vt bool +Set this to skip running +.Xr config 8 +during +.Dq Li "${MAKE} buildkernel" . +.It Va NO_KERNELDEPEND +.Pq Vt bool +Set this to skip running +.Dq Li "${MAKE} depend" +during +.Dq Li "${MAKE} buildkernel" . +.It Va NO_KERNELOBJ +.Pq Vt bool +Set this to skip running +.Dq Li "${MAKE} obj" +during +.Dq Li "${MAKE} buildkernel" . +.It Va NO_MODULES +.Pq Vt bool +Set to not build modules with the kernel. +.It Va PORTS_MODULES +Set this to the list of ports you wish to rebuild every time the kernel +is built. +.It Va WITHOUT_MODULES +.Pq Vt str +Set to a list of modules to exclude from the build. +This provides a +somewhat easier way to exclude modules you are certain you will never +need than specifying +.Va MODULES_OVERRIDE . +This is applied +.Em after +.Va MODULES_OVERRIDE . +.El +.Ss "BUILDING THE WORLD" +The following list provides a name and short description for variables +that are used during the world build: +.Bl -tag -width Ar +.It Va BOOT_COMCONSOLE_PORT +.Pq Vt str +The port address to use for the console if the boot blocks have +been configured to use a serial console instead of the keyboard/video card. +.It Va BOOT_COMCONSOLE_SPEED +.Pq Vt int +The baud rate to use for the console if the boot blocks have +been configured to use a serial console instead of the keyboard/video card. +.It Va BOOT_PXELDR_ALWAYS_SERIAL +.Pq Vt bool +Compile in the code into +.Xr pxeboot 8 +that forces the use of a serial console. +This is analogous to the +.Fl h +option in +.Xr boot 8 +blocks. +.It Va BOOT_PXELDR_PROBE_KEYBOARD +.Pq Vt bool +Compile in the code into +.Xr pxeboot 8 +that probes the keyboard. +If no keyboard is found, boot with the dual console configuration. +This is analogous to the +.Fl D +option in +.Xr boot 8 +blocks. +.It Va ENABLE_SUID_K5SU +.Pq Vt bool +Set this if you wish to use the ksu utility. +Otherwise, it will be +installed without the set-user-ID bit set. +.It Va ENABLE_SUID_NEWGRP +.Pq Vt bool +Set this to install +.Xr newgrp 1 +with the set-user-ID bit set. +Otherwise, +.Xr newgrp 1 +will not be able to change users' groups. +.It Va ENABLE_SUID_SSH +.Pq Vt bool +Set this to install +.Xr ssh 1 +with the set-user-ID bit turned on. +.It Va LOADER_TFTP_SUPPORT +.Pq Vt bool +By default the +.Xr pxeboot 8 +loader retrieves the kernel via NFS. +Defining this and recompiling +.Pa /usr/src/sys/boot +will cause it to retrieve the kernel via TFTP. +This allows +.Xr pxeboot 8 +to load a custom BOOTP diskless kernel yet +still mount the server's +.Pa / +rather than load the server's kernel. +.It Va LOADER_FIREWIRE_SUPPORT +.Pq Vt bool +Defining this and recompiling +.Pa /usr/src/sys/boot/i386 +will add +.Xr dcons 4 +console driver to +.Xr loader 8 +and allow access over FireWire(IEEE1394) using +.Xr dconschat 8 . +Currently, only i386 and amd64 are supported. +.It Va MALLOC_PRODUCTION +.Pq Vt bool +Set this to disable assertions and statistics gathering in +.Xr malloc 3 . +It also defaults the A and J runtime options to off. +Disabled by default on -CURRENT. +.It Va MODULES_WITH_WORLD +.Pq Vt bool +Set to build modules with the system instead of the kernel. +.It Va NO_CLEAN +.Pq Vt bool +Set this to disable cleaning during +.Dq Li "make buildworld" . +This should not be set unless you know what you are doing. +.It Va NO_CLEANDIR +.Pq Vt bool +Set this to run +.Dq Li "${MAKE} clean" +instead of +.Dq Li "${MAKE} cleandir" . +.It Va NO_MANCOMPRESS +.Pq Vt bool +Set to install manual pages uncompressed. +.It Va NO_SHARE +.Pq Vt bool +Set to not build in the +.Pa share +subdir. +.It Va NO_SHARED +.Pq Vt bool +Set to build +.Pa /bin +and +.Pa /sbin +statically linked, this can be bad. +If set, every utility that uses +.Pa bsd.prog.mk +will be linked statically. +.It Va PPP_NO_NAT +.Pq Vt bool +Build +.Xr ppp 8 +without support for network address translation (NAT). +.It Va PPP_NO_NETGRAPH +.Pq Vt bool +Set to build +.Xr ppp 8 +without support for Netgraph. +.It Va PPP_NO_RADIUS +.Pq Vt bool +Set to build +.Xr ppp 8 +without support for RADIUS. +.It Va PPP_NO_SUID +.Pq Vt bool +Set to disable the installation of +.Xr ppp 8 +as a set-user-ID root program. +.It Va SENDMAIL_ADDITIONAL_MC +.Pq Vt str +Additional +.Pa .mc +files which should be built into +.Pa .cf +files at build time. +The value should include the full path to the +.Pa .mc +file(s), e.g., +.Pa /etc/mail/foo.mc +.Pa /etc/mail/bar.mc . +.It Va SENDMAIL_ALIASES +.Pq Vt str +List of +.Xr aliases 5 +files to rebuild when using +.Pa /etc/mail/Makefile . +The default value is +.Pa /etc/mail/aliases . +.It Va SENDMAIL_CFLAGS +.Pq Vt str +Flags to pass to the compile command when building +.Xr sendmail 8 . +The +.Va SENDMAIL_* +flags can be used to provide SASL support with setting such as: +.Bd -literal -offset indent +SENDMAIL_CFLAGS=-I/usr/local/include -DSASL +SENDMAIL_LDFLAGS=-L/usr/local/lib +SENDMAIL_LDADD=-lsasl +.Ed +.It Va SENDMAIL_CF_DIR +.Pq Vt str +Override the default location for the +.Xr m4 1 +configuration files used to build a +.Pa .cf +file from a +.Pa .mc +file. +.It Va SENDMAIL_DPADD +.Pq Vt str +Extra dependencies to add when building +.Xr sendmail 8 . +.It Va SENDMAIL_LDADD +.Pq Vt str +Flags to add to the end of the +.Xr ld 1 +command when building +.Xr sendmail 8 . +.It Va SENDMAIL_LDFLAGS +.Pq Vt str +Flags to pass to the +.Xr ld 1 +command when building +.Xr sendmail 8 . +.It Va SENDMAIL_M4_FLAGS +.Pq Vt str +Flags passed to +.Xr m4 1 +when building a +.Pa .cf +file from a +.Pa .mc +file. +.It Va SENDMAIL_MAP_PERMS +.Pq Vt str +Mode to use when generating alias and map database files using +.Pa /etc/mail/Makefile . +The default value is 0640. +.It Va SENDMAIL_MAP_SRC +.Pq Vt str +Additional maps to rebuild when using +.Pa /etc/mail/Makefile . +The +.Pa access , +.Pa bitdomain , +.Pa domaintable , +.Pa genericstable , +.Pa mailertable , +.Pa uucpdomain , +and +.Pa virtusertable +maps are always rebuilt if they exist. +.It Va SENDMAIL_MAP_TYPE +.Pq Vt str +Database map type to use when generating map database files using +.Pa /etc/mail/Makefile . +The default value is hash. +The alternative is btree. +.It Va SENDMAIL_MC +.Pq Vt str +The default +.Xr m4 1 +configuration file to use at install time. +The value should include the full path to the +.Pa .mc +file, e.g., +.Pa /etc/mail/myconfig.mc . +Use with caution as a make install will overwrite any existing +.Pa /etc/mail/sendmail.cf . +Note that +.Va SENDMAIL_CF +is now deprecated. +.It Va SENDMAIL_SET_USER_ID +.Pq Vt bool +If set, install +.Xr sendmail 8 +as a set-user-ID root binary instead of a set-group-ID binary +and do not install +.Pa /etc/mail/submit.{cf,mc} . +Use of this flag is not recommended and the alternative advice in +.Pa /etc/mail/README +should be followed instead if at all possible. +.It Va SENDMAIL_START_SCRIPT +.Pq Vt str +The script used by +.Pa /etc/mail/Makefile +to start, stop, and restart +.Xr sendmail 8 . +The default value is +.Pa /etc/rc.sendmail . +This value should match the +.Dq Li mta_start_script +setting in +.Xr rc.conf 5 . +.It Va SENDMAIL_SUBMIT_MC +.Pq Vt str +The default +.Xr m4 1 +configuration file for mail submission +to use at install time. +The value should include the full path to the +.Pa .mc +file, e.g., +.Pa /etc/mail/mysubmit.mc . +Use with caution as a make install will overwrite any existing +.Pa /etc/mail/submit.cf . +.It Va TOP_TABLE_SIZE +.Pq Vt int +.Xr top 1 +uses a hash table for the user names. +The size of this hash can be tuned to match the number of local users. +The table size should be a prime number +approximately twice as large as the number of lines in +.Pa /etc/passwd . +The default number is 20011. +.It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE +.Pq Vt int +Causes the system compiler to be built such that it forces high optimization +levels to a lower one. +.Xr gcc 1 +.Fl O2 +and above is known to trigger known optimizer bugs at various +times. +The value assigned is the highest optimization value used. +.El +.Ss "BUILDING DOCUMENTATION" +The following list provides a name and short description for variables +that are used when building documentation. +.Bl -tag -width ".Va PRINTERDEVICE" +.It Va DISTDIR +.Pq Vt str +Where distfiles are kept. +Normally, this is +.Pa distfiles +in +.Va PORTSDIR . +.It Va DOC_LANG +.Pq Vt str +The list of languages and encodings to build and install. +.It Va PRINTERDEVICE +.Pq Vt str +The default format for system documentation, depends on your +printer. +This can be set to +.Dq Li ascii +for simple printers, or +.Dq Li ps +for postscript or graphics printers with a ghostscript +filter, or both. +.El +.Sh FILES +.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact +.It Pa /etc/make.conf +.It Pa /usr/doc/Makefile +.It Pa /usr/share/examples/etc/make.conf +.It Pa /usr/share/mk/sys.mk +.It Pa /usr/src/Makefile +.It Pa /usr/src/Makefile.inc1 +.El +.Sh SEE ALSO +.Xr gcc 1 , +.Xr install 1 , +.Xr make 1 , +.Xr src.conf 5 , +.Xr environ 7 , +.Xr ports 7 , +.Xr sendmail 8 +.Sh HISTORY +The +.Nm +file appeared sometime before +.Fx 4.0 . +.Sh AUTHORS +This +manual page was written by +.An Mike W. Meyer Aq mwm@mired.org . +.Sh CAVEATS +Note, that +.Ev MAKEOBJDIRPREFIX +and +.Ev MAKEOBJDIR +are environment variables and should not be set in +.Nm +but in make's environment. +.Sh BUGS +This manual page may occasionally be out of date with respect to +the options currently available for use in +.Nm . +Please check the +.Pa /usr/share/examples/etc/make.conf +file for the latest options which are available. diff --git a/share/man/man5/moduli.5 b/share/man/man5/moduli.5 new file mode 100644 index 0000000..32d7989 --- /dev/null +++ b/share/man/man5/moduli.5 @@ -0,0 +1,159 @@ +.\" $OpenBSD: moduli.5,v 1.3 2001/06/24 18:50:52 provos Exp $ +.\" +.\" Copyright 1997, 2000 William Allen Simpson <wsimpson@greendragon.com> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software designed by William Allen Simpson. +.\" 4. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd July 28, 1997 +.Dt MODULI 5 +.Os +.Sh NAME +.Nm moduli +.Nd system moduli file +.Sh DESCRIPTION +The +.Nm +file contains the system-wide Diffie-Hellman prime moduli for the +.Xr photurisd 8 +and +.Xr sshd 8 +programs. +.Pp +Each line in this file contains the following fields: +.Va Time , Type , Tests , Tries , Size , Generator , +and +.Va Modulus . +The fields are separated by white space (tab or blank). +.Bl -tag -width indent +.It Va Time Pq Vt yyyymmddhhmmss +Specifies the system time that the line was appended to the file. +The value 00000000000000 means unknown (historic). +.\"The file is sorted in ascending order. +.It Va Type Pq Vt decimal +Specifies the internal structure of the prime modulus. +.Pp +.Bl -tag -width indent -compact +.It 0 +unknown; +often learned from peer during protocol operation, +and saved for later analysis. +.It 1 +unstructured; +a common large number. +.It 2 +safe (p = 2q + 1); +meets basic structural requirements. +.It 3 +Schnorr. +.It 4 +Sophie-Germaine (q = (p-1)/2); +usually generated in the process of testing safe or strong primes. +.It 5 +strong; +useful for RSA public key generation. +.El +.It Xo +.Va Tests Pq Vt decimal +(bit field) +.Xc +Specifies the methods used in checking for primality. +Usually, more than one test is used. +.Pp +.Bl -tag -width indent -compact +.It 0 +not tested; +often learned from peer during protocol operation, +and saved for later analysis. +.It 1 +composite; +failed one or more tests. +In this case, the highest bit specifies the test that failed. +.It 2 +sieve; +checked for division by a range of smaller primes. +.It 4 +Miller-Rabin. +.It 8 +Jacobi. +.It 16 +Elliptic Curve. +.El +.It Va Tries Pq Vt decimal +Depends on the value of the highest valid Test bit, +where the method specified is: +.Pp +.Bl -tag -width indent -compact +.It 0 +not tested +(always zero). +.It 1 +composite +(irrelevant). +.It 2 +sieve; +number of primes sieved. +Commonly on the order of 32,000,000. +.It 4 +Miller-Rabin; +number of M-R iterations. +Commonly on the order of 32 to 64. +.It 8 +Jacobi; +unknown +(always zero). +.It 16 +Elliptic Curve; +unused +(always zero). +.El +.It Va Size Pq Vt decimal +Specifies the number of significant bits. +.It Va Generator Pq Vt "hex string" +Specifies the best generator for a Diffie-Hellman exchange. +0 = unknown or variable, +2, 3, 5, etc. +.It Va Modulus Pq Vt "hex string" +The prime modulus. +.El +.Pp +The file is searched for moduli that meet the appropriate +.Va Time , Size +and +.Va Generator +criteria. +When more than one meet the criteria, +the selection should be weighted toward newer moduli, +without completely disqualifying older moduli. +.Sh FILES +.Bl -tag -width ".Pa /etc/ssh/moduli" -compact +.It Pa /etc/ssh/moduli +.El +.Sh SEE ALSO +.Xr photurisd 8 , +.Xr sshd 8 diff --git a/share/man/man5/motd.5 b/share/man/man5/motd.5 new file mode 100644 index 0000000..2ffbc9e --- /dev/null +++ b/share/man/man5/motd.5 @@ -0,0 +1,43 @@ +.\" $NetBSD: motd.5,v 1.2 1994/12/28 18:58:53 glass Exp $ +.\" +.\" This file is in the public domain. +.\" $FreeBSD$ +.\" +.Dd February 13, 1997 +.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 or through +.Xr login.conf 5 . +.Sh FILES +.Bl -tag -width $HOME/.hushlogin -compact +.It Pa /etc/motd +The message of the day. +.It Pa $HOME/.hushlogin +Suppresses output of +.Pa /etc/motd . +.El +.Sh EXAMPLES +.Bd -literal +FreeBSD 2.1.6.1-RELEASE (GENERIC) #0: Sun Dec 29 03:08:31 PST 1996 + +/home is full. Please cleanup your directories. +.Ed +.Sh SEE ALSO +.Xr login 1 , +.Xr login.conf 5 diff --git a/share/man/man5/mqueuefs.5 b/share/man/man5/mqueuefs.5 new file mode 100644 index 0000000..d5de933 --- /dev/null +++ b/share/man/man5/mqueuefs.5 @@ -0,0 +1,124 @@ +.\" Copyright (c) 2005 David Xu <davidxu@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(s), this list of conditions and the following disclaimer as +.\" the first lines of this file unmodified other than the possible +.\" addition of one or more copyright notices. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice(s), 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 COPYRIGHT HOLDER(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 COPYRIGHT HOLDER(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. +.\" +.\" $FreeBSD$ +.\" +.Dd November 30, 2005 +.Dt MQUEUEFS 5 +.Os +.Sh NAME +.Nm mqueuefs +.Nd POSIX message queue file system +.Sh SYNOPSIS +To link into kernel: +.Pp +.D1 Cd "options P1003_1B_MQUEUE" +.Pp +To load as a kernel loadable module: +.Pp +.Dl "kldload mqueuefs" +.Sh DESCRIPTION +The +.Nm +module will permit the +.Fx +kernel to support +.Tn POSIX +message queue. +The module contains system calls to manipulate +.Tn POSIX +message queues. +It also contains a file system to implement a view for all message queues of +the system. +This helps users to keep track of their message queues and make +it more easily usable without having to invent additional tools. +.Pp +The most common usage is as follows: +.Pp +.Dl "mount -t mqueuefs null /mnt/mqueue" +.Pp +where +.Pa /mnt/mqueue +is a mount point. +.Pp +It is possible to define an entry in +.Pa /etc/fstab +that looks similar to: +.Bd -literal +null /mnt/mqueue mqueuefs rw 0 0 +.Ed +.Pp +This will mount +.Nm +at the +.Pa /mnt/mqueue +mount point during system boot. +Using +.Pa /mnt/mqueue +as a permanent mount point is not advised as its intention +has always been to be a temporary mount point. +See +.Xr hier 7 +for more information on +.Fx +directory layout. +.Pp +Some common tools can be used on the file system, e.g.: +.Xr cat 1 , +.Xr chmod 1 , +.Xr chown 8 , +.Xr ls 1 , +.Xr rm 1 , +etc. +To use only the message queue system calls, it is not necessary for +user to mount the file system, just load the module or compile it +into the kernel. +Manually creating a file, for example, +.Dq Li "touch /mnt/mqueue/myqueue" , +will create a message queue named +.Pa myqueue +in the kernel, default +message queue attributes will be applied to the queue. +It is not +advised to use this method to create a queue; +it is better to use the +.Xr mq_open 2 +system call to create a queue as it +allows the user to specify different attributes. +.Pp +To see the queue's attributes, just read the file: +.Pp +.Dl "cat /mnt/mqueue/myqueue" +.Sh SEE ALSO +.Xr mq_open 2 , +.Xr nmount 2 , +.Xr unmount 2 , +.Xr mount 8 , +.Xr umount 8 +.Sh AUTHORS +This manual page was written by +.An "David Xu" Aq davidxu@FreeBSD.org . diff --git a/share/man/man5/msdosfs.5 b/share/man/man5/msdosfs.5 new file mode 100644 index 0000000..933577a --- /dev/null +++ b/share/man/man5/msdosfs.5 @@ -0,0 +1,69 @@ +.\" $FreeBSD$ +.\" Written by Tom Rhodes +.\" This file is in the public domain. +.\" +.Dd August 22, 2007 +.Dt MSDOSFS 5 +.Os +.Sh NAME +.Nm msdosfs +.Nd MS-DOS file system +.Sh SYNOPSIS +.Cd "options MSDOSFS" +.Sh DESCRIPTION +The +.Nm +driver will permit the +.Fx +kernel to read and write +.Tn MS-DOS +based file systems. +.Pp +The most common usage follows: +.Pp +.Dl "mount -t msdosfs /dev/ad0sN /mnt" +.Pp +where +.Ar N +is the partition number and +.Pa /mnt +is a mount point. +Some users tend to create a +.Pa /dos +directory for +.Nm +mount points. +This helps to keep better track of the file system, +and make it more easily accessible. +.Pp +It is possible to define an entry in +.Pa /etc/fstab +that looks similar to: +.Bd -literal +/dev/ad0sN /dos msdosfs rw 0 0 +.Ed +.Pp +This will mount an +.Tn MS-DOS +based partition at the +.Pa /dos +mount point during system boot. +Using +.Pa /mnt +as a permanent mount point is not advised as its intention +has always been to be a temporary mount point for floppy and +ZIP disks. +See +.Xr hier 7 +for more information on +.Fx +directory layout. +.Sh SEE ALSO +.Xr mount 2 , +.Xr unmount 2 , +.Xr mount 8 , +.Xr mount_msdosfs 8 , +.Xr umount 8 +.Sh AUTHORS +This manual page was written by +.An Tom Rhodes Aq trhodes@FreeBSD.org . diff --git a/share/man/man5/networks.5 b/share/man/man5/networks.5 new file mode 100644 index 0000000..386ee7d --- /dev/null +++ b/share/man/man5/networks.5 @@ -0,0 +1,89 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd June 5, 1993 +.Dt NETWORKS 5 +.Os +.Sh NAME +.Nm networks +.Nd network name data base +.Sh DESCRIPTION +The +.Nm +file contains information regarding +the known networks which comprise the +.Tn DARPA +Internet. +For each network a single line should be present with the following information: +.Bd -unfilled -offset indent +official network name +network number +aliases +.Ed +.Pp +Items are separated by any number of blanks and/or tab characters. +A ``#'' indicates the beginning of a comment; characters up to the end of +the line are not interpreted by routines which search the file. +This file is normally created from the official network data base +maintained at the Network Information Control Center +.Pq Tn NIC , +though local +changes may be required to bring it up to date regarding unofficial aliases +and/or unknown networks. +.Pp +Network numbers may be specified in the conventional +``.'' (dot) notation using the +.Xr inet_network 3 +routine +from the Internet address manipulation library, +.Xr inet 3 . +Network names may contain any printable character other than a field +delimiter, newline, or comment character. +.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 +.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/share/man/man5/nsmb.conf.5 b/share/man/man5/nsmb.conf.5 new file mode 100644 index 0000000..1c439be --- /dev/null +++ b/share/man/man5/nsmb.conf.5 @@ -0,0 +1,142 @@ +.\" Copyright (c) 2003 +.\" Originally written by Sergey A. Osokin +.\" Rewritten by Tom Rhodes +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd June 30, 2003 +.Dt NSMB.CONF 5 +.Os +.Sh NAME +.Nm nsmb.conf +.Nd configuration file for +.Tn SMB +requests +.Sh DESCRIPTION +The +.Nm +file contains information about the computers, users, and shares +or mount points for the +.Tn SMB +network protocol. +.Pp +The configuration hierarchy is made up of several sections, +each section containing a few or several lines of parameters +and their assigned values. +Each of these sections must begin with a section name enclosed within +square brackets, similar to: +.Pp +.D1 Bq Ar section_name +.Pp +The end of each section is marked by either the start of a new section, +or by the abrupt ending of the file, commonly referred to as the +.Tn EOF . +Each section may contain zero or more parameters such as: +.Pp +.D1 Bq Ar section_name +.D1 Ar key Ns = Ns Ar value +.Pp +where +.Ar key +represents a parameter name, and +.Ar value +would be the parameter's assigned value. +.Pp +The +.Tn SMB +library uses the following information for section names: +.Pp +.Bl -tag -width indent -compact +.It Ic A) +.Bq Li default +.It Ic B) +.Bq Ar SERVER +.It Ic C) +.Bq Ar SERVER : Ns Ar USER +.It Ic D) +.Op Ar SERVER : Ns Ar USER : Ns Ar SHARE +.El +.Pp +Possible keywords may include: +.Bl -column ".Va retry_count" ".Sy Section" +.It Sy "Keyword Section Comment" +.It Sy " A B C D" +.It Va addr Ta "- + - -" Ta "IP or IPX address of SMB server" +.It Va charsets Ta "- + + +" Ta "local:remote charset pair" +.It Va nbns Ta "+ + - -" Ta "address of NetBIOS name server (WINS)" +.It Va nbscope Ta "+ + - -" Ta "NetBIOS scope" +.It Va nbtimeout Ta "+ + - -" Ta "timeout for NetBIOS name servers" +.It Va password Ta "- - + +" Ta "plain text password used to access the given share" +.It Va retry_count Ta "+ + - -" Ta "number of retries before connection is marked as broken" +.It Va timeout Ta "+ + - -" Ta "SMB request timeout" +.It Va workgroup Ta "+ + + +" Ta "workgroup name" +.El +.Sh FILES +.Bl -tag -width ".Pa /etc/nsmb.conf" +.It Pa /etc/nsmb.conf +The default remote mount-point configuration file. +.El +.Sh EXAMPLES +What follows is a sample configuration file which may, +or may not match your environment: +.Bd -literal -offset indent +# Configuration file for example.com +[default] +workgroup=SALES +# The 'FSERVER' is an NT server. +[FSERVER] +charsets=koi8-r:cp866 +addr=fserv.example.com +.Ed +.Pp +All lines which begin with the +.Ql # +character are comments and will not be parsed. +The +.Dq Li default +section describes the default workgroup or domain, in this case +.Dq Li SALES . +The next section depicted here as +.Dq Li FSERVER , +defines a server section and then assigns it a charset which is only +required when Cyrillic characters are not used. +The hostname value, +.Dq Li fserv.example.com , +is also assigned in this section. +.Sh COMPATIBILITY +At the time of this writing, the +.Tn IPX +protocol remains unsupported. +Future +.Fx +releases are expected to support this. +.Sh SEE ALSO +.Xr smbutil 1 , +.Xr mount_smbfs 8 +.Sh AUTHORS +This manual page was written by +.An -nosplit +.An Sergey Osokin Aq osa@FreeBSD.org +and +.An Tom Rhodes Aq trhodes@FreeBSD.org . diff --git a/share/man/man5/nsswitch.conf.5 b/share/man/man5/nsswitch.conf.5 new file mode 100644 index 0000000..c28720b --- /dev/null +++ b/share/man/man5/nsswitch.conf.5 @@ -0,0 +1,386 @@ +.\" $NetBSD: nsswitch.conf.5,v 1.14 1999/03/17 20:19:47 garbled 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. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by Luke Mewburn. +.\" 4. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS +.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR +.\" TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE +.\" USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd April 4, 2010 +.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, etc. +Each database comes from a source (such as local files, DNS, +.Tn NIS , +and cache), and the order to look up the sources is specified in +.Nm . +.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: +.Pp +.Bl -tag -width Source -compact +.It Sy Source +.Sy Description +.It files +Local files, such as +.Pa /etc/hosts , +and +.Pa /etc/passwd . +.It db +Local database. +.It dns +Internet Domain Name System. +.Dq hosts +and +.Sq networks +use +.Sy IN +class entries, all other databases use +.Sy HS +class (Hesiod) entries. +.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. +.It cache +makes use of the +.Xr nscd 8 +daemon. +.El +.Ss Databases +The following databases are used by the following C library functions: +.Pp +.Bl -tag -width networks -compact +.It Sy Database +.Sy "Used by" +.It group +.Xr getgrent 3 , +.Xr getgrent_r 3 , +.Xr getgrgid_r 3 , +.Xr getgrnam_r 3 , +.Xr setgrent 3 , +.Xr endgrent 3 +.It hosts +.Xr getaddrinfo 3 , +.Xr gethostbyaddr 3 , +.Xr gethostbyaddr_r 3 , +.Xr gethostbyname 3 , +.Xr gethostbyname2 3 , +.Xr gethostbyname_r 3 , +.Xr getipnodebyaddr 3 , +.Xr getipnodebyname 3 +.It networks +.Xr getnetbyaddr 3 , +.Xr getnetbyaddr_r 3 , +.Xr getnetbyname 3 , +.Xr getnetbyname_r 3 +.It passwd +.Xr getpwent 3 , +.Xr getpwent_r 3 , +.Xr getpwnam_r 3 , +.Xr getpwuid_r 3 , +.Xr setpwent 3 , +.Xr endpwent 3 +.It shells +.Xr getusershell 3 +.It services +.Xr getservent 3 +.It rpc +.Xr getrpcbyname 3 , +.Xr getrpcbynumber 3 , +.Xr getrpcent 3 +.It proto +.Xr getprotobyname 3 , +.Xr getprotobynumber 3 , +.Xr getprotoent 3 +.It netgroup +.Xr getnetgrent 3 , +.Xr setnetgrent 3 , +.Xr innetgr 3 +.El +.Ss Status codes +The following status codes are available: +.Pp +.Bl -tag -width tryagain -compact +.It Sy Status +.Sy 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: +.Pp +.Bl -tag -width continue -compact +.It Sy Action +.Sy 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: +.Pp +.Bl -tag -width <criterion> -compact +.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 Cache +You can enable caching for the particular database by specifying +.Dq cache +as the first source in the +.Xr nsswitch.conf 5 +file. +You should also enable caching for this database in +.Xr nscd.conf 5 . +If for the particular query +.Dq cache +source returns success, no further sources are queried. +On the other hand, if there are no previously cached data, the +query result will be placed into the cache right after +all other sources are processed. +Note, that +.Dq cache +requires +.Xr nscd 8 +daemon to be running. +.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 do not 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 +does not 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: +.Pp +.Bl -tag -width services_compat -compact +.It Sy Database +.Sy "Default source list" +.It group +compat +.It group_compat +nis +.It hosts +files dns +.It passwd +compat +.It passwd_compat +nis +.It services +compat +.It services_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 cache, then in +.Pa /etc/hosts +and then from the DNS, and lookup user information from +.Tn NIS +then files, use: +.Pp +.Bl -tag -width passwd: -compact +.It hosts: +cache 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, do not try files." +This treats nis as the authoritative source of information, except +when the server is down. +.Sh NOTES +If system got compiled with +.Va WITHOUT_NIS +you have to remove +.Sq nis +entries. +.Pp +.Fx Ns 's +.Lb libc +provides stubs for compatibility with NSS modules +written for the +.Tn GNU +C Library +.Nm nsswitch +interface. +However, these stubs only support the use of the +.Dq Li passwd +and +.Dq Li group +databases. +.Sh SEE ALSO +.Xr nsdispatch 3 , +.Xr nscd.conf 5 , +.Xr resolv.conf 5 , +.Xr nscd 8 , +.Xr named 8 , +.Xr ypbind 8 +.Sh HISTORY +The +.Nm +file format first appeared in +.Fx 5.0 . +It was imported from the +.Nx +Project, where it appeared first in +.Nx 1.4 . +.Sh AUTHORS +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/share/man/man5/nullfs.5 b/share/man/man5/nullfs.5 new file mode 100644 index 0000000..653711b --- /dev/null +++ b/share/man/man5/nullfs.5 @@ -0,0 +1,75 @@ +.\" +.\" Copyright (c) 2008 Daniel Gerzo +.\" 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 DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd October 5, 2008 +.Dt NULLFS 5 +.Os +.Sh NAME +.Nm nullfs +.Nd "null file system" +.Sh SYNOPSIS +To enable support for +.Nm , +place the following line in the kernel configuration file: +.Bd -ragged -offset indent +.Cd "options NULLFS" +.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 +nullfs_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver will permit the +.Fx +kernel to mount a loopback file system sub-tree. +.Sh EXAMPLES +To mount a +.Nm +file system: +.Pp +.Dl "mount_nullfs /usr/ports /home/devel/ports" +.Sh SEE ALSO +.Xr fstab 5 , +.Xr mount_nullfs 8 +.Sh HISTORY +The +.Nm +layer first appeared in +.Bx 4.4 . +.Sh AUTHORS +.An -nosplit +The +.Nm +kernel implementation was written by +.An John Heideman . +.Pp +This manual page was written by +.An Daniel Gerzo Aq danger@FreeBSD.org . diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5 new file mode 100644 index 0000000..2acef53 --- /dev/null +++ b/share/man/man5/passwd.5 @@ -0,0 +1,452 @@ +.\" $NetBSD: passwd.5,v 1.12.2.2 1999/12/17 23:14:50 he Exp $ +.\" +.\" Copyright (c) 1988, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" 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. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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: @(#)passwd.5 8.1 (Berkeley) 6/5/93 +.\" $FreeBSD$ +.\" +.Dd May 8, 2007 +.Dt PASSWD 5 +.Os +.Sh NAME +.Nm passwd , +.Nm master.passwd +.Nd format of the password file +.Sh DESCRIPTION +The +.Nm +files are the local source of password information. +They can be used in conjunction with the Hesiod domains +.Sq Li passwd +and +.Sq Li uid , +and the +.Tn NIS +maps +.Sq Li passwd.byname , +.Sq Li passwd.byuid , +.Sq Li master.passwd.byname , +and +.Sq Li master.passwd.byuid , +as controlled by +.Xr nsswitch.conf 5 . +.Pp +For consistency, none of these files should ever be modified +manually. +.Pp +The +.Nm master.passwd +file is readable only by root, and consists of newline separated +records, one per user, containing ten colon +.Pq Ql \&: +separated +fields. +These fields are as follows: +.Pp +.Bl -tag -width ".Ar password" -offset indent +.It Ar name +User's login name. +.It Ar password +User's +.Em encrypted +password. +.It Ar uid +User's id. +.It Ar gid +User's login group id. +.It Ar class +User's login class. +.It Ar change +Password change time. +.It Ar expire +Account expiration time. +.It Ar gecos +General information about the user. +.It Ar home_dir +User's home directory. +.It Ar shell +User's login shell. +.El +.Pp +The +.Nm +file is generated from the +.Nm master.passwd +file by +.Xr pwd_mkdb 8 , +has the +.Ar class , +.Ar change , +and +.Ar expire +fields removed, and the +.Ar password +field replaced by a +.Ql * +character. +.Pp +The +.Ar name +field is the login used to access the computer account, and the +.Ar 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 Ql - ; +also, it is strongly +suggested that neither upper-case characters or dots +.Pq Ql \&. +be part +of the name, as this tends to confuse mailers. +No field may contain a +colon +.Pq Ql \&: +as this has been used historically to separate the fields +in the user database. +.Pp +In the +.Nm master.passwd +file, +the +.Ar password +field is the +.Em encrypted +form of the password, see +.Xr crypt 3 . +If the +.Ar password +field is empty, no password will be required to gain access to the +machine. +This is almost invariably a mistake, so authentication components +such as PAM can forcibly disallow remote access to passwordless accounts. +Because this file contains the encrypted user passwords, it should +not be readable by anyone without appropriate privileges. +.Pp +A password of +.Ql * +indicates that +password authentication is disabled for that account +(logins through other forms of +authentication, e.g., using +.Xr ssh 1 +keys, will still work). +The field only contains encrypted passwords, and +.Ql * +can never be the result of encrypting a password. +.Pp +An encrypted password prefixed by +.Ql *LOCKED* +means that the account is temporarily locked out +and no one can log into it using any authentication. +For a convenient command-line interface to account locking, see +.Xr pw 8 . +.Pp +The +.Ar group +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 +.Ar class +field is a key for a user's login class. +Login classes +are defined in +.Xr login.conf 5 , +which is a +.Xr termcap 5 +style database of user attributes, accounting, resource, +and environment settings. +.Pp +The +.Ar 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. +.Pp +The +.Ar 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 +The +.Ar gecos +field normally contains comma +.Pq Ql \&, +separated subfields as follows: +.Pp +.Bl -tag -width ".Ar office" -offset indent -compact +.It Ar name +user's full name +.It Ar office +user's office number +.It Ar wphone +user's work phone number +.It Ar hphone +user's home phone number +.El +.Pp +The full +.Ar name +may contain a ampersand +.Pq Ql & +which will be replaced by +the capitalized login +.Ar name +when the +.Ar gecos +field is displayed or used +by various programs such as +.Xr finger 1 , +.Xr sendmail 8 , +etc. +.Pp +The +.Ar office +and phone number subfields are used by the +.Xr finger 1 +program, and possibly other applications. +.Pp +The user's home directory, +.Ar home_dir , +is the full +.Ux +path name where the user +will be placed on login. +.Pp +The +.Ar shell +field is the command interpreter the user prefers. +If there is nothing in the +.Ar shell +field, the Bourne shell +.Pq Pa /bin/sh +is assumed. +The conventional way to disable logging into an account once and for all, +as it is done for system accounts, +is to set its +.Ar shell +to +.Xr nologin 8 . +.Sh HESIOD SUPPORT +If +.Sq Li dns +is specified for the +.Sq Li passwd +database in +.Xr nsswitch.conf 5 , +then +.Nm +lookups occur from the +.Sq Li passwd +Hesiod domain. +.Sh NIS SUPPORT +If +.Sq Li nis +is specified for the +.Sq Li passwd +database in +.Xr nsswitch.conf 5 , +then +.Nm +lookups occur from the +.Sq Li passwd.byname , +.Sq Li passwd.byuid , +.Sq Li master.passwd.byname , +and +.Sq Li master.passwd.byuid +.Tn NIS +maps. +.Sh COMPAT SUPPORT +If +.Sq Li compat +is specified for the +.Sq Li passwd +database, and either +.Sq Li dns +or +.Sq Li nis +is specified for the +.Sq Li passwd_compat +database in +.Xr nsswitch.conf 5 , +then the +.Nm +file also supports standard +.Sq Li + Ns / Ns Li - +exclusions and inclusions, based on user names and netgroups. +.Pp +Lines beginning with a +.Ql - +(minus sign) are entries marked as being excluded +from any following inclusions, which are marked with a +.Ql + +(plus sign). +.Pp +If the second character of the line is a +.Ql @ +(at sign), the operation +involves the user fields of all entries in the netgroup specified by the +remaining characters of the +.Ar name +field. +Otherwise, the remainder of the +.Ar name +field is assumed to be a specific user name. +.Pp +The +.Ql + +token may also be alone in the +.Ar name +field, which causes all users from either the Hesiod domain +.Nm +(with +.Sq Li passwd_compat: dns ) +or +.Sq Li passwd.byname +and +.Sq Li passwd.byuid +.Tn NIS +maps (with +.Sq Li passwd_compat: nis ) +to be included. +.Pp +If the entry contains non-empty +.Ar uid +or +.Ar gid +fields, the specified numbers will override the information retrieved +from the Hesiod domain or the +.Tn NIS +maps. +As well, if the +.Ar gecos , +.Ar dir +or +.Ar shell +entries contain text, it will override the information included via +Hesiod or +.Tn NIS . +On some systems, the +.Ar passwd +field may also be overridden. +.Sh FILES +.Bl -tag -width ".Pa /etc/master.passwd" -compact +.It Pa /etc/passwd +.Tn ASCII +password file, with passwords removed +.It Pa /etc/pwd.db +.Xr db 3 Ns -format +password database, with passwords removed +.It Pa /etc/master.passwd +.Tn ASCII +password file, with passwords intact +.It Pa /etc/spwd.db +.Xr db 3 Ns -format +password database, with passwords intact +.El +.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 +.Ar class , +.Ar change +and +.Ar expire +are added, but are turned off by default. +Class is currently not implemented, but change and expire are; 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 passwd 1 , +.Xr crypt 3 , +.Xr getpwent 3 , +.Xr login.conf 5 , +.Xr netgroup 5 , +.Xr nsswitch.conf 5 , +.Xr adduser 8 , +.Xr nologin 8 , +.Xr pw 8 , +.Xr pwd_mkdb 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 v6 . +.Pp +The +.Tn NIS +.Nm +file format first appeared in SunOS. +.Pp +The Hesiod support first appeared in +.Fx 4.1 . +It was imported from the +.Nx +Project, where it first appeared in +.Nx 1.4 . +.Sh BUGS +User information should (and eventually will) be stored elsewhere. +.Pp +Placing +.Sq Li compat +exclusions in the file after any inclusions will have +unexpected results. diff --git a/share/man/man5/pbm.5 b/share/man/man5/pbm.5 new file mode 100644 index 0000000..55d2c5c --- /dev/null +++ b/share/man/man5/pbm.5 @@ -0,0 +1,88 @@ +.\" +.\" $FreeBSD$ +.\" +.Dd September 27, 1991 +.Dt PBM 5 +.Os +.Sh NAME +.Nm pbm +.Nd portable bitmap file format +.Sh DESCRIPTION +The portable bitmap format is a lowest common denominator monochrome +file format. +It was originally designed to make it reasonable to mail bitmaps +between different types of machines using the typical stupid network +mailers we have today. +Now it serves as the common language of a large family of bitmap +conversion filters. +The definition is as follows: +.Pp +.Bl -bullet -compact +.It +A "magic number" for identifying the file type. +A pbm file's magic number is the two characters "P1". +.It +Whitespace (blanks, TABs, CRs, LFs). +.It +A width, formatted as ASCII characters in decimal. +.It +Whitespace. +.It +A height, again in ASCII decimal. +.It +Whitespace. +.It +Width * height bits, each either '1' or '0', starting at the top-left +corner of the bitmap, proceeding in normal English reading order. +.It +The character '1' means black, '0' means white. +.It +Whitespace in the bits section is ignored. +.It +Characters from a "#" to the next end-of-line are ignored (comments). +.It +No line should be longer than 70 characters. +.El +.Pp +Here is an example of a small bitmap in this format: +.Bd -literal +P1 +# feep.pbm +24 7 +0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 +0 1 1 1 1 0 0 1 1 1 1 0 0 1 1 1 1 0 0 1 1 1 1 0 +0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 1 0 +0 1 1 1 0 0 0 1 1 1 0 0 0 1 1 1 0 0 0 1 1 1 1 0 +0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 +0 1 0 0 0 0 0 1 1 1 1 0 0 1 1 1 1 0 0 1 0 0 0 0 +0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 +.Ed +.Pp +Programs that read this format should be as lenient as possible, +accepting anything that looks remotely like a bitmap. +.Pp +There is also a variant on the format, available +by setting the RAWBITS option at compile time. +This variant is +different in the following ways: +.Pp +.Bl -bullet -compact +.It +The "magic number" is "P4" instead of "P1". +.It +The bits are stored eight per byte, high bit first low bit last. +.It +No whitespace is allowed in the bits section, and only a single character +of whitespace (typically a newline) is allowed after the height. +.It +The files are eight times smaller and many times faster to read and write. +.El +.Sh AUTHORS +Copyright (C) 1989, 1991 by +.An Jef Poskanzer . +.\" 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. This software is provided "as is" without express or +.\" implied warranty. diff --git a/share/man/man5/periodic.conf.5 b/share/man/man5/periodic.conf.5 new file mode 100644 index 0000000..7947a59 --- /dev/null +++ b/share/man/man5/periodic.conf.5 @@ -0,0 +1,796 @@ +.\"- +.\" Copyright (c) 2000 Brian Somers <brian@Awfulhak.org> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd June 15, 2010 +.Dt PERIODIC.CONF 5 +.Os +.Sh NAME +.Nm periodic.conf +.Nd periodic job configuration information +.Sh DESCRIPTION +The file +.Nm +contains a description of how daily, weekly and monthly system maintenance +jobs should run. +It resides in the +.Pa /etc/defaults +directory and parts may be overridden by a file of the same name in +.Pa /etc , +which itself may be overridden by the +.Pa /etc/periodic.conf.local +file. +.Pp +The +.Nm +file +is actually sourced as a shell script from each of the periodic scripts +and is intended to simply provide default configuration variables. +.Pp +The following variables are used by +.Xr periodic 8 +itself: +.Bl -tag -offset 4n -width 2n +.It Va local_periodic +.Pq Vt str +List of directories to search for periodic scripts. +This list is always prefixed with +.Pa /etc/periodic , +and is only used when an argument to +.Xr periodic 8 +is not an absolute directory name. +.It Ao Ar dir Ac Ns Va _output +.Pq Vt path No or Vt list +What to do with the output of the scripts executed from +the directory +.Ar dir . +If this variable is set to an absolute path name, output is logged to +that file, otherwise it is taken as one or more space separated email +addresses and mailed to those users. +If this variable is not set or is empty, output is sent to standard output. +.Pp +For an unattended machine, suitable values for +.Va daily_output , +.Va weekly_output , +and +.Va monthly_output +might be +.Dq Li /var/log/daily.log , +.Dq Li /var/log/weekly.log , +and +.Dq Li /var/log/monthly.log +respectively, as +.Xr newsyslog 8 +will rotate these files (if they exists) at the appropriate times. +.It Ao Ar dir Ac Ns Va _show_success +.It Ao Ar dir Ac Ns Va _show_info +.It Ao Ar dir Ac Ns Va _show_badconfig +.Pq Vt bool +These variables control whether +.Xr periodic 8 +will mask the output of the executed scripts based on their return code +(where +.Ar dir +is the base directory name in which each script resides). +If the return code of a script is +.Sq 0 +and +.Ao Ar dir Ac Ns Va _show_success +is set to +.Dq Li NO , +.Xr periodic 8 +will mask the script's output. +If the return code of a script is +.Sq 1 +and +.Ao Ar dir Ac Ns Va _show_info +is set to +.Dq Li NO , +.Xr periodic 8 +will mask the script's output. +If the return code of a script is +.Sq 2 +and +.Ao Ar dir Ac Ns Va _show_badconfig +is set to +.Dq Li NO , +.Xr periodic 8 +will mask the script's output. +If these variables are set to neither +.Dq Li YES +nor +.Dq Li NO , +they default to +.Dq Li YES , +.Dq Li YES +and +.Dq Li NO +respectively. +.Pp +Refer to the +.Xr periodic 8 +manual page for how script return codes are interpreted. +.El +.Pp +The following variables are used by the standard scripts that reside in +.Pa /etc/periodic/daily : +.Bl -tag -offset 4n -width 2n +.It Va daily_clean_disks_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to remove all files matching +.Va daily_clean_disks_files +daily. +.It Va daily_clean_disks_files +.Pq Vt str +Set to a list of file names to match. +Wild cards are permitted. +.It Va daily_clean_disks_days +.Pq Vt num +When +.Va daily_clean_disks_enable +is set to +.Dq Li YES , +this must also be set to the number of days old that a file's access +and modification times must be before it is deleted. +.It Va daily_clean_disks_verbose +.Pq Vt bool +Set to +.Dq Li YES +if you want the removed files to be reported in your daily output. +.It Va daily_clean_tmps_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to clear temporary directories daily. +.It Va daily_clean_tmps_dirs +.Pq Vt str +Set to the list of directories to clear if +.Va daily_clean_tmps_enable +is set to +.Dq Li YES . +.It Va daily_clean_tmps_days +.Pq Vt num +When +.Va daily_clean_tmps_enable +is set, this must also be set to the number of days old that a file's access +and modification times must be before it is deleted. +.It Va daily_clean_tmps_ignore +.Pq Vt str +Set to the list of files that should not be deleted when +.Va daily_clean_tmps_enable +is set to +.Dq Li YES . +Wild card characters are permitted. +.It Va daily_clean_tmps_verbose +.Pq Vt bool +Set to +.Dq Li YES +if you want the removed files to be reported in your daily output. +.It Va daily_clean_preserve_enable +.Pq Vt bool +Set to +.Dq Li YES +if you wish to remove old files from +.Pa /var/preserve . +.It Va daily_clean_preserve_days +.Pq Vt num +Set to the number of days that files must not have been modified before +they are deleted. +.It Va daily_clean_preserve_verbose +.Pq Vt bool +Set to +.Dq Li YES +if you want the removed files to be reported in your daily output. +.It Va daily_clean_msgs_enable +.Pq Vt bool +Set to +.Dq Li YES +if you wish old system messages to be purged. +.It Va daily_clean_msgs_days +.Pq Vt num +Set to the number of days that files must not have been modified before +they are deleted. +If this variable is left blank, the +.Xr msgs 1 +default is used. +.It Va daily_clean_rwho_enable +.Pq Vt bool +Set to +.Dq Li YES +if you wish old files in +.Pa /var/who +to be purged. +.It Va daily_clean_rwho_days +.Pq Vt num +Set to the number of days that files must not have been modified before +they are deleted. +.It Va daily_clean_rwho_verbose +.Pq Vt bool +Set to +.Dq Li YES +if you want the removed files to be reported in your daily output. +.It Va daily_clean_hoststat_enable +.Pq Vt bool +Set to +.Dq Li YES +to run +.Nm sendmail Fl bH +to automatically purge stale entries from +.Xr sendmail 8 Ns 's +host status cache. +Files will be deleted using the same criteria as +.Xr sendmail 8 +would normally use when determining whether to believe the cached information, +as configured in +.Pa /etc/mail/sendmail.cf . +.It Va daily_backup_passwd_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want the +.Pa /etc/master.passwd +and +.Pa /etc/group +files backed up and reported on. +Reporting consists of checking both files for modifications and running +.Xr chkgrp 8 +on the +.Pa group +file. +.It Va daily_backup_aliases_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want the +.Pa /etc/mail/aliases +file backed up and modifications to be displayed in your daily output. +.It Va daily_calendar_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Nm calendar Fl a +daily. +.It Va daily_accounting_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to rotate your daily accounting files. +No rotations are necessary unless +.Va accounting_enable +is enabled in +.Xr rc.conf 5 . +.It Va daily_accounting_compress +.Pq Vt bool +Set to +.Dq Li YES +if you want your daily accounting files to be compressed using +.Xr gzip 1 . +.It Va daily_accounting_save +.Pq Vt num +When +.Va daily_accounting_enable +is set, this may also be set to the number of daily accounting files that are +to be saved. +The default is +.Dq Li 3 . +.It Va daily_accounting_flags +.Pq Vt str +Set to the arguments to pass to the +.Xr sa 8 +utility (in addition to +.Fl s ) +when +.Va daily_accounting_enable +is set to +.Dq Li YES . +The default is +.Fl q . +.It Va daily_news_expire_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Pa /etc/news.expire . +.It Va daily_status_disks_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Xr df 1 +(with the arguments supplied in +.Va daily_status_disks_df_flags ) +and +.Nm dump Fl W . +.It Va daily_status_disks_df_flags +.Pq Vt str +Set to the arguments for the +.Xr df 1 +utility when +.Va daily_status_disks_enable +is set to +.Dq Li YES . +.It Va daily_status_ata_raid_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Nm atacontrol Cm status +on your +.Xr ataraid 4 +arrays. +.It Va daily_status_gmirror_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Nm gmirror Cm status +on your +.Xr gmirror 8 +devices. +.It Va daily_status_graid3_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Nm graid3 Cm status +on your +.Xr graid3 8 +devices. +.It Va daily_status_gstripe_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Nm gstripe Cm status +on your +.Xr gstripe 8 +devices. +.It Va daily_status_gconcat_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Nm gconcat Cm status +on your +.Xr gconcat 8 +devices. +.It Va daily_status_network_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Nm netstat Fl i . +.It Va daily_status_network_usedns +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Xr netstat 1 +without the +.Fl n +option (to do DNS lookups). +.It Va daily_status_rwho_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Xr uptime 1 +(or +.Xr ruptime 1 +if +.Va rwhod_enable +is set to +.Dq Li YES +in +.Pa /etc/rc.conf ) . +.It Va daily_status_mailq_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Xr mailq 1 . +.It Va daily_status_mailq_shorten +.Pq Vt bool +Set to +.Dq Li YES +if you want to shorten the +.Xr mailq 1 +output when +.Va daily_status_mailq_enable +is set to +.Dq Li YES . +.It Va daily_status_include_submit_mailq +.Pq Vt bool +Set to +.Dq Li YES +if you also want to run +.Xr mailq 1 +on the submit mail queue when +.Va daily_status_mailq_enable +is set to +.Dq Li YES . +This may not work with MTAs other than +.Xr sendmail 8 . +.It Va daily_status_security_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run the security check. +The security check is another set of +.Xr periodic 8 +scripts. +The system defaults are in +.Pa /etc/periodic/security . +Local scripts should be placed in +.Pa /usr/local/etc/periodic/security . +See the +.Xr periodic 8 +manual page for more information. +.It Va daily_status_security_inline +.Pq Vt bool +Set to +.Dq Li YES +if you want the security check output inline. +The default is to either mail or log the output according to the value of +.Va daily_status_security_output . +.It Va daily_status_security_output +.Pq Vt str +Where to send the output of the security check if +.Va daily_status_security_inline +is set to +.Dq Li NO . +This variable behaves in the same way as the +.Va *_output +variables above, namely it can be set either to one or more email addresses +or to an absolute file name. +.It Va daily_status_security_diff_flags +.Pq Vt str +Set to the arguments to pass to the +.Xr diff 1 +utility when generating differences. +The default is +.Fl b u . +.It Va daily_status_security_chksetuid_enable +.Pq Vt bool +Set to +.Dq Li YES +to compare the modes and modification times of setuid executables with +the previous day's values. +.It Va daily_status_security_chkmounts_enable +.Pq Vt bool +Set to +.Dq Li YES +to check for changes mounted file systems to the previous day's values. +.It Va daily_status_security_noamd +.Pq Vt bool +Set to +.Dq Li YES +if you want to ignore +.Xr amd 8 +mounts when comparing against yesterday's file system mounts in the +.Va daily_status_security_chkmounts_enable +check. +.It Va daily_status_security_chkuid0_enable +.Pq Vt bool +Set to +.Dq Li YES +to check +.Pa /etc/master.passwd +for accounts with UID 0. +.It Va daily_status_security_passwdless_enable +.Pq Vt bool +Set to +.Dq Li YES +to check +.Pa /etc/master.passwd +for accounts with empty passwords. +.It Va daily_status_security_logincheck_enable +.Pq Vt bool +Set to +.Dq Li YES +to check +.Pa /etc/login.conf +ownership, see +.Xr login.conf 5 +for more information. +.It Va daily_status_security_ipfwdenied_enable +.Pq Vt bool +Set to +.Dq Li YES +to show log entries for packets denied by +.Xr ipfw 8 +since yesterday's check. +.It Va daily_status_security_ipfdenied_enable +.Pq Vt bool +Set to +.Dq Li YES +to show log entries for packets denied by +.Xr ipf 8 +since yesterday's check. +.It Va daily_status_security_pfdenied_enable +.Pq Vt bool +Set to +.Dq Li YES +to show log entries for packets denied by +.Xr pf 4 +since yesterday's check. +.It Va daily_status_security_ipfwlimit_enable +.Pq Vt bool +Set to +.Dq Li YES +to display +.Xr ipfw 8 +rules that have reached their verbosity limit. +.It Va daily_status_security_kernelmsg_enable +.Pq Vt bool +Set to +.Dq Li YES +to show new +.Xr dmesg 8 +entries since yesterday's check. +.It Va daily_status_security_loginfail_enable +.Pq Vt bool +Set to +.Dq Li YES +to display failed logins from +.Pa /var/log/messages +in the previous day. +.It Va daily_status_security_tcpwrap_enable +.Pq Vt bool +Set to +.Dq Li YES +to display connections denied by tcpwrappers (see +.Xr hosts_access 5 ) +from +.Pa /var/log/messages +during the previous day. +.It Va daily_status_mail_rejects_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to summarise mail rejections logged to +.Pa /var/log/maillog +for the previous day. +.It Va daily_status_mail_rejects_logs +.Pq Vt num +Set to the number of maillog files that should be checked +for yesterday's mail rejects. +.It Va daily_status_named_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to summarise denied zone transfers (AXFR and IXFR) +for the previous day. +.It Va daily_status_named_usedns +.Pq Vt bool +Set to +.Dq Li YES +if you want to enable reverse DNS lookups. +.It Va daily_status_ntpd +.Pq Vt bool +Set to +.Dq Li YES +if you want to enable NTP status check. +.It Va daily_queuerun_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to manually run the mail queue at least once a day. +.It Va daily_submit_queuerun +.Pq Vt bool +Set to +.Dq Li YES +if you also want to manually run the submit mail queue at least once a day +when +.Va daily_queuerun_enable +is set to +.Dq Li YES . +.It Va daily_scrub_zfs_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run a zfs scrub periodically. +.It Va daily_scrub_zfs_pools +.Pq Vt str +A space separated list of names of zfs pools to scrub. +If the list is empty or not set, all zfs pools are scrubbed. +.It Va daily_scrub_zfs_default_threshold +.Pq Vt int +Number of days between a scrub if no pool-specific threshold is set. +The default value if no value is set is 30. +.It Va daily_scrub_zfs_ Ns Ao Ar poolname Ac Ns Va _threshold +.Pq Vt int +The same as +.Va daily_scrub_zfs_default_threshold +but specific to the pool +.Va Ns Ao Ar poolname Ac Ns . +.It Va daily_local +.Pq Vt str +Set to a list of extra scripts that should be run after all other +daily scripts. +All scripts must be absolute path names. +.El +.Pp +The following variables are used by the standard scripts that reside in +.Pa /etc/periodic/weekly : +.Bl -tag -offset 4n -width 2n +.It Va weekly_locate_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Pa /usr/libexec/locate.updatedb . +This script is run using +.Nm nice Fl 5 +as user +.Dq Li nobody , +and generates the table used by the +.Xr locate 1 +command. +.It Va weekly_whatis_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Pa /usr/libexec/makewhatis.local . +This script regenerates the database used by the +.Xr apropos 1 +command. +.It Va weekly_catman_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to run +.Pa /usr/libexec/catman.local . +This script processes all out of date manual pages, speeding up the +.Xr man 1 +command at the expense of disk space. +.It Va weekly_noid_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to locate orphaned files on the system. +An orphaned file is one with an invalid owner or group. +.It Va weekly_noid_dirs +.Pq Vt str +A list of directories under which orphaned files are searched for. +This would usually be set to +.Pa / . +.It Va weekly_status_pkg_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to use +.Xr pkg_version 1 +to list installed packages which are out of date. +.It Va pkg_version +.Pq Vt str +When +.Va weekly_status_pkg_enable +is set to +.Dq Li YES , +this variable specifies the program that is used to determine the out of +date packages. +If unset, the +.Xr pkg_version 1 +program is used. +As an example, this variable might be set to +.Dq Li portversion +if the +.Pa ports/sysutils/portupgrade +port has been installed. +.It Va pkg_version_index +.Pq Vt str +This variable specifies the +.Pa INDEX +file from +.Pa /usr/ports +that should be used by +.Xr pkg_version 1 . +Because the dependency tree may be substantially different between versions of +.Fx , +there may be more than one +.Pa INDEX +file in +.Pa /usr/ports . +.Pp +Note, if the +.Va pkg_version +variable is set to +.Dq Li portversion , +it will also be necessary to arrange that the correct +.Pa INDEX +file is specified +using environment variables and that +.Va pkg_version_index +is cleared in +.Pa /etc/periodic.conf +.Pq Dq Li pkg_version_index= . +.It Va weekly_local +.Pq Vt str +Set to a list of extra scripts that should be run after all other +weekly scripts. +All scripts must be absolute path names. +.El +.Pp +The following variables are used by the standard scripts that reside in +.Pa /etc/periodic/monthly : +.Bl -tag -offset 4n -width 2n +.It Va monthly_accounting_enable +.Pq Vt bool +Set to +.Dq Li YES +if you want to do login accounting using the +.Xr ac 8 +command. +.It Va monthly_local +.Pq Vt str +Set to a list of extra scripts that should be run after all other +monthly scripts. +All scripts must be absolute path names. +.El +.Sh FILES +.Bl -tag -width ".Pa /etc/defaults/periodic.conf" +.It Pa /etc/defaults/periodic.conf +The default configuration file. +This file contains all default variables and values. +.It Pa /etc/periodic.conf +The usual system specific variable override file. +.It Pa /etc/periodic.conf.local +An additional override file, useful when +.Pa /etc/periodic.conf +is shared or distributed. +.El +.Sh SEE ALSO +.Xr apropos 1 , +.Xr calendar 1 , +.Xr df 1 , +.Xr diff 1 , +.Xr gzip 1 , +.Xr locate 1 , +.Xr man 1 , +.Xr msgs 1 , +.Xr netstat 1 , +.Xr nice 1 , +.Xr pkg_version 1 , +.Xr login.conf 5 , +.Xr rc.conf 5 , +.Xr ac 8 , +.Xr chkgrp 8 , +.Xr dump 8 , +.Xr newsyslog 8 , +.Xr periodic 8 , +.Xr sendmail 8 +.Sh HISTORY +The +.Nm +file appeared in +.Fx 4.1 . +.Sh AUTHORS +.An Brian Somers Aq brian@Awfulhak.org diff --git a/share/man/man5/phones.5 b/share/man/man5/phones.5 new file mode 100644 index 0000000..59b491b --- /dev/null +++ b/share/man/man5/phones.5 @@ -0,0 +1,82 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd June 5, 1993 +.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. +The format of the file is a series of lines +of the form: <system-name>[\ \et]*<phone-number>. +The system name is +one of those defined in the +.Xr remote 5 +file and the phone number is constructed from any sequence of +characters terminated only by ``,'' or the end of the line. +The ``='' and ``*'' characters are +indicators to the auto call units to pause and wait for a second dial +tone (when going through an exchange). +The ``='' is required by the +.Tn DF02-AC +and the ``*'' 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/share/man/man5/portindex.5 b/share/man/man5/portindex.5 new file mode 100644 index 0000000..f7b126f --- /dev/null +++ b/share/man/man5/portindex.5 @@ -0,0 +1,101 @@ +.\" +.\" Copyright (c) 2004 Paul Armstrong +.\" Copyright (c) 2009 Thomas Abthorpe +.\" +.\" 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 DEVELOPERS ``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 DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd January 28, 2009 +.Dt PORTINDEX 5 +.Os +.Sh NAME +.Nm INDEX +.Nd "File containing information about the state of the ports tree" +.Sh DESCRIPTION +The port index file in +.Pa /usr/ports +contains various bits of information about the ports tree. +Each major branch of +.Fx +has a separate index file, named +.Dq INDEX- Ns Ar N , +where +.Ar N +is the major version number of the +.Fx +branch, i.e.: +.Pa INDEX-7 , +or +.Pa INDEX-8 . +.Bl -tag -compact -width indent +.It Cm \&name +The name of the package. +.It Cm \&path +The path to the port directory. +.It Cm \&install prefix +The default install prefix. +.It Cm \&short description +A short description. +.It Cm \&full description +The path to the full description. +.It Cm \&maintainer email +The email address of the maintainer. +.It Cm \&index +The categories this port is part of. +.It Cm \&build dependencies +Ports required to be installed prior to building this port. +.It Cm \&run dependencies +Ports required to be installed for this port to run. +.It Cm \&website +The project website for the port. +.It Cm \&e-deps +Ports that may be required to extract this port. +.It Cm \&p-deps +Ports that may be required to patch this port. +.It Cm \&f-deps +Ports that may be required to fetch this port. +.El +.Sh FILES +.Bl -tag -width /usr/ports/INDEX-8 +.It Pa /usr/ports/INDEX- Ns Ar N +where +.Ar N +is the major version number of the +.Fx +branch. +.El +.Sh EXAMPLES +.Bd -literal +vim-6.3.15|/usr/ports/editors/vim|/usr/local|Vi "workalike", with many additional features|/usr/ports/editors/vim/pkg-descr|obrien@FreeBSD.org|editors|libiconv-1.9.2_1|libiconv-1.9.2_1|http://www.vim.org/||| +.Ed +.Sh SEE ALSO +.Xr build 1 , +.Xr csup 1 , +.Xr ports 7 +.Sh AUTHORS +.An -nosplit +This manual page was written by +.An Paul Armstrong +and +.An Thomas Abthorpe Aq tabthorpe@FreeBSD.org . diff --git a/share/man/man5/portsnap.conf.5 b/share/man/man5/portsnap.conf.5 new file mode 100644 index 0000000..b936d98 --- /dev/null +++ b/share/man/man5/portsnap.conf.5 @@ -0,0 +1,143 @@ +.\"- +.\" Copyright 2004-2005 Colin Percival +.\" All rights reserved +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted providing that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd January 30, 2005 +.Dt PORTSNAP.CONF 5 +.Os FreeBSD +.Sh NAME +.Nm portsnap.conf +.Nd configuration file for +.Xr portsnap 8 +.Sh DESCRIPTION +The +.Nm +file controls where +.Xr portsnap 8 +fetches ports tree snapshots from, +which RSA key should be trusted to sign the updates, and what +directories should hold the compressed and live ports trees. +.Pp +A line of the form +.Dl SERVERNAME=portsnap.example.com +specifies the source from which snapshots should be fetched. +This is equivalent to the +.Fl s Ar server +option to +.Xr portsnap 8 , and will be ignored if the command-line +option is used. +.Pp +A line of the form +.Dl KEYPRINT=0123456789abc ... 456789abcdef +(64 characters in total) +specifies the SHA-256 hash of the OpenSSL public key file +belonging to an RSA keypair which is trusted to sign updates. +This is equivalent to the +.Fl k Ar KEY +option to +.Xr portsnap 8 , and will be ignored if the command-line +option is used. +.Pp +A line of the form +.Dl WORKDIR=/path/to/workdir +specifies the directory in which portsnap should maintain its compressed +snapshot of the ports tree. +This is equivalent to the +.Fl d Ar workdir +option to +.Xr portsnap 8 , and will be ignored if the command-line option +is used. +.Pp +A line of the form +.Dl PORTSDIR=/path/to/portstree +specifies the directory in which portsnap will create the live ports +tree from its compressed snapshot via the +.Cm extract +and +.Cm update +commands. +This is equivalent to the +.Fl p Ar portsdir +option to +.Xr portsnap 8 , and will be ignored if the command-line option +is used. +.Pp +If more than one line of any of the above forms is included in +.Nm +then only the last one will take effect. +.Pp +A line of the form +.Dl INDEX INDEXFILE DESCRIBEFILE +will instruct +.Xr portsnap 8 +that the specified INDEX file is generated from the specified +describe file distributed by the portsnap server. +.Pp +Finally, a line of the form +.Dl REFUSE foo bar +will instruct +.Xr portsnap 8 +to ignore parts of the ports tree with paths starting with +.Ar foo +or +.Ar bar , +which are interpreted as extended regular expressions by +.Xr egrep 1 . +This will result in those parts of the tree not being updated +in the compressed snapshot when the +.Cm fetch +and +.Cm cron +commands are used and not being extracted when the +.Cm extract +command is used (unless a specific +.Ar path +is passed to +.Xr portsnap 8 ) , +and if those parts of the ports tree are present they +will not be updated when the +.Cm update +command is used. +Unlike the other options, the parameters in REFUSE lines +accumulate and all such lines are considered. +.Bf Em +Note that operating with an incomplete ports tree is not +supported and may cause unexpected results. +.Ef +.Pp +Any lines not of the above forms will be ignored. +.Sh FILES +.Bl -tag -width "/etc/portsnap.conf" +.It /etc/portsnap.conf +Default location of the portsnap configuration file. +.El +.Sh SEE ALSO +.Xr egrep 1 , +.Xr fetch 1 , +.Xr portsnap 8 , +.Xr sha256 8 +.Sh AUTHORS +.An Colin Percival Aq cperciva@FreeBSD.org diff --git a/share/man/man5/procfs.5 b/share/man/man5/procfs.5 new file mode 100644 index 0000000..1707273 --- /dev/null +++ b/share/man/man5/procfs.5 @@ -0,0 +1,277 @@ +.\" $FreeBSD$ +.\" Written by Garrett Wollman +.\" This file is in the public domain. +.\" +.Dd September 22, 2009 +.Dt PROCFS 5 +.Os +.Sh NAME +.Nm procfs +.Nd process file system +.Sh SYNOPSIS +.Bd -literal +proc /proc procfs rw 0 0 +.Ed +.Sh DESCRIPTION +The process file system, or +.Nm , +implements a view of the system process table inside the file system. +It is normally mounted on +.Pa /proc , +and is required for the complete operation of programs such as +.Xr ps 1 +and +.Xr w 1 . +.Pp +The +.Nm +provides a two-level view of process space, unlike the previous +.Fx 1.1 +.Nm +implementation. +At the highest level, processes themselves are named, according to +their process ids in decimal, with no leading zeros. +There is also a +special node called +.Pa curproc +which always refers to the process making the lookup request. +.Pp +Each node is a directory which contains the following entries: +.Pp +Each directory contains several files: +.Bl -tag -width status +.It Pa ctl +a write-only file which supports a variety +of control operations. +Control commands are written as strings to the +.Pa ctl +file. +The control commands are: +.Bl -tag -width detach -compact +.It attach +stops the target process and arranges for the sending +process to become the debug control process. +.It detach +continue execution of the target process and +remove it from control by the debug process (which +need not be the sending process). +.It run +continue running the target process until +a signal is delivered, a breakpoint is hit, or the +target process exits. +.It step +single step the target process, with no signal delivery. +.It wait +wait for the target process to come to a steady +state ready for debugging. +The target process must be in this state before +any of the other commands are allowed. +.El +.Pp +The string can also be the name of a signal, lower case +and without the +.Dv SIG +prefix, +in which case that signal is delivered to the process +(see +.Xr sigaction 2 ) . +.Pp +The +.Xr procctl 8 +utility can be used to clear tracepoints in a stuck process. +.It Pa dbregs +The debug registers as defined by +.Dv "struct dbregs" +in +.In machine/reg.h . +.Pa dbregs +is currently only implemented on the i386 architecture. +.It Pa etype +The type of the executable referenced by the +.Pa file +entry. +.It Pa file +A symbolic link to the file from which the process text was read. +This can be used to gain access to the process' symbol table, +or to start another copy of the process. +If the file cannot be found, the link target is +.Ql unknown . +.It Pa fpregs +The floating point registers as defined by +.Dv "struct fpregs" +in +.In machine/reg.h . +.Pa fpregs +is only implemented on machines which have distinct general +purpose and floating point register sets. +.It Pa map +A map of the process' virtual memory. +.It Pa mem +The complete virtual memory image of the process. +Only those address which exist in the process can be accessed. +Reads and writes to this file modify the process. +Writes to the text segment remain private to the process. +.It Pa note +Used for sending signals to the process. +Not implemented. +.It Pa notepg +Used for sending signal to the process group. +Not implemented. +.It Pa osrel +Allows read and write of the kernel osrel value assigned to the process. +It affects the compatibility shims that are turned on and off +depending on the value. +Initial process value is read from the ABI note tag in the executed ELF image, +and is zero if the tag not supported by binary format or was not found. +.It Pa regs +Allows read and write access to the process' register set. +This file contains a binary data structure +.Dv "struct regs" +defined in +.In machine/reg.h . +.Pa regs +can only be written when the process is stopped. +.It Pa rlimit +This is a read-only file containing the process current and maximum +limits. +Each line is of the format +.Ar rlimit current max , +with -1 +indicating infinity. +.It Pa status +The process status. +This file is read-only and returns a single line containing +multiple space-separated fields as follows: +.Pp +.Bl -bullet -compact +.It +command name +.It +process id +.It +parent process id +.It +process group id +.It +session id +.It +.Ar major , Ns Ar minor +of the controlling terminal, or +.Dv -1,-1 +if there is no controlling terminal. +.It +a list of process flags: +.Dv ctty +if there is a controlling terminal, +.Dv sldr +if the process is a session leader, +.Dv noflags +if neither of the other two flags are set. +.It +the process start time in seconds and microseconds, +comma separated. +.It +the user time in seconds and microseconds, +comma separated. +.It +the system time in seconds and microseconds, +comma separated. +.It +the wait channel message +.It +the process credentials consisting of +the effective user id +and the list of groups (whose first member +is the effective group id) +all comma separated. +.It +the hostname of the jail in which the process runs, or +.Ql - +to indicate that the process is not running within a jail. +.El +.El +.Pp +In a normal debugging environment, +where the target is fork/exec'd by the debugger, +the debugger should fork and the child should stop +itself (with a self-inflicted +.Dv SIGSTOP +for example). +The parent should issue a +.Dv wait +and then an +.Dv attach +command via the appropriate +.Pa ctl +file. +The child process will receive a +.Dv SIGTRAP +immediately after the call to exec (see +.Xr execve 2 ) . +.Pp +Each node is owned by the process's user, and belongs to that user's +primary group, except for the +.Pa mem +node, which belongs to the +.Li kmem +group. +.Sh FILES +.Bl -tag -width /proc/curproc/XXXXXXX -compact +.It Pa /proc +normal mount point for the +.Nm . +.It Pa /proc/pid +directory containing process information for process +.Pa pid . +.It Pa /proc/curproc +directory containing process information for the current process +.It Pa /proc/curproc/cmdline +the process executable name +.It Pa /proc/curproc/ctl +used to send control messages to the process +.It Pa /proc/curproc/etype +executable type +.It Pa /proc/curproc/file +executable image +.It Pa /proc/curproc/fpregs +the process floating point register set +.It Pa /proc/curproc/map +virtual memory map of the process +.It Pa /proc/curproc/mem +the complete virtual address space of the process +.It Pa /proc/curproc/note +used for signaling the process +.It Pa /proc/curproc/notepg +used for signaling the process group +.It Pa /proc/curproc/osrel +the process osrel value +.It Pa /proc/curproc/regs +the process register set +.It Pa /proc/curproc/rlimit +the process current and maximum rlimit +.It Pa /proc/curproc/status +the process' current status +.El +.Sh EXAMPLES +To mount a +.Nm +file system on +.Pa /proc : +.Pp +.Dl "mount -t procfs proc /proc" +.Sh SEE ALSO +.Xr procstat 1 , +.Xr mount 2 , +.Xr sigaction 2 , +.Xr unmount 2 , +.Xr procctl 8 , +.Xr pseudofs 9 +.Sh AUTHORS +.An -nosplit +This manual page written by +.An Garrett Wollman , +based on the description +provided by +.An Jan-Simon Pendry , +and revamped later by +.An Mike Pritchard . diff --git a/share/man/man5/protocols.5 b/share/man/man5/protocols.5 new file mode 100644 index 0000000..37d3541 --- /dev/null +++ b/share/man/man5/protocols.5 @@ -0,0 +1,80 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd June 5, 1993 +.Dt PROTOCOLS 5 +.Os +.Sh NAME +.Nm protocols +.Nd protocol name data base +.Sh DESCRIPTION +The +.Nm +file contains information regarding the known protocols used in the +.Tn DARPA +Internet. +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 ``#'' 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 +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr getprotoent 3 +.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/share/man/man5/quota.user.5 b/share/man/man5/quota.user.5 new file mode 100644 index 0000000..010b99c --- /dev/null +++ b/share/man/man5/quota.user.5 @@ -0,0 +1,131 @@ +.\" Copyright (c) 2001 Nik Clayton +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd October 30, 2007 +.Dt QUOTA.USER 5 +.Os +.Sh NAME +.Nm quota.user , quota.group +.Nd per file system quota database +.Sh DESCRIPTION +Each file system with active quotas should contain a +.Pa quota.user +and +.Pa quota.group +file in the file system root. +These files are created by +.Xr quotacheck 8 , +and should be edited with +.Xr edquota 8 . +It is possible to specify a different location and file name with the +.Dq Li userquota +and +.Dq Li groupquota +options in the +.Xr fstab 5 +file. +.Pp +.Pp +The data files contain the following information: +.Pp +.Bl -bullet -offset indent -compact +.It +Current block usage +.It +Current number of files +.It +Soft block limit +.It +Soft file limit +.It +Hard block limit +.It +Hard file limit +.It +Block grace time remaining if over the soft limit +.It +File grace time remaining if over the soft limit +.El +.Pp +.Pp +See +.Xr edquota 8 +for an explanation on the various limits and grace periods. +.Pp +During normal quota operations the +.Xr quotactl 2 +interface is used to query or set quota information and the kernel +will maintain the data files as needed. +If quotas are disabled on +a file system, but marked as having quotas enabled in +.Xr fstab 5 , +then the quota data files will be used directly. +.Pp +The data files are stored as an array of +.Dq Li struct dqblk +structures, as defined in +.In ufs/ufs/quota.h , +and indexed by UID or GID. +The data files will be written as a sparse file if possible. +Data is only maintained for ids that have either non-zero usage or +non-zero quota limits. +If an attempt is made to access data for an id that would exist past the +end of the current data file, a quota structure with all values set +to zero will be created, and the data file extended as needed. +The +.Xr quotacheck 8 +utility will truncate the data files to the minimum size needed +to store the highest id with either non-zero file usage or +non-zero quota limits. +.Pp +The data record for id 0 has special meaning. If the +.Dq Dv dqb_btime +or +.Dq Dv dbq_itime +fields are non-zero, they are used to indicate the grace period on +that file system for users who have exceeded their soft limit. +These times can be set by +.Xr edquota 8 +with the +.Fl t +flag. +If no explicit grace period has been set with +.Xr edquota 8 , +then the default value of 7 days will be used. +The default values are defined by +.Dv MAX_DQ_TIME +and +.Dv MAX_IQ_TIME +in +.In ufs/ufs/quota.h . +.Sh SEE ALSO +.Xr quota 1 , +.Xr quotactl 2 , +.Xr fstab 5 , +.Xr edquota 8 , +.Xr quotacheck 8 , +.Xr quotaoff 8 , +.Xr quotaon 8 , +.Xr repquota 8 diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 new file mode 100644 index 0000000..f9f9167 --- /dev/null +++ b/share/man/man5/rc.conf.5 @@ -0,0 +1,4369 @@ +.\" Copyright (c) 1995 +.\" Jordan K. Hubbard +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd July 13, 2010 +.Dt RC.CONF 5 +.Os +.Sh NAME +.Nm rc.conf +.Nd system configuration information +.Sh DESCRIPTION +The file +.Nm +contains descriptive information about the local host name, configuration +details for any potential network interfaces and which services should be +started up at system initial boot time. +In new installations, the +.Nm +file is generally initialized by the system installation utility, +.Xr sysinstall 8 . +.Pp +The purpose of +.Nm +is not to run commands or perform system startup actions +directly. +Instead, it is included by the +various generic startup scripts in +.Pa /etc +which conditionalize their +internal actions according to the settings found there. +.Pp +The +.Pa /etc/rc.conf +file is included from the file +.Pa /etc/defaults/rc.conf , +which specifies the default settings for all the available options. +Options need only be specified in +.Pa /etc/rc.conf +when the system administrator wishes to override these defaults. +The file +.Pa /etc/rc.conf.local +is used to override settings in +.Pa /etc/rc.conf +for historical reasons. +See the +.Va rc_conf_files +variable below. +.Pp +Options are set with +.Dq Ar name Ns Li = Ns Ar value +assignments that use +.Xr sh 1 +syntax. +The following list provides a name and short description for each +variable that can be set in the +.Nm +file: +.Bl -tag -width indent-two +.It Va rc_debug +.Pq Vt bool +If set to +.Dq Li YES , +enable output of debug messages from rc scripts. +This variable can be helpful in diagnosing mistakes when +editing or integrating new scripts. +Beware that this produces copious output to the terminal and +.Xr syslog 3 . +.It Va rc_info +.Pq Vt bool +If set to +.Dq Li NO , +disable informational messages from the rc scripts. +Informational messages are displayed when +a condition that is not serious enough to warrant a warning or +an error occurs. +.It Va rc_startmsgs +.Pq Vt bool +If set to +.Dq Li YES , +show +.Dq Starting foo: +when faststart is used (e.g., at boot time). +.It Va early_late_divider +.Pq Vt str +The name of the script that should be used as the +delimiter between the +.Dq early +and +.Dq late +stages of the boot process. +The early stage should contain all the services needed to +get the disks (local or remote) mounted so that the late +stage can include scripts contained in the directories +listed in the +.Va local_startup +variable (see below). +Thus, the two likely candidates for this value are +.Pa mountcritlocal +for the typical system, and +.Pa mountcritremote +if the system needs remote file +systems mounted to get access to the +.Va local_startup +directories; for example when +.Pa /usr/local +is NFS mounted. +For +.Pa rc.conf +within a +.Xr jail 8 +.Pa NETWORKING +is likely to be an appropriate value. +Extreme care should be taken when changing this value, +and before changing it one should ensure that there are +adequate provisions to recover from a failed boot +(such as physical contact with the machine, +or reliable remote console access). +.It Va swapfile +.Pq Vt str +If set to +.Dq Li NO , +no swapfile is installed, otherwise the value is used as the full +pathname to a file to use for additional swap space. +.It Va apm_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable support for Automatic Power Management with +the +.Xr apm 8 +command. +.It Va apmd_enable +.Pq Vt bool +Run +.Xr apmd 8 +to handle APM event from userland. +This also enables support for APM. +.It Va apmd_flags +.Pq Vt str +If +.Va apmd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr apmd 8 +daemon. +.It Va devd_enable +.Pq Vt bool +Run +.Xr devd 8 +to handle device added, removed or unknown events from the kernel. +.It Va ddb_enable +.Pq Vt bool +Run +.Xr ddb 8 +to install +.Xr ddb 4 +scripts at boot time. +.It Va ddb_config +.Pq Vt str +Configuration file for +.Xr ddb 8 . +Default +.Pa /etc/ddb.conf . +.It Va kldxref_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Set to +.Dq Li YES +to automatically rebuild +.Pa linker.hints +files with +.Xr kldxref 8 +at boot time. +.It Va kldxref_clobber +.Pq Vt bool +Set to +.Dq Li NO +by default. +If +.Va kldxref_enable +is true, +setting to +.Dq Li YES +will overwrite existing +.Pa linker.hints +files at boot time. +Otherwise, +only missing +.Pa linker.hints +files are generated. +.It Va kldxref_module_path +.Pq Vt str +Empty by default. +A semi-colon +.Pq Ql \&; +delimited list of paths containing +.Xr kld 4 +modules. +If empty, +the contents of the +.Va kern.module_path +.Xr sysctl 8 +are used. +.It Va powerd_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable the system power control facility with the +.Xr powerd 8 +daemon. +.It Va powerd_flags +.Pq Vt str +If +.Va powerd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr powerd 8 +daemon. +.It Va tmpmfs +Controls the creation of a +.Pa /tmp +memory file system. +Always happens if set to +.Dq Li YES +and never happens if set to +.Dq Li NO . +If set to anything else, a memory file system is created if +.Pa /tmp +is not writable. +.It Va tmpsize +Controls the size of a created +.Pa /tmp +memory file system. +.It Va tmpmfs_flags +Extra options passed to the +.Xr mdmfs 8 +utility when the memory file system for +.Pa /tmp +is created. +The default is +.Dq Li "-S" , +which inhibits the use of softupdates on +.Pa /tmp +so that file system space is freed without delay +after file truncation or deletion. +See +.Xr mdmfs 8 +for other options you can use in +.Va tmpmfs_flags . +.It Va varmfs +Controls the creation of a +.Pa /var +memory file system. +Always happens if set to +.Dq Li YES +and never happens if set to +.Dq Li NO . +If set to anything else, a memory file system is created if +.Pa /var +is not writable. +.It Va varsize +Controls the size of a created +.Pa /var +memory file system. +.It Va varmfs_flags +Extra options passed to the +.Xr mdmfs 8 +utility when the memory file system for +.Pa /var +is created. +The default is +.Dq Li "-S" , +which inhibits the use of softupdates on +.Pa /var +so that file system space is freed without delay +after file truncation or deletion. +See +.Xr mdmfs 8 +for other options you can use in +.Va varmfs_flags . +.It Va populate_var +Controls the automatic population of the +.Pa /var +file system. +Always happens if set to +.Dq Li YES +and never happens if set to +.Dq Li NO . +If set to anything else, a memory file system is created if +.Pa /var +is not writable. +Note that this process requires access to certain commands in +.Pa /usr +before +.Pa /usr +is mounted on normal systems. +.It Va cleanvar_enable +.Pq Vt bool +Clean the +.Pa /var +directory. +.It Va local_startup +.Pq Vt str +List of directories to search for startup script files. +.It Va script_name_sep +.Pq Vt str +The field separator to use for breaking down the list of startup script files +into individual filenames. +The default is a space. +It is not necessary to change this unless there are startup scripts with names +containing spaces. +.It Va hostapd_enable +.Pq Vt bool +Set to +.Dq Li YES +to start +.Xr hostapd 8 +at system boot time. +.It Va hostname +.Pq Vt str +The fully qualified domain name (FQDN) of this host on the network. +This should almost certainly be set to something meaningful, even if +there is no network connection. +If +.Xr dhclient 8 +is used to set the hostname via DHCP, +this variable should be set to an empty string. +If this value remains unset when the system is done booting +your console login will display the default hostname of +.Dq Amnesiac. +.It Va nisdomainname +.Pq Vt str +The NIS domain name of this host, or +.Dq Li NO +if NIS is not used. +.It Va dhclient_program +.Pq Vt str +Path to the DHCP client program +.Pa ( /sbin/dhclient , +the +.Ox +DHCP client, +is the default). +.It Va dhclient_flags +.Pq Vt str +Additional flags to pass to the DHCP client program. +For the +.Ox +DHCP client, see the +.Xr dhclient 8 +manpage for a description of the command line options available. +.It Va dhclient_flags_ Ns Aq Ar iface +Additional flags to pass to the DHCP client program running on +.Ar iface +only. +When specified, this variable overrides +.Va dhclient_flags . +.It Va background_dhclient +.Pq Vt bool +Set to +.Dq Li YES +to start the DHCP client in background. +This can cause trouble with applications depending on +a working network, but it will provide a faster startup +in many cases. +.It Va background_dhclient_ Ns Aq Ar iface +When specified, this variable overrides the +.Va background_dhclient +variable for interface +.Ar iface +only. +.It Va synchronous_dhclient +.Pq Vt bool +Set to +.Dq Li YES +to start +.Xr dhclient 8 +synchronously at startup. +This behavior can be overridden on a per-interface basis by replacing +the +.Dq Li DHCP +keyword in the +.Va ifconfig_ Ns Aq Ar interface +variable with +.Dq Li SYNCDHCP +or +.Dq Li NOSYNCDHCP . +.It Va defaultroute_delay +.Pq Vt int +When set to a positive value, wait up to this long after configuring +DHCP interfaces at startup to give the interfaces time to receive a lease. +.It Va firewall_enable +.Pq Vt bool +Set to +.Dq Li YES +to load firewall rules at startup. +If the kernel was not built with +.Cd "options IPFIREWALL" , +the +.Pa ipfw.ko +kernel module will be loaded. +See also +.Va ipfilter_enable . +.It Va firewall_script +.Pq Vt str +This variable specifies the full path to the firewall script to run. +The default is +.Pa /etc/rc.firewall . +.It Va firewall_type +.Pq Vt str +Names the firewall type from the selection in +.Pa /etc/rc.firewall , +or the file which contains the local firewall ruleset. +Valid selections from +.Pa /etc/rc.firewall +are: +.Pp +.Bl -tag -width ".Li simple" -compact +.It Li open +unrestricted IP access +.It Li closed +all IP services disabled, except via +.Dq Li lo0 +.It Li client +basic protection for a workstation +.It Li simple +basic protection for a LAN. +.El +.Pp +If a filename is specified, the full path +must be given. +.It Va firewall_quiet +.Pq Vt bool +Set to +.Dq Li YES +to disable the display of firewall rules on the console during boot. +.It Va firewall_logging +.Pq Vt bool +Set to +.Dq Li YES +to enable firewall event logging. +This is equivalent to the +.Dv IPFIREWALL_VERBOSE +kernel option. +.It Va firewall_flags +.Pq Vt str +Flags passed to +.Xr ipfw 8 +if +.Va firewall_type +specifies a filename. +.It Va firewall_coscripts +.Pq Vt str +List of executables and/or rc scripts to run after firewall starts/stops. +Default is empty. +.\" ----- firewall_nat_enable setting -------------------------------- +.It Va firewall_nat_enable +.Pq Vt bool +The +.Xr ipfw 8 +equivalent of +.Va natd_enable . +Setting this to +.Dq Li YES +enables kernel NAT. +.Va firewall_enable +must also be set to +.Dq Li YES . +.It Va firewall_nat_interface +.Pq Vt str +The +.Xr ipfw 8 +equivalent of +.Va natd_interface . +This is the name of the public interface or IP address on which +kernel NAT should run. +.It Va firewall_nat_flags +.Pq Vt str +Additional configuration parameters for kernel NAT should be placed here. +.It Va dummynet_enable +.Pq Vt bool +Setting this to +.Dq Li YES +will automatically load the +.Xr dummynet 4 +module if +.Va firewall_enable +is also set to +.Dq Li YES . +.\" ------------------------------------------------------------------- +.It Va natd_program +.Pq Vt str +Path to +.Xr natd 8 . +.It Va natd_enable +.Pq Vt bool +Set to +.Dq Li YES +to enable +.Xr natd 8 . +.Va firewall_enable +must also be set to +.Dq Li YES , +and +.Xr divert 4 +sockets must be enabled in the kernel. +If the kernel was not built with +.Cd "options IPDIVERT" , +the +.Pa ipdivert.ko +kernel module will be loaded. +.It Va natd_interface +.Pq Vt str +This is the name of the public interface on which +.Xr natd 8 +should run. +The interface may be given as an interface name or as an IP address. +.It Va natd_flags +.Pq Vt str +Additional +.Xr natd 8 +flags should be placed here. +The +.Fl n +or +.Fl a +flag is automatically added with the above +.Va natd_interface +as an argument. +.\" ----- ipfilter_enable setting -------------------------------- +.It Va ipfilter_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Setting this to +.Dq Li YES +enables +.Xr ipf 8 +packet filtering. +.Pp +Typical usage will require putting +.Bd -literal +ipfilter_enable="YES" +ipnat_enable="YES" +ipmon_enable="YES" +ipfs_enable="YES" +.Ed +.Pp +into +.Pa /etc/rc.conf +and editing +.Pa /etc/ipf.rules +and +.Pa /etc/ipnat.rules +appropriately. +.Pp +Note that +.Va ipfilter_enable +and +.Va ipnat_enable +can be enabled independently. +.Va ipmon_enable +and +.Va ipfs_enable +both require at least one of +.Va ipfilter_enable +and +.Va ipnat_enable +to be enabled. +.Pp +Having +.Bd -literal +options IPFILTER +options IPFILTER_LOG +options IPFILTER_DEFAULT_BLOCK +.Ed +.Pp +in the kernel configuration file is a good idea, too. +.\" ----- ipfilter_program setting ------------------------------ +.It Va ipfilter_program +.Pq Vt str +Path to +.Xr ipf 8 +(default +.Pa /sbin/ipf ) . +.\" ----- ipfilter_rules setting -------------------------------- +.It Va ipfilter_rules +.Pq Vt str +Set to +.Pa /etc/ipf.rules +by default. +This variable contains the name of the filter rule definition file. +The file is expected to be readable for the +.Xr ipf 8 +command to execute. +.\" ----- ipv6_ipfilter_rules setting --------------------------- +.It Va ipv6_ipfilter_rules +.Pq Vt str +Set to +.Pa /etc/ipf6.rules +by default. +This variable contains the IPv6 filter rule definition file. +The file is expected to be readable for the +.Xr ipf 8 +command to execute. +.\" ----- ipfilter_flags setting -------------------------------- +.It Va ipfilter_flags +.Pq Vt str +Empty by default. +This variable contains flags passed to the +.Xr ipf 8 +program. +.\" ----- ipnat_enable setting ---------------------------------- +.It Va ipnat_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Set it to +.Dq Li YES +to enable +.Xr ipnat 8 +network address translation. +See +.Va ipfilter_enable +for a detailed discussion. +.\" ----- ipnat_program setting --------------------------------- +.It Va ipnat_program +.Pq Vt str +Path to +.Xr ipnat 8 +(default +.Pa /sbin/ipnat ) . +.\" ----- ipnat_rules setting ----------------------------------- +.It Va ipnat_rules +.Pq Vt str +Set to +.Pa /etc/ipnat.rules +by default. +This variable contains the name of the file +holding the network address translation definition. +This file is expected to be readable for the +.Xr ipnat 8 +command to execute. +.\" ----- ipnat_flags setting ----------------------------------- +.It Va ipnat_flags +.Pq Vt str +Empty by default. +This variable contains flags passed to the +.Xr ipnat 8 +program. +.\" ----- ipmon_enable setting ---------------------------------- +.It Va ipmon_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Set it to +.Dq Li YES +to enable +.Xr ipmon 8 +monitoring (logging +.Xr ipf 8 +and +.Xr ipnat 8 +events). +Setting this variable needs setting +.Va ipfilter_enable +or +.Va ipnat_enable +too. +See +.Va ipfilter_enable +for a detailed discussion. +.\" ----- ipmon_program setting --------------------------------- +.It Va ipmon_program +.Pq Vt str +Path to +.Xr ipmon 8 +(default +.Pa /sbin/ipmon ) . +.\" ----- ipmon_flags setting ----------------------------------- +.It Va ipmon_flags +.Pq Vt str +Set to +.Dq Li -Ds +by default. +This variable contains flags passed to the +.Xr ipmon 8 +program. +Another typical example would be +.Dq Fl D Pa /var/log/ipflog +to have +.Xr ipmon 8 +log directly to a file bypassing +.Xr syslogd 8 . +Make sure to adjust +.Pa /etc/newsyslog.conf +in such case like this: +.Bd -literal +/var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid +.Ed +.\" ----- ipfs_enable setting ----------------------------------- +.It Va ipfs_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Set it to +.Dq Li YES +to enable +.Xr ipfs 8 +saving the filter and NAT state tables during shutdown +and reloading them during startup again. +Setting this variable needs setting +.Va ipfilter_enable +or +.Va ipnat_enable +to +.Dq Li YES +too. +See +.Va ipfilter_enable +for a detailed discussion. +Note that if +.Va kern_securelevel +is set to 3, +.Va ipfs_enable +cannot be used +because the raised securelevel will prevent +.Xr ipfs 8 +from saving the state tables at shutdown time. +.\" ----- ipfs_program setting ---------------------------------- +.It Va ipfs_program +.Pq Vt str +Path to +.Xr ipfs 8 +(default +.Pa /sbin/ipfs ) . +.\" ----- ipfs_flags setting ------------------------------------ +.It Va ipfs_flags +.Pq Vt str +Empty by default. +This variable contains flags passed to the +.Xr ipfs 8 +program. +.\" ----- end of added ipf hook --------------------------------- +.It Va pf_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Setting this to +.Dq Li YES +enables +.Xr pf 4 +packet filtering. +.Pp +Typical usage will require putting +.Pp +.Dl pf_enable="YES" +.Pp +into +.Pa /etc/rc.conf +and editing +.Pa /etc/pf.conf +appropriately. +Adding +.Pp +.Dl "device pf" +.Pp +builds support for +.Xr pf 4 +into the kernel, otherwise the +kernel module will be loaded. +.It Va pf_rules +.Pq Vt str +Path to +.Xr pf 4 +ruleset configuration file +(default +.Pa /etc/pf.conf ) . +.It Va pf_program +.Pq Vt str +Path to +.Xr pfctl 8 +(default +.Pa /sbin/pfctl ) . +.It Va pf_flags +.Pq Vt str +If +.Va pf_enable +is set to +.Dq Li YES , +these flags are passed to the +.Xr pfctl 8 +program when loading the ruleset. +.It Va pflog_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Setting this to +.Dq Li YES +enables +.Xr pflogd 8 +which logs packets from the +.Xr pf 4 +packet filter. +.It Va pflog_logfile +.Pq Vt str +If +.Va pflog_enable +is set to +.Dq Li YES +this controls where +.Xr pflogd 8 +stores the logfile +(default +.Pa /var/log/pflog ) . +Check +.Pa /etc/newsyslog.conf +to adjust logfile rotation for this. +.It Va pflog_program +.Pq Vt str +Path to +.Xr pflogd 8 +(default +.Pa /sbin/pflogd ) . +.It Va pflog_flags +.Pq Vt str +Empty by default. +This variable contains additional flags passed to the +.Xr pflogd 8 +program. +.It Va ftpproxy_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Setting this to +.Dq Li YES +enables +.Xr ftp-proxy 8 +which supports the +.Xr pf 4 +packet filter in translating ftp connections. +.It Va ftpproxy_flags +.Pq Vt str +Empty by default. +This variable contains additional flags passed to the +.Xr ftp-proxy 8 +program. +.It Va pfsync_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +Setting this to +.Dq Li YES +enables exposing +.Xr pf 4 +state changes to other hosts over the network by means of +.Xr pfsync 4 . +The +.Va pfsync_syncdev +variable +must also be set then. +.It Va pfsync_syncdev +.Pq Vt str +Empty by default. +This variable specifies the name of the network interface +.Xr pfsync 4 +should operate through. +It must be set accordingly if +.Va pfsync_enable +is set to +.Dq Li YES . +.It Va pfsync_syncpeer +.Pq Vt str +Empty by default. +This variable is optional. +By default, state change messages are sent out on the synchronisation +interface using IP multicast packets. +The protocol is IP protocol 240, PFSYNC, and the multicast group used is +224.0.0.240. +When a peer address is specified using the +.Va pfsync_syncpeer +option, the peer address is used as a destination for the pfsync +traffic, and the traffic can then be protected using +.Xr ipsec 4 . +See the +.Xr pfsync 4 +manpage for more details about using +.Xr ipsec 4 +with +.Xr pfsync 4 +interfaces. +.It Va pfsync_ifconfig +.Pq Vt str +Empty by default. +This variable can contain additional options to be passed to the +.Xr ifconfig 8 +command used to set up +.Xr pfsync 4 . +.It Va tcp_extensions +.Pq Vt bool +Set to +.Dq Li YES +by default. +Setting this to +.Dq Li NO +disables certain TCP options as described by +.Rs +.%T "RFC 1323" +.Re +Setting this to +.Dq Li NO +might help remedy such problems with connections as randomly hanging +or other weird behavior. +Some network devices are known +to be broken with respect to these options. +.It Va log_in_vain +.Pq Vt int +Set to 0 by default. +The +.Xr sysctl 8 +variables, +.Va net.inet.tcp.log_in_vain +and +.Va net.inet.udp.log_in_vain , +as described in +.Xr tcp 4 +and +.Xr udp 4 , +are set to the given value. +.It Va tcp_keepalive +.Pq Vt bool +Set to +.Dq Li YES +by default. +Setting to +.Dq Li NO +will disable probing idle TCP connections to verify that the +peer is still up and reachable. +.It Va tcp_drop_synfin +.Pq Vt bool +Set to +.Dq Li NO +by default. +Setting to +.Dq Li YES +will cause the kernel to ignore TCP frames that have both +the SYN and FIN flags set. +This prevents OS fingerprinting, but may +break some legitimate applications. +.It Va icmp_drop_redirect +.Pq Vt bool +Set to +.Dq Li NO +by default. +Setting to +.Dq Li YES +will cause the kernel to ignore ICMP REDIRECT packets. +Refer to +.Xr icmp 4 +for more information. +.It Va icmp_log_redirect +.Pq Vt bool +Set to +.Dq Li NO +by default. +Setting to +.Dq Li YES +will cause the kernel to log ICMP REDIRECT packets. +Note that +the log messages are not rate-limited, so this option should only be used +for troubleshooting networks. +Refer to +.Xr icmp 4 +for more information. +.It Va icmp_bmcastecho +.Pq Vt bool +Set to +.Dq Li YES +to respond to broadcast or multicast ICMP ping packets. +Refer to +.Xr icmp 4 +for more information. +.It Va ip_portrange_first +.Pq Vt int +If not set to +.Dq Li NO , +this is the first port in the default portrange. +Refer to +.Xr ip 4 +for more information. +.It Va ip_portrange_last +.Pq Vt int +If not set to +.Dq Li NO , +this is the last port in the default portrange. +Refer to +.Xr ip 4 +for more information. +.It Va network_interfaces +.Pq Vt str +Set to the list of network interfaces to configure on this host or +.Dq Li AUTO +(the default) for all current interfaces. +Setting the +.Va network_interfaces +variable to anything other than the default is deprecated. +Interfaces that the administrator wishes to store configuration for, +but not start at boot should be configured with the +.Dq Li NOAUTO +keyword in their +.Va ifconfig_ Ns Aq Ar interface +variables as described below. +.Pp +An +.Va ifconfig_ Ns Aq Ar interface +variable is also assumed to exist for each value of +.Ar interface . +When an interface name contains any of the characters +.Dq Li .-/+ +they are translated to +.Dq Li _ +before lookup. +The variable can contain arguments to +.Xr ifconfig 8 , +as well as special case-insensitive keywords described below. +Such keywords are removed before passing the value to +.Xr ifconfig 8 +while the order of the other arguments is preserved. +.Pp +One can configure more than one IPv4 address with the +.Va ipv4_addrs_ Ns Aq Ar interface +variable. +One or more IP addresses must be provided in Classless Inter-Domain +Routing (CIDR) address notation, whose last byte can be a range like +192.0.2.5-23/24. +In this case the address 192.0.2.5 will be configured with the +netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with +the non-conflicting netmask /32 as explained in the +.Xr ifconfig 8 +alias section. +With the interface in question being +.Li ed0 , +an example could look like: +.Bd -literal +ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28" +.Ed +.Pp +It is also possible to add IP alias entries using +.Xr ifconfig 8 +syntax. +Assuming that the interface in question was +.Li ed0 , +it might look +something like this: +.Bd -literal +ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff" +ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff" +.Ed +.Pp +And so on. +For each +.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n +entry that is found, +its contents are passed to +.Xr ifconfig 8 . +Execution stops at the first unsuccessful access, so if +something like this is present: +.Bd -literal +ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff" +ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff" +ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff" +ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff" +.Ed +.Pp +Then note that alias4 would +.Em not +be added since the search would +stop with the missing +.Dq Li alias3 +entry. +Due to this difficult to manage behavior, the +.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n +form is deprecated. +.Pp +If the +.Pa /etc/start_if. Ns Aq Ar interface +file is present, it is read and executed by the +.Xr sh 1 +interpreter +before configuring the interface as specified in the +.Va ifconfig_ Ns Aq Ar interface +and +.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n +variables. +.Pp +If a +.Va vlans_ Ns Aq Ar interface +variable is set, +a +.Xr vlan 4 +interface will be created for each item in the list with the +.Ar vlandev +argument set to +.Ar interface . +If a vlan interface's name is a number, +then that number is used as the vlan tag and the new vlan interface is +named +.Ar interface . Ns Ar tag . +Otherwise, +the vlan tag must be specified via a +.Va vlan +parameter in the +.Va create_args_ Ns Aq Ar interface +variable. +.Pp +To create a vlan device named +.Li em0.101 +on +.Li em0 +with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24: +.Bd -literal +vlans_em0="101" +ifconfig_em0_101="inet 192.0.2.1/24" +.Ed +.Pp +To create a vlan device named +.Li myvlan +on +.Li em0 +with the vlan tag 102: +.Bd -literal +vlans_em0="myvlan" +create_args_myvlan="vlan 102" +.Ed +.Pp +If a +.Va wlans_ Ns Aq Ar interface +variable is set, +an +.Xr wlan 4 +interface will be created for each item in the list with the +.Ar wlandev +argument set to +.Ar interface . +Further wlan cloning arguments may be passed to the +.Xr ifconfig 8 +.Cm create +command by setting the +.Va create_args_ Ns Aq Ar interface +variable. +One or more +.Xr wlan 4 +devices must be created for each wireless devices as of +.Fx 8.0 . +Debugging flags for +.Xr wlan 4 +devices as set by +.Xr wlandebug 8 +may be specified with an +.Va wlandebug_ Ns Aq Ar interface +variable. +The contents of this variable will be passed directly to +.Xr wlandebug 8 . +.Pp +If the +.Va ifconfig_ Ns Aq Ar interface +contains the keyword +.Dq Li NOAUTO +then the interface will not be configured +at boot or by +.Pa /etc/pccard_ether +when +.Va network_interfaces +is set to +.Dq Li AUTO . +.Pp +It is possible to bring up an interface with DHCP by adding +.Dq Li DHCP +to the +.Va ifconfig_ Ns Aq Ar interface +variable. +For instance, to initialize the +.Li ed0 +device via DHCP, +it is possible to use something like: +.Bd -literal +ifconfig_ed0="DHCP" +.Ed +.Pp +Also, if you want to configure your wireless interface with +.Xr wpa_supplicant 8 +for use with WPA, EAP/LEAP or WEP, you need to add +.Dq Li WPA +to the +.Va ifconfig_ Ns Aq Ar interface +variable. +.Pp +Finally, you can add +.Xr ifconfig 8 +options in this variable, in addition to the +.Pa /etc/start_if. Ns Aq Ar interface +file. +For instance, to configure an +.Xr ath 4 +wireless device in station mode with an address obtained +via DHCP, using WPA authentication and 802.11b mode, it is +possible to use something like: +.Bd -literal +wlans_ath0="wlan0" +ifconfig_wlan0="DHCP WPA mode 11b" +.Ed +.Pp +In addition to the +.Va ifconfig_ Ns Aq Ar interface +form, a fallback variable +.Va ifconfig_DEFAULT +may be configured. +It will be used for all interfaces with no +.Va ifconfig_ Ns Aq Ar interface +variable. +This is intended to replace the no longer supported +.Va pccard_ifconfig +variable. +.Pp +It is also possible to rename an interface by doing: +.Bd -literal +ifconfig_ed0_name="net0" +ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00" +.Ed +.\" Remove in FreeBSD 10.x +.It Va ipv6_enable +.Pq Vt bool +.Pp +This option is deprecated. +.Pp +If the variable is +.Dq Li YES +it has no effect. +To configure IPv6 for an interface see +.Va ipv6_network_interfaces +below. +.Pp +If the variable is +.Dq Li NO +then other than +.Dq Li lo0 +IPv6 will be disabled for each interface, +however the same effect can be achieved by +not configuring the interface. +.It Va ipv6_network_interfaces +.Pq Vt str +This is the IPv6 equivalent of +.Va network_interfaces . +Normally configuration of this variable is not needed, +the value should be left as +.Dq Li AUTO . +.Pp +If +.Dq Li INET6 +is configured in the kernel configuration for the +.Dq Li lo0 +interface will always be performed. +It is not necessary to list it in +.Va ipv6_network_interfaces . +.Pp +Example configuration to accept Router Advertisements (RA) for the +.Dq Li ed0 +interface: +.Bd -literal +ifconfig_ed0_ipv6="RTADV" +.Ed +.Pp +To configure only a link-local address on the +.Dq Li ed0 +interface: +.Bd -literal +ifconfig_ed0_ipv6="inet6 auto_linklocal" +.Ed +.Pp +To disable RA the +.Dq Li NORTADV +option is available, although not required if manual +configuration is performed as described below. +.Pp +An IPv6 interface can be configured manually with +.Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 . +For example: +.Bd -literal +ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64" +.Ed +.Pp +Manual configuration of an IPv6 address will also +require configuration of the +.Va ipv6_defaultrouter +option. +.Pp +Aliases should be set by +.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n +with the +.Dq Li inet6 +keyword. +For example: +.Pp +.Bd -literal +ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64" +.Ed +.Pp +.It Va ipv6_prefer +.Pq Vt bool +If the variable is +.Dq Li YES , +the default policy of the source address selection set by +.Xr ip6addrctl 8 +will be IPv6-preferred. +.Pp +If the variable is +.Dq Li NO , +the default policy of the source address selection set by +.Xr ip6addrctl 8 +will be IPv4-preferred. +.Pp +.It Va ipv6_privacy +.Pq Vt bool +If the variable is +.Dq Li YES +privacy addresses will be generated for each IPv6 +interface as described in RFC 4193. +.Pp +.It Va ipv6_prefix_ Ns Aq Ar interface +.Pq Vt str +If one or more prefixes are defined in +.Va ipv6_prefix_ Ns Aq Ar interface +addresses based on each prefix and the EUI-64 interface index will be +configured on that interface. +.It Va ipv6_default_interface +.Pq Vt str +If not set to +.Dq Li NO , +this is the default output interface for scoped addresses. +This works only with ipv6_gateway_enable="NO". +.It Va ip6addrctl_enable +.Pq Vt bool +If set to +.Dq Li YES , +install default address selection policy table +.Pq RFC 3484 . +If a file +.Pa /etc/ip6addrctl.conf +is found the +.Xr ip6addrctl 8 +reads and installs it. +If not, a pre-defined policy table will be installed. +There are two pre-defined ones; IPv4-preferred and IPv6-preferred. +If set +.Va ipv6_prefer +variable to +.Dq Li YES +the IPv6-preferred one is used. Default is IPv4-preferred. +.It Va cloned_interfaces +.Pq Vt str +Set to the list of clonable network interfaces to create on this host. +Further cloning arguments may be passed to the +.Xr ifconfig 8 +.Cm create +command for each interface by setting the +.Va create_args_ Ns Aq Ar interface +variable. +Entries in +.Va cloned_interfaces +are automatically appended to +.Va network_interfaces +for configuration. +.It Va fec_interfaces +.Pq Vt str +Set to the list of +.Xr ng_fec 4 +Fast EtherChannel interfaces to configure on this host. +A +.Va fecconfig_ Ns Aq Ar interface +variable is assumed to exist for each value of +.Ar interface . +The value of this variable is used to configure link aggregated interfaces +according to the syntax of the +.Cm NGM_FEC_ADD_IFACE +to +.Xr ngctl 8 +msg. +Additionally, this option ensures that each listed interface is created +via the +.Cm mkpeer +command to +.Xr ngctl 8 +before attempting to configure it. +For example: +.Bd -literal +fec_interfaces="fec0" +fecconfig_fec0="em0 em1" +ifconfig_fec0="DHCP" +.Ed +.It Va gif_interfaces +.Pq Vt str +Set to the list of +.Xr gif 4 +tunnel interfaces to configure on this host. +A +.Va gifconfig_ Ns Aq Ar interface +variable is assumed to exist for each value of +.Ar interface . +The value of this variable is used to configure the link layer of the +tunnel according to the syntax of the +.Cm tunnel +option to +.Xr ifconfig 8 . +Additionally, this option ensures that each listed interface is created +via the +.Cm create +option to +.Xr ifconfig 8 +before attempting to configure it. +.It Va sppp_interfaces +.Pq Vt str +Set to the list of +.Xr sppp 4 +interfaces to configure on this host. +A +.Va spppconfig_ Ns Aq Ar interface +variable is assumed to exist for each value of +.Ar interface . +Each interface should also be configured by a general +.Va ifconfig_ Ns Aq Ar interface +setting. +Refer to +.Xr spppcontrol 8 +for more information about available options. +.It Va ppp_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr ppp 8 +daemon. +.It Va ppp_profile +.Pq Vt str +The name of the profile to use from +.Pa /etc/ppp/ppp.conf . +Also used for per-profile overrides of +.Va ppp_mode +and +.Va ppp_nat , +and +.Va ppp_ Ns Ao Ar profile Ac Ns _unit . +When the profile name contains any of the characters +.Dq Li .-/+ +they are translated to +.Dq Li _ +for the proposes of the override variable names. +.It Va ppp_mode +.Pq Vt str +Mode in which to run the +.Xr ppp 8 +daemon. +.It Va ppp_ Ns Ao Ar profile Ac Ns _mode +.Pq Vt str +Overrides the global +.Va ppp_mode +for +.Ar profile . +Accepted modes are +.Dq Li auto , +.Dq Li ddial , +.Dq Li direct +and +.Dq Li dedicated . +See the manual for a full description. +.It Va ppp_nat +.Pq Vt bool +If set to +.Dq Li YES , +enables network address translation. +Used in conjunction with +.Va gateway_enable +allows hosts on private network addresses access to the Internet using +this host as a network address translating router. +.It Va ppp_ Ns Ao Ar profile Ac Ns _nat +.Pq Vt str +Overrides the global +.Va ppp_nat +for +.Ar profile . +.It Va ppp_ Ns Ao Ar profile Ac Ns _unit +.Pq Vt int +Set the unit number to be used for this profile. +See the manual description of +.Fl unit Ns Ar N +for details. +.It Va ppp_user +.Pq Vt str +The name of the user under which +.Xr ppp 8 +should be started. +By +default, +.Xr ppp 8 +is started as +.Dq Li root . +.It Va rc_conf_files +.Pq Vt str +This option is used to specify a list of files that will override +the settings in +.Pa /etc/defaults/rc.conf . +The files will be read in the order in which they are specified and should +include the full path to the file. +By default, the files specified are +.Pa /etc/rc.conf +and +.Pa /etc/rc.conf.local +.It Va zfs_enable +.Pq Vt bool +If set to +.Dq Li YES , +.Pa /etc/rc.d/zfs +will attempt to automatically mount ZFS file systems and initialize ZFS volumes +(ZVOLs). +.It Va gbde_autoattach_all +.Pq Vt bool +If set to +.Dq Li YES , +.Pa /etc/rc.d/gbde +will attempt to automatically initialize your .bde devices in +.Pa /etc/fstab . +.It Va gbde_devices +.Pq Vt str +List the devices that the script should try to attach, +or +.Dq Li AUTO . +.It Va gbde_lockdir +.Pq Vt str +The directory where the +.Xr gbde 4 +lockfiles are located. +The default lockfile directory is +.Pa /etc . +.Pp +The lockfile for each individual +.Xr gbde 4 +device can be overridden by setting the variable +.Va gbde_lock_ Ns Aq Ar device , +where +.Ar device +is the encrypted device without the +.Dq Pa /dev/ +and +.Dq Pa .bde +parts. +.It Va gbde_attach_attempts +.Pq Vt int +Number of times to attempt attaching to a +.Xr gbde 4 +device, i.e., how many times the user is asked for the pass-phrase. +Default is 3. +.It Va geli_devices +.Pq Vt str +List of devices to automatically attach on boot. +Note that .eli devices from +.Pa /etc/fstab +are automatically appended to this list. +.It Va geli_tries +.Pq Vt int +Number of times user is asked for the pass-phrase. +If empty, it will be taken from +.Va kern.geom.eli.tries +sysctl variable. +.It Va geli_default_flags +.Pq Vt str +Default flags to use by +.Xr geli 8 +when configuring disk encryption. +Flags can be configured for every device separately by defining +.Va geli_ Ns Ao Ar device Ac Ns Va _flags +variable. +.It Va geli_autodetach +.Pq Vt str +Specifies if GELI devices should be marked for detach on last close after +file systems are mounted. +Default is +.Dq Li YES . +This can be changed for every device separately by defining +.Va geli_ Ns Ao Ar device Ac Ns Va _autodetach +variable. +.It Va geli_swap_flags +Options passed to the +.Xr geli 8 +utility when encrypted GEOM providers for swap partitions are created. +The default is +.Dq Li "-e aes -l 256 -s 4096 -d" . +.It Va root_rw_mount +.Pq Vt bool +Set to +.Dq Li YES +by default. +After the file systems are checked at boot time, the root file system +is remounted as read-write if this is set to +.Dq Li YES . +Diskless systems that mount their root file system from a read-only remote +NFS share should set this to +.Dq Li NO +in their +.Pa rc.conf . +.It Va fsck_y_enable +.Pq Vt bool +If set to +.Dq Li YES , +.Xr fsck 8 +will be run with the +.Fl y +flag if the initial preen +of the file systems fails. +.It Va background_fsck +.Pq Vt bool +If set to +.Dq Li YES , +the system will attempt to run +.Xr fsck 8 +in the background where possible. +.It Va background_fsck_delay +.Pq Vt int +The amount of time in seconds to sleep before starting a background +.Xr fsck 8 . +It defaults to sixty seconds to allow large applications such as +the X server to start before disk I/O bandwidth is monopolized by +.Xr fsck 8 . +If set to a negative number, the background file system check will be +delayed indefinitely to allow the administrator to run it at a more +convenient time. +For example it may be run from +.Xr cron 8 +by adding a line like +.Pp +.Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart" +.Pp +to +.Pa /etc/crontab . +.It Va netfs_types +.Pq Vt str +List of file system types that are network-based. +This list should generally not be modified by end users. +Use +.Va extra_netfs_types +instead. +.It Va extra_netfs_types +.Pq Vt str +If set to something other than +.Dq Li NO +(the default), +this variable extends the list of file system types +for which automatic mounting at startup by +.Xr rc 8 +should be delayed until the network is initialized. +It should contain +a whitespace-separated list of network file system descriptor pairs, +each consisting of a file system type as passed to +.Xr mount 8 +and a human-readable, one-word description, +joined with a colon +.Pq Ql \&: . +Extending the default list in this way is only necessary +when third party file system types are used. +.It Va syslogd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr syslogd 8 +daemon. +.It Va syslogd_program +.Pq Vt str +Path to +.Xr syslogd 8 +(default +.Pa /usr/sbin/syslogd ) . +.It Va syslogd_flags +.Pq Vt str +If +.Va syslogd_enable +is set to +.Dq Li YES , +these are the flags to pass to +.Xr syslogd 8 . +.It Va inetd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr inetd 8 +daemon. +.It Va inetd_program +.Pq Vt str +Path to +.Xr inetd 8 +(default +.Pa /usr/sbin/inetd ) . +.It Va inetd_flags +.Pq Vt str +If +.Va inetd_enable +is set to +.Dq Li YES , +these are the flags to pass to +.Xr inetd 8 . +.It Va hastd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr hastd 8 +daemon. +.It Va hastd_program +.Pq Vt str +Path to +.Xr hastd 8 +(default +.Pa /sbin/hastd ) . +.It Va hastd_flags +.Pq Vt str +If +.Va hastd_enable +is set to +.Dq Li YES , +these are the flags to pass to +.Xr hastd 8 . +.It Va named_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr named 8 +daemon. +.It Va named_program +.Pq Vt str +Path to +.Xr named 8 +(default +.Pa /usr/sbin/named ) . +.It Va named_conf +.Pq Vt str +Path to +.Xr named 8 +configuration file, (default +.Pa /etc/namedb/named.conf ) . +.It Va named_flags +.Pq Vt str +If +.Va named_enable +is set to +.Dq Li YES , +these are the flags to pass to +.Xr named 8 . +.It Va named_pidfile +.Pq Vt str +This is the default path to the +.Xr named 8 +daemon's PID file. +This must match the location in +.Xr named.conf 5 . +.It Va named_uid +.Pq Vt str +The user that the +.Xr named 8 +process should be run as. +.It Va named_chrootdir +.Pq Vt str +The root directory for a name server run in a +.Xr chroot 8 +environment (default +.Pa /var/named ) . +If left empty +.Xr named 8 +will not be run in a +.Xr chroot 8 +environment. +.It Va named_chroot_autoupdate +.Pq Vt bool +Set to +.Dq Li NO +to disable automatic update of the +.Xr chroot 8 +environment. +.It Va named_symlink_enable +.Pq Vt bool +Set to +.Dq Li NO +to disable symlinking of +daemon's PID file +into the +.Xr chroot 8 +environment. +.It Va named_wait +.Pq Vt bool +Set to have +.Pa /etc/rc.d/named +loop until working name service is established. +.It Va named_wait_host +.Pq Vt str +Name of host to lookup for the named_wait option. +(Default localhost) +.It Va named_auto_forward +.Pq Vt bool +Set to enable automatic creation of a forwarder +configuration file derived from +.Pa /etc/resolv.conf . +.It Va named_auto_forward_only +.Pq Vt bool +Set to change the default forwarder configuration from +.Dq forward first +to +.Dq forward only . +.It Va kerberos5_server_enable +.Pq Vt bool +Set to +.Dq Li YES +to start a Kerberos 5 authentication server +at boot time. +.It Va kerberos5_server +.Pq Vt str +If +.Va kerberos5_server_enable +is set to +.Dq Li YES +this is the path to Kerberos 5 Authentication Server. +.It Va kerberos5_server_flags +.Pq Vt str +Empty by default. +This variable contains additional flags to be passed to the Kerberos 5 +authentication server. +.It Va kadmind5_server_enable +.Pq Vt bool +Set to +.Dq Li YES +to start +.Xr kadmind 8 , +the Kerberos 5 Administration Daemon; set to +.Dq Li NO +on a slave server. +.It Va kadmind5_server +.Pq Vt str +If +.Va kadmind5_server_enable +is set to +.Dq Li YES +this is the path to Kerberos 5 Administration Daemon. +.It Va kpasswdd_server_enable +.Pq Vt bool +Set to +.Dq Li YES +to start +.Xr kpasswdd 8 , +the Kerberos 5 Password-Changing Daemon; set to +.Dq Li NO +on a slave server. +.It Va kpasswdd_server +.Pq Vt str +If +.Va kpasswdd_server_enable +is set to +.Dq Li YES +this is the path to Kerberos 5 Password-Changing Daemon. +.It Va rwhod_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr rwhod 8 +daemon at boot time. +.It Va rwhod_flags +.Pq Vt str +If +.Va rwhod_enable +is set to +.Dq Li YES , +these are the flags to pass to it. +.It Va amd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr amd 8 +daemon at boot time. +.It Va amd_flags +.Pq Vt str +If +.Va amd_enable +is set to +.Dq Li YES , +these are the flags to pass to it. +See the +.Xr amd 8 +manpage for more information. +.It Va amd_map_program +.Pq Vt str +If set, +the specified program is run to get the list of +.Xr amd 8 +maps. +For example, if the +.Xr amd 8 +maps are stored in NIS, one can set this to +run +.Xr ypcat 1 +to get a list of +.Xr amd 8 +maps from the +.Pa amd.master +NIS map. +.It Va update_motd +.Pq Vt bool +If set to +.Dq Li YES , +.Pa /etc/motd +will be updated at boot time to reflect the kernel release +being run. +If set to +.Dq Li NO , +.Pa /etc/motd +will not be updated. +.It Va nfs_client_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the NFS client daemons at boot time. +.It Va nfs_access_cache +.Pq Vt int +If +.Va nfs_client_enable +is set to +.Dq Li YES , +this can be set to +.Dq Li 0 +to disable NFS ACCESS RPC caching, or to the number of seconds for which +NFS ACCESS +results should be cached. +A value of 2-10 seconds will substantially reduce network +traffic for many NFS operations. +.It Va nfs_server_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the NFS server daemons at boot time. +.It Va nfs_server_flags +.Pq Vt str +If +.Va nfs_server_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr nfsd 8 +daemon. +.It Va idmapd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the ID mapping daemon for NFS version 4. +.It Va idmapd_flags +.Pq Vt str +If +.Va idmapd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr idmapd 8 +daemon. +.It Va mountd_enable +.Pq Vt bool +If set to +.Dq Li YES , +and no +.Va nfs_server_enable +is set, start +.Xr mountd 8 , +but not +.Xr nfsd 8 +daemon. +It is commonly needed to run CFS without real NFS used. +.It Va mountd_flags +.Pq Vt str +If +.Va mountd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr mountd 8 +daemon. +.It Va weak_mountd_authentication +.Pq Vt bool +If set to +.Dq Li YES , +allow services like PCNFSD to make non-privileged mount +requests. +.It Va nfs_reserved_port_only +.Pq Vt bool +If set to +.Dq Li YES , +provide NFS services only on a secure port. +.It Va nfs_bufpackets +.Pq Vt int +If set to a number, indicates the number of packets worth of +socket buffer space to reserve on an NFS client. +The kernel default is typically 4. +Using a higher number may be +useful on gigabit networks to improve performance. +The minimum value is +2 and the maximum is 64. +.It Va rpc_lockd_enable +.Pq Vt bool +If set to +.Dq Li YES +and also an NFS server or client, run +.Xr rpc.lockd 8 +at boot time. +.It Va rpc_lockd_flags +.Pq Vt str +If +.Va rpc_lockd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr rpc.lockd 8 +daemon. +.It Va rpc_statd_enable +.Pq Vt bool +If set to +.Dq Li YES +and also an NFS server or client, run +.Xr rpc.statd 8 +at boot time. +.It Va rpc_statd_flags +.Pq Vt str +If +.Va rpc_statd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr rpc.statd 8 +daemon. +.It Va rpcbind_program +.Pq Vt str +Path to +.Xr rpcbind 8 +(default +.Pa /usr/sbin/rpcbind ) . +.It Va rpcbind_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr rpcbind 8 +service at boot time. +.It Va rpcbind_flags +.Pq Vt str +If +.Va rpcbind_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr rpcbind 8 +daemon. +.It Va keyserv_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr keyserv 8 +daemon on boot for running Secure RPC. +.It Va keyserv_flags +.Pq Vt str +If +.Va keyserv_enable +is set to +.Dq Li YES , +these are the flags to pass to +.Xr keyserv 8 +daemon. +.It Va pppoed_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr pppoed 8 +daemon at boot time to provide PPP over Ethernet services. +.It Va pppoed_ Ns Aq Ar provider +.Pq Vt str +.Xr pppoed 8 +listens to requests to this +.Ar provider +and ultimately runs +.Xr ppp 8 +with a +.Ar system +argument of the same name. +.It Va pppoed_flags +.Pq Vt str +Additional flags to pass to +.Xr pppoed 8 . +.It Va pppoed_interface +.Pq Vt str +The network interface to run +.Xr pppoed 8 +on. +This is mandatory when +.Va pppoed_enable +is set to +.Dq Li YES . +.It Va timed_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr timed 8 +service at boot time. +This command is intended for networks of +machines where a consistent +.Dq "network time" +for all hosts must be established. +This is often useful in large NFS +environments where time stamps on files are expected to be consistent +network-wide. +.It Va timed_flags +.Pq Vt str +If +.Va timed_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr timed 8 +service. +.It Va ntpdate_enable +.Pq Vt bool +If set to +.Dq Li YES , +run +.Xr ntpdate 8 +at system startup. +This command is intended to +synchronize the system clock only +.Em once +from some standard reference. +An option to set this up initially +(from a list of known servers) is also provided by the +.Xr sysinstall 8 +program when the system is first installed. +.It Va ntpdate_config +.Pq Vt str +Configuration file for +.Xr ntpdate 8 . +Default +.Pa /etc/ntp.conf . +.It Va ntpdate_hosts +.Pq Vt str +A whitespace-separated list of NTP servers to synchronize with at startup. +The default is to use the servers listed in +.Va ntpdate_config , +if that file exists. +.It Va ntpdate_program +.Pq Vt str +Path to +.Xr ntpdate 8 +(default +.Pa /usr/sbin/ntpdate ) . +.It Va ntpdate_flags +.Pq Vt str +If +.Va ntpdate_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr ntpdate 8 +command (typically a hostname). +.It Va ntpd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr ntpd 8 +command at boot time. +.It Va ntpd_program +.Pq Vt str +Path to +.Xr ntpd 8 +(default +.Pa /usr/sbin/ntpd ) . +.It Va ntpd_config +.Pq Vt str +Path to +.Xr ntpd 8 +configuration file. +Default +.Pa /etc/ntp.conf . +.It Va ntpd_flags +.Pq Vt str +If +.Va ntpd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr ntpd 8 +daemon. +.It Va ntpd_sync_on_start +.Pq Vt bool +If set to +.Dq Li YES , +.Xr ntpd 8 +is run with the +.Fl g +flag, which syncs the system's clock on startup. +See +.Xr ntpd 8 +for more information regarding the +.Fl g +option. +This is a preferred alternative to using +.Xr ntpdate 8 +or specifying the +.Va ntpdate_enable +variable. +.It Va nis_client_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr ypbind 8 +service at system boot time. +.It Va nis_client_flags +.Pq Vt str +If +.Va nis_client_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr ypbind 8 +service. +.It Va nis_ypset_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr ypset 8 +daemon at system boot time. +.It Va nis_ypset_flags +.Pq Vt str +If +.Va nis_ypset_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr ypset 8 +daemon. +.It Va nis_server_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr ypserv 8 +daemon at system boot time. +.It Va nis_server_flags +.Pq Vt str +If +.Va nis_server_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr ypserv 8 +daemon. +.It Va nis_ypxfrd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr rpc.ypxfrd 8 +daemon at system boot time. +.It Va nis_ypxfrd_flags +.Pq Vt str +If +.Va nis_ypxfrd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr rpc.ypxfrd 8 +daemon. +.It Va nis_yppasswdd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr rpc.yppasswdd 8 +daemon at system boot time. +.It Va nis_yppasswdd_flags +.Pq Vt str +If +.Va nis_yppasswdd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr rpc.yppasswdd 8 +daemon. +.It Va rpc_ypupdated_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Nm rpc.ypupdated +daemon at system boot time. +.It Va bsnmpd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr bsnmpd 1 +daemon at system boot time. +Be sure to understand the security implications of running SNMP daemon +on your host. +.It Va bsnmpd_flags +.Pq Vt str +If +.Va bsnmpd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr bsnmpd 1 +daemon. +.It Va defaultrouter +.Pq Vt str +If not set to +.Dq Li NO , +create a default route to this host name or IP address +(use an IP address if this router is also required to get to the +name server!). +.It Va ipv6_defaultrouter +.Pq Vt str +The IPv6 equivalent of +.Va defaultrouter . +.It Va static_arp_pairs +.Pq Vt str +Set to the list of static ARP pairs that are to be added at system +boot time. +For each whitespace separated +.Ar element +in the value, a +.Va static_arp_ Ns Aq Ar element +variable is assumed to exist whose contents will later be passed to a +.Dq Nm arp Cm -S +operation. +For example +.Bd -literal +static_arp_pairs="gw" +static_arp_gw="192.168.1.1 00:01:02:03:04:05" +.Ed +.It Va static_routes +.Pq Vt str +Set to the list of static routes that are to be added at system +boot time. +If not set to +.Dq Li NO +then for each whitespace separated +.Ar element +in the value, a +.Va route_ Ns Aq Ar element +variable is assumed to exist +whose contents will later be passed to a +.Dq Nm route Cm add +operation. +For example: +.Bd -literal +static_routes="mcast gif0local" +route_mcast="-net 224.0.0.0/4 -iface gif0" +route_gif0local="-host 169.254.1.1 -iface lo0" +.Ed +.It Va ipv6_static_routes +.Pq Vt str +The IPv6 equivalent of +.Va static_routes . +If not set to +.Dq Li NO +then for each whitespace separated +.Ar element +in the value, a +.Va ipv6_route_ Ns Aq Ar element +variable is assumed to exist +whose contents will later be passed to a +.Dq Nm route Cm add Fl inet6 +operation. +.It Va natm_static_routes +.Pq Vt str +The +.Xr natmip 4 +equivalent of +.Va static_routes . +If not empty then for each whitespace separated +.Ar element +in the value, a +.Va route_ Ns Aq Ar element +variable is assumed to exist whose contents will later be passed to a +.Dq Nm atmconfig Cm natm Cm add +operation. +.It Va gateway_enable +.Pq Vt bool +If set to +.Dq Li YES , +configure host to act as an IP router, e.g.\& to forward packets +between interfaces. +.It Va ipv6_gateway_enable +.Pq Vt bool +The IPv6 equivalent of +.Va gateway_enable . +.It Va routed_enable +.Pq Vt bool +If set to +.Dq Li YES , +run a routing daemon of some sort, based on the +settings of +.Va routed_program +and +.Va routed_flags . +.It Va route6d_enable +.Pq Vt bool +The IPv6 equivalent of +.Va routed_enable . +If set to +.Dq Li YES , +run a routing daemon of some sort, based on the +settings of +.Va route6d_program +and +.Va route6d_flags . +.It Va routed_program +.Pq Vt str +If +.Va routed_enable +is set to +.Dq Li YES , +this is the name of the routing daemon to use. +.It Va route6d_program +.Pq Vt str +The IPv6 equivalent of +.Va routed_program . +.It Va routed_flags +.Pq Vt str +If +.Va routed_enable +is set to +.Dq Li YES , +these are the flags to pass to the routing daemon. +.It Va route6d_flags +.Pq Vt str +The IPv6 equivalent of +.Va routed_flags . +.It Va mrouted_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the multicast routing daemon, +.Xr mrouted 8 . +.It Va mroute6d_enable +.Pq Vt bool +The IPv6 equivalent of +.Va mrouted_enable . +If set to +.Dq Li YES , +run the IPv6 multicast routing daemon. +.Pp +Note that multicast routing daemons are no longer included in the +.Fx +base system, however, both +.Xr mrouted 8 +and +.Xr pim6dd 8 +may be installed from the +.Fx +Ports Collection. +.It Va mrouted_flags +.Pq Vt str +If +.Va mrouted_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr mrouted 8 +daemon. +.It Va mroute6d_flags +.Pq Vt str +The IPv6 equivalent of +.Va mrouted_flags . +If +.Va mroute6d_enable +is set to +.Dq Li YES , +these are the flags passed to the IPv6 multicast routing daemon. +.It Va mroute6d_program +.Pq Vt str +If +.Va mroute6d_enable +is set to +.Dq Li YES , +this is the path to the IPv6 multicast routing daemon. +.It Va rtadvd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr rtadvd 8 +daemon at boot time. +.Xr rtadvd 8 +will only run if +.Va ipv6_gateway_enable +is also set to +.Dq Li YES . +The +.Xr rtadvd 8 +utility sends router advertisement packets to the interfaces specified in +.Va rtadvd_interfaces +and should only be enabled with great care. +You may want to fine-tune +.Xr rtadvd.conf 5 . +.It Va rtadvd_interfaces +.Pq Vt str +If +.Va rtadvd_enable +is set to +.Dq Li YES +this is the list of interfaces to use. +.It Va ipxgateway_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable the routing of IPX traffic. +.It Va ipxrouted_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr IPXrouted 8 +daemon at system boot time. +.It Va ipxrouted_flags +.Pq Vt str +If +.Va ipxrouted_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr IPXrouted 8 +daemon. +.It Va arpproxy_all +.Pq Vt bool +If set to +.Dq Li YES , +enable global proxy ARP. +.It Va forward_sourceroute +.Pq Vt bool +If set to +.Dq Li YES +and +.Va gateway_enable +is also set to +.Dq Li YES , +source-routed packets are forwarded. +.It Va accept_sourceroute +.Pq Vt bool +If set to +.Dq Li YES , +the system will accept source-routed packets directed at it. +.It Va rarpd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr rarpd 8 +daemon at system boot time. +.It Va rarpd_flags +.Pq Vt str +If +.Va rarpd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr rarpd 8 +daemon. +.It Va bootparamd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr bootparamd 8 +daemon at system boot time. +.It Va bootparamd_flags +.Pq Vt str +If +.Va bootparamd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr bootparamd 8 +daemon. +.It Va stf_interface_ipv4addr +.Pq Vt str +If not set to +.Dq Li NO , +this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling +interface). +Specify this entry to enable the 6to4 interface. +.It Va stf_interface_ipv4plen +.Pq Vt int +Prefix length for 6to4 IPv4 addresses, to limit peer address range. +An effective value is 0-31. +.It Va stf_interface_ipv6_ifid +.Pq Vt str +IPv6 interface ID for +.Xr stf 4 . +This can be set to +.Dq Li AUTO . +.It Va stf_interface_ipv6_slaid +.Pq Vt str +IPv6 Site Level Aggregator for +.Xr stf 4 . +.It Va ipv6_faith_prefix +.Pq Vt str +If not set to +.Dq Li NO , +this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP +translator. +You also need +.Xr faithd 8 +setup. +.It Va ipv6_ipv4mapping +.Pq Vt bool +If set to +.Dq Li YES +this enables IPv4 mapped IPv6 address communication (like +.Li ::ffff:a.b.c.d ) . +.It Va atm_enable +.Pq Vt bool +Set to +.Dq Li YES +to enable the configuration of ATM interfaces at system boot time. +For all of the ATM variables described below, please refer to the +.Xr atm 8 +manual page for further details on the available command parameters. +Also refer to the files in +.Pa /usr/share/examples/atm +for more detailed configuration information. +.It Va atm_load +.Pq Vt str +This is a list of physical ATM interface drivers to load. +Typical values are +.Dq Li hfa_pci +and/or +.Dq Li hea_pci . +.It Va atm_netif_ Ns Aq Ar intf +.Pq Vt str +For the ATM physical interface +.Ar intf , +this variable defines the name prefix and count for the ATM network +interfaces to be created. +The value will be passed as the parameters of an +.Dq Nm atm Cm "set netif" Ar intf +command. +.It Va atm_sigmgr_ Ns Aq Ar intf +.Pq Vt str +For the ATM physical interface +.Ar intf , +this variable defines the ATM signalling manager to be used. +The value will be passed as the parameters of an +.Dq Nm atm Cm attach Ar intf +command. +.It Va atm_prefix_ Ns Aq Ar intf +.Pq Vt str +For the ATM physical interface +.Ar intf , +this variable defines the NSAP prefix for interfaces using a UNI signalling +manager. +If set to +.Dq Li ILMI , +the prefix will automatically be set via the +.Xr ilmid 8 +daemon. +Otherwise, the value will be passed as the parameters of an +.Dq Nm atm Cm "set prefix" Ar intf +command. +.It Va atm_macaddr_ Ns Aq Ar intf +.Pq Vt str +For the ATM physical interface +.Ar intf , +this variable defines the MAC address for interfaces using a UNI signalling +manager. +If set to +.Dq Li NO , +the hardware MAC address contained in the ATM interface card will be used. +Otherwise, the value will be passed as the parameters of an +.Dq Nm atm Cm "set mac" Ar intf +command. +.It Va atm_arpserver_ Ns Aq Ar netif +.Pq Vt str +For the ATM network interface +.Ar netif , +this variable defines the ATM address for a host which is to provide ATMARP +service. +This variable is only applicable to interfaces using a UNI signalling +manager. +If set to +.Dq Li local , +this host will become an ATMARP server. +The value will be passed as the parameters of an +.Dq Nm atm Cm "set arpserver" Ar netif +command. +.It Va atm_scsparp_ Ns Aq Ar netif +.Pq Vt bool +If set to +.Dq Li YES , +SCSP/ATMARP service for the network interface +.Ar netif +will be initiated using the +.Xr scspd 8 +and +.Xr atmarpd 8 +daemons. +This variable is only applicable if +.Va atm_arpserver_ Ns Aq Ar netif +is set to +.Dq Li local . +.It Va atm_pvcs +.Pq Vt str +Set to the list of ATM PVCs to be added at system +boot time. +For each whitespace separated +.Ar element +in the value, an +.Va atm_pvc_ Ns Aq Ar element +variable is assumed to exist. +The value of each of these variables +will be passed as the parameters of an +.Dq Nm atm Cm "add pvc" +command. +.It Va atm_arps +.Pq Vt str +Set to the list of permanent ATM ARP entries to be added +at system boot time. +For each whitespace separated +.Ar element +in the value, an +.Va atm_arp_ Ns Aq Ar element +variable is assumed to exist. +The value of each of these variables +will be passed as the parameters of an +.Dq Nm atm Cm "add arp" +command. +.It Va natm_interfaces +.Pq Vt str +Set to the list of +.Xr natm 4 +interfaces that will also be used for HARP through +.Xr harp 4 . +If this list is not empty all interfaces in the list will be brought up +with +.Xr ifconfig 8 +and +.Xr harp 4 +will be loaded. +For this to work the interface drivers must be either compiled into the +kernel or must reside on the root partition. +.It Va keybell +.Pq Vt str +The keyboard bell sound. +Set to +.Dq Li normal , +.Dq Li visual , +.Dq Li off , +or +.Dq Li NO +if the default behavior is desired. +For details, refer to the +.Xr kbdcontrol 1 +manpage. +.It Va keyboard +.Pq Vt str +If set to a non-null string, the virtual console's keyboard input is +set to this device. +.It Va keymap +.Pq Vt str +If set to +.Dq Li NO , +no keymap is installed, otherwise the value is used to install +the keymap file in +.Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd . +.It Va keyrate +.Pq Vt str +The keyboard repeat speed. +Set to +.Dq Li slow , +.Dq Li normal , +.Dq Li fast , +or +.Dq Li NO +if the default behavior is desired. +.It Va keychange +.Pq Vt str +If not set to +.Dq Li NO , +attempt to program the function keys with the value. +The value should +be a single string of the form: +.Dq Ar funkey_number new_value Op Ar funkey_number new_value ... . +.It Va cursor +.Pq Vt str +Can be set to the value of +.Dq Li normal , +.Dq Li blink , +.Dq Li destructive , +or +.Dq Li NO +to set the cursor behavior explicitly or choose the default behavior. +.It Va scrnmap +.Pq Vt str +If set to +.Dq Li NO , +no screen map is installed, otherwise the value is used to install +the screen map file in +.Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value . +.It Va font8x16 +.Pq Vt str +If set to +.Dq Li NO , +the default 8x16 font value is used for screen size requests, otherwise +the value in +.Pa /usr/share/syscons/fonts/ Ns Aq Ar value +is used. +.It Va font8x14 +.Pq Vt str +If set to +.Dq Li NO , +the default 8x14 font value is used for screen size requests, otherwise +the value in +.Pa /usr/share/syscons/fonts/ Ns Aq Ar value +is used. +.It Va font8x8 +.Pq Vt str +If set to +.Dq Li NO , +the default 8x8 font value is used for screen size requests, otherwise +the value in +.Pa /usr/share/syscons/fonts/ Ns Aq Ar value +is used. +.It Va blanktime +.Pq Vt int +If set to +.Dq Li NO , +the default screen blanking interval is used, otherwise it is set +to +.Ar value +seconds. +.It Va saver +.Pq Vt str +If not set to +.Dq Li NO , +this is the actual screen saver to use +.Li ( blank , snake , daemon , +etc). +.It Va moused_nondefault_enable +.Pq Vt str +If set to +.Dq Li NO , +the mouse device specified on +the command line is not automatically treated as enabled by the +.Pa /etc/rc.d/moused +script. +Having this variable set to +.Dq Li YES +allows a +.Xr usb 4 +mouse, +for example, +to be enabled as soon as it is plugged in. +.It Va moused_enable +.Pq Vt str +If set to +.Dq Li YES , +the +.Xr moused 8 +daemon is started for doing cut/paste selection on the console. +.It Va moused_type +.Pq Vt str +This is the protocol type of the mouse connected to this host. +This variable must be set if +.Va moused_enable +is set to +.Dq Li YES . +The +.Xr moused 8 +daemon +is able to detect the appropriate mouse type automatically in many cases. +Set this variable to +.Dq Li auto +to let the daemon detect it, or +select one from the following list if the automatic detection fails. +.Pp +If the mouse is attached to the PS/2 mouse port, choose +.Dq Li auto +or +.Dq Li ps/2 , +regardless of the brand and model of the mouse. +Likewise, if the +mouse is attached to the bus mouse port, choose +.Dq Li auto +or +.Dq Li busmouse . +All other protocols are for serial mice and will not work with +the PS/2 and bus mice. +If this is a USB mouse, +.Dq Li auto +is the only protocol type which will work. +.Pp +.Bl -tag -width ".Li x10mouseremote" -compact +.It Li microsoft +Microsoft mouse (serial) +.It Li intellimouse +Microsoft IntelliMouse (serial) +.It Li mousesystems +Mouse systems Corp.\& mouse (serial) +.It Li mmseries +MM Series mouse (serial) +.It Li logitech +Logitech mouse (serial) +.It Li busmouse +A bus mouse +.It Li mouseman +Logitech MouseMan and TrackMan (serial) +.It Li glidepoint +ALPS GlidePoint (serial) +.It Li thinkingmouse +Kensington ThinkingMouse (serial) +.It Li ps/2 +PS/2 mouse +.It Li mmhittab +MM HitTablet (serial) +.It Li x10mouseremote +X10 MouseRemote (serial) +.It Li versapad +Interlink VersaPad (serial) +.El +.Pp +Even if the mouse is not in the above list, it may be compatible +with one in the list. +Refer to the manual page for +.Xr moused 8 +for compatibility information. +.Pp +It should also be noted that while this is enabled, any +other client of the mouse (such as an X server) should access +the mouse through the virtual mouse device, +.Pa /dev/sysmouse , +and configure it as a +.Dq Li sysmouse +type mouse, since all +mouse data is converted to this single canonical format when +using +.Xr moused 8 . +If the client program does not support the +.Dq Li sysmouse +type, +specify the +.Dq Li mousesystems +type. +It is the second preferred type. +.It Va moused_port +.Pq Vt str +If +.Va moused_enable +is set to +.Dq Li YES , +this is the actual port the mouse is on. +It might be +.Pa /dev/cuad0 +for a COM1 serial mouse, +.Pa /dev/psm0 +for a PS/2 mouse or +.Pa /dev/mse0 +for a bus mouse, for example. +.It Va moused_flags +.Pq Vt str +If +.Va moused_flags +is set, its value is used as an additional set of flags to pass to the +.Xr moused 8 +daemon. +.It Va "moused_" Ns Ar XXX Ns Va "_flags" +When +.Va moused_nondefault_enable +is enabled, and a +.Xr moused 8 +daemon is started for a non-default port, the +.Va "moused_" Ns Ar XXX Ns Va "_flags" +set of options has precedence over and replaces the default +.Va moused_flags (where +.Ar XXX +is the name of the non-default port, i.e.\& +.Ar ums0 ) . +By setting +.Va "moused_" Ns Ar XXX Ns Va "_flags" +it is possible to set up a different set of default flags for each +.Xr moused 8 +instance. +For example, you can use +.Dq Li "-3" +for the default +.Va moused_flags +to make your laptop's touchpad more comfortable to use, +but an empty set of options for +.Va moused_ums0_flags +when your +.Xr usb 4 +mouse has three or more buttons. +.It Va mousechar_start +.Pq Vt int +If set to +.Dq Li NO , +the default mouse cursor character range +.Li 0xd0 Ns - Ns Li 0xd3 +is used, +otherwise the range start is set +to +.Ar value +character, see +.Xr vidcontrol 1 . +Use if the default range is occupied in the language code table. +.It Va allscreens_flags +.Pq Vt str +If set, +.Xr vidcontrol 1 +is run with these options for each of the virtual terminals +.Pq Pa /dev/ttyv* . +For example, +.Dq Fl m Cm on +will enable the mouse pointer on all virtual terminals +if +.Va moused_enable +is set to +.Dq Li YES . +.It Va allscreens_kbdflags +.Pq Vt str +If set, +.Xr kbdcontrol 1 +is run with these options for each of the virtual terminals +.Pq Pa /dev/ttyv* . +For example, +.Dq Fl h Li 200 +will set the +.Xr syscons 4 +scrollback (history) buffer to 200 lines. +.It Va cron_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr cron 8 +daemon at system boot time. +.It Va cron_program +.Pq Vt str +Path to +.Xr cron 8 +(default +.Pa /usr/sbin/cron ) . +.It Va cron_flags +.Pq Vt str +If +.Va cron_enable +is set to +.Dq Li YES , +these are the flags to pass to +.Xr cron 8 . +.It Va cron_dst +.Pq Vt bool +If set to +.Dq Li YES , +enable the special handling of transitions to and from the +Daylight Saving Time in +.Xr cron 8 +(equivalent to using the flag +.Fl s ) . +.It Va lpd_program +.Pq Vt str +Path to +.Xr lpd 8 +(default +.Pa /usr/sbin/lpd ) . +.It Va lpd_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr lpd 8 +daemon at system boot time. +.It Va lpd_flags +.Pq Vt str +If +.Va lpd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr lpd 8 +daemon. +.It Va chkprintcap_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr chkprintcap 8 +command before starting the +.Xr lpd 8 +daemon. +.It Va chkprintcap_flags +.Pq Vt str +If +.Va lpd_enable +and +.Va chkprintcap_enable +are set to +.Dq Li YES , +these are the flags to pass to the +.Xr chkprintcap 8 +program. +The default is +.Dq Li -d , +which causes missing directories to be created. +.It Va mta_start_script +.Pq Vt str +This variable specifies the full path to the script to run to start +a mail transfer agent. +The default is +.Pa /etc/rc.sendmail . +The +.Va sendmail_* +variables which +.Pa /etc/rc.sendmail +uses are documented in the +.Xr rc.sendmail 8 +manual page. +.It Va dumpdev +.Pq Vt str +Indicates the device (usually a swap partition) to which a crash dump +should be written in the event of a system crash. +If the value of this variable is +.Dq Li AUTO , +the first suitable swap device listed in +.Pa /etc/fstab +will be used as dump device. +Otherwise, the value of this variable is passed as the argument to +.Xr dumpon 8 . +To disable crash dumps, set this variable to +.Dq Li NO . +.It Va dumpdir +.Pq Vt str +When the system reboots after a crash and a crash dump is found on the +device specified by the +.Va dumpdev +variable, +.Xr savecore 8 +will save that crash dump and a copy of the kernel to the directory +specified by the +.Va dumpdir +variable. +The default value is +.Pa /var/crash . +Set to +.Dq Li NO +to not run +.Xr savecore 8 +at boot time when +.Va dumpdir +is set. +.It Va savecore_flags +.Pq Vt str +If crash dumps are enabled, these are the flags to pass to the +.Xr savecore 8 +utility. +.It Va quota_enable +.Pq Vt bool +Set to +.Dq Li YES +to turn on user and group disk quotas on system startup via the +.Xr quotaon 8 +command for all file systems marked as having quotas enabled in +.Pa /etc/fstab . +The kernel must be built with +.Cd "options QUOTA" +for disk quotas to function. +.It Va check_quotas +.Pq Vt bool +Set to +.Dq Li YES +to enable user and group disk quota checking via the +.Xr quotacheck 8 +command. +.It Va quotacheck_flags +.Pq Vt str +If +.Va quota_enable +is set to +.Dq Li YES , +and +.Va check_quotas +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr quotacheck 8 +utility. +The default is +.Dq Li "-a" , +which checks quotas for all file systems with quotas enabled in +.Pa /etc/fstab . +.It Va quotaon_flags +.Pq Vt str +If +.Va quota_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr quotaon 8 +utility. +The default is +.Dq Li "-a" , +which enables quotas for all file systems with quotas enabled in +.Pa /etc/fstab . +.It Va quotaoff_flags +.Pq Vt str +If +.Va quota_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr quotaoff 8 +utility when shutting down the quota system. +The default is +.Dq Li "-a" , +which disables quotas for all file systems with quotas enabled in +.Pa /etc/fstab . +.It Va accounting_enable +.Pq Vt bool +Set to +.Dq Li YES +to enable system accounting through the +.Xr accton 8 +facility. +.It Va ibcs2_enable +.Pq Vt bool +Set to +.Dq Li YES +to enable iBCS2 (SCO) binary emulation at system initial boot +time. +.It Va ibcs2_loaders +.Pq Vt str +If not set to +.Dq Li NO +and if +.Va ibcs2_enable +is set to +.Dq Li YES , +this specifies a list of additional iBCS2 loaders to enable. +.It Va linux_enable +.Pq Vt bool +Set to +.Dq Li YES +to enable Linux/ELF binary emulation at system initial +boot time. +.It Va svr4_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable SysVR4 emulation at boot time. +.It Va sysvipc_enable +.Pq Vt bool +If set to +.Dq Li YES , +load System V IPC primitives at boot time. +.It Va clear_tmp_enable +.Pq Vt bool +Set to +.Dq Li YES +to have +.Pa /tmp +cleaned at startup. +.It Va clear_tmp_X +.Pq Vt bool +Set to +.Dq Li NO +to disable removing of X11 lock files, +and the removal and (secure) recreation +of the various socket directories for X11 +related programs. +.It Va ldconfig_paths +.Pq Vt str +Set to the list of shared library paths to use with +.Xr ldconfig 8 . +NOTE: +.Pa /usr/lib +will always be added first, so it need not appear in this list. +.It Va ldconfig32_paths +.Pq Vt str +Set to the list of 32-bit compatibility shared library paths to +use with +.Xr ldconfig 8 . +.It Va ldconfig_paths_aout +.Pq Vt str +Set to the list of shared library paths to use with +.Xr ldconfig 8 +legacy +.Xr a.out 5 +support. +.It Va ldconfig_insecure +.Pq Vt bool +The +.Xr ldconfig 8 +utility normally refuses to use directories +which are writable by anyone except root. +Set this variable to +.Dq Li YES +to disable that security check during system startup. +.It Va ldconfig_local_dirs +.Pq Vt str +Set to the list of local +.Xr ldconfig 8 +directories. +The names of all files in the directories listed will be +passed as arguments to +.Xr ldconfig 8 . +.It Va ldconfig_local32_dirs +.Pq Vt str +Set to the list of local 32-bit compatibility +.Xr ldconfig 8 +directories. +The names of all files in the directories listed will be +passed as arguments to +.Dq Nm ldconfig Fl 32 . +.It Va kern_securelevel_enable +.Pq Vt bool +Set to +.Dq Li YES +to set the kernel security level at system startup. +.It Va kern_securelevel +.Pq Vt int +The kernel security level to set at startup. +The allowed range of +.Ar value +ranges from \-1 (the compile time default) to 3 (the +most secure). +See +.Xr security 7 +for the list of possible security levels and their effect +on system operation. +.It Va sshd_program +.Pq Vt str +Path to the SSH server program +.Pa ( /usr/sbin/sshd +is the default). +.It Va sshd_enable +.Pq Vt bool +Set to +.Dq Li YES +to start +.Xr sshd 8 +at system boot time. +.It Va sshd_flags +.Pq Vt str +If +.Va sshd_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr sshd 8 +daemon. +.It Va ftpd_program +.Pq Vt str +Path to the FTP server program +.Pa ( /usr/libexec/ftpd +is the default). +.It Va ftpd_enable +.Pq Vt bool +Set to +.Dq Li YES +to start +.Xr ftpd 8 +as a stand-alone daemon at system boot time. +.It Va ftpd_flags +.Pq Vt str +If +.Va ftpd_enable +is set to +.Dq Li YES , +these are the additional flags to pass to the +.Xr ftpd 8 +daemon. +.It Va watchdogd_enable +.Pq Vt bool +If set to +.Dq Li YES , +start the +.Xr watchdogd 8 +daemon at boot time. +This requires that the kernel have been compiled with a +.Xr watchdog 4 +compatible device. +.It Va watchdogd_flags +.Pq Vt str +If +.Va watchdogd_enable +is set to +.Dq Li YES , +these are the flags passed to the +.Xr watchdogd 8 +daemon. +.It Va performance_cx_lowest +.Pq Vt str +CPU idle state to use while on AC power. +The string +.Dq Li LOW +indicates that +.Xr acpi 4 +should use the lowest power state available while +.Dq Li HIGH +indicates that the lowest latency state (less power savings) should be used. +.It Va performance_cpu_freq +.Pq Vt str +CPU clock frequency to use while on AC power. +The string +.Dq Li LOW +indicates that +.Xr cpufreq 4 +should use the lowest frequency available while +.Dq Li HIGH +indicates that the highest frequency (less power savings) should be used. +.It Va economy_cx_lowest +.Pq Vt str +CPU idle state to use when off AC power. +The string +.Dq Li LOW +indicates that +.Xr acpi 4 +should use the lowest power state available while +.Dq Li HIGH +indicates that the lowest latency state (less power savings) should be used. +.It Va economy_cpu_freq +.Pq Vt str +CPU clock frequency to use when off AC power. +The string +.Dq Li LOW +indicates that +.Xr cpufreq 4 +should use the lowest frequency available while +.Dq Li HIGH +indicates that the highest frequency (less power savings) should be used. +.It Va jail_enable +.Pq Vt bool +If set to +.Dq Li NO , +any configured jails will not be started. +.It jail_parallel_start +.Pq Vt bool +If set to +.Dq Li YES +all configured jails will be started in the background (= in parallel). +.It Va jail_list +.Pq Vt str +A space separated list of names for jails. +This is purely a configuration aid to help identify and +configure multiple jails. +The names specified in this list will be used to +identify settings common to an instance of a jail. +Assuming that the jail in question was named +.Li vjail , +you would have the following dependent variables: +.Bd -literal +jail_vjail_hostname="jail.example.com" +jail_vjail_ip="192.0.2.100" +jail_vjail_rootdir="/var/jails/vjail/root" +.Ed +.Pp +.It Va jail_flags +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _flags +for every jail in +.Va jail_list . +.It Va jail_interface +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _interface +for every jail in +.Va jail_list . +.It Va jail_fstab +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _fstab +for every jail in +.Va jail_list . +.It Va jail_mount_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +When set to +.Dq Li YES , +sets +.Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable +to +.Dq Li YES +by default for every jail in +.Va jail_list . +.It Va jail_devfs_ruleset +.Pq Vt str +Unset by default. +When set, sets +.Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset +to given value for every jail in +.Va jail_list . +.It Va jail_devfs_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +When set to +.Dq Li YES , +sets +.Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable +to +.Dq Li YES +by default for every jail in +.Va jail_list . +.It Va jail_fdescfs_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +When set to +.Dq Li YES , +sets +.Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable +to +.Dq Li YES +by default for every jail in +.Va jail_list . +.It Va jail_procfs_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +When set to +.Dq Li YES , +sets +.Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable +to +.Dq Li YES +by default for every jail in +.Va jail_list . +.It Va jail_exec_prestart Ns Aq Ar N +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N +for every jail in +.Va jail_list . +.It Va jail_exec_start +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start +for every jail in +.Va jail_list . +.It Va jail_exec_afterstart Ns Aq Ar N +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N +for every jail in +.Va jail_list . +.It Va jail_exec_poststart Ns Aq Ar N +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N +for every jail in +.Va jail_list . +.It Va jail_exec_prestop Ns Aq Ar N +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N +for every jail in +.Va jail_list . +.It Va jail_exec_stop +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop +for every jail in +.Va jail_list . +.It Va jail_exec_poststop Ns Aq Ar N +.Pq Vt str +Unset by default. +When set, use as default value for +.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N +for every jail in +.Va jail_list . +.It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir +.Pq Vt str +Unset by default. +Set to the root directory used by jail +.Va jname . +.It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname +.Pq Vt str +Unset by default. +Set to the fully qualified domain name (FQDN) assigned to jail +.Va jname . +.It Va jail_ Ns Ao Ar jname Ac Ns Va _ip +.Pq Vt str +Unset by default. +Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail. +The argument can be a sole address or a comma separated list of addresses. +Additionally each address can be prefixed by the name of an interface +followed by a pipe to overwrite +.Va jail_ Ns Ao Ar jname Ac Ns Va _interface +or +.Va jail_interface +and/or suffixed by a netmask, prefixlen or prefix. +In case no netmask, prefixlen or prefix is given, +.Sq /32 +will be used for IPv4 and +.Sq /128 +will be used for an IPv6 address. +If no address is given for the jail then the jail will be started with +no networking support. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n +.Pq Vt str +Unset by default. +Set additional IPv4 and/or IPv6 address(es) assigned to the jail. +The sequence starts with +.Dq Li _multi0 +and the numbers have to be strictly ascending. +These entries follow the same syntax as their primary +.Va jail_ Ns Ao Ar jname Ac Ns Va _ip +entry. +The order of the entries can be important as the first address for +each address family found will be the primary address of the jail. +See +.Va ip-addresses +option in +.Xr jail 8 +for more details. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _flags +.Pq Vt str +Set to +.Dq Li -l -U root +by default. +These are flags to pass to +.Xr jail . +.It Va jail_ Ns Ao Ar jname Ac Ns Va _interface +.Pq Vt str +Unset by default. +When set, sets the interface to use when setting IP address alias. +Note that the alias is created at jail startup and removed at jail shutdown. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _fib +.Pq Vt str +Unset by default. +When set, the jail is started with the specified forwarding table (sometimes +referred to as a routing table) via +.Xr setfib 1 . +.It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab +.Pq Vt str +Set to +.Pa /etc/fstab. Ns Aq Ar jname +by default. +This is the file system information file to use for jail +.Va jname . +.It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +When set to +.Dq Li YES , +mount all file systems from +.Va jail_ Ns Ao Ar jname Ac Ns Va _fstab +at jail startup. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset +.Pq Vt str +Unset by default. +When set, defines the device file system ruleset file to use for jail +.Va jname . +.It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +When set to +.Dq Li YES , +mount the device file system inside jail +.Ar jname +at jail startup. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +When set to +.Dq Li YES , +mount the file-descriptor file system inside jail +.Ar jname +at jail startup. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable +.Pq Vt bool +Set to +.Dq Li NO +by default. +When set to +.Dq Li YES , +mount the process file system inside jail +.Ar jname +at jail startup. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N +.Pq Vt str +Unset by default. +This is the command run as +.Ar N Ns +th command +before jail startup, where +.Ar N +is 0, 1, and so on. +It is run outside the jail. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start +.Pq Vt str +Set to +.Dq Li /bin/sh /etc/rc +by default. +This is the command executed in a jail at jail startup. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N +.Pq Vt str +Unset by default. +This is the command run as +.Ar N Ns +th command +in a jail +after jail startup, where +.Ar N +is 1, 2, and so on. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N +.Pq Vt str +Unset by default. +This is the command run as +.Ar N Ns +th command +after jail startup, where +.Ar N +is 0, 1, and so on. +It is run outside the jail. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N +.Pq Vt str +Unset by default. +This is the command run as +.Ar N Ns +th command +before jail shutdown, where +.Ar N +is 0, 1, and so on. +It is run outside the jail. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop +.Pq Vt str +Set to +.Dq Li /bin/sh /etc/rc.shutdown +by default. +This is the command executed in a jail at jail shutdown. +.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N +.Pq Vt str +Unset by default. +This is the command run as +.Ar N Ns +th command +after jail shutdown, where +.Ar N +is 0, 1, and so on. +It is run outside the jail. +.It Va jail_set_hostname_allow +.Pq Vt bool +If set to +.Dq Li NO , +do not allow the root user in a jail to set its hostname. +.It Va jail_socket_unixiproute_only +.Pq Vt bool +If set to +.Dq Li YES , +do not allow any sockets, +besides UNIX/IP/route sockets, +to be used within a jail. +.It Va jail_sysvipc_allow +.Pq Vt bool +If set to +.Dq Li YES , +allow applications within a jail to use System V IPC. +.\" ----------------------------------------------------- +.It Va harvest_interrupt +.Pq Vt bool +Set to +.Dq Li YES +to use hardware interrupts as an entropy source. +Refer to +.Xr random 4 +for more information. +.It Va harvest_ethernet +.Pq Vt bool +Set to +.Dq Li YES +to use LAN traffic as an entropy source. +Refer to +.Xr random 4 +for more information. +.It Va harvest_p_to_p +.Pq Vt bool +Set to +.Dq Li YES +to use serial line traffic as an entropy source. +Refer to +.Xr random 4 +for more information. +.It Va entropy_dir +.Pq Vt str +Set to +.Dq Li NO +to disable caching entropy via +.Xr cron 8 . +Otherwise set to the directory used to store entropy files in. +.It Va entropy_file +.Pq Vt str +Set to +.Dq Li NO +to disable caching entropy through reboots. +Otherwise set to the filename used to store cached entropy through +reboots. +This file should be located on the root file system to seed the +.Xr random 4 +device as early as possible in the boot process. +.It Va entropy_save_sz +.Pq Vt int +Size of the entropy cache files saved by +.Nm save-entropy +periodically. +.It Va entropy_save_num +.Pq Vt int +Number of entropy cache files to save by +.Nm save-entropy +periodically. +.It Va ipsec_enable +.Pq Vt bool +Set to +.Dq Li YES +to run +.Xr setkey 8 +on +.Va ipsec_file +at boot time. +.It Va ipsec_file +.Pq Vt str +Configuration file for +.Xr setkey 8 . +.It Va dmesg_enable +.Pq Vt bool +Set to +.Dq Li YES +to save +.Xr dmesg 8 +to +.Pa /var/run/dmesg.boot +on boot. +.It Va rcshutdown_timeout +.Pq Vt int +If set, start a watchdog timer in the background which will terminate +.Pa rc.shutdown +if +.Xr shutdown 8 +has not completed within the specified time (in seconds). +Notice that in addition to this soft timeout, +.Xr init 8 +also applies a hard timeout for the execution of +.Pa rc.shutdown . +This is configured via +.Xr sysctl 8 +variable +.Va kern.init_shutdown_timeout +and defaults to 120 seconds. +Setting the value of +.Va rcshutdown_timeout +to more than 120 seconds will have no effect until the +.Xr sysctl 8 +variable +.Va kern.init_shutdown_timeout +is also increased. +.It Va virecover_enable +.Pq Vt bool +Set to +.Dq Li NO +to prevent the system from trying to +recover pre-maturely terminated +.Xr vi 1 +sessions. +.It Va ugidfw_enable +.Pq Vt bool +Set to +.Dq Li YES +to load the +.Xr mac_bsdextended 4 +module upon system initialization and load a default +ruleset file. +.It Va bsdextended_script +.Pq Vt str +The default +.Xr mac_bsdextended 4 +ruleset file to load. +The default value of this variable is +.Pa /etc/rc.bsdextended . +.It Va newsyslog_enable +.Pq Vt bool +If set to +.Dq Li YES , +run +.Xr newsyslog 8 +command at startup. +.It Va newsyslog_flags +.Pq Vt str +If +.Va newsyslog_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr newsyslog 8 +program. +The default is +.Dq Li -CN , +which causes log files flagged with a +.Cm C +to be created. +.It Va mdconfig_md Ns Aq Ar X +.Pq Vt str +Arguments to +.Xr mdconfig 8 +for +.Xr md 4 +device +.Ar X . +At minimum a +.Fl t Ar type +must be specified and either a +.Fl s Ar size +for malloc or swap backed +.Xr md 4 +devices or a +.Fl f Ar file +for vnode backed +.Xr md 4 +devices. +Note that +.Va mdconfig_md Ns Aq Ar X +variables are evaluated until one variable is unset or null. +.It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs +.Pq Vt str +Optional arguments passed to +.Xr newfs 8 +to initialize +.Xr md 4 +device +.Ar X . +.It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner +.Pq Vt str +An ownership specification passed to +.Xr chown 8 +after the specified +.Xr md 4 +device +.Ar X +has been mounted. +Both the +.Xr md 4 +device and the mount point will be changed. +.It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms +.Pq Vt str +A mode string passed to +.Xr chmod 1 +after the specified +.Xr md 4 +device +.Ar X +has been mounted. +Both the +.Xr md 4 +device and the mount point will be changed. +.It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files +.Pq Vt str +Files to be copied to the mount point of the +.Xr md 4 +device +.Ar X +after it has been mounted. +.It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd +.Pq Vt str +Command to execute after the specified +.Xr md 4 +device +.Ar X +has been mounted. +Note that the command is passed to +.Ic eval +and that both +.Va _dev +and +.Va _mp +variables can be used to reference respectively the +.Xr md 4 +device and the mount point. +Assuming that the +.Xr md 4 +device is +.Li md0 , +one could set the following: +.Bd -literal +mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}" +.Ed +.It Va ramdisk_units +.Pq Vt str +A list of one or more ramdisk units to configure with +.Xr mdconfig 8 +and +.Xr newfs 8 +in time to be mounted from +.Xr fstab 5 . +Each listed unit +.Ar X +must specify at least a +.Ar type +in a +.Va ramdisk_ Ns Ao Ar X Ac Ns Va _config +variable. +Note that this way to configure ramdisks has been deprecated +in favor of new +.Va mdconfig_md* +variables (see above). +.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _config +.Pq Vt str +Arguments to +.Xr mdconfig 8 +for ramdisk +.Ar X . +At minimum a +.Fl t Ar type +must be specified, where +.Ar type +must be one of +.Cm malloc +or +.Cm swap . +.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _newfs +.Pq Vt str +Optional arguments passed to +.Xr newfs 8 +to initialize ramdisk +.Ar X . +.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _owner +.Pq Vt str +An ownership specification passed to +.Xr chown 8 +after the specified ramdisk unit +.Ar X +has been mounted. +Both the +.Xr md 4 +device and the mount point will be changed. +.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _perms +.Pq Vt str +A mode string passed to +.Xr chmod 1 +after the specified ramdisk unit +.Ar X +has been mounted. +Both the +.Xr md 4 +device and the mount point will be changed. +.It Va autobridge_interfaces +.Pq Vt str +Set to the list of bridge interfaces that will have newly arriving interfaces +checked against to be automatically added. +If not set to +.Dq Li NO +then for each whitespace separated +.Ar element +in the value, a +.Va autobridge_ Ns Aq Ar element +variable is assumed to exist which has a whitespace separated list of interface +names to match, these names can use wildcards. +For example: +.Bd -literal +autobridge_interfaces="bridge0" +autobridge_bridge0="tap* dc0 vlan[345]" +.Ed +.It Va mixer_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable support for sound mixer. +.It Va hcsecd_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable Bluetooth security daemon. +.It Va hcsecd_config +.Pq Vt str +Configuration file for +.Xr hcsecd 8 . +Default +.Pa /etc/bluetooth/hcsecd.conf . +.It Va sdpd_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable Bluetooth Service Discovery Protocol daemon. +.It Va sdpd_control +.Pq Vt str +Path to +.Xr sdpd 8 +control socket. +Default +.Pa /var/run/sdp . +.It Va sdpd_groupname +.Pq Vt str +Sets +.Xr sdpd 8 +group to run as after it initializes. +Default +.Dq Li nobody . +.It Va sdpd_username +.Pq Vt str +Sets +.Xr sdpd 8 +user to run as after it initializes. +Default +.Dq Li nobody . +.It Va bthidd_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable Bluetooth Human Interface Device daemon. +.It Va bthidd_config +.Pq Vt str +Configuration file for +.Xr bthidd 8 . +Default +.Pa /etc/bluetooth/bthidd.conf . +.It Va bthidd_hids +.Pq Vt str +Path to a file, where +.Xr bthidd 8 +will store information about known HID devices. +Default +.Pa /var/db/bthidd.hids . +.It Va rfcomm_pppd_server_enable +.Pq Vt bool +If set to +.Dq Li YES , +enable Bluetooth RFCOMM PPP wrapper daemon. +.It Va rfcomm_pppd_server_profile +.Pq Vt str +The name of the profile to use from +.Pa /etc/ppp/ppp.conf . +Multiple profiles can be specified here. +Also used to specify per-profile overrides. +When the profile name contains any of the characters +.Dq Li .-/+ +they are translated to +.Dq Li _ +for the proposes of the override variable names. +.It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr +.Pq Vt str +Overrides local address to listen on. +By default +.Xr rfcomm_pppd 8 +will listen on +.Dq Li ANY +address. +The address can be specified as BD_ADDR or name. +.It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel +.Pq Vt str +Overrides local RFCOMM channel to listen on. +By default +.Xr rfcomm_pppd 8 +will listen on RFCOMM channel 1. +Must set properly if multiple profiles used in the same time. +.It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp +.Pq Vt bool +Tells +.Xr rfcomm_pppd 8 +if it should register Serial Port service on the speficied RFCOMM channel. +Default +.Dq Li NO . +.It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun +.Pq Vt bool +Tells +.Xr rfcomm_pppd 8 +if it should register Dial-Up Networking service on the speficied +RFCOMM channel. +Default +.Dq Li NO . +.It Va ubthidhci_enable +.Pq Vt bool +If set to +.Dq Li YES , +change the USB Bluetooth controller from HID mode to HCI mode. +You also need to specify the location of USB Bluetooth controller with the +.Va ubthidhci_busnum +and +.Va ubthidhci_addr +variables. +.It Va ubthidhci_busnum +Bus number where the USB Bluetooth controller is located. +Check the output of +.Xr usbconfig 1 +on your system to find this information. +.It Va ubthidhci_addr +Bus address of the USB Bluetooth controller. +Check the output of +.Xr usbconfig 1 +on your system to find this information. +.El +.Sh FILES +.Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact +.It Pa /etc/defaults/rc.conf +.It Pa /etc/rc.conf +.It Pa /etc/rc.conf.local +.El +.Sh SEE ALSO +.Xr catman 1 , +.Xr chmod 1 , +.Xr gdb 1 , +.Xr info 1 , +.Xr kbdcontrol 1 , +.Xr makewhatis 1 , +.Xr sh 1 , +.Xr usbconfig 1 , +.Xr vi 1 , +.Xr vidcontrol 1 , +.Xr bridge 4 , +.Xr dummynet 4 , +.Xr ip 4 , +.Xr ipf 4 , +.Xr ipfw 4 , +.Xr ipnat 4 , +.Xr kld 4 , +.Xr pf 4 , +.Xr pflog 4 , +.Xr pfsync 4 , +.Xr tcp 4 , +.Xr udp 4 , +.Xr exports 5 , +.Xr fstab 5 , +.Xr ipf 5 , +.Xr ipnat 5 , +.Xr motd 5 , +.Xr newsyslog.conf 5 , +.Xr pf.conf 5 , +.Xr security 7 , +.Xr accton 8 , +.Xr amd 8 , +.Xr apm 8 , +.Xr atm 8 , +.Xr bthidd 8 , +.Xr chkprintcap 8 , +.Xr chown 8 , +.Xr cron 8 , +.Xr dhclient 8 , +.Xr ftpd 8 , +.Xr geli 8 , +.Xr hcsecd 8 , +.Xr ifconfig 8 , +.Xr inetd 8 , +.Xr ipf 8 , +.Xr ipfw 8 , +.Xr ipnat 8 , +.Xr jail 8 , +.Xr kldxref 8 , +.Xr lpd 8 , +.Xr mdconfig 8 , +.Xr mdmfs 8 , +.Xr mixer 8 , +.Xr mountd 8 , +.Xr moused 8 , +.Xr mrouted 8 , +.Xr named 8 , +.Xr newfs 8 , +.Xr newsyslog 8 , +.Xr nfsd 8 , +.Xr ntpd 8 , +.Xr ntpdate 8 , +.Xr pfctl 8 , +.Xr pflogd 8 , +.Xr powerd 8 , +.Xr quotacheck 8 , +.Xr quotaon 8 , +.Xr rc 8 , +.Xr rc.sendmail 8 , +.Xr rfcomm_pppd 8 , +.Xr route 8 , +.Xr routed 8 , +.Xr rpcbind 8 , +.Xr rpc.lockd 8 , +.Xr rpc.statd 8 , +.Xr rwhod 8 , +.Xr savecore 8 , +.Xr sdpd 8 , +.Xr sshd 8 , +.Xr swapon 8 , +.Xr sysctl 8 , +.Xr syslogd 8 , +.Xr timed 8 , +.Xr wlandebug 8 , +.Xr yp 8 , +.Xr ypbind 8 , +.Xr ypserv 8 , +.Xr ypset 8 +.Sh HISTORY +The +.Nm +file appeared in +.Fx 2.2.2 . +.Sh AUTHORS +.An Jordan K. Hubbard . diff --git a/share/man/man5/regdomain.5 b/share/man/man5/regdomain.5 new file mode 100644 index 0000000..495f4b7 --- /dev/null +++ b/share/man/man5/regdomain.5 @@ -0,0 +1,48 @@ +.\" Copyright (c) 2008 Sam Leffler, Errno Consulting +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.Dd April 13, 2008 +.Dt REGDOMAIN 5 +.Os +.Sh NAME +.Nm regdomain.xml +.Nd "802.11 wireless regulatory definitions" +.Sh DESCRIPTION +The +.Nm +file describes regulations for the operation of IEEE 802.11 wireless radios. +.Pp +This information is used by the +.Xr ifconfig 8 +program to construct regulatory state for download to the system. +This file should be changed only to reflect changes in regulations. +.Sh FILES +.Bl -tag -width /etc/regdomain.xml -compact +.It Pa /etc/regdomain.xml +XML database of 802.11 regulatory constraints +.El +.Sh SEE ALSO +.Xr wlan 4 , +.Xr ifconfig 8 diff --git a/share/man/man5/reiserfs.5 b/share/man/man5/reiserfs.5 new file mode 100644 index 0000000..eda7028 --- /dev/null +++ b/share/man/man5/reiserfs.5 @@ -0,0 +1,84 @@ +.\" +.\" Copyright (c) 2005 Jean-Sébastien Pédron +.\" 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. +.\" +.\" $FreeBSD$ +.\" +.Dd May 16, 2006 +.Dt REISERFS 5 +.Os +.Sh NAME +.Nm reiserfs +.Nd "Reiser file system" +.Sh SYNOPSIS +To link into the kernel: +.Bd -ragged -offset indent +.Cd "options REISERFS" +.Ed +.Pp +To load as a kernel loadable module: +.Pp +.Dl "kldload reiserfs" +.Sh DESCRIPTION +The +.Nm +driver will permit the +.Fx +kernel to access +.Tn ReiserFS +file systems. +.Sh EXAMPLES +To mount a +.Nm +volume located on +.Pa /dev/ad1s1 : +.Pp +.Dl "mount -t reiserfs /dev/ad1s1 /mnt" +.Sh SEE ALSO +.Xr nmount 2 , +.Xr unmount 2 , +.Xr fstab 5 , +.Xr mount 8 +.Sh HISTORY +The +.Nm +file system support +first appeared in +.Fx 6.0 . +.Sh AUTHORS +.An -nosplit +The ReiserFS kernel implementation was written by +.An Hans Reiser +.Pq Pa http://www.namesys.com/ , +and ported to +.Fx +by +.An Jean-S\['e]bastien P\['e]dron Aq dumbbell@FreeBSD.org . +.Pp +This manual page was written by +.An Craig Rodrigues Aq rodrigc@FreeBSD.org . +.Sh CAVEATS +Currently, only read-only access is supported for ReiserFS volumes, +writing to a volume is not supported. diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5 new file mode 100644 index 0000000..666608d --- /dev/null +++ b/share/man/man5/remote.5 @@ -0,0 +1,214 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd October 20, 2003 +.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 somewhat like the +.Xr termcap 5 +file. +Each line in the file provides a description for a single +.Em system . +Fields are separated by a colon (``:''). +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. +A field name followed by a `#' sign indicates a numeric value. +.Pp +Entries named ``tip*'' and ``cu*'' are used as default entries by +.Xr tip 1 , +and the +.Xr cu 1 +interface to +.Nm tip , +as follows. +When +.Nm tip +is invoked with only a phone number, it looks for an entry +of the form ``tip300'', where 300 is the data rate with +which the connection is to be made. +When the +.Nm cu +interface is used, entries of the form ``cu300'' are used. +.Sh CAPABILITIES +Capabilities are either strings (str), numbers (num), or boolean +flags (bool). +A string capability is specified by +.Em capability Ns Ar = Ns Em value ; +for example, ``dv=/dev/harris''. +A numeric capability is specified by +.Em capability Ns Ar # Ns Em value ; +for example, ``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 data rate (bits per second) used for communications on the +serial port. +When a modem is used, the data rate used to communicate +with the remote modem may be different than this rate. +This is a decimal number. +The default rate is 9600 bits per second. +.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 \&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 +.Nm tip +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 \&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 +.Nm tip +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 ``even'', +``odd'', ``none'', ``zero'' (always set bit 8 to zero), +``one'' (always set bit 8 to 1). +The default is even parity. +.It Cm \&pn +(str) +Telephone number(s) for this host. +If the telephone number field contains an @ sign, +.Nm tip +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 +.Sh FILES +.Bl -tag -width /etc/remote -compact +.It Pa /etc/remote +The +.Nm +host description file resides in +.Pa /etc . +.El +.Sh EXAMPLES +Here is a short example showing the use of the capability continuation +feature. +It defines a 56k modem connection on the first serial port at 115200 +bits per second, no parity using the Hayes command set with standard +line editing and end of file characters. +The arpavax entry includes everything in the UNIX-57600 entry plus +the phone number for arpavax (in this case an @ character so that it +is retrieved from the environment). +.Bd -literal +UNIX-57600:\e +:dv=/dev/cuad0:el=^D^U^C^S^Q^O@:oe=^D:du:at=hayes:br#115200:pa=none: +arpavax|ax:\e +:pn=\e@:tc=UNIX-57600 +.Ed +.Sh SEE ALSO +.Xr cu 1 , +.Xr tip 1 , +.Xr phones 5 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . +.Sh BUGS +The +.Xr tip 1 +utility uses its own notion of the serial ports data rate rather than the +system default for a serial port. diff --git a/share/man/man5/resolver.5 b/share/man/man5/resolver.5 new file mode 100644 index 0000000..5c196f3 --- /dev/null +++ b/share/man/man5/resolver.5 @@ -0,0 +1,223 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 8.1 (Berkeley) 6/5/93 +.\" $FreeBSD$ +.\" +.Dd September 9, 2004 +.Dt RESOLVER 5 +.Os +.Sh NAME +.Nm resolver +.Nd resolver configuration file +.Sh SYNOPSIS +.Nm resolv.conf +.Sh DESCRIPTION +The +.Xr resolver 3 +is a set of routines in the C library +which provide access to the Internet Domain Name System. +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 +Internet address (in dot notation) of a name server +that the resolver should query. +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 +.Ql \&. . +Finally, if the host name does not contain a domain part, the root +domain is assumed. +.It Sy search +Search list for host-name lookup. +The search list is normally determined from the local domain name; +by default, it contains only the local domain name. +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 256 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. +E.g., +.Pp +.Dl "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 +\fBoptions\fP \fIoption\fP \fI...\fP +.Pp +where +.Sy option +is one of the following: +.Pp +.Bl -tag -width no_tld_query +.It Sy debug +sets +.Dv RES_DEBUG +in _res.options. +.It Sy ndots: Ns Ar n +sets a threshold for the number of dots which must appear in a name given to +.Fn res_query +(see +.Xr resolver 3 ) +before an +.Em initial absolute query +will be made. +The default for +.Em n +is +.Dq 1 , +meaning that if there are any dots in a name, the name +will be tried first as an absolute name before any +.Em search list +elements are appended to it. +.It Sy timeout: Ns Ar n +sets the initial amount of time the resolver will wait +for a response from a remote +name server before retrying the query via a different name server. +The resolver may wait longer during subsequent retries +of the current query since an exponential back-off is applied to +the timeout value. +Measured in seconds, the default is +.Dv RES_TIMEOUT , +the allowed maximum is +.Dv RES_MAXRETRANS +(see +.In resolv.h ) . +.It Sy attempts: Ns Ar n +sets the number of times the resolver will send a query to each of +its name servers +before giving up and returning an error to the calling application. +The default is +.Dv RES_DFLRETRY , +the allowed maximum is +.Dv RES_MAXRETRY +(see +.In resolv.h ) . +.It Sy no_tld_query +tells the resolver not to attempt to resolve a top level domain name, that +is, a name that contains no dots. +Use of this option does not prevent +the resolver from obeying the standard +.Sy domain +and +.Sy search +rules with the given name. +.El +.Pp +Options may also be specified as a space or tab separated list using the +.Dv RES_OPTIONS +environment variable. +.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 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 hostname 7 , +.Xr named 8 +.Rs +.%T "Name Server Operations Guide for BIND" +.Re +.Sh HISTORY +The +.Nm resolv.conf +file format appeared in +.Bx 4.3 . diff --git a/share/man/man5/services.5 b/share/man/man5/services.5 new file mode 100644 index 0000000..55e0c9d --- /dev/null +++ b/share/man/man5/services.5 @@ -0,0 +1,107 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd April 4, 2010 +.Dt SERVICES 5 +.Os +.Sh NAME +.Nm services +.Nd service name data base +.Sh DESCRIPTION +The +.Nm +file contains information regarding +the known services available in the +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 ``/'' is used to +separate the port and protocol (e.g.\& ``512/tcp''). +A ``#'' 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 +If +.Dq db +is specified as source in the +.Xr nsswitch.conf 5 , +.Pa /var/db/services.db +is searched. +The database in +.Pa /var/db/services.db +needs to be updated with +.Xr services_mkdb 8 +after changes to the services file have been applied. +.Sh NIS INTERACTION +Access to the NIS +.Pa services.byname +map can be enabled by adding a single ``+'' on a line by itself +in the +.Pa /etc/services +file. +This causes the contents of the NIS services map to be inserted +at the location where the ``+'' appears. +.Sh FILES +.Bl -tag -width /etc/services -compact +.It Pa /etc/services +The +.Nm +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr getservent 3 +.Xr nsswitch.conf 5 +.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/share/man/man5/shells.5 b/share/man/man5/shells.5 new file mode 100644 index 0000000..585cc83 --- /dev/null +++ b/share/man/man5/shells.5 @@ -0,0 +1,66 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd June 5, 1993 +.Dt SHELLS 5 +.Os +.Sh NAME +.Nm shells +.Nd shell database +.Sh DESCRIPTION +The +.Nm +file contains a list of the shells on the system. +For each shell a single line should be present, consisting of the +shell's path, relative to root. +.Pp +A hash mark (``#'') 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 +file resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr getusershell 3 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.3 tahoe . diff --git a/share/man/man5/src.conf.5 b/share/man/man5/src.conf.5 new file mode 100644 index 0000000..f9548b0 --- /dev/null +++ b/share/man/man5/src.conf.5 @@ -0,0 +1,862 @@ +.\" DO NOT EDIT-- this file is automatically generated. +.\" from FreeBSD: head/tools/build/options/makeman 188848 2009-02-20 11:09:55Z mtm +.\" $FreeBSD$ +.Dd June 10, 2010 +.Dt SRC.CONF 5 +.Os +.Sh NAME +.Nm src.conf +.Nd "source build options" +.Sh DESCRIPTION +The +.Nm +file contains settings that will apply to every build involving the +.Fx +source tree; see +.Xr build 7 . +.Pp +The +.Nm +file uses the standard makefile syntax. +However, +.Nm +should not specify any dependencies to +.Xr make 1 . +Instead, +.Nm +is to set +.Xr make 1 +variables that control the aspects of how the system builds. +.Pp +The default location of +.Nm +is +.Pa /etc/src.conf , +though an alternative location can be specified in the +.Xr make 1 +variable +.Va SRCCONF . +Overriding the location of +.Nm +may be necessary if the system-wide settings are not suitable +for a particular build. +For instance, setting +.Va SRCCONF +to +.Pa /dev/null +effectively resets all build controls to their defaults. +.Pp +The only purpose of +.Nm +is to control the compilation of the +.Fx +source code, which is usually located in +.Pa /usr/src . +As a rule, the system administrator creates +.Nm +when the values of certain control variables need to be changed +from their defaults. +.Pp +In addition, control variables can be specified +for a particular build via the +.Fl D +option of +.Xr make 1 +or in its environment; see +.Xr environ 7 . +.Pp +The values of variables are ignored regardless of their setting; +even if they would be set to +.Dq Li FALSE +or +.Dq Li NO . +Just the existence of an option will cause +it to be honoured by +.Xr make 1 . +.Pp +The following list provides a name and short description for variables +that can be used for source builds. +.Bl -tag -width indent +.It Va WITHOUT_ACCT +.\" from FreeBSD: head/tools/build/options/WITHOUT_ACCT 183242 2008-09-21 22:02:26Z sam +Set to not build process accounting tools such as +.Xr ac 8 +and +.Xr accton 8 . +.It Va WITHOUT_ACPI +.\" from FreeBSD: head/tools/build/options/WITHOUT_ACPI 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr acpiconf 8 , +.Xr acpidump 8 +and related programs. +.It Va WITHOUT_AMD +.\" from FreeBSD: head/tools/build/options/WITHOUT_AMD 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr amd 8 , +and related programs. +.It Va WITHOUT_APM +.\" from FreeBSD: head/tools/build/options/WITHOUT_APM 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr apm 8 , +.Xr apmd 8 +and related programs. +.It Va WITHOUT_ASSERT_DEBUG +.\" from FreeBSD: head/tools/build/options/WITHOUT_ASSERT_DEBUG 162215 2006-09-11 13:55:27Z ru +Set to compile programs and libraries without the +.Xr assert 3 +checks. +.It Va WITHOUT_AT +.\" from FreeBSD: head/tools/build/options/WITHOUT_AT 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr at 1 +and related utilities. +.It Va WITHOUT_ATM +.\" from FreeBSD: head/tools/build/options/WITHOUT_ATM 156932 2006-03-21 07:50:50Z ru +Set to not build +programs and libraries related to ATM networking. +.It Va WITHOUT_AUDIT +.\" from FreeBSD: head/tools/build/options/WITHOUT_AUDIT 156932 2006-03-21 07:50:50Z ru +Set to not build audit support into system programs. +.It Va WITHOUT_AUTHPF +.\" from FreeBSD: head/tools/build/options/WITHOUT_AUTHPF 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr authpf 8 . +.It Va WITHOUT_BIND +.\" from FreeBSD: head/tools/build/options/WITHOUT_BIND 156932 2006-03-21 07:50:50Z ru +Setting this variable will prevent any part of BIND from being built. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_BIND_DNSSEC +.It +.Va WITHOUT_BIND_ETC +.It +.Va WITHOUT_BIND_LIBS_LWRES +.It +.Va WITHOUT_BIND_MTREE +.It +.Va WITHOUT_BIND_NAMED +.It +.Va WITHOUT_BIND_UTILS +.El +.It Va WITHOUT_BIND_DNSSEC +.\" from FreeBSD: head/tools/build/options/WITHOUT_BIND_DNSSEC 156932 2006-03-21 07:50:50Z ru +Set to avoid building or installing the DNSSEC related binaries, +.Xr dnssec-keygen 8 +and +.Xr dnssec-signzone 8 . +.It Va WITHOUT_BIND_ETC +.\" from FreeBSD: head/tools/build/options/WITHOUT_BIND_ETC 156932 2006-03-21 07:50:50Z ru +Set to avoid installing the default files to +.Pa /var/named/etc/namedb . +.It Va WITH_BIND_IDN +.\" from FreeBSD: head/tools/build/options/WITH_BIND_IDN 193280 2009-06-01 21:58:59Z dougb +Set to enable IDN support for dig, host, and nslookup. +This requires ports/dns/idnkit to be installed in /usr/local. +.It Va WITH_BIND_LARGE_FILE +.\" from FreeBSD: head/tools/build/options/WITH_BIND_LARGE_FILE 193280 2009-06-01 21:58:59Z dougb +Set to enable 64-bit file support. +.It Va WITH_BIND_LIBS +.\" from FreeBSD: head/tools/build/options/WITH_BIND_LIBS 193280 2009-06-01 21:58:59Z dougb +Set to install BIND libraries and include files. +.It Va WITHOUT_BIND_LIBS_LWRES +.\" from FreeBSD: head/tools/build/options/WITHOUT_BIND_LIBS_LWRES 156932 2006-03-21 07:50:50Z ru +Set to avoid installing the lightweight resolver library in +.Pa /usr/lib . +.It Va WITHOUT_BIND_MTREE +.\" from FreeBSD: head/tools/build/options/WITHOUT_BIND_MTREE 157717 2006-04-13 10:37:29Z ru +Set to avoid running +.Xr mtree 8 +to create the chroot directory structure under +.Pa /var/named , +and avoid creating an +.Pa /etc/namedb +symlink to the chroot directory. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_BIND_ETC +.El +.It Va WITHOUT_BIND_NAMED +.\" from FreeBSD: head/tools/build/options/WITHOUT_BIND_NAMED 156932 2006-03-21 07:50:50Z ru +Set to avoid building or installing +.Xr named 8 , +.Xr named.reload 8 , +.Xr named-checkconf 8 , +.Xr named-checkzone 8 , +.Xr rndc 8 , +and +.Xr rndc-confgen 8 . +.It Va WITH_BIND_SIGCHASE +.\" from FreeBSD: head/tools/build/options/WITH_BIND_SIGCHASE 193280 2009-06-01 21:58:59Z dougb +Set to enable DNSSEC validation support for dig, host, and nslookup. +.It Va WITHOUT_BIND_UTILS +.\" from FreeBSD: head/tools/build/options/WITHOUT_BIND_UTILS 156932 2006-03-21 07:50:50Z ru +Set to avoid building or installing the BIND userland utilities, +.Xr dig 1 , +.Xr host 1 , +.Xr nslookup 1 , +and +.Xr nsupdate 8 . +.It Va WITH_BIND_XML +.\" from FreeBSD: head/tools/build/options/WITH_BIND_XML 193280 2009-06-01 21:58:59Z dougb +Set to enable the http statistics interface for named. +This requires ports/textproc/libxml2 to be installed in /usr/local. +.It Va WITHOUT_BLUETOOTH +.\" from FreeBSD: head/tools/build/options/WITHOUT_BLUETOOTH 156932 2006-03-21 07:50:50Z ru +Set to not build Bluetooth related kernel modules, programs and libraries. +.It Va WITHOUT_BOOT +.\" from FreeBSD: head/tools/build/options/WITHOUT_BOOT 156932 2006-03-21 07:50:50Z ru +Set to not build the boot blocks and loader. +.It Va WITHOUT_BSD_CPIO +.\" from FreeBSD: head/tools/build/options/WITHOUT_BSD_CPIO 179813 2008-06-16 05:48:15Z dougb +Set to not build the BSD licensed version of cpio based on +.Xr libarchive 3 . +.It Va WITHOUT_BSNMP +.\" from FreeBSD: head/tools/build/options/WITHOUT_BSNMP 183306 2008-09-23 16:15:42Z sam +Set to not build or install +.Xr bsnmpd 1 +and related libraries and data files. +.It Va WITHOUT_BZIP2 +.\" from FreeBSD: head/tools/build/options/WITHOUT_BZIP2 174550 2007-12-12 16:43:17Z ru +Set to not build contributed bzip2 software as a part of the base system. +.Bf -symbolic +The option has no effect yet. +.Ef +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_BZIP2_SUPPORT +.El +.It Va WITHOUT_BZIP2_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_BZIP2_SUPPORT 166255 2007-01-26 10:19:08Z delphij +Set to build some programs without optional bzip2 support. +.It Va WITHOUT_CALENDAR +.\" from FreeBSD: head/tools/build/options/WITHOUT_CALENDAR 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr calendar 1 . +.It Va WITHOUT_CDDL +.\" from FreeBSD: head/tools/build/options/WITHOUT_CDDL 163861 2006-11-01 09:02:11Z jb +Set to not build code licensed under Sun's CDDL. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_ZFS +.El +.It Va WITHOUT_CLANG +.\" from FreeBSD: head/tools/build/options/WITHOUT_CLANG 208971 2010-06-10 06:20:26Z ed +Set to not build the Clang C/C++ compiler. +.It Va WITHOUT_CPP +.\" from FreeBSD: head/tools/build/options/WITHOUT_CPP 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr cpp 1 . +.It Va WITHOUT_CRYPT +.\" from FreeBSD: head/tools/build/options/WITHOUT_CRYPT 156932 2006-03-21 07:50:50Z ru +Set to not build any crypto code. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_GSSAPI +(can be overridden with +.Va WITH_GSSAPI ) +.It +.Va WITHOUT_KERBEROS +.It +.Va WITHOUT_KERBEROS_SUPPORT +.It +.Va WITHOUT_OPENSSH +.It +.Va WITHOUT_OPENSSL +.El +.It Va WITHOUT_CTM +.\" from FreeBSD: head/tools/build/options/WITHOUT_CTM 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr ctm 1 +and related utilities. +.It Va WITHOUT_CVS +.\" from FreeBSD: head/tools/build/options/WITHOUT_CVS 156932 2006-03-21 07:50:50Z ru +Set to not build CVS. +.It Va WITHOUT_CXX +.\" from FreeBSD: head/tools/build/options/WITHOUT_CXX 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr g++ 1 +and related libraries. +.It Va WITHOUT_DICT +.\" from FreeBSD: head/tools/build/options/WITHOUT_DICT 156932 2006-03-21 07:50:50Z ru +Set to not build the Webster dictionary files. +.It Va WITHOUT_DYNAMICROOT +.\" from FreeBSD: head/tools/build/options/WITHOUT_DYNAMICROOT 156932 2006-03-21 07:50:50Z ru +Set this if you do not want to link +.Pa /bin +and +.Pa /sbin +dynamically. +.It Va WITHOUT_EXAMPLES +.\" from FreeBSD: head/tools/build/options/WITHOUT_EXAMPLES 156938 2006-03-21 09:06:24Z ru +Set to avoid installing examples to +.Pa /usr/share/examples/ . +.It Va WITH_FDT +.\" from FreeBSD: head/tools/build/options/WITH_FDT 208537 2010-05-25 15:12:21Z raj +Set to build Flattened Device Tree support as part of the base system. This +includes the device tree compiler (dtc) and libfdt support library. +.It Va WITHOUT_FLOPPY +.\" from FreeBSD: head/tools/build/options/WITHOUT_FLOPPY 183306 2008-09-23 16:15:42Z sam +Set to not build or install programs +for operating floppy disk driver. +.It Va WITHOUT_FORTH +.\" from FreeBSD: head/tools/build/options/WITHOUT_FORTH 156932 2006-03-21 07:50:50Z ru +Set to build bootloaders without Forth support. +.It Va WITHOUT_FP_LIBC +.\" from FreeBSD: head/tools/build/options/WITHOUT_FP_LIBC 156932 2006-03-21 07:50:50Z ru +Set to build +.Nm libc +without floating-point support. +.It Va WITHOUT_FREEBSD_UPDATE +.\" from FreeBSD: head/tools/build/options/WITHOUT_FREEBSD_UPDATE 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr freebsd-update 8 . +.It Va WITHOUT_GAMES +.\" from FreeBSD: head/tools/build/options/WITHOUT_GAMES 156932 2006-03-21 07:50:50Z ru +Set to not build games. +.It Va WITHOUT_GCOV +.\" from FreeBSD: head/tools/build/options/WITHOUT_GCOV 156932 2006-03-21 07:50:50Z ru +Set to not build the +.Xr gcov 1 +tool. +.It Va WITHOUT_GDB +.\" from FreeBSD: head/tools/build/options/WITHOUT_GDB 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr gdb 1 . +.It Va WITHOUT_GNU +.\" from FreeBSD: head/tools/build/options/WITHOUT_GNU 174550 2007-12-12 16:43:17Z ru +Set to not build contributed GNU software as a part of the base system. +This option can be useful if the system built must not contain any code +covered by the GNU Public License due to legal reasons. +.Bf -symbolic +The option has no effect yet. +.Ef +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_GNU_SUPPORT +.El +.It Va WITHOUT_GNU_GREP +.\" from FreeBSD: head/tools/build/options/WITHOUT_GNU_GREP 179813 2008-06-16 05:48:15Z dougb +Set to not build GNU grep as a part of the base system. +.It Va WITHOUT_GNU_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_GNU_SUPPORT 156932 2006-03-21 07:50:50Z ru +Set to build some programs without optional GNU support. +.It Va WITHOUT_GPIB +.\" from FreeBSD: head/tools/build/options/WITHOUT_GPIB 156932 2006-03-21 07:50:50Z ru +Set to not build GPIB bus support. +.It Va WITHOUT_GROFF +.\" from FreeBSD: head/tools/build/options/WITHOUT_GROFF 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr groff 1 . +.It Va WITHOUT_GSSAPI +.\" from FreeBSD: head/tools/build/options/WITHOUT_GSSAPI 174548 2007-12-12 16:39:32Z ru +Set to not build libgssapi. +.It Va WITH_HESIOD +.\" from FreeBSD: head/tools/build/options/WITH_HESIOD 156932 2006-03-21 07:50:50Z ru +Set to build Hesiod support. +.It Va WITHOUT_HTML +.\" from FreeBSD: head/tools/build/options/WITHOUT_HTML 156932 2006-03-21 07:50:50Z ru +Set to not build HTML docs. +.It Va WITH_IDEA +.\" from FreeBSD: head/tools/build/options/WITH_IDEA 156932 2006-03-21 07:50:50Z ru +Set to build the IDEA encryption code. +This code is patented in the USA and many European countries. +It is +.Em "YOUR RESPONSIBILITY" +to determine if you can legally use IDEA. +.It Va WITHOUT_INET6 +.\" from FreeBSD: head/tools/build/options/WITHOUT_INET6 156932 2006-03-21 07:50:50Z ru +Set to not build +programs and libraries related to IPv6 networking. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_INET6_SUPPORT +.El +.It Va WITHOUT_INET6_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_INET6_SUPPORT 156932 2006-03-21 07:50:50Z ru +Set to build libraries, programs, and kernel modules without IPv6 support. +.It Va WITHOUT_INFO +.\" from FreeBSD: head/tools/build/options/WITHOUT_INFO 156932 2006-03-21 07:50:50Z ru +Set to not make or install +.Xr info 5 +files. +.It Va WITHOUT_INSTALLLIB +.\" from FreeBSD: head/tools/build/options/WITHOUT_INSTALLLIB 174497 2007-12-09 21:56:21Z dougb +Set this if you do not want to install optional libraries. +For example when creating a +.Xr nanobsd 8 +image. +.It Va WITHOUT_IPFILTER +.\" from FreeBSD: head/tools/build/options/WITHOUT_IPFILTER 156932 2006-03-21 07:50:50Z ru +Set to not build IP Filter package. +.It Va WITHOUT_IPFW +.\" from FreeBSD: head/tools/build/options/WITHOUT_IPFW 183242 2008-09-21 22:02:26Z sam +Set to not build IPFW tools. +.It Va WITHOUT_IPX +.\" from FreeBSD: head/tools/build/options/WITHOUT_IPX 156932 2006-03-21 07:50:50Z ru +Set to not build programs and libraries related to IPX networking. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_IPX_SUPPORT +.It +.Va WITHOUT_NCP +.El +.It Va WITHOUT_IPX_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_IPX_SUPPORT 156932 2006-03-21 07:50:50Z ru +Set to build some programs without IPX support. +.It Va WITHOUT_JAIL +.\" from FreeBSD: head/tools/build/options/WITHOUT_JAIL 183242 2008-09-21 22:02:26Z sam +Set to not build tools for the support of jails; e.g. +.Xr jail 8 . +.It Va WITHOUT_KERBEROS +.\" from FreeBSD: head/tools/build/options/WITHOUT_KERBEROS 174549 2007-12-12 16:42:03Z ru +Set this if you do not want to build Kerberos 5 (KTH Heimdal). +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_GSSAPI +(can be overridden with +.Va WITH_GSSAPI ) +.It +.Va WITHOUT_KERBEROS_SUPPORT +.El +.It Va WITHOUT_KERBEROS_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_KERBEROS_SUPPORT 156932 2006-03-21 07:50:50Z ru +Set to build some programs without Kerberos support, like +.Xr cvs 1 , +.Xr ssh 1 , +.Xr telnet 1 , +.Xr sshd 8 , +and +.Xr telnetd 8 . +.It Va WITHOUT_KVM +.\" from FreeBSD: head/tools/build/options/WITHOUT_KVM 174550 2007-12-12 16:43:17Z ru +Set to not build the +.Nm libkvm +library as a part of the base system. +.Bf -symbolic +The option has no effect yet. +.Ef +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_KVM_SUPPORT +.El +.It Va WITHOUT_KVM_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_KVM_SUPPORT 170644 2007-06-13 02:08:04Z sepotvin +Set to build some programs without optional +.Nm libkvm +support. +.It Va WITHOUT_LEGACY_CONSOLE +.\" from FreeBSD: head/tools/build/options/WITHOUT_LEGACY_CONSOLE 183242 2008-09-21 22:02:26Z sam +Set to not build programs that support a legacy PC console; e.g. +.Xr kbdcontrol 8 +and +.Xr vidcontrol 8 . +.It Va WITHOUT_LIB32 +.\" from FreeBSD: head/tools/build/options/WITHOUT_LIB32 156932 2006-03-21 07:50:50Z ru +On amd64, set to not build 32-bit library set and a +.Nm ld-elf32.so.1 +runtime linker. +.It Va WITHOUT_LIBPTHREAD +.\" from FreeBSD: head/tools/build/options/WITHOUT_LIBPTHREAD 188848 2009-02-20 11:09:55Z mtm +Set to not build the +.Nm libpthread +providing library, +.Nm libthr . +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_BIND +.It +.Va WITHOUT_BIND_DNSSEC +.It +.Va WITHOUT_BIND_ETC +.It +.Va WITHOUT_BIND_LIBS_LWRES +.It +.Va WITHOUT_BIND_MTREE +.It +.Va WITHOUT_BIND_NAMED +.It +.Va WITHOUT_BIND_UTILS +.It +.Va WITHOUT_LIBTHR +.El +.It Va WITHOUT_LIBTHR +.\" from FreeBSD: head/tools/build/options/WITHOUT_LIBTHR 156932 2006-03-21 07:50:50Z ru +Set to not build the +.Nm libthr +(1:1 threading) +library. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_BIND +.It +.Va WITHOUT_BIND_DNSSEC +.It +.Va WITHOUT_BIND_ETC +.It +.Va WITHOUT_BIND_LIBS_LWRES +.It +.Va WITHOUT_BIND_MTREE +.It +.Va WITHOUT_BIND_NAMED +.It +.Va WITHOUT_BIND_UTILS +.El +.It Va WITHOUT_LOCALES +.\" from FreeBSD: head/tools/build/options/WITHOUT_LOCALES 156932 2006-03-21 07:50:50Z ru +Set to not build localization files; see +.Xr locale 1 . +.It Va WITHOUT_LOCATE +.\" from FreeBSD: head/tools/build/options/WITHOUT_LOCATE 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr locate 1 +and related programs. +.It Va WITHOUT_LPR +.\" from FreeBSD: head/tools/build/options/WITHOUT_LPR 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr lpr 1 +and related programs. +.It Va WITHOUT_MAIL +.\" from FreeBSD: head/tools/build/options/WITHOUT_MAIL 183242 2008-09-21 22:02:26Z sam +Set to not build any mail support (MUA or MTA). +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_MAILWRAPPER +.It +.Va WITHOUT_SENDMAIL +.El +.It Va WITHOUT_MAILWRAPPER +.\" from FreeBSD: head/tools/build/options/WITHOUT_MAILWRAPPER 156932 2006-03-21 07:50:50Z ru +Set to not build the +.Xr mailwrapper 8 +MTA selector. +.It Va WITHOUT_MAKE +.\" from FreeBSD: head/tools/build/options/WITHOUT_MAKE 183242 2008-09-21 22:02:26Z sam +Set to not install +.Xr make 1 +and related support files. +.It Va WITHOUT_MAN +.\" from FreeBSD: head/tools/build/options/WITHOUT_MAN 156932 2006-03-21 07:50:50Z ru +Set to not build manual pages. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_MAN_UTILS +(can be overridden with +.Va WITH_MAN_UTILS ) +.El +.It Va WITHOUT_MAN_UTILS +.\" from FreeBSD: head/tools/build/options/WITHOUT_MAN_UTILS 208322 2010-05-20 00:07:21Z jkim +Set to not build utilities for manual pages, +.Xr apropos 1 , +.Xr catman 1 , +.Xr makewhatis 1 , +.Xr man 1 , +.Xr whatis 1 , +.Xr manctl 8 , +and related support files. +.It Va WITHOUT_NCP +.\" from FreeBSD: head/tools/build/options/WITHOUT_NCP 156932 2006-03-21 07:50:50Z ru +Set to not build programs, libraries, and kernel modules +related to NetWare Core protocol. +.It Va WITHOUT_NDIS +.\" from FreeBSD: head/tools/build/options/WITHOUT_NDIS 183242 2008-09-21 22:02:26Z sam +Set to not build programs and libraries +related to NDIS emulation support. +.It Va WITHOUT_NETCAT +.\" from FreeBSD: head/tools/build/options/WITHOUT_NETCAT 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr nc 1 +utility. +.It Va WITHOUT_NETGRAPH +.\" from FreeBSD: head/tools/build/options/WITHOUT_NETGRAPH 183242 2008-09-21 22:02:26Z sam +Set to not build applications to support +.Xr netgraph 4 . +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_ATM +.It +.Va WITHOUT_BLUETOOTH +.It +.Va WITHOUT_NETGRAPH_SUPPORT +.El +.It Va WITHOUT_NETGRAPH_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_NETGRAPH_SUPPORT 183305 2008-09-23 16:11:15Z sam +Set to build libraries, programs, and kernel modules without netgraph support. +.It Va WITHOUT_NIS +.\" from FreeBSD: head/tools/build/options/WITHOUT_NIS 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr NIS 8 +support and related programs. +If set, you might need to adopt your +.Xr nsswitch.conf 5 +and remove +.Sq nis +entries. +.It Va WITHOUT_NLS +.\" from FreeBSD: head/tools/build/options/WITHOUT_NLS 156932 2006-03-21 07:50:50Z ru +Set to not build NLS catalogs. +.It Va WITHOUT_NLS_CATALOGS +.\" from FreeBSD: head/tools/build/options/WITHOUT_NLS_CATALOGS 156932 2006-03-21 07:50:50Z ru +Set to not build NLS catalog support for +.Xr csh 1 . +.It Va WITHOUT_NS_CACHING +.\" from FreeBSD: head/tools/build/options/WITHOUT_NS_CACHING 172803 2007-10-19 14:01:25Z ru +Set to disable name caching in the +.Pa nsswitch +subsystem. +The generic caching daemon, +.Xr nscd 8 , +will not be built either if this option is set. +.It Va WITHOUT_NTP +.\" from FreeBSD: head/tools/build/options/WITHOUT_NTP 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr ntpd 8 +and related programs. +.It Va WITHOUT_OBJC +.\" from FreeBSD: head/tools/build/options/WITHOUT_OBJC 156932 2006-03-21 07:50:50Z ru +Set to not build Objective C support. +.It Va WITHOUT_OPENSSH +.\" from FreeBSD: head/tools/build/options/WITHOUT_OPENSSH 156932 2006-03-21 07:50:50Z ru +Set to not build OpenSSH. +.It Va WITHOUT_OPENSSL +.\" from FreeBSD: head/tools/build/options/WITHOUT_OPENSSL 156932 2006-03-21 07:50:50Z ru +Set to not build OpenSSL. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_GSSAPI +(can be overridden with +.Va WITH_GSSAPI ) +.It +.Va WITHOUT_KERBEROS +.It +.Va WITHOUT_KERBEROS_SUPPORT +.It +.Va WITHOUT_OPENSSH +.El +.It Va WITHOUT_PAM +.\" from FreeBSD: head/tools/build/options/WITHOUT_PAM 174550 2007-12-12 16:43:17Z ru +Set to not build PAM library and modules. +.Bf -symbolic +This option is deprecated and does nothing. +.Ef +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_PAM_SUPPORT +.El +.It Va WITHOUT_PAM_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_PAM_SUPPORT 156932 2006-03-21 07:50:50Z ru +Set to build some programs without PAM support, particularly +.Xr ftpd 8 +and +.Xr ppp 8 . +.It Va WITHOUT_PF +.\" from FreeBSD: head/tools/build/options/WITHOUT_PF 156932 2006-03-21 07:50:50Z ru +Set to not build PF firewall package. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_AUTHPF +.El +.It Va WITHOUT_PKGTOOLS +.\" from FreeBSD: head/tools/build/options/WITHOUT_PKGTOOLS 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr pkg_add 8 +and related programs. +.It Va WITHOUT_PMC +.\" from FreeBSD: head/tools/build/options/WITHOUT_PMC 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr pmccontrol 8 +and related programs. +.It Va WITHOUT_PORTSNAP +.\" from FreeBSD: head/tools/build/options/WITHOUT_PORTSNAP 183242 2008-09-21 22:02:26Z sam +Set to not build or install +.Xr portsnap 8 +and related files. +.It Va WITHOUT_PPP +.\" from FreeBSD: head/tools/build/options/WITHOUT_PPP 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr ppp 8 +and related programs. +.It Va WITHOUT_PROFILE +.\" from FreeBSD: head/tools/build/options/WITHOUT_PROFILE 156932 2006-03-21 07:50:50Z ru +Set to avoid compiling profiled libraries. +.It Va WITHOUT_QUOTAS +.\" from FreeBSD: head/tools/build/options/WITHOUT_QUOTAS 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr quota 8 +and related programs. +.It Va WITHOUT_RCMDS +.\" from FreeBSD: head/tools/build/options/WITHOUT_RCMDS 156932 2006-03-21 07:50:50Z ru +Disable building of the +.Bx +r-commands. +This includes +.Xr rlogin 1 , +.Xr rsh 1 , +etc. +.It Va WITHOUT_RCS +.\" from FreeBSD: head/tools/build/options/WITHOUT_RCS 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr rcs 1 +and related utilities. +.It Va WITHOUT_RESCUE +.\" from FreeBSD: head/tools/build/options/WITHOUT_RESCUE 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr rescue 8 . +.It Va WITHOUT_ROUTED +.\" from FreeBSD: head/tools/build/options/WITHOUT_ROUTED 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr routed 8 +utility. +.It Va WITHOUT_SENDMAIL +.\" from FreeBSD: head/tools/build/options/WITHOUT_SENDMAIL 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr sendmail 8 +and related programs. +.It Va WITHOUT_SETUID_LOGIN +.\" from FreeBSD: head/tools/build/options/WITHOUT_SETUID_LOGIN 156932 2006-03-21 07:50:50Z ru +Set this to disable the installation of +.Xr login 1 +as a set-user-ID root program. +.It Va WITHOUT_SHAREDOCS +.\" from FreeBSD: head/tools/build/options/WITHOUT_SHAREDOCS 156932 2006-03-21 07:50:50Z ru +Set to not build the +.Bx 4.4 +legacy docs. +.It Va WITHOUT_SSP +.\" from FreeBSD: head/tools/build/options/WITHOUT_SSP 180012 2008-06-25 21:33:28Z ru +Set to not build world with propolice stack smashing protection. +.It Va WITHOUT_SYMVER +.\" from FreeBSD: head/tools/build/options/WITHOUT_SYMVER 169649 2007-05-17 05:03:24Z deischen +Set to disable symbol versioning when building shared libraries. +.It Va WITHOUT_SYSCONS +.\" from FreeBSD: head/tools/build/options/WITHOUT_SYSCONS 156932 2006-03-21 07:50:50Z ru +Set to not build +.Xr syscons 4 +support files such as keyboard maps, fonts, and screen output maps. +.It Va WITHOUT_SYSINSTALL +.\" from FreeBSD: head/tools/build/options/WITHOUT_SYSINSTALL 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr sysinstall 8 +and related programs. +.It Va WITHOUT_TCSH +.\" from FreeBSD: head/tools/build/options/WITHOUT_TCSH 156932 2006-03-21 07:50:50Z ru +Set to not build and install +.Pa /bin/csh +(which is +.Xr tcsh 1 ) . +.It Va WITHOUT_TELNET +.\" from FreeBSD: head/tools/build/options/WITHOUT_TELNET 183242 2008-09-21 22:02:26Z sam +Set to not build +.Xr telnet 8 +and related programs. +.It Va WITHOUT_TEXTPROC +.\" from FreeBSD: head/tools/build/options/WITHOUT_TEXTPROC 183242 2008-09-21 22:02:26Z sam +Set to not build +programs used for text processing. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_GROFF +.El +.It Va WITHOUT_TOOLCHAIN +.\" from FreeBSD: head/tools/build/options/WITHOUT_TOOLCHAIN 174550 2007-12-12 16:43:17Z ru +Set to not install +programs used for program development, +compilers, debuggers etc. +.Bf -symbolic +The option does not work for build targets. +.Ef +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_CLANG +.It +.Va WITHOUT_GDB +.El +.It Va WITHOUT_USB +.\" from FreeBSD: head/tools/build/options/WITHOUT_USB 156932 2006-03-21 07:50:50Z ru +Set to not build USB-related programs and libraries. +.It Va WITHOUT_WIRELESS +.\" from FreeBSD: head/tools/build/options/WITHOUT_WIRELESS 183242 2008-09-21 22:02:26Z sam +Set to not build programs used for 802.11 wireless networks; especially +.Xr wpa_supplicant 8 +and +.Xr hostapd 8 . +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_WIRELESS_SUPPORT +.El +.It Va WITHOUT_WIRELESS_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_WIRELESS_SUPPORT 183305 2008-09-23 16:11:15Z sam +Set to build libraries, programs, and kernel modules without +802.11 wireless support. +.It Va WITHOUT_WPA_SUPPLICANT_EAPOL +.\" from FreeBSD: head/tools/build/options/WITHOUT_WPA_SUPPLICANT_EAPOL 156932 2006-03-21 07:50:50Z ru +Build +.Xr wpa_supplicant 8 +without support for the IEEE 802.1X protocol and without +support for EAP-PEAP, EAP-TLS, EAP-LEAP, and EAP-TTLS +protocols (usable only via 802.1X). +.It Va WITHOUT_ZFS +.\" from FreeBSD: head/tools/build/options/WITHOUT_ZFS 168409 2007-04-06 02:13:30Z pjd +Set to not build ZFS file system. +.It Va WITHOUT_ZONEINFO +.\" from FreeBSD: head/tools/build/options/WITHOUT_ZONEINFO 171994 2007-08-27 20:01:08Z remko +Set to not build the timezone database +.El +.Sh FILES +.Bl -tag -compact +.It Pa /etc/src.conf +.It Pa /usr/share/mk/bsd.own.mk +.El +.Sh SEE ALSO +.Xr make 1 , +.Xr make.conf 5 , +.Xr build 7 , +.Xr ports 7 +.Sh HISTORY +The +.Nm +file appeared in +.Fx 7.0 . +.Sh AUTHORS +This manual page was autogenerated. diff --git a/share/man/man5/stab.5 b/share/man/man5/stab.5 new file mode 100644 index 0000000..bc4e680 --- /dev/null +++ b/share/man/man5/stab.5 @@ -0,0 +1,221 @@ +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. 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 +.\" $FreeBSD$ +.\" +.Dd June 10, 2010 +.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 +.Xr pc 1 . +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 { + const 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 /* alternate 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, +.Xr pc 1 , +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 ld 1 , +.Xr a.out 5 +.Sh HISTORY +The +.Nm +file appeared in +.Bx 4.0 . +.Sh BUGS +More basic types are needed. diff --git a/share/man/man5/style.Makefile.5 b/share/man/man5/style.Makefile.5 new file mode 100644 index 0000000..bdf2830 --- /dev/null +++ b/share/man/man5/style.Makefile.5 @@ -0,0 +1,276 @@ +.\" Copyright (c) 2002-2003 David O'Brien <obrien@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. Neither the name of the author nor the names of any 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 DAVID O'BRIEN OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd January 8, 2005 +.Dt STYLE.MAKEFILE 5 +.Os +.Sh NAME +.Nm style.Makefile +.Nd +.Fx +.Pa Makefile +file style guide +.Sh DESCRIPTION +This file specifies the preferred style for makefiles in the +.Fx +source tree. +.Bl -bullet +.It +All makefiles should have an SCM ID at the start of the file, +followed by a blank line. +.Bd -literal +# $FreeBSD\&$ + +.Ed +.It +.Cm .PATH : +comes next if needed, and is spelled +.Dq Li ".PATH: " , +with a single +.Tn ASCII +space after a colon. +Do not use the +.Va VPATH +variable. +.It +Special variables (i.e., +.Va LIB , SRCS , MLINKS , +etc.) are listed in order of +.Dq product , +then building and installing a binary. +Special variables may also be listed in +.Dq build +order: i.e., ones for the primary program (or library) first. +The general +.Dq product +order is: +.Va PROG Ns / Ns Oo Va SH Oc Ns Va LIB Ns / Ns Va SCRIPTS +.Va FILES +.Va LINKS +.Oo Va NO_ Oc Ns Va MAN +.Va MLINKS +.Va INCS +.Va SRCS +.Va WARNS +.Va CFLAGS +.Va DPADD +.Va LDADD . +The general +.Dq build +order is: +.Va PROG Ns / Ns Oo Va SH Oc Ns Va LIB Ns / Ns Va SCRIPTS +.Va SRCS +.Va WARNS +.Va CFLAGS +.Va DPADD +.Va LDADD +.Va INCS +.Va FILES +.Va LINKS +.Oo Va NO_ Oc Ns Va MAN +.Va MLINKS . +.It +Omit +.Va SRCS +when using +.In bsd.prog.mk +and there is a single source file named the same as the +.Va PROG . +.It +Omit +.Va MAN +when using +.In bsd.prog.mk +and the manual page is named the same as the +.Va PROG , +and is in section 1. +.It +All variable assignments are spelled +.Dq Va VAR Ns Ic = , +i.e., no space between the variable name and the +.Ic = . +Keep values sorted alphabetically, if possible. +.It +Do not use +.Ic += +to set variables that are only set once +(or to set variables for the first time). +.It +Do not use vertical whitespace in simple makefiles, +but do use it to group locally related things in more complex/longer ones. +.It +.Va WARNS +comes before +.Va CFLAGS , +as it is basically a +.Va CFLAGS +modifier. +It comes before +.Va CFLAGS +rather than after +.Va CFLAGS +so it does not get lost in a sea of +.Va CFLAGS +statements as +.Va WARNS +is an important thing. +The usage of +.Va WARNS +is spelled +.Dq Li "WARNS?= " , +so that it may be overridden on the command line or in +.Xr make.conf 5 . +.It +.Dq Li "NO_WERROR= yes" +should not be used, +it defeats the purpose of +.Va WARNS . +It should only be used on the command line and in special circumstances. +.It +.Va CFLAGS +is spelled +.Dq Li "CFLAGS+= " . +.It +Listing +.Fl D Ns 's +before +.Fl I Ns 's +in +.Va CFLAGS +is preferred for alphabetical ordering and to make +.Fl D Ns 's +easier to see. +The +.Fl D Ns 's +often affect conditional compilation, +and +.Fl I Ns 's +tend to be quite long. +Split long +.Va CFLAGS +settings between the +.Fl D Ns 's +and +.Fl I Ns 's. +.It +Do not use GCCisms (such as +.Fl g +and +.Fl Wall ) +in +.Va CFLAGS . +.It +Typically, there is one +.Tn ASCII +tab between +.Va VAR Ns Ic = +and the value in order to start the value in column 9. +An +.Tn ASCII +space is allowed for variable names that extend beyond column 9. +A lack of whitespace is also allowed for very long variable names. +.It +.Ic .include In bsd.*.mk +goes last. +.It +Do not use anachronisms like +.Va $< +and +.Va $@ . +Instead use +.Va ${.IMPSRC} +or +.Va ${.ALLSRC} +and +.Va ${.TARGET} . +.It +To not build the +.Dq foo +part of the base system, +use +.Va NO_FOO , +not +.Va NOFOO . +.It +To optionally build something in the base system, +spell the knob +.Va WITH_FOO +not +.Va WANT_FOO +or +.Va USE_FOO . +The latter are reserved for the +.Fx +Ports Collection. +.It +For variables that are only checked with +.Fn defined , +do not provide any fake value. +.El +.Pp +The desire to express a logical grouping often means not obeying some of the +above. +.Sh EXAMPLES +The simplest program +.Pa Makefile +is: +.Bd -literal -offset indent +# $FreeBSD\&$ + +PROG= foo + +\&.include <bsd.prog.mk> +.Ed +.Pp +The simplest library +.Pa Makefile +is: +.Bd -literal -offset indent +# $FreeBSD\&$ + +LIB= foo +SHLIB_MAJOR= 1 +MAN= libfoo.3 +SRCS= foo.c + +\&.include <bsd.lib.mk> +.Ed +.Sh SEE ALSO +.Xr make 1 , +.Xr make.conf 5 , +.Xr style 9 +.Sh HISTORY +This manual page is inspired from the same source as +.Xr style 9 +manual page in +.Fx . +.Sh BUGS +There are few hard and fast style rules here. +The style of many things is too dependent on the context of the whole makefile, +or the lines surrounding it. diff --git a/share/man/man5/sysctl.conf.5 b/share/man/man5/sysctl.conf.5 new file mode 100644 index 0000000..0e69bcc --- /dev/null +++ b/share/man/man5/sysctl.conf.5 @@ -0,0 +1,84 @@ +.\" Copyright (c) 1999 Chris Costello <chris@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. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd December 30, 1999 +.Dt SYSCTL.CONF 5 +.Os +.Sh NAME +.Nm sysctl.conf +.Nd kernel state defaults +.Sh DESCRIPTION +The +.Pa /etc/sysctl.conf +file is read in when the system goes into multi-user mode to set default +settings for the kernel. +The +.Pa /etc/sysctl.conf +is in the format of the +.Xr sysctl 8 +command, i.e.\& +.Bd -literal -offset indent +sysctl_mib=value +.Ed +.Pp +Comments are denoted by a +.Dq # +at the beginning of a line. +Comments can also exist at the end of a line, +as seen in the +.Sx EXAMPLES +section, below. +.Sh FILES +.Bl -tag -width /etc/sysctl.conf -compact +.It Pa /etc/sysctl.conf +Initial settings for +.Xr sysctl 8 . +.El +.Sh EXAMPLES +To turn off logging of programs that exit due to fatal signals you may use +a configuration like +.Bd -literal -offset indent +# Configure logging. +kern.logsigexit=0 # Do not log fatal signal exits (e.g. sig 11) +.Ed +.Sh SEE ALSO +.Xr rc.conf 5 , +.Xr rc 8 , +.Xr sysctl 8 +.Sh HISTORY +The +.Nm +file appeared in +.Fx 4.0 . +.Sh BUGS +If loadable kernel modules are used to introduce additional kernel +functionality and sysctls to manage that functionality, +.Nm +may be processed too early in the boot process to set those sysctls. +For example, sysctls to manage the linux emulator cannot be set in +.Nm +if the linux emulator is loaded as a module rather than +compiled into the kernel. diff --git a/share/man/man5/tmpfs.5 b/share/man/man5/tmpfs.5 new file mode 100644 index 0000000..4d66f5d --- /dev/null +++ b/share/man/man5/tmpfs.5 @@ -0,0 +1,149 @@ +.\"- +.\" Copyright (c) 2007 Xin LI +.\" 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 DOCUMENTATION 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) 2005, 2006 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. +.\" +.\" $FreeBSD$ +.\" +.Dd February 16, 2010 +.Dt TMPFS 5 +.Os +.Sh NAME +.Nm tmpfs +.Nd "efficient memory file system" +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "options TMPFS" +.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 +tmpfs_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver will permit the +.Fx +kernel to access +.Tn tmpfs +file systems. +.Sh OPTIONS +The following options are available when +mounting +.Nm +file systems: +.Bl -tag -width indent +.It Cm gid +Specifies the group ID of the root inode of the file system. +Defaults to the mount point's GID. +.It Cm uid +Specifies the user ID of the root inode of the file system. +Defaults to the mount point's UID. +.It Cm mode +Specifies the mode (in octal notation) of the root inode of the file system. +Defaults to the mount point's mode. +.It Cm inodes +Specifies the maximum number of nodes available to the file system. +If not specified, the file system chooses a reasonable maximum based on +the file system size, which can be limited with the +.Cm size +option. +.It Cm size +Specifies the total file system size in bytes. +If zero (the default) or a value larger than SIZE_MAX - PAGE_SIZE +is given, the available amount of memory (including +main memory and swap space) will be used. +.It Cm maxfilesize +Specifies the maximum file size in bytes. +Defaults to the maximum possible value. +.El +.Sh EXAMPLES +To mount a +.Nm +memory file system: +.Pp +.Dl "mount -t tmpfs tmpfs /tmp" +.Sh SEE ALSO +.Xr nmount 2 , +.Xr unmount 2 , +.Xr fstab 5 , +.Xr mdmfs 8 , +.Xr mount 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 7.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +kernel implementation was written by +.An Julio M. Merino Vidal Aq jmmv@NetBSD.org +as a Google SoC project. +.Pp +.An Rohit Jalan +and others ported it from +.Nx +to +.Fx . +.Pp +This manual page was written by +.An Xin LI Aq delphij@FreeBSD.org . +.Sh BUGS +The +.Nm +kernel implementation is currently considered as +an experimental feature. +Some file system mount +time options are not well supported. diff --git a/share/man/man5/xfs.5 b/share/man/man5/xfs.5 new file mode 100644 index 0000000..c350424 --- /dev/null +++ b/share/man/man5/xfs.5 @@ -0,0 +1,108 @@ +.\" +.\" Copyright (c) 2007 Craig Rodrigues +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd June 16, 2007 +.Dt XFS 5 +.Os +.Sh NAME +.Nm xfs +.Nd "XFS file system" +.Sh SYNOPSIS +To link into the kernel: +.Bd -ragged -offset indent +.Cd "options XFS" +.Ed +.Pp +To load as a kernel loadable module: +.Pp +.Dl "kldload xfs" +.Sh DESCRIPTION +The +.Nm +driver will permit the +.Fx +kernel to access +.Tn XFS +file systems. +.Sh EXAMPLES +To mount a +.Nm +volume located on +.Pa /dev/ad1s1 : +.Pp +.Dl "mount -t xfs /dev/ad1s1 /mnt" +.Sh SEE ALSO +.Xr nmount 2 , +.Xr unmount 2 , +.Xr fstab 5 , +.Xr mount 8 +.Sh NOTES +The +.Pa sysutils/xfsprogs +port contains the +.Cm mkfs.xfs +utility for +creating XFS file systems, and also other utilities for analyzing, +and repairing XFS file systems. +.Sh HISTORY +XFS was originally written by SGI for the IRIX operating system. +SGI ported XFS to Linux, and released the source code under the GNU +Public License. For more details, see: +.Pa http://oss.sgi.com/projects/xfs +.Pp +The port to +.Fx +was based on the Linux port, and started by +.An -nosplit +.An Russell Cattelan Aq cattelan@xfs.org , +.An Alexander Kabaev Aq kan@FreeBSD.org , +and +.An Craig Rodrigues Aq rodrigc@FreeBSD.org . +.Pp +The +.Nm +file system support +first appeared in +.Fx 7.0 . +.Sh AUTHORS +This manual page was written by +.An Craig Rodrigues Aq rodrigc@FreeBSD.org . +.Sh CAVEATS +The port of XFS to +.Fx +is currently incomplete. +Only read-only access is supported for XFS volumes. +Writing to a volume is not supported. +.Pp +The +.Fl p +flag to +.Cm mkfs.xfs +can be used to create an XFS file system which is populated with files +and other metadata. +This can be used to quickly create a read-only file system which +can be tested on +.Fx . |
