Merge branch 'vendor/DIALOG'
[dragonfly.git] / share / man / man4 / tbridge.4
1 .\" Copyright (c) 2020 The DragonFly BSD Project.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\"
26 .Dd November 25, 2020
27 .Dt TBRIDGE 4
28 .Os
29 .Sh NAME
30 .Nm tbridge
31 .Nd Testbridge Device Support
32 .Sh SYNOPSIS
33 To compile testbridge device support into the kernel, place the following lines
34 in your kernel configuration file:
35 .Bd -ragged -offset indent
36 .Cd "device tbridge"
37 .Ed
38 .Pp
39 Alternatively, to load testbridge support as modules at boot time, place the
40 following lines in
41 .Xr loader.conf 5 :
42 .Bd -literal -offset indent
43 tbridge_load="YES"
44 .Ed
45 .Sh DESCRIPTION
46 The
47 .Nm
48 driver is part of the
49 .Xr dfregress 8
50 suite and it provides the interface for running test cases in the kernel space.
51 Each test case will have the form of a kernel module which is loaded and
52 unloaded automatically during the test process.
53 For this reason, the
54 .Nm
55 kernel module must be loaded before
56 .Xr dfregress 8
57 is run.
58 .Sh SEE ALSO
59 .Xr dfregress 8 ,
60 .Xr tbridge 9
61 .Sh AUTHORS
62 The
63 .Nm
64 driver was written for
65 .Dx
66 by
67 .An -nosplit
68 .An Alex Hornung Aq Mt alex@alexhornung.com .