From 956eeec06548f85c249b5a7495dc9bbdcb30b86b Mon Sep 17 00:00:00 2001 From: Andreas Dilger Date: Mon, 17 Jun 2019 05:37:00 +0200 Subject: [PATCH] LU-4315 doc: add separate lctl-list_param man page Split the lctl list_param man page from the main lctl.8 man page. Test-Parameters: trivial Signed-off-by: Andreas Dilger Change-Id: Ib3f125e953427ec6ace1709588f5d40b1e3ebbe5 Reviewed-on: https://review.whamcloud.com/35649 Reviewed-by: Joseph Gmitter Tested-by: jenkins Reviewed-by: James Nunez Reviewed-by: Ben Evans Tested-by: Maloo Reviewed-by: Oleg Drokin --- lustre/doc/Makefile.am | 1 + lustre/doc/lctl-get_param.8 | 1 + lustre/doc/lctl-list_param.8 | 62 +++++++++++++++++++ lustre/doc/lctl-set_param.8 | 1 + lustre/doc/lctl.8 | 141 ++----------------------------------------- 5 files changed, 70 insertions(+), 136 deletions(-) create mode 100644 lustre/doc/lctl-list_param.8 diff --git a/lustre/doc/Makefile.am b/lustre/doc/Makefile.am index 08a069e..8fa2f10 100644 --- a/lustre/doc/Makefile.am +++ b/lustre/doc/Makefile.am @@ -35,6 +35,7 @@ MANFILES = \ lctl.8 \ lctl-get_param.8 \ + lctl-list_param.8 \ lctl-network.8 \ lctl-set_param.8 \ ldev.8 \ diff --git a/lustre/doc/lctl-get_param.8 b/lustre/doc/lctl-get_param.8 index 59449ed..d2db46d 100644 --- a/lustre/doc/lctl-get_param.8 +++ b/lustre/doc/lctl-get_param.8 @@ -76,4 +76,5 @@ osc.testfs-OST0002-osc-ffff8803c9c0f000.max_rpcs_in_flight=8 .SH SEE ALSO .BR lustre (7), .BR lctl (8), +.BR lctl-list_param (8), .BR lctl-set_param (8) diff --git a/lustre/doc/lctl-list_param.8 b/lustre/doc/lctl-list_param.8 new file mode 100644 index 0000000..6917a3f --- /dev/null +++ b/lustre/doc/lctl-list_param.8 @@ -0,0 +1,62 @@ +.TH lctl-list_param 8 "2019 Sep 30" Lustre "configuration utilities" +.SH NAME +lctl list_param \- list configuration parameter names +.SH SYNOPSIS +.BR list_param " [" -F | -R ] +.RI < param_search " ...>" +.SH DESCRIPTION +List the Lustre or LNet parameter name(s) matching +.IR param_search . +The parameter name(s) may contain wildcards using +.BR glob (3) +pathname patterns. +.TP +.B -F +Append '/', '@' or '=' for dirs, symlinks and writeable files, respectively. +.TP +.B -R +Recursively list all parameters under the specified parameter search string. If +.I param_search +is unspecified, all the parameters will be shown. +.SH EXAMPLES +.B +# lctl list_param ost.* +.br + ost.OSS +.br + ost.num_refs +.br +.B +# lctl list_param -F ost.* debug +.br + ost.OSS/ +.br + ost.num_refs +.br + debug= +.br +.B +# lctl list_param -R mdt +.br + mdt +.br + mdt.lustre-MDT0000 +.br + mdt.lustre-MDT0000.capa +.br + mdt.lustre-MDT0000.capa_count +.br + mdt.lustre-MDT0000.capa_key_timeout +.br + mdt.lustre-MDT0000.capa_timeout +.br + mdt.lustre-MDT0000.commit_on_sharing +.br + mdt.lustre-MDT0000.evict_client +.br + ... +.SH SEE ALSO +.BR lustre (7), +.BR lctl-get_param (8), +.BR lctl-set_parm (8), +.BR lfs (1) diff --git a/lustre/doc/lctl-set_param.8 b/lustre/doc/lctl-set_param.8 index 033df02..dc8f639 100644 --- a/lustre/doc/lctl-set_param.8 +++ b/lustre/doc/lctl-set_param.8 @@ -92,5 +92,6 @@ osc.testfs-OST0004-osc-ffff8803c9c0f000.max_dirty_mb=512 .BR lustre (7), .BR lctl (8), .BR lctl-get_param (8), +.BR lctl-list_param (8), .BR lctl-llog_catlist (8), .BR lctl-llog_print (8) diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8 index b3be0e8..58a18c3 100644 --- a/lustre/doc/lctl.8 +++ b/lustre/doc/lctl.8 @@ -106,140 +106,6 @@ Show all the local Lustre OBDs. AKA .PP .SS Device Operations .TP -.BI list_param " [-F|-R] " -List the Lustre or LNet parameter name -.B -F -Add '/', '@' or '=' for dirs, symlinks and writeable files, respectively. -.br -.B -R -Recursively list all parameters under the specified parameter search string. If -.I param_search -is unspecified, all the parameters will be shown. -.br -.B Examples: -.br -.B -# lctl list_param ost.* -.br - ost.OSS -.br - ost.num_refs -.br -.B -# lctl list_param -F ost.* debug -.br - ost.OSS/ -.br - ost.num_refs -.br - debug= -.br -.B -# lctl list_param -R mdt -.br - mdt -.br - mdt.lustre-MDT0000 -.br - mdt.lustre-MDT0000.capa -.br - mdt.lustre-MDT0000.capa_count -.br - mdt.lustre-MDT0000.capa_key_timeout -.br - mdt.lustre-MDT0000.capa_timeout -.br - mdt.lustre-MDT0000.commit_on_sharing -.br - mdt.lustre-MDT0000.evict_client -.br - ... -.TP -.BI get_param " [-F|-n|-N|-R] " -Get the value of Lustre or LNET parameter. -.br -.B -F -When -N specified, add '/', '@' or '=' for directories, symlinks and writeable files, respectively. -.br -.br -.B -n -Print only the value and not parameter name. -.br -.B -N -Print only matched parameter names and not the values. (Especially useful when using patterns.) -.br -.B -R -Print all of the parameter names below the specified name. -.br -.B Examples: -.br -.B -# lctl get_param ost.* -.br - ost.OSS -.br - ost.num_refs -.br -.B -# lctl get_param -n debug timeout -.br - super warning dlmtrace error emerg ha rpctrace vfstrace config console -.br - 20 -.br -.B -# lctl get_param -N ost.* debug -.br - ost.OSS -.br - ost.num_refs -.br - debug -.br -lctl "get_param -NF" is equivalent to "list_param -F". -.TP -.BI set_param " [-n] [-P] [-d] " -Set the value of Lustre or LNET parameter. -.br -.B -n -Disable printing of the key name when printing values. -.br -.B -P -Set the parameter permanently, filesystem-wide. -This parameters are only visible to 2.5.0 and later clients, older clients will not see these parameters. -.br -.B -d -Remove the permanent setting (only with -P option) -.br -.B Examples: -.br -.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 -P osc.*.max_dirty_mb=32 -.br -.TP -.BI "set_param -F " -.br -Apply configuration file specified by -.br -File is in YAML format, created as an output from -\fBlctl --device MGS llog_print -client\fR or any other valid -llog_file from the output of \fBlctl --device MGS llog_catlist\fR -.br -.TP .BI conf_param " [-d] .=" Set a permanent configuration parameter for any device via the MGS. This command must be run on the MGS node. @@ -570,11 +436,14 @@ filesystem package. .BR mkfs.lustre (8), .BR mount.lustre (8), .BR lctl (8), +.BR lctl-barrier (8), +.BR lctl-lcfg (8), +.BR lctl-get_param (8), .BR lctl-lfsck-start (8), .BR lctl-lfsck-stop (8), .BR lctl-lfsck-query (8), -.BR lctl-lcfg (8), -.BR lctl-barrier (8), +.BR lctl-list_param (8), +.BR lctl-set_param (8), .BR lctl-snapshot-create (8), .BR lctl-snapshot-destroy (8), .BR lctl-snapshot-modify (8), -- 1.8.3.1