Add man page for cryfs-unmount

This commit is contained in:
Sebastian Messmer 2022-10-11 21:10:31 -07:00
parent 39e792ad78
commit 16c3a47304
3 changed files with 73 additions and 1 deletions

View File

@ -13,7 +13,13 @@ ELSE (WIN32)
) )
add_custom_target(man ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/cryfs.1.gz) 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 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
CONFIGURATIONS Release CONFIGURATIONS Release
) )

65
doc/man/cryfs-unmount.1 Normal file
View File

@ -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.

View File

@ -270,6 +270,7 @@ Default value: ${HOME}/.cryfs
. .
.BR mount.fuse (1), .BR mount.fuse (1),
.BR fusermount (1) .BR fusermount (1)
.BR cryfs-unmount (1)
.PP .PP
. .
For more information about the design of CryFS, visit For more information about the design of CryFS, visit