From 5893ca17da5e5fa4e482e9d95fd98bce2138d1e0 Mon Sep 17 00:00:00 2001 From: Zdenek Kabelac Date: Fri, 22 Nov 2024 13:25:37 +0100 Subject: [PATCH] make: generate --- man/lvchange.8_pregen | 2 +- man/lvdisplay.8_pregen | 265 ++++++++++++++++++++++++++++++----- man/lvm-fullreport.8_pregen | 38 ++--- man/lvs.8_pregen | 40 +++--- man/pvdisplay.8_pregen | 251 ++++++++++++++++++++++++++++----- man/pvs.8_pregen | 40 +++--- man/vgdisplay.8_pregen | 269 ++++++++++++++++++++++++++++++++---- man/vgs.8_pregen | 38 ++--- 8 files changed, 773 insertions(+), 170 deletions(-) diff --git a/man/lvchange.8_pregen b/man/lvchange.8_pregen index 616ae5083..04ecf8ade 100644 --- a/man/lvchange.8_pregen +++ b/man/lvchange.8_pregen @@ -257,7 +257,7 @@ LV1 types: mirror raid Resynchronize or check a raid LV. .br .P -\fBlvchange\fP \fB--syncaction\fP \fBcheck\fP|\fBrepair\fP \fIVG\fP|\fILV1\fP|\fITag\fP|\fISelect\fP ... +\fBlvchange\fP \fB--\fP[\fBraid\fP]\fBsyncaction\fP \fBcheck\fP|\fBrepair\fP \fIVG\fP|\fILV1\fP|\fITag\fP|\fISelect\fP ... .br .RS 4 .ad l diff --git a/man/lvdisplay.8_pregen b/man/lvdisplay.8_pregen index 1d4eabd75..9a950b286 100644 --- a/man/lvdisplay.8_pregen +++ b/man/lvdisplay.8_pregen @@ -6,12 +6,107 @@ lvdisplay \(em Display information about a logical volume . .SH SYNOPSIS . -\fBlvdisplay\fP +\fBlvdisplay\fP \fIoption_args\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +.P +.ad l + \fB--aligned\fP +.br + \fB-a\fP|\fB--all\fP +.br + \fB--binary\fP +.br + \fB-c\fP|\fB--colon\fP +.br + \fB-C\fP|\fB--columns\fP +.br + \fB--commandprofile\fP \fIString\fP +.br + \fB--config\fP \fIString\fP +.br + \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP +.br + \fB-d\fP|\fB--debug\fP +.br + \fB--devices\fP \fIPV\fP +.br + \fB--devicesfile\fP \fIString\fP +.br + \fB--driverloaded\fP \fBy\fP|\fBn\fP +.br + \fB--foreign\fP +.br + \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP +.br + \fB-h\fP|\fB--help\fP +.br + \fB-H\fP|\fB--history\fP +.br + \fB--ignorelockingfailure\fP +.br + \fB--journal\fP \fIString\fP +.br + \fB--lockopt\fP \fIString\fP +.br + \fB--logonly\fP +.br + \fB--longhelp\fP +.br + \fB-m\fP|\fB--maps\fP +.br + \fB--nameprefixes\fP +.br + \fB--noheadings\fP +.br + \fB--nohints\fP +.br + \fB--nolocking\fP +.br + \fB--nosuffix\fP +.br + \fB-o\fP|\fB--options\fP \fIString\fP +.br + \fB--profile\fP \fIString\fP +.br + \fB-q\fP|\fB--quiet\fP +.br + \fB--readonly\fP +.br + \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP +.br + \fB--rows\fP +.br + \fB--segments\fP +.br + \fB-S\fP|\fB--select\fP \fIString\fP +.br + \fB--separator\fP \fIString\fP +.br + \fB--shared\fP +.br + \fB-O\fP|\fB--sort\fP \fIString\fP +.br + \fB-t\fP|\fB--test\fP +.br + \fB--unbuffered\fP +.br + \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +.br + \fB--unquoted\fP +.br + \fB-v\fP|\fB--verbose\fP +.br + \fB--version\fP +.br + \fB-y\fP|\fB--yes\fP +.ad b . .SH DESCRIPTION . @@ -23,30 +118,81 @@ and more, using a more compact and configurable output format. . .SH USAGE . -\fBlvdisplay\fP +\fBlvdisplay\fP \fB-C\fP|\fB--columns\fP .br .RS 4 .ad l -[ \fB-a\fP|\fB--all\fP ] -.br -[ \fB-c\fP|\fB--colon\fP ] -.br -[ \fB-C\fP|\fB--columns\fP ] -.br -[ \fB-H\fP|\fB--history\fP ] -.br -[ \fB-m\fP|\fB--maps\fP ] -.br [ \fB-o\fP|\fB--options\fP \fIString\fP ] .br -[ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.br -[ \fB-S\fP|\fB--select\fP \fIString\fP ] -.br [ \fB--aligned\fP ] .br [ \fB--binary\fP ] .br +[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] +.br +[ \fB--nameprefixes\fP ] +.br +[ \fB--noheadings\fP ] +.br +[ \fB--nosuffix\fP ] +.br +[ \fB--rows\fP ] +.br +[ \fB--separator\fP \fIString\fP ] +.br +[ \fB--unbuffered\fP ] +.br +[ \fB--unquoted\fP ] +.br +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIVG\fP|\fILV\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +\fBlvdisplay\fP \fB-c\fP|\fB--colon\fP +.br +.RS 4 +.ad l +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIVG\fP|\fILV\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +\fBlvdisplay\fP +.br +.RS 4 +.ad l +[ \fB-m\fP|\fB--maps\fP ] +.br +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIVG\fP|\fILV\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +Common options for command: +. +.RS 4 +.ad l +[ \fB-a\fP|\fB--all\fP ] +.br +[ \fB-H\fP|\fB--history\fP ] +.br +[ \fB-S\fP|\fB--select\fP \fIString\fP ] +.br +[ \fB-O\fP|\fB--sort\fP \fIString\fP ] +.br [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] .br [ \fB--foreign\fP ] @@ -55,32 +201,21 @@ and more, using a more compact and configurable output format. .br [ \fB--logonly\fP ] .br -[ \fB--noheadings\fP ] -.br -[ \fB--nosuffix\fP ] -.br [ \fB--readonly\fP ] .br +[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] +.br [ \fB--segments\fP ] .br -[ \fB--separator\fP \fIString\fP ] -.br [ \fB--shared\fP ] .br -[ \fB--unbuffered\fP ] -.br [ \fB--units\fP \c .nh \%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP .hy ] -.br -[ COMMON_OPTIONS ] .ad b .RE -.RS 4 -[ \fIVG\fP|\fILV\fP|\fITag\fP ... ] -.RE .P Common options for lvm: . @@ -150,13 +285,41 @@ the "unknown" value which denotes that the value could not be determined). \fB-c\fP|\fB--colon\fP .br Generate colon separated output for easier parsing in scripts or programs. -Also see \fBvgs\fP(8) which provides considerably more control over the output. +Also see \fBlvs\fP(8) which provides considerably more control over the output. +The values are: +.br + \[bu] logical volume name +.br + \[bu] volume group name +.br + \[bu] logical volume access +.br + \[bu] logical volume status +.br + \[bu] internal logical volume number +.br + \[bu] open count of logical volume +.br + \[bu] logical volume size in sectors +.br + \[bu] current logical extents associated to logical volume +.br + \[bu] allocated logical extents of logical volume +.br + \[bu] allocation policy of logical volume +.br + \[bu] read ahead sectors of logical volume +.br + \[bu] major device number of logical volume +.br + \[bu] minor device number of logical volume . .HP \fB-C\fP|\fB--columns\fP .br -Display output in columns, the equivalent of \fBvgs\fP(8). -Options listed are the same as options given in \fBvgs\fP(8). +Display output in columns. +The equivalent of \fBlvs\fP(8). +Options listed are the same as options given in \fBlvs\fP(8). . .HP \fB--commandprofile\fP \fIString\fP @@ -213,6 +376,14 @@ Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. . .HP +\fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP +.br +Type of headings to use in report output. +\fBnone\fP or \fB0\fP: No headings. +\fBabbrev\fP or \fB1\fP: Column name abbreviations. +\fBfull\fP or \fB2\fP: Full column names. +. +.HP \fB-h\fP|\fB--help\fP .br Display help text. @@ -264,6 +435,13 @@ To map physical extents to logical extents use: pvs --segments -o+lv_name,seg_start_pe,segtype . .HP +\fB--nameprefixes\fP +.br +Add an "LVM2_" prefix plus the field name to the output. Useful +with --noheadings to produce a list of field=value pairs that can +be used to set environment variables (for example, in udev rules). +. +.HP \fB--noheadings\fP .br Suppress the headings line that is normally the first line of output. @@ -328,6 +506,23 @@ Prevent the command from making changes, including activation and metadata updates. (See --permission r for read only LVs.) . .HP +\fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP +.br +Overrides current output format for reports which is defined globally by +the report/output_format setting in \fBlvm.conf\fP(5). +\fBbasic\fP is the original format with columns and rows. +If there is more than one report per command, each report is prefixed +with the report name for identification. \fBjson\fP produces report +output in JSON format. \fBjson_std\fP produces report output in +JSON format which is more compliant with JSON standard. +See \fBlvmreport\fP(7) for more information. +. +.HP +\fB--rows\fP +.br +Output columns as rows. +. +.HP \fB--segments\fP .br . @@ -391,6 +586,12 @@ Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. . .HP +\fB--unquoted\fP +.br +When used with --nameprefixes, output values in the field=value +pairs are not quoted. +. +.HP \fB-v\fP|\fB--verbose\fP ... .br Set verbose level. Repeat from 1 to 4 times to increase the detail diff --git a/man/lvm-fullreport.8_pregen b/man/lvm-fullreport.8_pregen index 7caea1e77..07d2aed24 100644 --- a/man/lvm-fullreport.8_pregen +++ b/man/lvm-fullreport.8_pregen @@ -29,50 +29,50 @@ if information changes between commands. .ad l [ \fB-a\fP|\fB--all\fP ] .br -[ \fB-o\fP|\fB--options\fP \fIString\fP ] -.br [ \fB-S\fP|\fB--select\fP \fIString\fP ] .br [ \fB-O\fP|\fB--sort\fP \fIString\fP ] .br -[ \fB--aligned\fP ] -.br -[ \fB--binary\fP ] +[ \fB-o\fP|\fB--options\fP \fIString\fP ] .br [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] .br [ \fB--foreign\fP ] .br -[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] -.br [ \fB--ignorelockingfailure\fP ] .br [ \fB--logonly\fP ] .br +[ \fB--readonly\fP ] +.br +[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] +.br +[ \fB--shared\fP ] +.br +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] +.br +[ \fB--aligned\fP ] +.br +[ \fB--binary\fP ] +.br +[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] +.br [ \fB--nameprefixes\fP ] .br [ \fB--noheadings\fP ] .br [ \fB--nosuffix\fP ] .br -[ \fB--readonly\fP ] -.br -[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] -.br [ \fB--rows\fP ] .br [ \fB--separator\fP \fIString\fP ] .br -[ \fB--shared\fP ] -.br [ \fB--unbuffered\fP ] .br -[ \fB--units\fP \c -.nh -\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP -.hy -] -.br [ \fB--unquoted\fP ] .br [ COMMON_OPTIONS ] diff --git a/man/lvs.8_pregen b/man/lvs.8_pregen index 0d6d0fa71..1a657f709 100644 --- a/man/lvs.8_pregen +++ b/man/lvs.8_pregen @@ -27,52 +27,52 @@ lvs produces formatted output about LVs. .br [ \fB-a\fP|\fB--all\fP ] .br -[ \fB-o\fP|\fB--options\fP \fIString\fP ] -.br [ \fB-S\fP|\fB--select\fP \fIString\fP ] .br [ \fB-O\fP|\fB--sort\fP \fIString\fP ] .br +[ \fB-o\fP|\fB--options\fP \fIString\fP ] +.br [ \fB--segments\fP ] .br -[ \fB--aligned\fP ] -.br -[ \fB--binary\fP ] -.br [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] .br [ \fB--foreign\fP ] .br -[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] -.br [ \fB--ignorelockingfailure\fP ] .br [ \fB--logonly\fP ] .br +[ \fB--readonly\fP ] +.br +[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] +.br +[ \fB--shared\fP ] +.br +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] +.br +[ \fB--aligned\fP ] +.br +[ \fB--binary\fP ] +.br +[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] +.br [ \fB--nameprefixes\fP ] .br [ \fB--noheadings\fP ] .br [ \fB--nosuffix\fP ] .br -[ \fB--readonly\fP ] -.br -[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] -.br [ \fB--rows\fP ] .br [ \fB--separator\fP \fIString\fP ] .br -[ \fB--shared\fP ] -.br [ \fB--unbuffered\fP ] .br -[ \fB--units\fP \c -.nh -\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP -.hy -] -.br [ \fB--unquoted\fP ] .br [ COMMON_OPTIONS ] diff --git a/man/pvdisplay.8_pregen b/man/pvdisplay.8_pregen index 0ba9e668d..812ec6cf8 100644 --- a/man/pvdisplay.8_pregen +++ b/man/pvdisplay.8_pregen @@ -6,12 +6,107 @@ pvdisplay \(em Display various attributes of physical volume(s) . .SH SYNOPSIS . -\fBpvdisplay\fP +\fBpvdisplay\fP \fIoption_args\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +.P +.ad l + \fB--aligned\fP +.br + \fB-a\fP|\fB--all\fP +.br + \fB--binary\fP +.br + \fB-c\fP|\fB--colon\fP +.br + \fB-C\fP|\fB--columns\fP +.br + \fB--commandprofile\fP \fIString\fP +.br + \fB--config\fP \fIString\fP +.br + \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP +.br + \fB-d\fP|\fB--debug\fP +.br + \fB--devices\fP \fIPV\fP +.br + \fB--devicesfile\fP \fIString\fP +.br + \fB--driverloaded\fP \fBy\fP|\fBn\fP +.br + \fB--foreign\fP +.br + \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP +.br + \fB-h\fP|\fB--help\fP +.br + \fB--ignorelockingfailure\fP +.br + \fB--journal\fP \fIString\fP +.br + \fB--lockopt\fP \fIString\fP +.br + \fB--logonly\fP +.br + \fB--longhelp\fP +.br + \fB-m\fP|\fB--maps\fP +.br + \fB--nameprefixes\fP +.br + \fB--noheadings\fP +.br + \fB--nohints\fP +.br + \fB--nolocking\fP +.br + \fB--nosuffix\fP +.br + \fB-o\fP|\fB--options\fP \fIString\fP +.br + \fB--profile\fP \fIString\fP +.br + \fB-q\fP|\fB--quiet\fP +.br + \fB--readonly\fP +.br + \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP +.br + \fB--rows\fP +.br + \fB--segments\fP +.br + \fB-S\fP|\fB--select\fP \fIString\fP +.br + \fB--separator\fP \fIString\fP +.br + \fB--shared\fP +.br + \fB-s\fP|\fB--short\fP +.br + \fB-O\fP|\fB--sort\fP \fIString\fP +.br + \fB-t\fP|\fB--test\fP +.br + \fB--unbuffered\fP +.br + \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +.br + \fB--unquoted\fP +.br + \fB-v\fP|\fB--verbose\fP +.br + \fB--version\fP +.br + \fB-y\fP|\fB--yes\fP +.ad b . .SH DESCRIPTION . @@ -23,30 +118,81 @@ and more, using a more compact and configurable output format. . .SH USAGE . -\fBpvdisplay\fP +\fBpvdisplay\fP \fB-C\fP|\fB--columns\fP .br .RS 4 .ad l -[ \fB-a\fP|\fB--all\fP ] -.br -[ \fB-c\fP|\fB--colon\fP ] -.br -[ \fB-C\fP|\fB--columns\fP ] -.br -[ \fB-m\fP|\fB--maps\fP ] -.br [ \fB-o\fP|\fB--options\fP \fIString\fP ] .br -[ \fB-S\fP|\fB--select\fP \fIString\fP ] -.br -[ \fB-s\fP|\fB--short\fP ] -.br -[ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.br [ \fB--aligned\fP ] .br [ \fB--binary\fP ] .br +[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] +.br +[ \fB--nameprefixes\fP ] +.br +[ \fB--noheadings\fP ] +.br +[ \fB--nosuffix\fP ] +.br +[ \fB--rows\fP ] +.br +[ \fB--separator\fP \fIString\fP ] +.br +[ \fB--unbuffered\fP ] +.br +[ \fB--unquoted\fP ] +.br +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIPV\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +\fBpvdisplay\fP \fB-c\fP|\fB--colon\fP +.br +.RS 4 +.ad l +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIPV\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +\fBpvdisplay\fP +.br +.RS 4 +.ad l +[ \fB-m\fP|\fB--maps\fP ] +.br +[ \fB-s\fP|\fB--short\fP ] +.br +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIPV\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +Common options for command: +. +.RS 4 +.ad l +[ \fB-a\fP|\fB--all\fP ] +.br +[ \fB-S\fP|\fB--select\fP \fIString\fP ] +.br +[ \fB-O\fP|\fB--sort\fP \fIString\fP ] +.br [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] .br [ \fB--foreign\fP ] @@ -55,32 +201,21 @@ and more, using a more compact and configurable output format. .br [ \fB--logonly\fP ] .br -[ \fB--noheadings\fP ] -.br -[ \fB--nosuffix\fP ] -.br [ \fB--readonly\fP ] .br [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] .br -[ \fB--separator\fP \fIString\fP ] +[ \fB--segments\fP ] .br [ \fB--shared\fP ] .br -[ \fB--unbuffered\fP ] -.br [ \fB--units\fP \c .nh \%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP .hy ] -.br -[ COMMON_OPTIONS ] .ad b .RE -.RS 4 -[ \fIPV\fP|\fITag\fP ... ] -.RE .P Common options for lvm: . @@ -149,13 +284,37 @@ the "unknown" value which denotes that the value could not be determined). \fB-c\fP|\fB--colon\fP .br Generate colon separated output for easier parsing in scripts or programs. -Also see \fBvgs\fP(8) which provides considerably more control over the output. +Also see \fBpvs\fP(8) which provides considerably more control over the output. +The values are: +.br + \[bu] physical volume device name +.br + \[bu] volume group name +.br + \[bu] physical volume size in sectors +.br + \[bu] internal physical volume number (obsolete) +.br + \[bu] physical volume status +.br + \[bu] physical volume (not) allocatable +.br + \[bu] current number of logical volumes on this physical volume +.br + \[bu] physical extent size in kilobytes +.br + \[bu] total number of physical extents +.br + \[bu] free number of physical extents +.br + \[bu] allocated number of physical extents . .HP \fB-C\fP|\fB--columns\fP .br -Display output in columns, the equivalent of \fBvgs\fP(8). -Options listed are the same as options given in \fBvgs\fP(8). +Display output in columns. +The equivalent of \fBpvs\fP(8). +Options listed are the same as options given in \fBpvs\fP(8). . .HP \fB--commandprofile\fP \fIString\fP @@ -212,6 +371,14 @@ Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. . .HP +\fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP +.br +Type of headings to use in report output. +\fBnone\fP or \fB0\fP: No headings. +\fBabbrev\fP or \fB1\fP: Column name abbreviations. +\fBfull\fP or \fB2\fP: Full column names. +. +.HP \fB-h\fP|\fB--help\fP .br Display help text. @@ -254,6 +421,13 @@ Display long help text. Display the mapping of physical extents to LVs and logical extents. . .HP +\fB--nameprefixes\fP +.br +Add an "LVM2_" prefix plus the field name to the output. Useful +with --noheadings to produce a list of field=value pairs that can +be used to set environment variables (for example, in udev rules). +. +.HP \fB--noheadings\fP .br Suppress the headings line that is normally the first line of output. @@ -330,6 +504,15 @@ JSON format which is more compliant with JSON standard. See \fBlvmreport\fP(7) for more information. . .HP +\fB--rows\fP +.br +Output columns as rows. +. +.HP +\fB--segments\fP +.br +. +.HP \fB-S\fP|\fB--select\fP \fIString\fP .br Select objects for processing and reporting based on specified criteria. @@ -394,6 +577,12 @@ Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. . .HP +\fB--unquoted\fP +.br +When used with --nameprefixes, output values in the field=value +pairs are not quoted. +. +.HP \fB-v\fP|\fB--verbose\fP ... .br Set verbose level. Repeat from 1 to 4 times to increase the detail diff --git a/man/pvs.8_pregen b/man/pvs.8_pregen index 3048f30ed..1174963ac 100644 --- a/man/pvs.8_pregen +++ b/man/pvs.8_pregen @@ -27,52 +27,52 @@ pvs produces formatted output about PVs. .br [ \fB-a\fP|\fB--all\fP ] .br -[ \fB-o\fP|\fB--options\fP \fIString\fP ] -.br [ \fB-S\fP|\fB--select\fP \fIString\fP ] .br [ \fB-O\fP|\fB--sort\fP \fIString\fP ] .br +[ \fB-o\fP|\fB--options\fP \fIString\fP ] +.br [ \fB--segments\fP ] .br -[ \fB--aligned\fP ] -.br -[ \fB--binary\fP ] -.br [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] .br [ \fB--foreign\fP ] .br -[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] -.br [ \fB--ignorelockingfailure\fP ] .br [ \fB--logonly\fP ] .br +[ \fB--readonly\fP ] +.br +[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] +.br +[ \fB--shared\fP ] +.br +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] +.br +[ \fB--aligned\fP ] +.br +[ \fB--binary\fP ] +.br +[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] +.br [ \fB--nameprefixes\fP ] .br [ \fB--noheadings\fP ] .br [ \fB--nosuffix\fP ] .br -[ \fB--readonly\fP ] -.br -[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] -.br [ \fB--rows\fP ] .br [ \fB--separator\fP \fIString\fP ] .br -[ \fB--shared\fP ] -.br [ \fB--unbuffered\fP ] .br -[ \fB--units\fP \c -.nh -\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP -.hy -] -.br [ \fB--unquoted\fP ] .br [ COMMON_OPTIONS ] diff --git a/man/vgdisplay.8_pregen b/man/vgdisplay.8_pregen index a26a0c511..1c5686d50 100644 --- a/man/vgdisplay.8_pregen +++ b/man/vgdisplay.8_pregen @@ -6,12 +6,105 @@ vgdisplay \(em Display volume group information . .SH SYNOPSIS . -\fBvgdisplay\fP +\fBvgdisplay\fP \fIoption_args\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +.P +.ad l + \fB-A\fP|\fB--activevolumegroups\fP +.br + \fB--aligned\fP +.br + \fB-a\fP|\fB--all\fP +.br + \fB--binary\fP +.br + \fB-c\fP|\fB--colon\fP +.br + \fB-C\fP|\fB--columns\fP +.br + \fB--commandprofile\fP \fIString\fP +.br + \fB--config\fP \fIString\fP +.br + \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP +.br + \fB-d\fP|\fB--debug\fP +.br + \fB--devices\fP \fIPV\fP +.br + \fB--devicesfile\fP \fIString\fP +.br + \fB--driverloaded\fP \fBy\fP|\fBn\fP +.br + \fB--foreign\fP +.br + \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP +.br + \fB-h\fP|\fB--help\fP +.br + \fB--ignorelockingfailure\fP +.br + \fB--journal\fP \fIString\fP +.br + \fB--lockopt\fP \fIString\fP +.br + \fB--logonly\fP +.br + \fB--longhelp\fP +.br + \fB--nameprefixes\fP +.br + \fB--noheadings\fP +.br + \fB--nohints\fP +.br + \fB--nolocking\fP +.br + \fB--nosuffix\fP +.br + \fB-o\fP|\fB--options\fP \fIString\fP +.br + \fB--profile\fP \fIString\fP +.br + \fB-q\fP|\fB--quiet\fP +.br + \fB--readonly\fP +.br + \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP +.br + \fB--rows\fP +.br + \fB-S\fP|\fB--select\fP \fIString\fP +.br + \fB--separator\fP \fIString\fP +.br + \fB--shared\fP +.br + \fB-s\fP|\fB--short\fP +.br + \fB-O\fP|\fB--sort\fP \fIString\fP +.br + \fB-t\fP|\fB--test\fP +.br + \fB--unbuffered\fP +.br + \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +.br + \fB--unquoted\fP +.br + \fB-v\fP|\fB--verbose\fP +.br + \fB--version\fP +.br + \fB-y\fP|\fB--yes\fP +.ad b . .SH DESCRIPTION . @@ -22,28 +115,81 @@ and more, using a more compact and configurable output format. . .SH USAGE . -\fBvgdisplay\fP +\fBvgdisplay\fP \fB-C\fP|\fB--columns\fP .br .RS 4 .ad l -[ \fB-A\fP|\fB--activevolumegroups\fP ] -.br -[ \fB-c\fP|\fB--colon\fP ] -.br -[ \fB-C\fP|\fB--columns\fP ] -.br [ \fB-o\fP|\fB--options\fP \fIString\fP ] .br -[ \fB-S\fP|\fB--select\fP \fIString\fP ] -.br -[ \fB-s\fP|\fB--short\fP ] -.br -[ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.br [ \fB--aligned\fP ] .br [ \fB--binary\fP ] .br +[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] +.br +[ \fB--nameprefixes\fP ] +.br +[ \fB--noheadings\fP ] +.br +[ \fB--nosuffix\fP ] +.br +[ \fB--rows\fP ] +.br +[ \fB--separator\fP \fIString\fP ] +.br +[ \fB--unbuffered\fP ] +.br +[ \fB--unquoted\fP ] +.br +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIVG\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +\fBvgdisplay\fP \fB-c\fP|\fB--colon\fP +.br +.RS 4 +.ad l +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIVG\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +\fBvgdisplay\fP +.br +.RS 4 +.ad l +[ \fB-s\fP|\fB--short\fP ] +.br +[ COMMON_OPTIONS ] +.ad b +.RE +.RS 4 +[ \fIVG\fP|\fITag\fP ... ] +.RE +.P +\(em +.P +Common options for command: +. +.RS 4 +.ad l +[ \fB-A\fP|\fB--activevolumegroups\fP ] +.br +[ \fB-a\fP|\fB--all\fP ] +.br +[ \fB-S\fP|\fB--select\fP \fIString\fP ] +.br +[ \fB-O\fP|\fB--sort\fP \fIString\fP ] +.br [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] .br [ \fB--foreign\fP ] @@ -52,30 +198,19 @@ and more, using a more compact and configurable output format. .br [ \fB--logonly\fP ] .br -[ \fB--noheadings\fP ] -.br -[ \fB--nosuffix\fP ] -.br [ \fB--readonly\fP ] .br +[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] +.br [ \fB--shared\fP ] .br -[ \fB--separator\fP \fIString\fP ] -.br -[ \fB--unbuffered\fP ] -.br [ \fB--units\fP \c .nh \%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP .hy ] -.br -[ COMMON_OPTIONS ] .ad b .RE -.RS 4 -[ \fIVG\fP|\fITag\fP ... ] -.RE .P Common options for lvm: . @@ -134,6 +269,10 @@ if at least one of its LVs is active. Use with --separator to align the output columns . .HP +\fB-a\fP|\fB--all\fP +.br +. +.HP \fB--binary\fP .br Use binary values "0" or "1" instead of descriptive literal values @@ -145,11 +284,47 @@ the "unknown" value which denotes that the value could not be determined). .br Generate colon separated output for easier parsing in scripts or programs. Also see \fBvgs\fP(8) which provides considerably more control over the output. +The values are: +.br + \[bu] volume group name +.br + \[bu] volume group access +.br + \[bu] volume group status +.br + \[bu] internal volume group number +.br + \[bu] maximum number of logical volumes +.br + \[bu] current number of logical volumes +.br + \[bu] open count of all logical volumes in this volume group +.br + \[bu] maximum logical volume size +.br + \[bu] maximum number of physical volumes +.br + \[bu] current number of physical volumes +.br + \[bu] actual number of physical volumes +.br + \[bu] size of volume group in kilobytes +.br + \[bu] physical extent size +.br + \[bu] total number of physical extents for this volume group +.br + \[bu] allocated number of physical extents for this volume group +.br + \[bu] free number of physical extents for this volume group +.br + \[bu] uuid of volume group . .HP \fB-C\fP|\fB--columns\fP .br -Display output in columns, the equivalent of \fBvgs\fP(8). +Display output in columns. +The equivalent of \fBvgs\fP(8). Options listed are the same as options given in \fBvgs\fP(8). . .HP @@ -207,6 +382,14 @@ Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. . .HP +\fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP +.br +Type of headings to use in report output. +\fBnone\fP or \fB0\fP: No headings. +\fBabbrev\fP or \fB1\fP: Column name abbreviations. +\fBfull\fP or \fB2\fP: Full column names. +. +.HP \fB-h\fP|\fB--help\fP .br Display help text. @@ -244,6 +427,13 @@ Suppress command report and display only log report. Display long help text. . .HP +\fB--nameprefixes\fP +.br +Add an "LVM2_" prefix plus the field name to the output. Useful +with --noheadings to produce a list of field=value pairs that can +be used to set environment variables (for example, in udev rules). +. +.HP \fB--noheadings\fP .br Suppress the headings line that is normally the first line of output. @@ -308,6 +498,23 @@ Prevent the command from making changes, including activation and metadata updates. (See --permission r for read only LVs.) . .HP +\fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP +.br +Overrides current output format for reports which is defined globally by +the report/output_format setting in \fBlvm.conf\fP(5). +\fBbasic\fP is the original format with columns and rows. +If there is more than one report per command, each report is prefixed +with the report name for identification. \fBjson\fP produces report +output in JSON format. \fBjson_std\fP produces report output in +JSON format which is more compliant with JSON standard. +See \fBlvmreport\fP(7) for more information. +. +.HP +\fB--rows\fP +.br +Output columns as rows. +. +.HP \fB-S\fP|\fB--select\fP \fIString\fP .br Select objects for processing and reporting based on specified criteria. @@ -372,6 +579,12 @@ Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. . .HP +\fB--unquoted\fP +.br +When used with --nameprefixes, output values in the field=value +pairs are not quoted. +. +.HP \fB-v\fP|\fB--verbose\fP ... .br Set verbose level. Repeat from 1 to 4 times to increase the detail diff --git a/man/vgs.8_pregen b/man/vgs.8_pregen index 7dbe73411..a688c084e 100644 --- a/man/vgs.8_pregen +++ b/man/vgs.8_pregen @@ -25,50 +25,50 @@ vgs produces formatted output about VGs. .ad l [ \fB-a\fP|\fB--all\fP ] .br -[ \fB-o\fP|\fB--options\fP \fIString\fP ] -.br [ \fB-S\fP|\fB--select\fP \fIString\fP ] .br [ \fB-O\fP|\fB--sort\fP \fIString\fP ] .br -[ \fB--aligned\fP ] -.br -[ \fB--binary\fP ] +[ \fB-o\fP|\fB--options\fP \fIString\fP ] .br [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] .br [ \fB--foreign\fP ] .br -[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] -.br [ \fB--ignorelockingfailure\fP ] .br [ \fB--logonly\fP ] .br +[ \fB--readonly\fP ] +.br +[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] +.br +[ \fB--shared\fP ] +.br +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] +.br +[ \fB--aligned\fP ] +.br +[ \fB--binary\fP ] +.br +[ \fB--headings\fP \fBnone\fP|\fBabbrev\fP|\fBfull\fP|\fB0\fP|\fB1\fP|\fB2\fP ] +.br [ \fB--nameprefixes\fP ] .br [ \fB--noheadings\fP ] .br [ \fB--nosuffix\fP ] .br -[ \fB--readonly\fP ] -.br -[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] -.br [ \fB--rows\fP ] .br [ \fB--separator\fP \fIString\fP ] .br -[ \fB--shared\fP ] -.br [ \fB--unbuffered\fP ] .br -[ \fB--units\fP \c -.nh -\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP -.hy -] -.br [ \fB--unquoted\fP ] .br [ COMMON_OPTIONS ]