LU-17871 ldlm: FLOCK ownlocks may be not set

[fs/lustre-release.git] / lustre / doc / lfs-mirror-resync.1

diff --git a/lustre/doc/lfs-mirror-resync.1 b/lustre/doc/lfs-mirror-resync.1
index 11eea0f..f492c97 100644 (file)
--- a/lustre/doc/lfs-mirror-resync.1
+++ b/lustre/doc/lfs-mirror-resync.1
@@ -1,29 +1,54 @@
 .TH LFS-MIRROR-RESYNC 1 2017-07-25 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror resync \- resynchronize an out-of-sync mirrored file
+lfs-mirror-resync \- resynchronize an out-of-sync mirrored file
 .SH SYNOPSIS
 .B lfs mirror resync
 [\fB\-\-only\fR <\fImirror_id\fR[,...]>]
-<\fImirrored_file\fR>
+<\fB\-\-bandwidth\-limit=\fR|\fB\-W\fR[\fIbandwidth_limit\fR]>
+[\fB\-\-stats\fR]
+<\fB\-\-stats\-interval\fR=\fIinterval_in_sec\fR>
+<\fImirrored_file\fR> [<\fImirrored_file2\fR>...]
 .SH DESCRIPTION
-This command resynchronizes an out-of-sync mirrored file specified by the path
+This command resynchronizes out-of-sync mirrored file(s) specified by the path
 name \fImirrored_file\fR.
 .br
-If there is no stale mirror for the \fImirrored_file\fR, then the command does
+If there is no stale mirror for the \fImirrored_file(s)\fR, then the command does
 nothing. Otherwise, it will copy data from synced mirror to stale mirror(s), and
 mark all successfully copied mirror(s) as SYNC.
+.br
+If \fB\-\-only\fR option is not specified, the \fBnosync\fR mirror(s) (i.e.
+components that have this flag set) will not be synced.
+.br
 If \fB\-\-only\fR <\fImirror_id\fR[,...]> option is specified, then the
-command will resynchronize the mirror(s) specified by the \fImirror_id\fR(s).
+command will resynchronize the mirror(s) specified by the \fImirror_id\fR(s),
+even nosync mirror(s) will be resynchronized as well.
+This option cannot be used when multiple mirrored files are specified.
 .SH OPTIONS
 .TP
 .BR \-\-only\fR\ <\fImirror_id\fR[,...]>
 This option indicates which mirror(s) specified by \fImirror_id\fR(s) needs to
 be resynchronized. The \fImirror_id\fR is the numerical unique identifier for
-a mirror. Multiple \fImirror_id\fRs are separated by comma.
+a mirror. Multiple \fImirror_id\fRs are separated by comma. This option cannot
+be used when multiple mirrored files are specified.
+.TP
+.BR \-\-stats
+This option enables progress updates every 5 seconds, in YAML format.
+.TP
+.BR \-\-stats-interval=\fIstats_interval
+This option enables progress updates every \fIstats_interval\fR seconds, in YAML format.
+.TP
+.BR \-\-bandwidth\-limit\fR|\fB\-W\fR\fIbandwidth_limit\fR
+This option enables throttling so that mirror extending writes no more than
+\fIbandwidth_limit\fR bytes a second.  An optional suffix can be used to
+specify the units in
+.BR K ilobytes,
+.BR M egabytes
+or
+.BR  G igabytes.
 .SH EXAMPLES
 .TP
-.B lfs mirror resync /mnt/lustre/file1
-Resynchronize all of the stale mirror(s) for /mnt/lustre/file1.
+.B lfs mirror resync /mnt/lustre/file1 /mnt/lustre/file2
+Resynchronize all of the stale and sync-able mirror(s) for /mnt/lustre/file1 and /mnt/lustre/file2.
 .TP
 .B lfs mirror resync --only 4,5 /mnt/lustre/file1
 Resynchronize mirrors with mirror ID 4 and 5 for /mnt/lustre/file1 even if they