From 452eec6f0017e9eab44bb46e2eacbd1d617a0f25 Mon Sep 17 00:00:00 2001 From: Erich Eckner Date: Mon, 30 Oct 2017 10:14:34 +0100 Subject: manpage new --- .gitignore | 1 + Makefile | 24 +++++++++++++----------- cryptfs.8.in | 25 +++++++++++++++++++++++++ 3 files changed, 39 insertions(+), 11 deletions(-) create mode 100644 cryptfs.8.in diff --git a/.gitignore b/.gitignore index b354d05..ca79aa8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +cryptfs.8 cryptfs.bin cryptfs.rc cryptfs.service diff --git a/Makefile b/Makefile index 9f7e5aa..25cb75b 100644 --- a/Makefile +++ b/Makefile @@ -23,6 +23,7 @@ DESTDIR = BINDIR = /usr/bin DEVDIR = /dev ETCDIR = /etc +MANDIR = /usr/share/man MAPDIR = $(DEVDIR)/mapper RCDDIR = $(ETCDIR)/rc.d SYSTEMDDIR = /usr/lib/systemd/system @@ -32,19 +33,19 @@ CONF_PREFIXES = VERSION = 0.4.3 -all: cryptfs.bin cryptfs.rc cryptfs.service +all: cryptfs.8 cryptfs.bin cryptfs.rc cryptfs.service %: %.in sed " \ - s@#BINDIR#@$(BINDIR)@; \ - s@#DEVDIR#@$(DEVDIR)@; \ - s@#ETCDIR#@$(ETCDIR)@; \ - s@#MAPDIR#@$(MAPDIR)@; \ - s@#RCDDIR#@$(RCDDIR)@; \ - s@#SYSTEMDDIR#@$(SYSTEMDDIR)@; \ - s@#UUIDDIR#@$(UUIDDIR)@; \ - s@#CONF_PREFIXES#@$(CONF_PREFIXES)@; \ - s@#VERSION#@$(VERSION)@; \ + s@#BINDIR#@$(BINDIR)@g; \ + s@#DEVDIR#@$(DEVDIR)@g; \ + s@#ETCDIR#@$(ETCDIR)@g; \ + s@#MAPDIR#@$(MAPDIR)@g; \ + s@#RCDDIR#@$(RCDDIR)@g; \ + s@#SYSTEMDDIR#@$(SYSTEMDDIR)@g; \ + s@#UUIDDIR#@$(UUIDDIR)@g; \ + s@#CONF_PREFIXES#@$(CONF_PREFIXES)@g; \ + s@#VERSION#@$(VERSION)@g; \ " $< | \ if which "ping6" >/dev/null 2>&1; then \ sed 's@#PING6#@ping6@'; \ @@ -58,6 +59,7 @@ all: cryptfs.bin cryptfs.rc cryptfs.service install_bin: install -D -m0755 cryptfs.bin $(DESTDIR)$(BINDIR)/cryptfs + install -D -m0644 cryptfs.8 $(DESTDIR)$(MANDIR)/man8/cryptfs.8 install_systemd: install_bin install -D -m0644 cryptfs.service $(DESTDIR)$(SYSTEMDDIR)/cryptfs.service @@ -66,7 +68,7 @@ install_sysvinit: install_bin install -D -m0755 cryptfs.rc $(DESTDIR)$(RCDDIR)/cryptfs clean: - rm -f cryptfs.bin cryptfs.rc cryptfs.service + rm -f cryptfs.8 cryptfs.bin cryptfs.rc cryptfs.service dist: clean git status --porcelain 2> /dev/null | grep -q "\S" && (git add .; git commit -m"neue Version: $(VERSION)") || true 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 +.fi -- cgit v1.2.3-70-g09d2