From 0333fc904b658c35df739b59495297d3386a9e67 Mon Sep 17 00:00:00 2001 From: Andreas Dilger Date: Thu, 4 Apr 2019 01:35:38 -0600 Subject: [PATCH] LU-930 doc: improve formatting of lfs.1 synopsis Add proper command formatting for the lfs.1 SYNOPSIS section. Test-Parameters: trivial Signed-off-by: Andreas Dilger Change-Id: Ic70d6ccc7127510fd2df17cf6d70b0af8e3ebbe5 Reviewed-on: https://review.whamcloud.com/34594 Tested-by: Jenkins Tested-by: Maloo Reviewed-by: Arshad Hussain Reviewed-by: Joseph Gmitter Reviewed-by: Oleg Drokin --- lustre/doc/lfs.1 | 140 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 73 insertions(+), 67 deletions(-) diff --git a/lustre/doc/lfs.1 b/lustre/doc/lfs.1 index ffad328..cdb50db 100644 --- a/lustre/doc/lfs.1 +++ b/lustre/doc/lfs.1 @@ -3,27 +3,27 @@ lfs \- client utility for Lustre-specific file layout and other attributes .SH SYNOPSIS .br -.B lfs changelog [--follow] [startrec [endrec]] +.B lfs changelog \fR[\fB--follow\fR] <\fImdtname\fR> [\fIstartrec \fR[\fIendrec\fR]] .br -.B lfs changelog_clear +.B lfs changelog_clear <\fImdtname\fR> <\fIid\fR> <\fIendrec\fR> .br -.B lfs check +.B lfs check \fR<\fBmgts\fR|\fBmdts\fR|\fBosts\fR|\fBall\fR> .br -.B lfs data_version [-nrw] \fB\fR +.B lfs data_version \fR[\fB-nrw\fR] \fB<\fIfilename\fR> .br -.B lfs df [-ihlv] [--pool|-p [.]] [path] +.B lfs df \fR[\fB-ihlv\fR] [\fB--pool\fR|\fB-p \fR<\fIfsname\fR>[.<\fIpool\fR>]] [\fIpath\fR] .br -.B lfs fid2path [--link ] ... +.B lfs fid2path \fR[\fB--link \fR<\fIlinkno\fR>] <\fIfsname\fR|\fIrootpath\fR> ... .br .B lfs find \fR<\fIdirectory\fR|\fIfilename \fR...> [[\fB!\fR] \fB--atime\fR|\fB-A\fR [\fB-+\fR]\fIn\fR] [[\fB!\fR] \fB--ctime\fR|\fB-C\fR [\fB+-\fR]\fIn\fR] [[\fB!\fR] \fB--mtime\fR|\fB-M\fR [\fB-+\fR]\fIn\fR] - [[\fB!\fR] \fB--component-count|\fB--comp-count\fR [\fB+-\fR]\fIn\fR] - [[\fB!\fR] \fB--component-flags|\fB--comp-flags\fR <[\fB^\fR]\fIflag\fB,\fR...>] - [[\fB!\fR] \fB--component-end|\fB--comp-end\fR|\fB-E\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]] - [[\fB!\fR] \fB--component-start|\fB--comp-start\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]] - [[\fB!\fR] \fB--mirror-count|\fB-N\fR [\fB+-\fR]\fIn\fR] + [[\fB!\fR] \fB--component-count\fR|\fB--comp-count\fR [\fB+-\fR]\fIn\fR] + [[\fB!\fR] \fB--component-flags\fR|\fB--comp-flags\fR <[\fB^\fR]\fIflag\fB,\fR...>] + [[\fB!\fR] \fB--component-end\fR|\fB--comp-end\fR|\fB-E\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]] + [[\fB!\fR] \fB--component-start\fR|\fB--comp-start\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]] + [[\fB!\fR] \fB--mirror-count\fR|\fB-N\fR [\fB+-\fR]\fIn\fR] [[\fB!\fR] \fB--mirror-state\fR <[^]\fIstate\fR>] [[\fB!\fR] \fB--gid\fR|\fB-g\fR|\fB--group\fR|\fB-G\fR <\fIgname\fR>|<\fIgid\fR>] [[\fB!\fR] \fB--layout\fR|\fB-L mdt\fR,\fBraid0\fR,\fBreleased\fR] @@ -37,21 +37,21 @@ lfs \- client utility for Lustre-specific file layout and other attributes [\fB--print\fR|\fB-P\fR] [\fB--print0\fR|\fB-0\fR] [[\fB!\fR] \fB--projid\fR |<\fIprojid\fR>] [[\fB!\fR] \fB--size|\fB-s\fR [\fB-+\fR]\fIn\fR[\fBKMGTPE\fR]] - [[\fB!\fR] \fB--stripe-count|\fB-c\fR [\fB+-\fR]\fIn\fR] - [[\fB!\fR] \fB--stripe-index|\fB-i\fR \fIn\fR,...] - [[\fB!\fR] \fB--stripe-size|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]] + [[\fB!\fR] \fB--stripe-count\fR|\fB-c\fR [\fB+-\fR]\fIn\fR] + [[\fB!\fR] \fB--stripe-index\fR|\fB-i\fR \fIn\fR,...] + [[\fB!\fR] \fB--stripe-size\fR|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]] [[\fB!\fR] \fB--type\fR|\fB-t\fR {\fBbcdflps\fR}] [[\fB!\fR] \fB--uid\fR|\fB-u\fR|\fB--user\fR|\fB-U -<\fIuname\fR>|<\fIuid>\fR] +\fR<\fIuname\fR>|<\fIuid\fR>] .br .B lfs getname [-h]|[path ...] .br .B lfs getstripe [\fB--component-count\fR|\fB--comp-count\fR] - [\fB--component-end\fR[=[\fB+-\fR]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]] + [\fB--component-end\fR|\fB-E\fR[=[\fB+-\fR]\fIN\fR[\fBKMGTPE\fR]] [\fB--component-flags\fR[=[\fB^\fR]\fIflag\fB,\fR...]] - [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[<\fIcomp_id\fR>]] - [\fB--component-start\fR[=[\fB+-\fR]\fIN\fR[kMGTPE]]] + [\fB--component-id\fR|\fB-I \fR[=\fIcomp_id\fR]] + [\fB--component-start\fR[=[\fB+-\fR]\fIN\fR[\fBKMGTPE\fR]]] [\fB--directory\fR|\fB-d\fR] [\fB--fid\fR|\fB-F\fR] [\fB--generation\fR|\fB-g\fR] @@ -69,68 +69,69 @@ lfs \- client utility for Lustre-specific file layout and other attributes [\fB--yaml\fR|\fB-y\fR] <\fIdirname\fR|\fIfilename\fR> ... .br -.B lfs migrate { --mdt-index | -m } \fI\fR -.IR directory -.br -.B lfs migrate [\fB-c | --stripe-count \fR] - [\fB-i | --stripe-index \fR] - [\fB-S | --stripe-size \fR] - [\fB-p | --pool \fR] - [\fB-o | --ost-list \fR] - [\fB-b | --block\fR] - [\fB-n | --non-block\fR] -.IR file|directory -.br -.B lfs migrate <\fB-E | --component-end comp_end1\fR> [\fBSTRIPE_OPTIONS\fR] - <\fB-E | --component-end comp_end2\fR> [\fBSTRIPE_OPTIONS\fR] - \fB...\fR -.IR filename -.br -.B lfs mkdir [\fB-c | --count \fR] - [\fB-i | --index \fR] - [\fB-h | --hash-type \fR] - [\fB-m | --mode \fR] - [\fB-D | --default\fR] -.IR directory -.br -.B lfs osts -.RB [ path ] +.B lfs migrate \fR{\fB--mdt-index\fR|\fB-m\fR} <\fImdt_index\fR> \fIdirectory\fR .br -.B lfs mdts -.RB [ path ] +.B lfs migrate \fR[\fB--stripe-count\fR|\fB-c\fR \fR<\fIstripe_count\fR>] + [\fB--stripe-index\fR|\fB-i\fR \fR<\fIstart_ost_idx\fR>] + [\fB--stripe-size\fR|\fB-S\fR \fR<\fIstripe_size\fR>] +[\fB--pool\fR|\fB-p\fR \fR<\fIpool_name\fR>] + [\fB-o\fR|\fB--ost-list \fR<\fIost_indices\fR>] +[\fB--block\fR|\fB-b\fR] + [\fB--non-block\fR|\fB-n\fR] <\fIfile\fR|\fIdirectory\fR> +.br +.B lfs migrate \fR<\fB--component-end\fR|\fB-E\fR \fIcomp_end1\fR> +[\fISTRIPE_OPTIONS\fR] + <\fB--component-end\fR|\fB-E\fR \fIcomp_end2\fR> +[\fISTRIPE_OPTIONS\fR] + ... \fIfilename\fR +.br +.B lfs mkdir \fR[\fB-c\fR|\fB--count \fR<\fIstripe_count\fR>] +[\fB-i\fR|\fB--index \fR<\fImdt_idx\fR>] + [\fB-h\fR|\fB--hash-type \fR<\fIhash_name\fR>] +[\fB-m\fR|\fB--mode \fR<\fImode\fR>] + [\fB-D\fR|\fB--default\fR] \fIdirectory\fR +.br +.B lfs osts \fR[<\fIpath\fR>] +.br +.B lfs mdts \fR[<\fIpath\fR>] .br -.B lfs path2fid [--parents] ... +.B lfs path2fid \fR[\fB--parents\fR] <\fIpath\fR> ... .br -.B lfs pool_list [.] | +.B lfs pool_list \fR<\fIfilesystem\fR>[\fB.\fR<\fIpool\fR>] | <\fIpathname\fR> .br -.B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u | -u |-g | -g ] [-p ] +.B lfs quota \fR[\fB-qv\fR] [\fB-o \fIobd_uuid\fR|\fB-I \fIost_idx\fR|\fB-i \fImdt_idx\fR] + [\fB-u <\fIuname\fR|\fIuid\fR>|\fB-g <\fIgname\fR|\fIgid\fR>] +[\fB-p <\fIprojid\fR>] <\fIfilesystem\fR> .br -.B lfs quota -t <-u|-g|-p> +.B lfs quota -t \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> <\fIfilesystem\fR> .br -.B lfs quotacheck [-ug] +.B lfs quotacheck \fR[\fB-ug\fR] <\fIfilesystem\fR> .br -.B lfs quota <-U|-G|-P> +.B lfs quota \fR<\fB-U\fR|\fB-G\fR|\fB-P\fR> <\fIfilesystem\fR> .br -.B lfs quotaon [-ugf] +.B lfs quotaon \fR[\fB-ugf\fR] <\fIfilesystem\fR> .br -.B lfs quotaoff [-ug] +.B lfs quotaoff \fR[\fB-ug\fR] <\fIfilesystem\fR> .br -.B lfs setstripe [--stripe-size|-S ] [--stripe-count|-c ] - \fB[--stripe-index|-i ] [--pool|-p ] - \fB[--ost-list|-o ] \fR +.B lfs setstripe \fR[\fB--stripe-size\fR|\fB-S <\fIsize\fR>] [\fB--stripe-count\fR|-c <\fIcount\fR>] + [\fB--stripe-index\fR|\fB-i <\fIstart_ost_index\fR>] [\fB--pool\fR|\fB-p \fR<\fIpoolname\fR>] + [\fB--ost-list\fR|\fB-o <\fIost_indices\fR>] <\fIdirectory\fR|\fIfilename\fR> .br -.B lfs setstripe -d +.B lfs setstripe -d \fR<\fIdir\fR> .br -.B lfs setstripe --component-end|-E [STRIPE_OPTIONS] - [\fB--component-end|-E [STRIPE_OPTIONS]] ... \fR +.B lfs setstripe --component-end\fR|\fB-E <\fIend1> [\fISTRIPE_OPTIONS\fR] + [\fB--component-end\fR|\fB-E \fR<\fIend2\fR> [\fISTRIPE_OPTIONS\fR]] + ... <\fIfilename>\fR .br -.B lfs setstripe --component-add --component-end|-E [STRIPE_OPTIONS] - \fB<--component-end|-E > [STRIPE_OPTIONS]] ... \fR +.B lfs setstripe --component-add \fB-E\fR <\fIend1> [\fISTRIPE_OPTIONS] + [\fB--component-end\fR|\fB-E \fR<\fIend2\fR> [\fISTRIPE_OPTIONS\fR]] + ... <\fIfilename\fR> .br -.B lfs setstripe --component-del {--component-id|-I id | - \fB--component-flags } +.B lfs setstripe --component-del \fR{\fB--component-id\fR|\fB-I \fR<\fIid\fR> | + \fB--component-flags \fR<\fIflags\fR>} +<\fIfilename\fR> .br -.B lfs setstripe --yaml= +.B lfs setstripe --yaml=\fR<\fIyaml_template_file\fR> <\fIfilename\fR> .br .B lfs --version .br @@ -143,8 +144,13 @@ can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and location) for a specific file. It can be invoked interactively without any arguments or in a non-interactive mode with one of the arguments supported. -.SH OPTIONS -The various options supported by lfs are listed and explained below: +.SH COMMANDS +A number of sub-commands supported by lfs are listed below. Other commands +are described in separate man pages of the form +.BI lfs- command +as listed in the +.B SEE ALSO +section at the end. .TP .B changelog Show the metadata changes on an MDT. Start and end points are optional. The --follow option will block on new changes; this option is only valid when run direclty on the MDT node. -- 1.8.3.1