From: Frederick Dilger Date: Thu, 15 Aug 2024 06:59:20 +0000 (-0600) Subject: LU-4315 doc: updating lctl-[p-s] man page style X-Git-Tag: 2.16.51~163 X-Git-Url: https://git.whamcloud.com/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F71%2F56071%2F8;p=fs%2Flustre-release.git LU-4315 doc: updating lctl-[p-s] man page style Updating files to match the new code style for Lustre manual pages as enforced by 'contrib/scripts/checkpatch-man.pl'. This also includes other changes like removing < > or { } for singular required arguments and placing [ ] around optional ones as well as making all arguments CAPITAL and italicized, literal arguments are bolded. Lines over 80 characters should be split at the natural line end rather than the word that goes over the limit as fewer lines will need to be modified when making changes if each sentence is on it's own line. Only using features that appear in groff 1.22.3 as this is the available version is CentOS 8. Checked files: - lctl-pcc.8 - lctl-pool_add.8 - lctl-pool_new.8 - lctl-set_param.8 - lctl-snapshot-create.8 - lctl-snapshot-destroy.8 - lctl-snapshot-list.8 - lctl-snapshot-modify.8 - lctl-snapshot-mount.8 - lctl-snapshot-umount.8 Test-Parameters: trivial Signed-off-by: Frederick Dilger Change-Id: Icd30b49a3025aede26524b09cefa438bdca2ccc4 Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56071 Tested-by: jenkins Tested-by: Maloo Reviewed-by: Arshad Hussain Reviewed-by: Andreas Dilger Reviewed-by: Oleg Drokin --- diff --git a/lustre/doc/lctl-pcc.8 b/lustre/doc/lctl-pcc.8 index 3e409be..cdf0102 100644 --- a/lustre/doc/lctl-pcc.8 +++ b/lustre/doc/lctl-pcc.8 @@ -1,68 +1,87 @@ -.TH LCTL-PCC 8 "2019-04-24" Lustre "configuration utilities" +.TH LCTL-PCC 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-pcc \- commands used to interact with PCC features .SH SYNOPSIS -.B lctl pcc add \fR<\fImntpath\fR> <\fIpccpath\fR> [\fB--param\fR|\fB-p\fR <\fIparam\fR>] -.br -.B lctl pcc del [\fB--keep\fR|\fB-k\fR] <\fImntpath\fR> <\fIpccpath\fR> -.br -.B lctl pcc clear [\fB--keep\fR|\fB-k\fR] <\fImntpath\fR> -.br -.B lctl pcc list <\fImntpath\fR> +.SY "lctl pcc add" +.I MNTPATH +.I PCCPATH +.RB [ --param | -p +.IR PARAM ] +.SY "lctl pcc del" +.RB [ --keep | -k ] +.I MNTPATH +.I PCCPATH +.SY "lctl pcc clear" [ --keep | -k ] +.I MNTPATH +.SY "lctl pcc list" +.I MNTPATH +.YS .SH DESCRIPTION .TP -.B lctl pcc add \fR<\fImntpath\fR> <\fIpccpath\fR> [\fB--param\fR|\fB-p\fR <\fIparam\fR>] +.BR "lctl pcc add " \fIMNTPATH\ PCCPATH " " [ --param | -p " " \fIPARAM ] Add a PCC backend specified by HSM root path -.IR pccpath +.I PCCPATH on a Lustre filesystem client instances with the mount point referenced by -.IR mntpath . +.IR MNTPATH . The parameter -.IR param +.IR PARAM is a string in the form of name-value pairs to config the PCC backend such as read-write attach id (archive ID) or read-only attach id and auto caching rule. -i.e. for the string "projid={500}&fname={*.h5} rwid=2", the first substring of -the config parameter is the auto caching rule. Where "&" represents the logical -conjunction operator while "," represents the logical disjunction operator. The -example rule means that new files are only auto cached if the project ID is 500 -and the suffix of the file name is "h5". "rwid" represents the read-write -attach id (2) which value is same as the archive ID of the copytool agent -running on this PCC node. -In addition to the equal (=) operator, it also supports greater than (>) and -less than (<) comparison operators. +i.e. for the string "projid={500}&fname={*.h5} rwid=2", +the first substring of the config parameter is the auto caching rule. +Where "&" represents the logical conjunction operator +while "," represents the logical disjunction operator. +The example rule means that new files are only auto cached +if the project ID is 500 and the suffix of the file name is "h5". +"rwid" represents the read-write attach id (2) which value is same +as the archive ID of the copytool agent running on this PCC node. +In addition to the equal (=) operator, +it also supports greater than (>) and less than (<) comparison operators. The following rule expressions are supported: +.EX - "projid={100}&size>{1M}&size<{500G}" - "projid>{100}&projid<{110}" - "uid<{1500}&uid>{1000}" -Currently each PCC backend only has one rule which is configured when setup PCC -backend on a client. If a user wants to change the rule, the PCC backend needs -to be removed first and then added back with a new rule. +.EE +Currently each PCC backend only has one rule +which is configured when setup PCC backend on a client. +If a user wants to change the rule, +the PCC backend needs to be removed first and then added back with a new rule. .TP -.B lctl pcc del [\fB--keep\fR|\fB-k\fR] <\fImntpath\fR> <\fIpccpath\fR> +.BR "lctl pcc del " [ --keep | -k ] \ \fIMNTPATH\ PCCPATH Delete a PCC backend specified by path .IR pccpath on a Lustre client referenced by the mount point of .IR mntpath . .TP -.B lctl pcc clear [\fB--keep\fR|\fB-k\fR] <\fImntpath\fR> +.BR "lctl pcc clear " [ --keep | -k ] \ \fIMNTPATH Remove all PCC backend on a Lustre client referenced by the mount point of .IR mntpath . .TP -.B lctl pcc list <\fImntpath\fR> +.B lctl pcc list \fIMNTPATH List all PCC backends on a Lustre client referenced by the mount point of .IR mntpath . .SH OPTIONS .TP -.B --param | -p +.BR -p ", " --param Specifies the configuration parameters for a PCC backend. .TP -.B --keep | -k -By default, when remove a PCC backend from a client, the action is to scan the -PCC backend fs, and then uncache (detach and remove) all scanned PCC copies -from PCC by FIDs. With the option "--keep|-k", the "lctl pcc del|clear" command -just removes the PCC backend from the Lustre client, and retains the data on the -cache. In this way, the PCC-RW backend falls back as a tranditional HSM storage -solution since the copytool is still running at this client. +.BR -k ", " --keep +By default, when remove a PCC backend from a client, +the action is to scan the PCC backend fs, +and then uncache (detach and remove) all scanned PCC copies from PCC by FIDs. +With the option "--keep|-k", the "lctl pcc del|clear" command +just removes the PCC backend from the Lustre client, +and retains the data on the cache. In this way, +the PCC-RW backend falls back as a tranditional HSM storage solution +since the copytool is still running at this client. .TP +.SH AVAILABILITY +.B lctl pcc +is part of the +.BR lustre (7) +filesystem package since release 2.13.0 +.\" Added in commit v2_12_53-113-gf172b11688 .SH SEE ALSO .BR lfs (1), .BR lfs-hsm (1), diff --git a/lustre/doc/lctl-pool_add.8 b/lustre/doc/lctl-pool_add.8 index fccfe05..a9d2627 100644 --- a/lustre/doc/lctl-pool_add.8 +++ b/lustre/doc/lctl-pool_add.8 @@ -1,35 +1,38 @@ -.TH LCTL-POOL_ADD 8 "2018-12-12" Lustre "configuration utilities" +.TH LCTL-POOL_ADD 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-pool_add \- add OSTs to a named pool .SH SYNOPSIS -.BR "lctl pool_add" " [" --nowait | -n "] " -.IR . " " " " ... -.br -.BR "lctl pool_add" " [" --nowait | -n "] " -.IR . " " " "... - +.SY "lctl pool_add" +.RB [ --nowait | -n ] +.IR FSNAME . POOL +.IR OST_INDEX1 " [" OST_INDEX2 ...] +.SY "lctl pool_add" +.RB [ --nowait | -n ] +.IR FSNAME . POOL +.IR OST_RANGE1 " [" OST_RANGE2 ...] +.YS .SH DESCRIPTION Add one or more OSTs to the pool named -.I poolname +.I POOLNAME in the filesystem named -.IR fsname . -There are several formats that the OSTs can be specified. Simplest is +.IR FSNAME . +There are several formats that the OSTs can be specified. Simplest is to just specify a list of -.RI < ost_index > -numbers or OST names. It is also possible to specify an -.RI < ost_range > +.I OST_INDEX +numbers or OST names. It is also possible to specify an +.I OST_RANGE expression of the form -.BI [ start - end ] +.BI [ START - END ] or -.BI [ start - end / step ] +.BI [ START - END / STEP ] that adds multiple OSTs with index numbers in the range from -.I start +.I START to -.I end +.I END (inclusive), optionally skipping every -.I step +.I STEP index values. - +.P .BR NOTE: After updating the MGS configuration, this command tries to wait and check if pools are updated on a client. @@ -38,7 +41,7 @@ be mounted on the MGS node while the .B lctl commands are being run for this. Otherwise, the client check is skipped. - +.P The OST pool can be used by .BR lfs-setstripe (1) to specify the OSTs on which new files can be created, and @@ -49,10 +52,9 @@ Note however, that the OSTs that make up a specific pool may change over time, and it is the .I poolname used at creation time that is stored on each file, not necessarily -OSTs that are in the current pool. As well, +OSTs that are in the current pool. As well, .BR lfs-df (1) can show only the free space or inodes in a named pool. - .SH OPTIONS .TP .BR -n ", " --nowait @@ -62,25 +64,37 @@ when calling a lot of " pool_*" in a row. This avoids revoking the clients "CONFIG" lock for each command (by default clients retake their lock and update their configurations in a delay between 5-10s). - .SH EXAMPLES -.TP -.B # lfs pool_new testfs.local +.PP Create a pool named .B local in the .B testfs -filesystem. -.TP -.B # lfs pool_add testfs.local 12 13 14 +filesystem: +.RS 8 +.EX +.B # lfs pool_new testfs.local +.EE +.RE +.PP Add OSTs numbered 12, 13, and 14 to the .B testfs.local -pool. - +pool: +.RS 8 +.EX +.B # lfs pool_add testfs.local 12 13 14 +.EE +.RE +.SH AVAILABILITY +.B lctl pool_add +is part of the +.BR lustre (7) +filesystem package since release 1.7.0 +.\" Added in commit 1.6.0-1808-g665e36b780 .SH SEE ALSO -.BR lctl (8), -.BR lctl-pool_new (8), .BR lfs-df (1), .BR lfs-find (1), .BR lfs-setstripe (1), -.BR lustre (7) +.BR lustre (7), +.BR lctl (8), +.BR lctl-pool_new (8) diff --git a/lustre/doc/lctl-pool_new.8 b/lustre/doc/lctl-pool_new.8 index 7fef593..d80f81c 100644 --- a/lustre/doc/lctl-pool_new.8 +++ b/lustre/doc/lctl-pool_new.8 @@ -1,20 +1,21 @@ -.TH LCTL-POOL_NEW 8 "2018-12-12" Lustre "Lustre Utilities" +.TH LCTL-POOL_NEW 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-pool_new \- create a new OST pool .SH SYNOPSIS -.BR "lctl pool_new" " [" --nowait | -n "] " -.IR . - +.SY "lctl pool_new" +.RB [ --nowait | -n ] +.IR FSNAME . POOL +.YS .SH DESCRIPTION Create a list of OSTs with the name -.I poolname +.I POOLNAME in the filesystem named -.IR fsname . +.IR FSNAME . The .B lctl pool_new command must be run on the MGS node and can only be used by the root user. - +.P .BR NOTE: After updating the MGS configuration, this command tries to wait and check if pools are updated on a client. @@ -23,15 +24,14 @@ be mounted on the MGS node while the .B lctl commands are being run for this. Otherwise, the client check is skipped. - +.P This named list of OSTs can be used by .BR lfs-setstripe (1) to specify the OSTs on which new files can be created, and .BR lfs-find (1) -to locate files that were created on the specified pool. As well, +to locate files that were created on the specified pool. As well, .BR lfs-df (1) can show only the free space or inodes in a named pool. - .SH OPTIONS .TP .BR -n ", " --nowait @@ -41,25 +41,37 @@ when calling a lot of " pool_*" in a row. This avoids revoking the clients "CONFIG" lock for each command (by default clients retake their lock and update their configurations in a delay between 5-10s). - .SH EXAMPLES -.TP -.B # lfs pool_new testfs.local +.PP Create a pool named .B local in the .B testfs -filesystem. -.TP -.B # lfs pool_add testfs.local 12 13 14 +filesystem: +.RS 8 +.EX +.B # lfs pool_new testfs.local +.EE +.RE +.PP Add OSTs numbered 12, 13, and 14 to the .B testfs.local -pool. - +pool: +.RS 8 +.EX +.B # lfs pool_add testfs.local 12 13 14 +.EE +.RE +.SH AVAILABILITY +.B lctl pool_new +is part of the +.BR lustre (7) +filesystem package since release 1.7.0 +.\" Added in commit 1.6.0-1808-g665e36b780 .SH SEE ALSO -.BR lctl (8), -.BR lctl-pool_add (8), .BR lfs-df (1), .BR lfs-find (1), .BR lfs-setstripe (1), .BR lustre (7) +.BR lctl (8), +.BR lctl-pool_add (8), diff --git a/lustre/doc/lctl-set_param.8 b/lustre/doc/lctl-set_param.8 index 9f48adf..fff4794 100644 --- a/lustre/doc/lctl-set_param.8 +++ b/lustre/doc/lctl-set_param.8 @@ -1,81 +1,84 @@ -.TH LCTL-SET_PARAM 8 "2019-05-10" Lustre "configuration utilities" +.TH LCTL-SET_PARAM 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-set_param \- Lustre filesystem set parameter utility .SH SYNOPSIS -.B "\fBlctl set_param " +.SY "lctl set_param" .RB [ --delete | -d ] .RB [ --file | -F ] .RB [ --no-name | -n ] .RB [ --permanent | -P ] -.RB [ --thread | -t [ \fITHREAD_COUNT ]] +.RB [ --thread | -t\c +.RI [ THREAD_COUNT ]] .IR PARAMETER \= VALUE " ..." -.br -.B lctl set_param -F -.IR FILENAME +.SY lctl set_param -F +.I FILENAME +.YS .SH DESCRIPTION Set the value of the named Lustre or LNet -.I parameter +.I PARAMETER to -.I value -on the local node. Parameter names consist of one or more components, -separated by a '.' (period). Each component may be specified by plain text -or by a wildcard in the +.I VALUE +on the local node. Parameter names consist of one or more components, +separated by a '.' (period). +Each component may be specified by plain text or by a wildcard in the .BR glob (7) -format. When wildcards are used, more than one parameter may match and -be changed. Parameters are often, but not always, of the form -.IR obd_name.obd_instance.parameter_name , +format. When wildcards are used, more than one parameter may match and +be changed. Parameters are often, but not always, of the form +.IR OBD_NAME.OBD_INSTANCE.PARAMETER_NAME , where -.I obd_name +.I OBD_NAME is one of the OBD object types, like .BR ldlm ", " llite ", " lmv ", " lov ", " mdc ", " osc , etc., and -.I obd_instance +.I OBD_INSTANCE is the name of a Lustre device, like .BR testfs-OST0000 , -but may be a specific component, or contain wildcards to match some or all -devices on the node. Parameters can only be modified by the root user for -security reasons. +but may be a specific component, +or contain wildcards to match some or all devices on the node. +Parameters can only be modified by the root user for security reasons. .SH OPTIONS The various options supported by .B lctl list_param are listed and explained below: .TP -.B -d ", " --delete +.BR -d ", " --delete Remove the permanent setting (only for parameters set with the .B -P option). .TP -.B -F ", " --file +.BR -F ", " --file Set parameters from -.I filename -instead of from the command-line. The contents of -.I filename +.I FILENAME +instead of from the command-line. The contents of +.I FILENAME is YAML format, created as an output from -.RB ' "lctl --device MGS llog_print " \fIFSNAME\fB "-client" ' +.RB ' "lctl --device MGS llog_print" +.I FSNAME\c +.BR -client ' or any other valid llog configuration log as listed by .RB ' "lctl --device MGS llog_catlist" ' .TP -.B -n ", " --no-name +.BR -n ", " --no-name Disable printing of the parameter name after setting it. .TP -.B -P ", " --permanent +.BR -P ", " --permanent Set -.I parameter +.I PARAMETER permanently on .B all -nodes connected to the MGS on which the command is run. To limit wildcard -.I parameter +nodes connected to the MGS on which the command is run. To limit wildcard +.I PARAMETER matching to specific filesystems or parameters, ensure that -.I parameter +.I PARAMETER contains a suitably-specific expression for the -.I obd_name +.I OBD_NAME and -.IR obd_instance , -such as the filesystem and/or target name. This option is only available +.IR OBD_INSTANCE , +such as the filesystem and/or target name. This option is only available in Lustre 2.5.0 and later clients, older clients cannot set persistent parameters, nor will they see them. .TP -.B -t ", " --thread +.BR -t ", " --thread " ["\fITHREAD_COUNT\fR] Spawn threads to set multiple parameters in parallel, optionally specifying the maximum number of threads to run (with no space between .B -t @@ -85,41 +88,32 @@ Without this option parameter(s) are set serially. If .B lctl was compiled without pthread support, a warning message will be -printed and parameters will be set serially. If +printed and parameters will be set serially. If .B -t is specified without any argument, it runs up to 8 threads by default. .SH EXAMPLES +.EX .B # lctl set_param fail_loc=0 timeout=20 -.br fail_loc=0 -.br timeout=20 -.br .B # lctl set_param -n fail_loc=0 timeout=20 -.br 0 -.br 20 -.br -.B -# lctl set_param -t2 "ldlm.namespaces.*osc*.lru_size=clear" -.br +.B # lctl set_param -t2 "ldlm.namespaces.*osc*.lru_size=clear" ldlm.namespaces.fsname-OST0001-osc-MDT0000.lru_size=clear -.br ldlm.namespaces.fsname-OST0000-osc-MDT0000.lru_size=clear -.br .B # lctl set_param -P osc.testfs-OST*.max_dirty_mb=512 -.br osc.testfs-OST0000-osc-ffff8803c9c0f000.max_dirty_mb=512 -.br osc.testfs-OST0001-osc-ffff8803c9c0f000.max_dirty_mb=512 -.br osc.testfs-OST0002-osc-ffff8803c9c0f000.max_dirty_mb=512 -.br osc.testfs-OST0003-osc-ffff8803c9c0f000.max_dirty_mb=512 -.br osc.testfs-OST0004-osc-ffff8803c9c0f000.max_dirty_mb=512 -.br +.SH AVAILABILITY +.B lctl set_param +is part of the +.BR lustre (7) +filesystem package since release 1.7.0 +.\" Added in commit 1.6.0-903-g04af22fc24 .SH SEE ALSO .BR lustre (7), .BR lctl (8), diff --git a/lustre/doc/lctl-snapshot-create.8 b/lustre/doc/lctl-snapshot-create.8 index f2a5a27..e1fef7a 100644 --- a/lustre/doc/lctl-snapshot-create.8 +++ b/lustre/doc/lctl-snapshot-create.8 @@ -1,12 +1,21 @@ -.TH LCTL-SNAPSHOT_CREATE 8 "2017-05-13" Lustre "configuration utilities" +.TH LCTL-SNAPSHOT_CREATE 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-snapshot_create \- create Lustre snapshot .SH SYNOPSIS -.TP -.B lctl snapshot_create \fR[-b | --barrier [on | off]] [-c | --comment comment] - {-F | --fsname fsname} [-h | --help] {-n | --name ssname} - [-r | --rsh remote_shell] [-t | --timeout timeout] -.br +.SY "lctl snapshot_create" +.RB [ -b | --barrier " [" on | off ]] +.RB [ -c | --comment +.IR COMMENT ] +.RB { -F | --fsname +.IR FSNAME } +.RB [ -h | --help ] +.RB { -n | --name +.IR SSNAME } +.RB [ -r | --rsh +.IR REMOTE_SHELL ] +.RB [ -t | --timeout +.IR TIMEOUT ] +.YS .SH DESCRIPTION Create snapshot with the given name. The tool loads system configuration from the file @@ -26,54 +35,54 @@ consistency and want to avoid blocking applications when creating the snapshot, then you can specify barrier .BR off . That will save time when creating the snapshot. If the barrier is -.IR on , +.BR on , then the timeout of the barrier can be specified via .B -t option as described in the subsequent section. .TP -.BR -c ", " --comment " "\fIcomment +.BR -c ", " --comment \ \fICOMMENT Add an optional comment to the .B snapshot_create request. The comment can include anything to describe what the snapshot is for or for a reminder. The comment can be shown via .BR snapshot_list . .TP -.BR -F ", " --fsname " "\fIfsname +.BR -F ", " --fsname \ \fIFSNAME The filesystem name. .TP -.BR -h ", " --help +.BR -h ", " --help For help information. .TP -.BR -n ", " --name " "\fIssname +.BR -n ", " --name \ \fISSNAME The snapshot's name must be specified. It follows the general ZFS snapshot name rules, such as the max length is 256 bytes, cannot conflict with the reserved names, and so on. .TP -.BR -r ", " --rsh " "\fIremote_shell +.BR -r ", " --rsh \ \fIREMOTE_SHELL Specify a shell to communicate with remote targets. The default value is .BR ssh . It is the system admin's duty to guarantee that the specified -.I remote_shell +.I REMOTE_SHELL works well among targets without password authentication. .TP -.BR -t ", " --timeout " "\fItimeout +.BR -t ", " --timeout \ \fITIMEOUT If write barrier is .BR on , then the -.I timeout +.I TIMEOUT specifies the write barrier's lifetime in second. The default value is 30. - .SH AVAILABILITY .B lctl-snapshot-create is part of the .BR lustre (7) -filesystem package. +filesystem package since release 2.10.0 +.\" Added in commit v2_9_54_0-67-gd73849a05e .SH SEE ALSO .BR lctl (8), -.BR lctl-lcfg (8), .BR lctl-barrier (8), +.BR lctl-lcfg (8), .BR lctl-snapshot-destroy (8), -.BR lctl-snapshot-modify (8), .BR lctl-snapshot-list (8), +.BR lctl-snapshot-modify (8), .BR lctl-snapshot-mount (8), .BR lctl-snapshot-umount (8) diff --git a/lustre/doc/lctl-snapshot-destroy.8 b/lustre/doc/lctl-snapshot-destroy.8 index b49e21d5..d9ad688 100644 --- a/lustre/doc/lctl-snapshot-destroy.8 +++ b/lustre/doc/lctl-snapshot-destroy.8 @@ -1,11 +1,17 @@ -.TH LCTL-SNAPSHOT_DESTROY 8 "2017-05-13" Lustre "configuration utilities" +.TH LCTL-SNAPSHOT_DESTROY 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-snapshot_destroy \- destroy Lustre snapshot .SH SYNOPSIS -.TP -.B lctl snapshot_destroy \fR[-f | --force] {-F | --fsname fsname} [-h | --help] - {-n | --name ssname} [-r | --rsh remote_shell] -.br +.SY "lctl snapshot_destroy" +.RB [ -f | --force ] +.RB { -F | --fsname +.IR FSNAME } +.RB [ -h | --help ] +.RB { -n | --name +.IR SSNAME } +.RB [ -r | --rsh +.IR REMOTE_SHELL ] +.YS .SH DESCRIPTION Destroy the specified snapshot. The tool loads system configuration from the file @@ -13,7 +19,7 @@ the file as described in the .BR lctl (8) .B SNAPSHOT -section. Then, the snapshot pieces are destroyed on every Lustre target +section. Then, the snapshot pieces are destroyed on every Lustre target (MGT/MDT/OST). .SH OPTIONS .TP @@ -24,33 +30,33 @@ it will be unmounted first and then destroyed. Even if some pieces of the snapshot are lost or broken for some reason(s), the remaining parts of the snapshot can still be destroyed with this option specified. .TP -.BR -F ", " --fsname " "\fIfsname +.BR -F ", " --fsname \ \fIFSNAME The filesystem name. .TP -.BR -h ", " --help +.BR -h ", " --help For help information. .TP -.BR -n ", " --name " "\fIssname +.BR -n ", " --name \ \fISSNAME The snapshot (to be destroyed) name must be specified. .TP -.BR -r ", " --rsh " "\fIremote_shell +.BR -r ", " --rsh \ \fIREMOTE_SHELL Specify a shell to communicate with remote targets. The default value is .BR ssh . It is the system admin's duty to guarantee that the specified -.I remote_shell +.I REMOTE_SHELL works well among targets without password authentication. - .SH AVAILABILITY .B lctl-snapshot-destroy is part of the .BR lustre (7) -filesystem package. +filesystem package since release 2.10.0 +.\" Added in commit v2_9_54_0-67-gd73849a05e .SH SEE ALSO .BR lctl (8), -.BR lctl-lcfg (8), .BR lctl-barrier (8), +.BR lctl-lcfg (8), .BR lctl-snapshot-create (8), -.BR lctl-snapshot-modify (8), .BR lctl-snapshot-list (8), +.BR lctl-snapshot-modify (8), .BR lctl-snapshot-mount (8), .BR lctl-snapshot-umount (8) diff --git a/lustre/doc/lctl-snapshot-list.8 b/lustre/doc/lctl-snapshot-list.8 index 643a160..d92f9ba 100644 --- a/lustre/doc/lctl-snapshot-list.8 +++ b/lustre/doc/lctl-snapshot-list.8 @@ -1,49 +1,55 @@ -.TH LCTL-SNAPSHOT_LIST 8 "2017-05-13" Lustre "configuration utilities" +.TH LCTL-SNAPSHOT_LIST 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-snapshot_list \- query Lustre snapshot .SH SYNOPSIS -.TP -.B lctl snapshot_list \fR[-d | --detail] {-F | --fsname fsname} [-h | --help] - [-n | --name ssname] [-r | --rsh remote_shell] -.br +.SY "lctl snapshot_list" +.RB [ -d | --detail ] +.RB { -F | --fsname +.IR FSNAME } +.RB [ -h | --help ] +.RB [ -n | --name +.IR SSNAME ] +.RB [ -r | --rsh +.IR REMOTE_SHELL] +.YS .SH DESCRIPTION Query the snapshot information, such as fsname of the snapshot, comment, create time, the latest modification time, including mount status and other details. .SH OPTIONS .TP -.BR -d ", " --detail +.BR -d ", " --detail List all the information available for each piece of the snapshot on every target (MGT/MDT/OST). Usually, the information for each piece of the snapshot are the same unless some error occurred during the snapshot operations, such as partly modified or mount. This option allows to check related issues. .TP -.BR -F ", " --fsname " "\fIfsname +.BR -F ", " --fsname \ \fIFSNAME The filesystem name. .TP -.BR -h ", " --help +.BR -h ", " --help For help information. .TP -.BR -n ", " --name " "\fIssname +.BR -n ", " --name \ \fISSNAME The snapshot's name to be queried. If no snapshot name is specified, then all the snapshots belonging to current Lustre filesystem will be listed. .TP -.BR -r ", " --rsh " "\fIremote_shell +.BR -r ", " --rsh \ \fIREMOTE_SHELL Specify a shell to communicate with remote targets. The default value is .BR ssh . It is the system admin's duty to guarantee that the specified -.I remote_shell +.I REMOTE_SHELL works well among targets without password authentication. - .SH AVAILABILITY .B lctl-snapshot-list is part of the .BR lustre (7) -filesystem package. +filesystem package since release 2.10.0 +.\" Added in commit v2_9_54_0-67-gd73849a05e .SH SEE ALSO .BR lctl (8), -.BR lctl-lcfg (8), .BR lctl-barrier (8), +.BR lctl-lcfg (8), .BR lctl-snapshot-create (8), .BR lctl-snapshot-destroy (8), .BR lctl-snapshot-modify (8), diff --git a/lustre/doc/lctl-snapshot-modify.8 b/lustre/doc/lctl-snapshot-modify.8 index 32967b1..f8c5690 100644 --- a/lustre/doc/lctl-snapshot-modify.8 +++ b/lustre/doc/lctl-snapshot-modify.8 @@ -1,12 +1,20 @@ -.TH LCTL-SNAPSHOT_MODIFY 8 "2017-05-13" Lustre "configuration utilities" +.TH LCTL-SNAPSHOT_MODIFY 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-snapshot_modify \- modify Lustre snapshot .SH SYNOPSIS -.TP -.B lctl snapshot_modify \fR[-c | --comment comment] {-F | --fsname fsname} - [-h | --help] {-n | --name ssname} [-N | --new new_ssname] - [-r | --rsh remote_shell] -.br +.SY "lctl snapshot_modify" +.RB [ -c | --comment +.IR COMMENT ] +.RB { -F | --fsname +.IR FSNAME } +.RB [ -h | --help ] +.RB { -n | --name +.IR SSNAME } +.RB [ -N | --new +.IR NEW_SSNAME ] +.RB [ -r | --rsh +.IR REMOTE_SHELL ] +.YS .SH DESCRIPTION Modify the specified snapshot. The tool loads system configuration from the file @@ -18,41 +26,41 @@ section. Then, the snapshot pieces are modified on every Lustre target (MGT/MDT/OST). .SH OPTIONS .TP -.BR -c ", " --comment " "\fIcomment +.BR -c ", " --comment \ \fICOMMENT Add comment (if it had not been specified with .BR snapshot_create ) or change the comment for the given snapshot. .TP -.BR -F ", " --fsname " "\fIfsname +.BR -F ", " --fsname \ \fIFSNAME The filesystem name. .TP -.BR -h ", " --help +.BR -h ", " --help For help information. .TP -.BR -n ", " --name " "\fIssname +.BR -n ", " --name \ \fISSNAME The snapshot (to be modified) name must be specified. .TP -.BR -N ", " --new " "\fInew_ssname +.BR -N ", " --new \ \fINEW_SSNAME Rename the snapshot to the new name. It follows the general ZFS snapshot name rules, such as the max length is 256 bytes, cannot conflict with the reserved names, and so on. .TP -.BR -r ", " --rsh " "\fIremote_shell +.BR -r ", " --rsh \ \fIREMOTE_SHELL Specify a shell to communicate with remote targets. The default value is .BR ssh . It is the system admin's duty to guarantee that the specified -.I remote_shell +.I REMOTE_SHELL works well among targets without password authentication. - .SH AVAILABILITY .B lctl-snapshot-modify is part of the .BR lustre (7) -filesystem package. +filesystem package since release 2.10.0 +.\" Added in commit v2_9_54_0-67-gd73849a05e .SH SEE ALSO .BR lctl (8), -.BR lctl-lcfg (8), .BR lctl-barrier (8), +.BR lctl-lcfg (8), .BR lctl-snapshot-create (8), .BR lctl-snapshot-destroy (8), .BR lctl-snapshot-list (8), diff --git a/lustre/doc/lctl-snapshot-mount.8 b/lustre/doc/lctl-snapshot-mount.8 index 7924e9d..4588049 100644 --- a/lustre/doc/lctl-snapshot-mount.8 +++ b/lustre/doc/lctl-snapshot-mount.8 @@ -1,11 +1,16 @@ -.TH LCTL-SNAPSHOT_MOUNT 8 "2017-05-13" Lustre "configuration utilities" +.TH LCTL-SNAPSHOT_MOUNT 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-snapshot_mount \- mount Lustre snapshot .SH SYNOPSIS -.TP -.B lctl snapshot_mount \fR{-F | --fsname fsname} [-h | --help] - {-n | --name ssname} [-r | --rsh remote_shell] -.br +.SY "lctl snapshot_mount" +.RB { -F | --fsname +.IR FSNAME } +.RB [ -h | --help ] +.RB { -n | --name +.IR SSNAME} +.RB [ -r | --rsh +.IR REMOTE_SHELL ] +.YS .SH DESCRIPTION Mount the specified snapshot on the servers. As a read-only filesystem, mounted snapshots cannot be renamed. @@ -17,33 +22,33 @@ filesystem fsname, it can be queried via .BR snapshot_list . .SH OPTIONS .TP -.BR -F ", " --fsname " "\fIfsname +.BR -F ", " --fsname \ \fIFSNAME The filesystem name. .TP -.BR -h ", " --help +.BR -h ", " --help For help information. .TP -.BR -n ", " --name " "\fIssname +.BR -n ", " --name \ \fISSNAME The snapshot (to be mounted) name must be specified. .TP -.BR -r ", " --rsh " "\fIremote_shell +.BR -r ", " --rsh \ \fIREMOTE_SHELL Specify a shell to communicate with remote targets. The default value is .BR ssh . It is the system admin's duty to guarantee that the specified -.I remote_shell +.I REMOTE_SHELL works well among targets without password authentication. - .SH AVAILABILITY .B lctl-snapshot-mount is part of the .BR lustre (7) -filesystem package. +filesystem package since release 2.10.0 +.\" Added in commit v2_9_54_0-67-gd73849a05e .SH SEE ALSO .BR lctl (8), -.BR lctl-lcfg (8), .BR lctl-barrier (8), +.BR lctl-lcfg (8), .BR lctl-snapshot-create (8), .BR lctl-snapshot-destroy (8), -.BR lctl-snapshot-modify (8), .BR lctl-snapshot-list (8), +.BR lctl-snapshot-modify (8), .BR lctl-snapshot-umount (8) diff --git a/lustre/doc/lctl-snapshot-umount.8 b/lustre/doc/lctl-snapshot-umount.8 index 1e067e6..6b25f3a 100644 --- a/lustre/doc/lctl-snapshot-umount.8 +++ b/lustre/doc/lctl-snapshot-umount.8 @@ -1,42 +1,47 @@ -.TH LCTL-SNAPSHOT_UMOUNT 8 "2017-05-13" Lustre "configuration utilities" +.TH LCTL-SNAPSHOT_UMOUNT 8 2024-08-14 Lustre "Lustre Configuration Utilities" .SH NAME lctl-snapshot_umount \- unmount Lustre snapshot .SH SYNOPSIS -.TP -.B lctl snapshot_umount \fR{-F | --fsname fsname} [-h | --help] - {-n | --name ssname} [-r | --rsh remote_shell] -.br +.SY "lctl snapshot_umount" +.RB { -F | --fsname +.IR FSNAME } +.RB [ -h | --help ] +.RB { -n | --name +.IR SSNAME } +.RB [ -r | --rsh +.IR REMOTE_SHELL ] +.YS .SH DESCRIPTION Unmount the specified snapshot on the servers. .SH OPTIONS .TP -.BR -F ", " --fsname " "\fIfsname +.BR -F ", " --fsname \ \fIfsname The filesystem name. .TP -.BR -h ", " --help +.BR -h ", " --help For help information. .TP -.BR -n ", " --name " "\fIssname +.BR -n ", " --name \ \fIssname The snapshot (to be unmounted) name must be specified. .TP -.BR -r ", " --rsh " "\fIremote_shell +.BR -r ", " --rsh \ \fIremote_shell Specify a shell to communicate with remote targets. The default value is .BR ssh . It is the system admin's duty to guarantee that the specified .I remote_shell works well among targets without password authentication. - .SH AVAILABILITY .B lctl-snapshot-umount is part of the .BR lustre (7) -filesystem package. +filesystem package since release 2.10.0 +.\" Added in commit v2_9_54_0-67-gd73849a05e .SH SEE ALSO .BR lctl (8), -.BR lctl-lcfg (8), .BR lctl-barrier (8), +.BR lctl-lcfg (8), .BR lctl-snapshot-create (8), .BR lctl-snapshot-destroy (8), -.BR lctl-snapshot-modify (8), .BR lctl-snapshot-list (8), +.BR lctl-snapshot-modify (8), .BR lctl-snapshot-mount (8)