dm - Add manpages for target crypt and striped
[dragonfly.git] / share / man / man4 / dm_target_crypt.4
1 .\" Copyright (c) 2012 The DragonFly BSD Project.
2 .\" All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to The DragonFly BSD Project
5 .\" by Alex Hornung
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 .\" POSSIBILITY OF SUCH DAMAGE.
27 .Dd February 24, 2012
28 .Dt DM_TARGET_CRYPT 4
29 .Os
30 .Sh NAME
31 .Nm dm_target_crypt
32 .Nd Device-mapper crypt target
33 .Sh SYNOPSIS
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
38 .Cd "device dm"
39 .Cd "device dm_target_crypt"
40 .Ed
41 .Pp
42 Alternatively, to load the driver as a
43 module at boot time, place the following line in
44 .Xr loader.conf 5 :
45 .Bd -literal -offset indent
46 dm_target_crypt_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 The
50 .Nm
51 target for
52 .Xr dm 4
53 provides transparent disk encryption compatible with Linux
54 .Nm dm-crypt .
55 .Sh SEE ALSO
56 .Xr dm 4 ,
57 .Xr cryptsetup 8 ,
58 .Xr dmsetup 8 ,
59 .Xr tcplay 8
60 .Sh HISTORY
61 The 
62 .Nm
63 .Xr dm 4
64 target first appeared in
65 .Dx 2.7 .
66 .Sh AUTHORS
67 .An Alex Hornung