.\"
.\" Copyright (c) 2020 Apple Computer, Inc.  All rights reserved.
.\"
.Dd June 1, 2020
.Dt APFS_UNLOCKFV 8
.Os
.Sh NAME
.Nm apfs_unlockfv
.Nd unlock an APFS FileVault data volume
.Sh SYNOPSIS
.Nm
.Op Fl h
.Nm
.Op Fl W
.Op path
.Sh DESCRIPTION
The
.Nm
utility unlocks an APFS-formatted FileVault-encrypted data volume.
.Pp
The
.Ar path
parameter is optional, but if provided should be a path on a mounted
APFS System volume.
(This volume must have the System role, and must
be in a volume group with a locked Data volume.)
If
.Ar path
is not provided,
.Nm
will attempt to unlock the data volume paired to the system volume at
.Pa /
\&.
.Pp
Upon invocation,
.Nm
will prompt the user for a password.
This password can be for any user on the volume being unlocked,
including the Disk user.
.Pp
The options are as follows:
.Bl -hang -offset indent
.It Fl h
Print a usage message.
.El
.Bl -hang -offset indent
.It Fl W
Unlock with empty password.
.El
.Sh EXIT STATUS
.Nm
exits with 0 on success, and >0 if an error occurs.
If the volume was already unlocked,
.Nm
also exits with 0.
.Sh SEE ALSO
.Xr diskutil 8 ,
.Xr mount_apfs 8 ,
.Xr newfs_apfs 8
.Sh HISTORY
The
.Nm
utility was introduced in macOS 11.