"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "man/cmtab.5.in" between
cryptmount-5.3.1.tar.gz and cryptmount-5.3.2.tar.gz

About: cryptmount allows any user to access encrypted filing systems on demand under GNU/Linux systems. It also assists the system administrator in creating and managing encrypted filesystems based on the kernels dm-crypt device-mapper target.

cmtab.5.in  (cryptmount-5.3.1):cmtab.5.in  (cryptmount-5.3.2)
skipping to change at line 14 skipping to change at line 14
.\" ---- macro definitions ---- .\" ---- macro definitions ----
.de Sh \" Subsection heading .de Sh \" Subsection heading
.br .br
.ne 5 .ne 5
.PP .PP
\fB\\$1\fR \fB\\$1\fR
.PP .PP
.. ..
.TH CMTAB 5 "2019-01-05" "@PACKAGE_VERSION@" "User commands" .TH CMTAB 5 "2019-10-06" "@PACKAGE_VERSION@" "User commands"
.SH NAME .SH NAME
cmtab \- static information about filesystems managed by cryptmount cmtab \- static information about filesystems managed by cryptmount
.\" -------------------------------- .\" --------------------------------
.SH DESCRIPTION .SH DESCRIPTION
Information about the encrypted filesystems managed by Information about the encrypted filesystems managed by
.B cryptmount .B cryptmount
is contained in the file @CM_SYSCONF_DIR@/cmtab. is contained in the file @CM_SYSCONF_DIR@/cmtab.
Each filesystem is labelled by a target name which can be used as an argument to Each filesystem is labelled by a target name which can be used as an argument to
.B cryptmount .B cryptmount
and which appears in @CM_SYSCONF_DIR@/cmtab in front of a list of parameters des and which appears in @CM_SYSCONF_DIR@/cmtab in front of a list of parameters
cribing where that filesystem is stored, and how it is encrypted. describing where that filesystem is stored, and how it is encrypted.
The format of the cmtab is flexible, with the description of each target being d The format of the cmtab is flexible, with the description of each target
elimited by braces, parameters being specified by KEY=VALUE pairs, and white-spa being delimited by braces, parameters being specified by KEY=VALUE pairs,
ce being freely usable. and white-space being freely usable.
Comments are prefixed by a `#' character, and can start at any point in a line, Comments are prefixed by a `#' character, and can start at any point in a line,
lasting to the end of the line. lasting to the end of the line.
The backslash character `\\' can be used to ignore any special significance of t The backslash character `\\' can be used to ignore any special significance
he following character, for example to include a space in a filename. of the following character, for example to include a space in a filename.
@CM_SYSCONF_DIR@/cmtab contains entries of the following form: @CM_SYSCONF_DIR@/cmtab contains entries of the following form:
.nf .nf
TARGET_NAME { TARGET_NAME {
dev=DEVICE # REQUIRED dev=DEVICE # REQUIRED
flags=FLAG,FLAG,... flags=FLAG,FLAG,...
startsector=STARTSECTOR startsector=STARTSECTOR
numsectors=NUMSECTORS numsectors=NUMSECTORS
loop=LOOPDEV loop=LOOPDEV
dir=MOUNT_POINT dir=MOUNT_POINT # REQUIRED
fstype=TYPE # REQUIRED fstype=TYPE # REQUIRED
mountoptions=MOPT,MOPT,... mountoptions=MOPT,MOPT,...
fsckoptions=FOPT;FOPT;... fsckoptions=FOPT;FOPT;...
supath=SUPATH supath=SUPATH
bootaction=BOOTACTION bootaction=BOOTACTION
cipher=CIPHER cipher=CIPHER
ivoffset=IVOFFSET ivoffset=IVOFFSET
keyformat=KEYMANAGER keyformat=KEYMANAGER
keyfile=KEYFILE # REQUIRED keyfile=KEYFILE # REQUIRED
keyhash=KEYHASH keyhash=KEYHASH
skipping to change at line 94 skipping to change at line 99
specifies the name that cryptmount uses to refer to a particular filesystem, specifies the name that cryptmount uses to refer to a particular filesystem,
with configuration options for that filesystem contained within with configuration options for that filesystem contained within
the matching braces. the matching braces.
The special name "_DEFAULTS_" may be used to set default values The special name "_DEFAULTS_" may be used to set default values
in subsequent targets for various parameters such as 'flags', 'fstype', 'mountop tions', 'cipher', 'keyformat', 'keyhash', 'keycipher', 'keymaxlen', 'passwdretri es'. in subsequent targets for various parameters such as 'flags', 'fstype', 'mountop tions', 'cipher', 'keyformat', 'keyhash', 'keycipher', 'keymaxlen', 'passwdretri es'.
Note that if the "_DEFAULTS_" target appears more than once, Note that if the "_DEFAULTS_" target appears more than once,
each will undo the effects of previous default values - each will undo the effects of previous default values -
i.e. this pseudo-target does not operate incrementally. i.e. this pseudo-target does not operate incrementally.
.\" ---- .\" ----
.TP .TP
.B dev=DEVICE .B dev=DEVICE\t(required)
sets the name of the raw device (e.g. /dev/hdb63) sets the name of the raw device (e.g. /dev/hdb63)
or ordinary file (e.g. /home/secretiveuser/private.fs) or ordinary file (e.g. /home/secretiveuser/private.fs)
that contains the encrypted filesystem. that contains the encrypted filesystem.
Note that it may be useful to use a symbolic name based on Note that it may be useful to use a symbolic name based on
an entry beneath /dev/disk/by-id, /dev/disk/by-path, an entry beneath /dev/disk/by-id, /dev/disk/by-path,
to reduce the risk of device nodes being renamed when new disks to reduce the risk of device nodes being renamed when new disks
are added to the system, etc. are added to the system, etc.
.\" ---- .\" ----
.TP .TP
.B flags=FLAG,FLAG,... .B flags=FLAG,FLAG,...
skipping to change at line 137 skipping to change at line 142
gives the total length of the filesystem in sectors (512-byte blocks). gives the total length of the filesystem in sectors (512-byte blocks).
This parameter is optional, and defaults to \-1 which is shorthand for the total available length of This parameter is optional, and defaults to \-1 which is shorthand for the total available length of
.BR DEVICE . .BR DEVICE .
.\" ---- .\" ----
.TP .TP
.B loop=LOOPDEV .B loop=LOOPDEV
can be used to specify a particular loopback device (e.g. /dev/loop0) can be used to specify a particular loopback device (e.g. /dev/loop0)
to be used when DEVICE is an ordinary file. to be used when DEVICE is an ordinary file.
This parameter is optional and defaults to "auto". This parameter is optional and defaults to "auto".
.TP .TP
.B dir=MOUNT_POINT .B dir=MOUNT_POINT\t(required)
specifies the directory onto which the encrypted filesystem will be mounted. specifies the directory onto which the encrypted filesystem will be mounted.
.\" ---- .\" ----
.TP .TP
.B fstype=TYPE .B fstype=TYPE\t(required)
sets the filesystem type (as used by sets the filesystem type (as used by
.B mount .B mount
(8)). (8)).
This must be set to "swap" if the device is to be used as an encrypted swap part ition. This must be set to "swap" if the device is to be used as an encrypted swap part ition.
.\" ---- .\" ----
.TP .TP
.B mountoptions=MOPT,MOPT,... .B mountoptions=MOPT,MOPT,...
sets filesystem mounting options, as used by sets filesystem mounting options, as used by
.B mount .B mount
(8). MOPT can typically be "default", "noatime", "noexec", "nosuid", "ro", "sync " etc. (8). MOPT can typically be "default", "noatime", "noexec", "nosuid", "ro", "sync " etc.
skipping to change at line 175 skipping to change at line 180
.B fsck .B fsck
and and
.B mount .B mount
need to run subcommands (e.g. fsck.ext4). need to run subcommands (e.g. fsck.ext4).
By default, this PATH is set to @CM_DEFAULT_SUPATH@. By default, this PATH is set to @CM_DEFAULT_SUPATH@.
.\" ---- .\" ----
.TP .TP
.B bootaction=BOOTACTION .B bootaction=BOOTACTION
indicates what action, if any, should be taken indicates what action, if any, should be taken
for this target on system bootup. for this target on system bootup.
BOOTACTION can be one of "none", "mount", "swap" or "prepare". BOOTACTION can be one of "none", "mount", "swap" or "prepare",
with the default being "none".
.TP .TP
.B cipher=CIPHER .B cipher=CIPHER
sets the encryption algorithm used on the sets the encryption algorithm used on the
.BR DEVICE . .BR DEVICE .
The available algorithms are determined by the system kernel. The available algorithms are determined by the system kernel.
This parameter is optional and defaults to "@CM_DEFAULT_CIPHER@". This parameter is optional and defaults to "@CM_DEFAULT_CIPHER@".
.\" ---- .\" ----
.TP .TP
.B keyformat=KEYMANAGER .B keyformat=KEYMANAGER
specifies the key management scheme used to interact with the specifies the key management scheme used to interact with the
skipping to change at line 199 skipping to change at line 205
section below. section below.
The set of available key management schemes is determined when The set of available key management schemes is determined when
.B cryptmount .B cryptmount
is built, but may include "libgcrypt", "luks", and "openssl-compat", is built, but may include "libgcrypt", "luks", and "openssl-compat",
in addition to "builtin" and "raw". in addition to "builtin" and "raw".
This parameter is optional: This parameter is optional:
if absent, "builtin" will be used on first generating the key, if absent, "builtin" will be used on first generating the key,
with an automatic choice being made when reading a pre-existing key. with an automatic choice being made when reading a pre-existing key.
.\" ---- .\" ----
.TP .TP
.B keyfile=KEYFILE .B keyfile=KEYFILE\t(required)
gives the name of an ordinary file that contains the key used by the gives the name of an ordinary file that contains the key used by the
.B CIPHER .B CIPHER
algorithm to decrypt the filesystem. This key is itself encrypted in a way speci fied by the algorithm to decrypt the filesystem. This key is itself encrypted in a way speci fied by the
.B KEYHASH .B KEYHASH
and and
.B KEYCIPHER .B KEYCIPHER
\. \.
.TP .TP
.B ivoffset=IVOFFSET .B ivoffset=IVOFFSET
sets the offset added to the sector-number used in constructing sets the offset added to the sector-number used in constructing
 End of changes. 9 change blocks. 
16 lines changed or deleted 17 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)