1
0
mirror of git://sourceware.org/git/lvm2.git synced 2025-01-03 05:18:29 +03:00

man: add dmfilemapd options to dmstats.8.in

Add descriptions of --follow and --nomonitor, and the behaviour
of create and update_filemap when starting dmfilemapd.
This commit is contained in:
Bryn M. Reeves 2016-12-17 16:41:00 +00:00
parent baa8a9be4a
commit b5c8accdf2

View File

@ -14,6 +14,9 @@
. RB [ \-\-region ] . RB [ \-\-region ]
. RB [ \-\-group ] . RB [ \-\-group ]
.. ..
.de OPT_FOREGROUND
. RB [ \-\-foreground ]
..
. .
.\" Print units suffix, use with arg to print human .\" Print units suffix, use with arg to print human
.\" man2html can't handle too many changes per command .\" man2html can't handle too many changes per command
@ -89,6 +92,10 @@ dmstats \(em device-mapper statistics management
. RB [ \-\-bounds . RB [ \-\-bounds
. IR \%histogram_boundaries ] . IR \%histogram_boundaries ]
. RB [ \-\-filemap ] . RB [ \-\-filemap ]
. RB [ \-\-follow
. IR follow_mode ]
. OPT_FOREGROUND
. RB [ \-\-nomonitor ]
. RB [ \-\-nogroup ] . RB [ \-\-nogroup ]
. RB [ \-\-precise ] . RB [ \-\-precise ]
. RB [ \-\-start . RB [ \-\-start
@ -215,6 +222,9 @@ dmstats \(em device-mapper statistics management
. IR file_path . IR file_path
. RB [ \-\-groupid . RB [ \-\-groupid
. IR id ] . IR id ]
. RB [ \-\-follow
. IR follow_mode ]
. OPT_FOREGROUND
. ad b . ad b
.. ..
.CMD_UPDATE_FILEMAP .CMD_UPDATE_FILEMAP
@ -314,6 +324,60 @@ create regions corresponding to the locations of the on-disk extents
allocated to the file(s). allocated to the file(s).
. .
.HP .HP
.BR \-\-nomonitor
.br
Disable the \fBdmfilemapd\fP daemon when creating new file mapped
groups. Normally the device-mapper filemap monitoring daemon,
\fBdmfilemapd\fP, is started for each file mapped group to update the
set of regions as the file changes on-disk: use of this option
disables this behaviour.
Regions in the group may still be updated with the
\fBupdate_filemap\fP command, or by starting the daemon manually.
.
.HP
.BR \-\-follow
.IR follow_mode
.br
Specify the \fBdmfilemapd\fP file following mode. The file map
monitoring daemon can monitor files in two distinct ways: the mode
affects the behaviour of the daemon when a file under monitoring is
renamed or unlinked, and the conditions which cause the daemon to
terminate.
The \fBfollow_mode\fP argument is either "inode", for follow-inode
mode, or "path", for follow-path.
If follow-inode mode is used, the daemon will hold the file open, and
continue to update regions from the same file descriptor. This means
that the mapping will follow rename, move (within the same file
system), and unlink operations. This mode is useful if the file is
expected to be moved, renamed, or unlinked while it is being
monitored.
In follow-inode mode, the daemon will exit once it detects that the
file has been unlinked and it is the last holder of a reference to it.
If follow-path is used, the daemon will re-open the provided path on
each monitoring iteration. This means that the group will be updated
to reflect a new file being moved to the same path as the original
file. This mode is useful for files that are expected to be updated
via unlink and rename.
In follow-path mode, the daemon will exit if the file is removed and
not replaced within a brief tolerance interval.
In either mode, the daemon exits automatically if the monitored group
is removed.
.
.HP
.BR \-\-foreground
.br
Specify that the \fBdmfilemapd\fP daemon should run in the foreground.
The daemon will not fork into the background, and will replace the
\fBdmstats\fP command that started it.
.
.HP
.BR \-\-groupid .BR \-\-groupid
.IR id .IR id
.br .br
@ -568,6 +632,11 @@ By default regions that map a file are placed into a group and the
group alias is set to the basename of the file. This behaviour can be group alias is set to the basename of the file. This behaviour can be
overridden with the \fB\-\-alias\fP and \fB\-\-nogroup\fP options. overridden with the \fB\-\-alias\fP and \fB\-\-nogroup\fP options.
Creating a group that maps a file automatically starts a daemon,
\fBdmfilemapd\fP to monitor the file and update the mapping as the
extents allocated to the file change. This behaviour can be disabled
using the \fB\-\-nomonitor\fP option.
Use the \fB\-\-group\fP option to only display information for groups Use the \fB\-\-group\fP option to only display information for groups
when listing and reporting. when listing and reporting.
. .
@ -678,17 +747,23 @@ The group to be removed is specified using \fB\-\-groupid\fP.
.CMD_UPDATE_FILEMAP .CMD_UPDATE_FILEMAP
.br .br
Update a group of \fBdmstats\fP regions specified by \fBgroup_id\fP, Update a group of \fBdmstats\fP regions specified by \fBgroup_id\fP,
that were previously created with \fB\-\-filemap\fP. This will add that were previously created with \fB\-\-filemap\fP, either directly,
and remove regions to reflect changes in the allocated extents of or by starting the monitoring daemon, \fBdmfilemapd\fP.
the file on-disk, since the time that it was crated or last updated.
This will add and remove regions to reflect changes in the allocated
extents of the file on-disk, since the time that it was crated or last
updated.
Use of this command is not normally needed since the \fBdmfilemapd\fP Use of this command is not normally needed since the \fBdmfilemapd\fP
daemon will automatically monitor filemap groups and perform these daemon will automatically monitor filemap groups and perform these
updates when required. updates when required.
If a filemapped group was created with \fB\-\-nominitor\fP, or the If a filemapped group was created with \fB\-\-nomonitor\fP, or the
daemon has been killed, the \fBupdate_filemap\fP can be used to daemon has been killed, the \fBupdate_filemap\fP can be used to
manually force an update. manually force an update or start a new daemon.
Use \fB\-\-nomonitor\fP to force a direct update and disable starting
the monitoring daemon.
. .
.SH REGIONS, AREAS, AND GROUPS .SH REGIONS, AREAS, AND GROUPS
. .