summaryrefslogtreecommitdiffstats
path: root/share/man/man7
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/man7')
-rw-r--r--share/man/man7/Makefile14
-rw-r--r--share/man/man7/adding_user.76
-rw-r--r--share/man/man7/ascii.76
-rw-r--r--share/man/man7/build.723
-rw-r--r--share/man/man7/development.72
-rw-r--r--share/man/man7/environ.76
-rw-r--r--share/man/man7/hier.750
-rw-r--r--share/man/man7/hostname.711
-rw-r--r--share/man/man7/intro.76
-rw-r--r--share/man/man7/mailaddr.76
-rw-r--r--share/man/man7/operator.76
-rw-r--r--share/man/man7/release.7128
-rw-r--r--share/man/man7/security.711
-rw-r--r--share/man/man7/sticky.76
-rw-r--r--share/man/man7/tests.7234
15 files changed, 423 insertions, 92 deletions
diff --git a/share/man/man7/Makefile b/share/man/man7/Makefile
index 8417934..9dcaad9 100644
--- a/share/man/man7/Makefile
+++ b/share/man/man7/Makefile
@@ -27,6 +27,7 @@ MAN= adding_user.7 \
sprog.7 \
stdint.7 \
sticky.7 \
+ tests.7 \
tuning.7
MLINKS= intro.7 miscellaneous.7
@@ -36,17 +37,4 @@ MLINKS+= c99.7 c78.7
MLINKS+= c99.7 c89.7
MLINKS+= c99.7 c90.7
-.if ${MK_ATF} != "no"
-ATF= ${.CURDIR}/../../../contrib/atf
-.PATH: ${ATF}/doc
-MAN+= atf.7
-
-CLEANFILES+= atf.7 atf.7.tmp
-atf.7: atf.7.in
- sed -e 's,__DOCDIR__,${DOCDIR}/atf,g' \
- -e 's,__TESTSDIR__,${TESTSBASE},g' \
- < ${.ALLSRC} > ${.TARGET}.tmp
- mv ${.TARGET}.tmp ${.TARGET}
-.endif
-
.include <bsd.prog.mk>
diff --git a/share/man/man7/adding_user.7 b/share/man/man7/adding_user.7
index 499bd48..b0f7e8c 100644
--- a/share/man/man7/adding_user.7
+++ b/share/man/man7/adding_user.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
diff --git a/share/man/man7/ascii.7 b/share/man/man7/ascii.7
index feba2338..a9c75ad 100644
--- a/share/man/man7/ascii.7
+++ b/share/man/man7/ascii.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
diff --git a/share/man/man7/build.7 b/share/man/man7/build.7
index 931b444..76a2fa6 100644
--- a/share/man/man7/build.7
+++ b/share/man/man7/build.7
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd October 10, 2012
+.Dd March 27, 2014
.Dt BUILD 7
.Os
.Sh NAME
@@ -411,8 +411,25 @@ then
is set to the value of
.Va KERNFAST .
.It Va LOCAL_DIRS
-If set, this variable supplies a list of additional directories to
-build, relative to the root of the source tree.
+If set, this variable supplies a list of additional directories relative to
+the root of the source tree to build as part of the
+.Cm everything
+target.
+.It Va LOCAL_LIB_DIRS
+If set, this variable supplies a list of additional directories relative to
+the root of the source tree to build as part of the
+.Cm libraries
+target.
+.It Va LOCAL_MTREE
+If set, this variable supplies a list of additional mtrees relative to the
+root of the source tree to use as part of the
+.Cm hierarchy
+target.
+.It Va LOCAL_TOOL_DIRS
+If set, this variable supplies a list of additional directories relative to
+the root of the source tree to build as part of the
+.Cm build-tools
+target.
.It Va PORTS_MODULES
A list of ports with kernel modules that should be built and installed
as part of the
diff --git a/share/man/man7/development.7 b/share/man/man7/development.7
index 58e6892..18b9813 100644
--- a/share/man/man7/development.7
+++ b/share/man/man7/development.7
@@ -454,8 +454,6 @@ This is a good time to also remind you that most of the
.Xr svn 1
operations you do will be done as
.Dq Li root .
-.Pp
-.Xr cron 8 .
.Sh SEE ALSO
.Xr crontab 1 ,
.Xr crontab 5 ,
diff --git a/share/man/man7/environ.7 b/share/man/man7/environ.7
index 2b80987..8269488 100644
--- a/share/man/man7/environ.7
+++ b/share/man/man7/environ.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7
index 328f88d..1722ea3 100644
--- a/share/man/man7/hier.7
+++ b/share/man/man7/hier.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
@@ -32,7 +28,7 @@
.\" @(#)hier.7 8.1 (Berkeley) 6/5/93
.\" $FreeBSD$
.\"
-.Dd January 21, 2010
+.Dd December 25, 2013
.Dt HIER 7
.Os
.Sh NAME
@@ -104,10 +100,6 @@ Sendmail control files
mtree configuration files;
see
.Xr mtree 8
-.It Pa namedb/
-named configuration files;
-see
-.Xr named 8
.It Pa pam.d/
configuration files for the Pluggable Authentication Modules (PAM)
library
@@ -287,8 +279,6 @@ mail filter API
machine-specific C include files
.It Pa net/
miscellaneous network C include files
-.It Pa netatalk/
-Appletalk protocol
.It Pa netinet/
C include files for Internet standard protocols;
see
@@ -301,8 +291,6 @@ see
kernel key-management service;
see
.Xr ipsec 4
-.It Pa netipx/
-IPX/SPX protocol stacks
.It Pa netnatm/
NATM include files;
see
@@ -387,6 +375,9 @@ a.out backward compatibility libraries
DTrace library scripts
.It Pa engines/
OpenSSL (Cryptography/SSL toolkit) dynamically loadable engines
+.It Pa private/
+Private system libraries not for use by third-party programs.
+ABI and API stability are not guaranteed.
.El
.Pp
.It Pa libdata/
@@ -547,6 +538,16 @@ ASCII text files used by various games
device description file for device name
.It Pa info/
GNU Info hypertext system
+.It Pa keys/
+known trusted and revoked keys.
+.Bl -tag -width ".Pa keys/pkg/" -compact
+.It Pa keys/pkg/
+fingerprints for
+.Xr pkg 7
+and
+.Xr pkg 8
+.El
+.Pp
.It Pa locale/
localization files;
see
@@ -692,6 +693,14 @@ source code for files in
source code for files in
.Pa /usr/sbin
.El
+.Pp
+.It Pa tests/
+The
+.Fx
+test suite.
+See
+.Xr tests 7
+for more details.
.El
.It Pa /var/
multi-purpose log, temporary, transient, and spool files
@@ -720,6 +729,14 @@ directory containing output spool files
.Pp
.It Pa backups/
miscellaneous backup files
+.It Pa cache/
+miscellaneous cached files
+.Bl -tag -width ".Pa pkg/" -compact
+.It Pa pkg/
+cached packages for
+.Xr pkg 8
+.El
+.Pp
.It Pa crash/
default directory to store kernel crash dumps; see
.Xr crash 8
@@ -780,11 +797,6 @@ system information files describing various info about
system since it was booted
.Pp
.Bl -tag -width Fl -compact
-.It Pa named/
-writable by the
-.Dq bind
-user; see
-.Xr named 8
.It Pa ppp/
writable by the
.Dq network
diff --git a/share/man/man7/hostname.7 b/share/man/man7/hostname.7
index 713a8b1..2068b55 100644
--- a/share/man/man7/hostname.7
+++ b/share/man/man7/hostname.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
@@ -32,7 +28,7 @@
.\" @(#)hostname.7 8.2 (Berkeley) 12/30/93
.\" $FreeBSD$
.\"
-.Dd December 30, 1993
+.Dd December 25, 2013
.Dt HOSTNAME 7
.Os
.Sh NAME
@@ -86,8 +82,7 @@ by a system-wide configuration file (see
.Sh SEE ALSO
.Xr gethostbyname 3 ,
.Xr resolver 5 ,
-.Xr mailaddr 7 ,
-.Xr named 8
+.Xr mailaddr 7
.Sh HISTORY
.Nm Hostname
appeared in
diff --git a/share/man/man7/intro.7 b/share/man/man7/intro.7
index 1d9968c..e7ea8cc 100644
--- a/share/man/man7/intro.7
+++ b/share/man/man7/intro.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
diff --git a/share/man/man7/mailaddr.7 b/share/man/man7/mailaddr.7
index 7726006..5956f34 100644
--- a/share/man/man7/mailaddr.7
+++ b/share/man/man7/mailaddr.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
diff --git a/share/man/man7/operator.7 b/share/man/man7/operator.7
index 0ca8abd..1971f2f 100644
--- a/share/man/man7/operator.7
+++ b/share/man/man7/operator.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
diff --git a/share/man/man7/release.7 b/share/man/man7/release.7
index b126cd7..f3f897e 100644
--- a/share/man/man7/release.7
+++ b/share/man/man7/release.7
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd August 14, 2013
+.Dd April 11, 2014
.Dt RELEASE 7
.Os
.Sh NAME
@@ -138,6 +138,11 @@ configuration file supports the following variables:
.Bl -tag -width Ev
.It Va CHROOTDIR
The directory within which the release will be built.
+.It Va CHROOT_MAKEENV
+Additional
+.Xr make 1
+arguments to pass through, which directly affect the
+tuning of the build chroot.
.It Va SVNROOT
The
.Xr svn 1
@@ -241,6 +246,110 @@ will prevent the
distribution package from being created.
Setting this also sets
.Va NODOC .
+.It Va WITH_DVD
+Set to a non-empty value to include the
+.Cm dvdrom
+target.
+.It Va WITH_COMPRESSED_IMAGES
+Set to a non-empty value to compress the release images with
+.Xr xz 1 .
+The original
+.Pq uncompressed
+images are not removed.
+.It Va VCSCMD
+The command run to obtain the source trees.
+Defaults to
+.Qq Cm svn checkout .
+.It Va CHROOTBUILD_SKIP
+If defined, the
+.Li buildworld ,
+.Li installworld ,
+and
+.Li distribution
+stages of the
+.Xr chroot 8
+build environment setup are skipped.
+This is intended solely for cases where the
+.Xr chroot 8
+userland are provided by alternate means.
+.It Va SRC_UPDATE_SKIP
+Set to a non-empty value to prevent checkout or update of
+.Fa /usr/src
+within the
+.Xr chroot 8 .
+This is intended for use only when
+.Fa /usr/src
+is expected to exist by alternative means.
+.It Va DOC_UPDATE_SKIP
+Set to a non-empty value to prevent checkout or update of
+.Fa /usr/doc
+within the
+.Xr chroot 8 .
+This is intended for use only when
+.Fa /usr/doc
+is expected to exist by alternative means.
+.It Va PORTS_UPDATE_SKIP
+Set to a non-empty value to prevent checkout or update of
+.Fa /usr/ports
+within the
+.Xr chroot 8 .
+This is intended for use only when
+.Fa /usr/ports
+is expected to exist by alternative means.
+.El
+.Sh EMBEDDED BUILDS
+The following
+.Fa release.conf
+variables are relevant only to release builds for embedded systems:
+.Bl -tag -width Ev
+.It Va EMBEDDEDBUILD
+Set to a non-null value to enable functionality for embedded device
+release builds.
+.Pq This option is considered highly experimental.
+.Pp
+When set,
+.Va WITH_DVD
+is unset, and
+.Va NODOC
+is defined.
+Additionally,
+.Va XDEV
+and
+.Va XDEV_ARCH
+must also be defined.
+When the build environment is created,
+.Fa release.sh
+runs a separate build script located in an architecture-specific
+directory in
+.Pa src/release/${XDEV}/ .
+.It Va EMBEDDEDPORTS
+Set to the list of any ports that are required for the target device
+in the format of
+.Fa category/port .
+The
+.Fa devel/subversion
+port is built by default.
+.It Va CROCHETSRC
+Set to the source URL for the Crochet build tool.
+.It Va CROCHETBRANCH
+Set to the subversion branch from
+.Va ${CROCHETSRC}
+to use.
+Defaults to
+.Pa trunk .
+.It Va UBOOTSRC
+Set to the source URL of u-boot, if required.
+.It Va UBOOTBRANCH
+Set to the subversion branch from
+.Va ${UBOOTSRC}
+to use.
+Defaults to
+.Pa trunk .
+.It Va UBOOTDIR
+Set to the target directory within
+.Va ${CHROOTDIR}
+to check out
+.Va ${UBOOTSRC}/${UBOOTBRANCH} .
.El
.Sh MAKEFILE TARGETS
The release makefile
@@ -270,6 +379,15 @@ This target produces files called
and
.Pa bootonly.iso
as its output.
+.It Cm dvdrom
+Builds installation DVD-ROM images.
+This may require the
+.Xr md 4
+(memory disk) device driver be present in the kernel
+(either by being compiled in or available as a module).
+This target produces the
+.Pa dvd1.iso
+file as its output.
.It Cm memstick
Builds an installation memory stick image named
.Pa memstick.img .
@@ -279,6 +397,11 @@ Requires that the
.Pq memory disk
device driver be present in the kernel
.Pq either by being compiled in or available as a module .
+.It Cm mini-memstick
+Similar to
+.Cm memstick ,
+with the exception that the installation distribution sets
+are not included.
.It Cm ftp
Creates a directory named
.Pa ftp
@@ -297,7 +420,8 @@ Builds a bootable installation system containing all the distribution files
packaged by the
.Cm packagesystem
target, and suitable for imaging by the
-.Cm cdrom
+.Cm cdrom ,
+.Cm dvdrom
and
.Cm memstick
targets.
diff --git a/share/man/man7/security.7 b/share/man/man7/security.7
index a3882d6..d51eea2 100644
--- a/share/man/man7/security.7
+++ b/share/man/man7/security.7
@@ -23,7 +23,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd February 8, 2012
+.Dd December 25, 2013
.Dt SECURITY 7
.Os
.Sh NAME
@@ -350,13 +350,6 @@ now defaults to running
and
.Xr fingerd 8
in a sandbox.
-Another program which may be a candidate for running in a sandbox is
-.Xr named 8 .
-The default
-.Pa rc.conf
-includes the arguments necessary to run
-.Xr named 8
-in a sandbox in a commented-out form.
Depending on whether you
are installing a new system or upgrading an existing system, the special
user accounts used by these sandboxes may not be installed.
@@ -825,8 +818,6 @@ ports A, B, C, D, and M-Z
This
way you can firewall off all of your low ports except for certain specific
services such as
-.Xr named 8
-(if you are primary for a zone),
.Xr talkd 8 ,
.Xr sendmail 8 ,
and other internet-accessible services.
diff --git a/share/man/man7/sticky.7 b/share/man/man7/sticky.7
index 0f06603..28fab62 100644
--- a/share/man/man7/sticky.7
+++ b/share/man/man7/sticky.7
@@ -9,11 +9,7 @@
.\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
diff --git a/share/man/man7/tests.7 b/share/man/man7/tests.7
new file mode 100644
index 0000000..f7d0611
--- /dev/null
+++ b/share/man/man7/tests.7
@@ -0,0 +1,234 @@
+.\" $FreeBSD$
+.\" $NetBSD: tests.kyua.7,v 1.2 2013/07/20 21:39:59 wiz Exp $
+.\"
+.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
+.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
+.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd April 13, 2014
+.Dt TESTS 7
+.Os
+.Sh NAME
+.Nm tests
+.Nd introduction to the FreeBSD Test Suite
+.Sh DESCRIPTION
+The
+.Fx
+Test Suite provides a collection of automated tests for two major purposes.
+On one hand, the test suite aids
+.Em developers
+to detect bugs and regressions when they modify the source tree. On the other
+hand, it allows
+.Em end users
+(and, in particular, system administrators) to verify that fresh installations
+of the
+.Fx
+operating system behave correctly on their hardware platform and also to ensure
+that the system does not suffer from regressions during regular operation and
+maintenance.
+.Pp
+The
+.Fx
+Test Suite can be found in the
+.Pa /usr/tests
+hierarchy.
+.Pp
+This manual page describes how to run the test suite and how to configure
+some of its optional features.
+.Ss Installing the test suite
+The test suite is not yet installed by default as part of
+.Fx ,
+but this is bound to change during the development of
+.Fx 11.0 .
+.Pp
+If the
+.Pa /usr/tests
+directory is missing, then you will have to enable the build of the test
+suite, rebuild your system and install the results.
+You can do so by setting
+.Sq WITH_TESTS=yes
+in your
+.Pa /etc/src.conf
+file (see
+.Xr src.conf 5
+for details)
+and rebuilding the system as described in
+.Xr build 7 .
+.Ss When to run the tests?
+Before diving into the details of how to run the test suite, here are some
+scenarios in which you should run it:
+.Bl -bullet -offset indent
+.It
+After a fresh installation of
+.Fx
+to ensure that the system works correctly on your hardware platform.
+.It
+After an upgrade of
+.Fx
+to a different version to ensure that the new code works well on your
+hardware platform and that the upgrade did not introduce regressions in your
+configuration.
+.It
+After modifying the source tree to detect any new bugs and/or regressions.
+.It
+Periodically, maybe from a
+.Xr cron 8
+job, to ensure that any changes to the system (such as the installation of
+third-party packages or manual modifications to configuration files) do not
+introduce unexpected failures.
+.El
+.Ss Running the tests
+First, you will need to install the
+.Sq devel/kyua
+package from
+.Xr ports 7 .
+Then use the following command to run the whole test suite:
+.Bd -literal -offset indent
+$ kyua test -k /usr/tests/Kyuafile
+.Ed
+.Pp
+The above will iterate through all test programs in
+.Pa /usr/tests
+recursively, execute them, store their results and debugging data in Kyua's
+database (by default in
+.Pa ~/.kyua/store.db ) ,
+and print a summary of the results.
+This summary includes a brief count of all total tests run and how many of
+them failed.
+.Pp
+It is possible to restrict which tests to run by providing their names in
+the command line.
+For example, this would execute the tests for the
+.Xr cp 1
+and
+.Xr cut 1
+utilities:
+.Bd -literal -offset indent
+$ kyua test -k /usr/tests/Kyuafile bin/cp usr.bin/cut
+.Ed
+.Ss Obtaining reports of the tests execution
+Additional information about the test results can be retrieved
+by using Kyua's various reporting commands.
+For example, the following would print a plain-text report of the executed
+tests and show which ones failed:
+.Bd -literal -offset indent
+$ kyua report
+.Ed
+.Pp
+This example would generate an HTML report ready to be published on a
+web server:
+.Bd -literal -offset indent
+$ kyua report-html --output ~/public_html/tests
+.Ed
+.Pp
+For further details on the command-line interface of Kyua, please refer
+to its manual page
+.Xr kyua 1 .
+.Ss Configuring the tests
+Some test cases in the
+.Fx
+Test Suite require manual configuration by the administrator before they can be
+run. Unless certain properties are defined, the tests that require them will
+be skipped.
+.Pp
+Test suites are configured by defining their configuration
+variables in
+.Pa /usr/local/etc/kyua/kyua.conf .
+The format of this file is detailed in
+.Xr kyua.conf 5 .
+.Pp
+The following configuration variables are available in the
+.Fx
+Test Suite:
+.Bl -tag -width "allow_sysctl_side_effects"
+.It allow_devfs_side_effects
+If defined, enables tests that may destroy and recreate semipermanent device
+nodes, like disk devices. Without this variable, tests may still create and
+destroy devices nodes that are normally transient, like /dev/tap* and
+/dev/pts*, as long as they clean them up afterwards. However, tests that
+require this variable have a relaxed cleanup requirement; they must recreate
+any devices that they destroyed, but not necessarily with the same devnames.
+.It allow_sysctl_side_effects
+Enables tests that change globally significant
+.Xr sysctl 8
+variables. The tests will undo any changes in their cleanup phases.
+.It disks
+Must be set to a space delimited list of disk device nodes. Tests that need
+destructive access to disks must use these devices. Tests are not required to
+preserve any data present on these disks.
+.It fibs
+Must be set to a space delimited list of FIBs (routing tables). Tests that
+need to modify a routing table may use any of these. Tests will cleanup any
+new routes that they create.
+.El
+.Ss What to do if something fails?
+If there is
+.Em any failure
+during the execution of the test suite, please consider reporting it to the
+.Fx
+developers so that the failure can be analyzed and fixed.
+To do so, either send a message to the appropriate mailing list or file a
+problem report.
+For more details please refer to:
+.Bl -bullet -offset indent -compact
+.It
+.Lk http://lists.freebsd.org/ "FreeBSD Mailing Lists"
+.It
+.Lk http://www.freebsd.org/send-pr.html "Submit a FreeBSD Problem Report"
+.El
+.Sh FILES
+.Bl -tag -compact -width usrXlocalXetcXkyuaXkyuaXconfXX
+.It Pa /usr/local/etc/kyua/kyua.conf
+System-wide configuration file for
+.Xr kyua 1 .
+.It Pa ~/.kyua/kyua.conf
+User-specific configuration file for
+.Xr kyua 1 ;
+overrides the system file.
+.It Pa ~/.kyua/store.db
+Default result database used by Kyua.
+.It Pa /usr/tests/
+Location of the
+.Fx
+Test Suite.
+.It Pa /usr/tests/Kyuafile
+Top-level test suite definition file.
+.El
+.Sh SEE ALSO
+.Xr kyua 1 ,
+.Xr build 7
+.Sh HISTORY
+The
+.Fx
+Test Suite first appeared in
+.Fx 10.1 .
+.Pp
+The
+.Nm
+manual page first appeared in
+.Nx 6.0
+and was later ported to
+.Fx 10.1 .
+.Sh AUTHORS
+.An Julio Merino Aq Mt jmmv@FreeBSD.org
OpenPOWER on IntegriCloud