LU-10092 pcc: Non-blocking PCC caching

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

diff --git a/lustre/doc/lfs-pcc.1 b/lustre/doc/lfs-pcc.1
index e4746f5..c709c8d 100644 (file)
--- a/lustre/doc/lfs-pcc.1
+++ b/lustre/doc/lfs-pcc.1
@@ -2,7 +2,9 @@
 .SH NAME
 lfs pcc commands used to interact with PCC features.
 .SH SYNOPSIS
-.B lfs pcc attach <\fB--id\fR|\fB-i\fR NUM>  <\fIfile \fR...>
+.B lfs pcc attach <\fB--id\fR|\fB-i\fR \fINUM\fR>  <\fIfile \fR...>
+.br
+.B lfs pcc attach <\fB--id\fR|\fB-i\fR \fINUM\fR>  <\fB--mnt\fR|\fB-m\fR \fImntpath\fR> <\fIfid \fR...>
 .br
 .B lfs pcc detach <\fIfile \fR...>
 .br
@@ -11,9 +13,12 @@ lfs pcc commands used to interact with PCC features.
 .B lfs pcc state <\fIfile \fR...>
 .SH DESCRIPTION
 .TP
-.B lfs pcc attach <\fB--id\fR|\fB-i\fR NUM>  <\fIfile \fR...>
+.B lfs pcc attach <\fB--id\fR|\fB-i\fR \fINUM\fR>  <\fIfile \fR...>
 Attach given files on the persistent client cache.
 .TP
+.B lfs pcc attach <\fB--id\fR|\fB-i\fR \fINUM\fR>  <\fB--mnt\fR|\fB-m\fR \fImntpath\fR> <\fIfid \fR...>
+Attach given fils into the persistent client cache by FID(s).
+.TP
 .B lfs pcc detach <\fIfile \fR...>
 Detach given files from the persistent client cache.
 .TP
@@ -28,9 +33,12 @@ Display the PCC state for given files.
 .B --id | -i
 For RW-PCC, it is HSM ARCHIVE ID to choose which backend for cache files.
 .TP
+.B --mnt | -m
+Specifies Lustre mount point.
+.TP
 Before using RW-PCC, you need to configure HSM root and Archive ID mapping properly:
 .TP
-.B lfs pcc add $MNTPATH $PCCPATH "$ARCHIVE_ID $PROJID"
+.B lfs pcc add $MNTPATH $PCCPATH \ "$ARCHIVE_ID $PROJID"
 Add one PCC backend to the Lustre client, you need to specify hsm root,
 archive ID, and project ID. On this client any subsequently created
 files with this project ID will be persistently cached automatically.
@@ -49,15 +57,21 @@ Enable HSM on the appropriate MDT.
 .B # lhsmtool_posix --daemon --hsm-root /mnt/pcc/ --archive=1 /mnt/lustre
 Launch one copytool on client node to connect cache storage.
 .TP
-.B # lfs pcc add /mnt/lustre /mnt/pcc \ "1\ 1"
+.B # lfs pcc add /mnt/lustre /mnt/pcc \ "1\ 100"
 Add HSM root and Archive ID mapping for RW-PCC.
 .TP
 .B $ lfs pcc attach -i 1 /mnt/lustre/file
 Attach an existing file into PCC and migrate data from lustre to Cache Device,
 any I/O to the Lustre file will direct to the RW-PCC copy.
 .TP
+.B $ lfs pcc attach_fid -i 1 -m /mnt/lustre 0x200000401:0x1:0x0
+Attach an existing file referenced by FID "0x200000401:0x1:0x0" into PCC.
+.TP
 .B $ lfs pcc detach /mnt/lustre/file
-Detach the file from RW-PCC, IO to the file will come to Lustre after this command.
+Detach the file from RW-PCC, IO to the file will come to Lustre after this
+command.
+.B $ lfs pcc detach_fid /mnt/lustre 0x200000401:0x1:0x0
+Detach the file referenced by FID "0x200000401:0x1:0x0" from PCC.
 .TP
 .B $ lfs pcc state /mnt/lustre/file
 .br