summaryrefslogtreecommitdiff
path: root/cryptfs.8.in
diff options
context:
space:
mode:
Diffstat (limited to 'cryptfs.8.in')
-rw-r--r--cryptfs.8.in25
1 files changed, 25 insertions, 0 deletions
diff --git a/cryptfs.8.in b/cryptfs.8.in
new file mode 100644
index 0000000..37dc16f
--- /dev/null
+++ b/cryptfs.8.in
@@ -0,0 +1,25 @@
+.TH cryptfs 8 "" "cryptfs #VERSION#" ""
+.SH NAME
+cryptfs \- simple script for (un)mounting encrypted partitions with all their requirements
+.SH SYNOPSIS
+\fBcryptfs [-u]\fP
+.SH DESCRIPTION
+\fBcryptfs\fP mounts/unmounts prerequisites for encrypted containers, unlocks/locks the containers and mounts/unmounts the partitions therein.
+Locking and unlocking of encrypted containers is done via \fBcryptsetup\fP.
+.SH CONFIGURATION
+The configuration is read from \fB#ETCDIR#/crypttab\fP and \fB#ETCDIR#/fstab\fP.
+To not interfere with systemd, if line prefixes match \fB#CONF_PREFIXES#\fP, the prefix will be removed.
+.SH FILES
+.TP
+.B "#BINDIR#/cryptfs"
+program file
+.TP
+.B "#ETCDIR#/crypttab"
+cryptsetup configuration
+.TP
+.B "#ETCDIR#/fstab"
+file system configuration
+.SH AUTHOR
+.nf
+Erich Eckner <opensource at eckner dot net>
+.fi