Debian Codegraph @

upstream/debian-unstable/man8/luksformat.8

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "LUKSFORMAT 8"
58 .TH LUKSFORMAT 8 2026-05-03 2:2.8.6-2 "Administrative commands"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 luksformat \- Create and format an encrypted LUKS device
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBluksformat\fR [\fB\-t\fR \fIfstype\fR] \fIdevice\fR [ mkfs options ]
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 \&\fBluksformat\fR is a wrapper around \fBcryptsetup\fR and \fBmkfs\fR which provides an
71 easy interface for creating an encrypted device that follows the LUKS standard
72 and for putting a file system onto the encrypted device.
73 .PP
74 The default file system is \fBvfat\fR since that is most commonly used on
75 removable devices. However, you can specify any available file system with the
76 \&\fB\-t\fR option.
77 .SH "SEE ALSO"
78 .IX Header "SEE ALSO"
79 \&\fBcryptsetup\fR\|(8), \fBmkfs\fR\|(8)
80 .SH AUTHOR
81 .IX Header "AUTHOR"
82 This program was written by Martin Pitt <[email protected]>.