From 16c3a4730496da985744e81f80e0903cd040e4a0 Mon Sep 17 00:00:00 2001 From: Sebastian Messmer Date: Tue, 11 Oct 2022 21:10:31 -0700 Subject: [PATCH] Add man page for cryfs-unmount --- doc/CMakeLists.txt | 8 ++++- doc/man/cryfs-unmount.1 | 65 +++++++++++++++++++++++++++++++++++++++++ doc/man/cryfs.1 | 1 + 3 files changed, 73 insertions(+), 1 deletion(-) create mode 100644 doc/man/cryfs-unmount.1 diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 491ed801..d670be55 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -13,7 +13,13 @@ ELSE (WIN32) ) add_custom_target(man ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/cryfs.1.gz) - install(FILES ${CMAKE_CURRENT_BINARY_DIR}/cryfs.1.gz + add_custom_command( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/cryfs-unmount.1.gz + COMMAND ${GZIP} -c ${CMAKE_CURRENT_SOURCE_DIR}/man/cryfs-unmount.1 > ${CMAKE_CURRENT_BINARY_DIR}/cryfs-unmount.1.gz + ) + add_custom_target(umountman ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/cryfs-unmount.1.gz) + + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/cryfs.1.gz ${CMAKE_CURRENT_BINARY_DIR}/cryfs-unmount.1.gz DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 CONFIGURATIONS Release ) diff --git a/doc/man/cryfs-unmount.1 b/doc/man/cryfs-unmount.1 new file mode 100644 index 00000000..94849547 --- /dev/null +++ b/doc/man/cryfs-unmount.1 @@ -0,0 +1,65 @@ +.\" cryfs-unmount(1) man page +. +.TH cryfs-unmount 1 +. +. +. +.SH NAME +cryfs-unmount \- unmount a CryFS volume +. +. +. +.SH SYNOPSIS +.B cryfs-unmount +[\fB\-h\fR] +[\fB\--version\fR] +.I mountpoint +. +. +. +.SH DESCRIPTION +. +Unmount a mounted +.B CryFS +volume. +.PP +. +. +.SH OPTIONS +. +.TP +\fB\-h\fR, \fB\-\-help\fR +. +Show a help message containing short descriptions for all options. +. +. +.TP +\fB\-\-verson\fR +. +Show the version of the installed +.B CryFS +package. +. +. +. +. +.SH SEE ALSO +. +.BR mount.fuse (1), +.BR fusermount (1), +.BR cryfs (1) +.PP +. +For more information about the design of CryFS, visit +.B https://www.cryfs.org +.PP +. +Visit the development repository at +.B https://github.com/cryfs/cryfs +for the source code and the full list of contributors to CryFS. +. +. +. +.SH AUTHORS +. +CryFS was created by Sebastian Messmer and contributors. diff --git a/doc/man/cryfs.1 b/doc/man/cryfs.1 index 9611e229..a66dcbf0 100644 --- a/doc/man/cryfs.1 +++ b/doc/man/cryfs.1 @@ -270,6 +270,7 @@ Default value: ${HOME}/.cryfs . .BR mount.fuse (1), .BR fusermount (1) +.BR cryfs-unmount (1) .PP . For more information about the design of CryFS, visit