pass-mount.1

.\" Man page generated from reStructuredText.
.
.TH PASS-MOUNT 1 "2023-03-27" "0.2.1" "Password Store Extension"
.SH NAME
pass-mount \- A Password Store extension for managing encrypted filesystems.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
pass mount [\fICOMMAND\fP] [\fIOPTIONS\fP]... [\fIARGS\fP]...
.SH DESCRIPTION
.sp
pass\-mount extends the \fBpass\fP(1) utility with an interface to mount
encrypted filesystems.
.sp
If no COMMAND is specified, COMMAND defaults to \fBtarget\fP\&.
.SH COMMANDS
.SS mount target \fIpass\-name\fP
.sp
Mount an encrypted filesystem from the password and configuration stored that
is in \fIpass\-name\fP\&.
.SS mount \fIpass\-name\fP
.sp
This is equivilent to the \fItarget\fP command above.
.SS mount status \fIpass\-name\fP
.sp
Display the status and configuration of an encrypted filesystem from the
configuration stored in \fIpass\-name\fP\&.
.SS mount init \fIpass\-name\fP
.sp
Initialize encrypted filesystem and store the configuration in \fIpass\-name\fP\&.
.SS umount \fIpass\-name\fP
.sp
Unmount an encrypted filesystem.
.SH OPTIONS
.INDENT 0.0
.TP
.B help, \-h, \-\-help
Show usage message.
.UNINDENT
.SH EXAMPLE CONFIG - CRYFS
.sp
Configuration can be manually edited by using \fBpass edit\fP \fIpass\-name\fP\&.
Relative directory paths in the config are automatically prepended with $HOME.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_password
type: cryfs
basedir: .cryfs/encrypted_dir
mountpoint: /usr/local/data
.ft P
.fi
.UNINDENT
.UNINDENT
.SH EXAMPLE CONFIG - UDISKS
.sp
Configuration can be manually edited by using \fBpass edit\fP \fIpass\-name\fP\&.
The uuid can be determined by running
\fBfindmnt \-\-target /media/$USER/$DISK_LABEL \-\-output SOURCE \-\-noheadings\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_password
type: udisks
uuid: 222254e3\-c547\-4b4e\-823a\-5181698e0a39
.ft P
.fi
.UNINDENT
.UNINDENT
.SH EXAMPLE CONFIG - CRYPTSETUP
.sp
Configuration can be manually edited by using \fBpass edit\fP \fIpass\-name\fP\&.
The uuid for \fB/dev/sdb1\fP can be determined by running
\fBudevadm info /dev/sdb1 | grep ID_FS_UUID=\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
my_password
type: cryptsetup
uuid: 222254e3\-c547\-4b4e\-823a\-5181698e0a39
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBpass\fP(1)
\fBcryfs\fP(1)
.sp
<\fI\%https://github.com/humanxrobot/pass\-mount\fP>
.SH COPYING
.sp
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.sp
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.sp
You should have received a copy of the GNU General Public License
along with this program.  If not, see <\fI\%http://www.gnu.org/licenses/\fP>.
.SH AUTHOR
Lucid One <LucidOne@users.noreply.github.com>
.SH COPYRIGHT
GPLv3
.\" Generated by docutils manpage writer.
.