The branch main has been updated by lwhsu: URL: https://cgit.FreeBSD.org/src/commit/?id=1d94247d0e3fe79fee7902383d27f51b089beb0d
commit 1d94247d0e3fe79fee7902383d27f51b089beb0d Author: Li-Wen Hsu <[email protected]> AuthorDate: 2026-09-27 17:54:40 +0000 Commit: Li-Wen Hsu <[email protected]> CommitDate: 2026-09-27 17:54:40 +0000 geom: Document existing --libxo support in the manual pages The standard list and status subcommands of every GEOM class emit through libxo, and so does geom -p, but only geom.8 (list, status) and gpart.8 (show) mentioned it. Mark the list and status forms with --libxo in all class manual pages, add the option description, and cross-reference xo_options(7). Also mark geom -p in geom.8. Only forms whose output already goes through libxo are marked; class-specific verbs such as gmirror dump still print directly and are left alone. Reviewed by: adrian, bcr, carlavilla, des MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D59574 --- lib/geom/cache/gcache.8 | 12 +++++++++++- lib/geom/concat/gconcat.8 | 12 +++++++++++- lib/geom/eli/geli.8 | 12 +++++++++++- lib/geom/journal/gjournal.8 | 12 +++++++++++- lib/geom/label/glabel.8 | 12 +++++++++++- lib/geom/mirror/gmirror.8 | 12 +++++++++++- lib/geom/mountver/gmountver.8 | 12 +++++++++++- lib/geom/multipath/gmultipath.8 | 12 +++++++++++- lib/geom/nop/gnop.8 | 12 +++++++++++- lib/geom/part/gpart.8 | 4 +++- lib/geom/raid/graid.8 | 12 +++++++++++- lib/geom/raid3/graid3.8 | 12 +++++++++++- lib/geom/shsec/gshsec.8 | 12 +++++++++++- lib/geom/stripe/gstripe.8 | 12 +++++++++++- lib/geom/union/gunion.8 | 12 +++++++++++- lib/geom/virstor/gvirstor.8 | 12 +++++++++++- lib/geom/zoned/gzoned.8 | 12 +++++++++++- sbin/geom/core/geom.8 | 3 ++- 18 files changed, 181 insertions(+), 18 deletions(-) diff --git a/lib/geom/cache/gcache.8 b/lib/geom/cache/gcache.8 index 072f35e92c01..575339a4bf94 100644 --- a/lib/geom/cache/gcache.8 +++ b/lib/geom/cache/gcache.8 @@ -23,7 +23,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 3, 2010 +.Dd September 28, 2026 .Dt GCACHE 8 .Os .Sh NAME @@ -66,8 +66,10 @@ .Cm dump .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Op Fl s Ar name .Nm @@ -146,6 +148,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -180,6 +189,7 @@ maximum amount of debug information is printed. Exit status is 0 on success, and 1 if the command fails. .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr geom 8 .Sh HISTORY The diff --git a/lib/geom/concat/gconcat.8 b/lib/geom/concat/gconcat.8 index 165f809ffba8..9d9530ab4970 100644 --- a/lib/geom/concat/gconcat.8 +++ b/lib/geom/concat/gconcat.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 23, 2025 +.Dd September 28, 2026 .Dt GCONCAT 8 .Os .Sh NAME @@ -60,8 +60,10 @@ .Cm dump .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -164,6 +166,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -214,6 +223,7 @@ growfs /dev/concat/data .Sh SEE ALSO .Xr geom 4 , .Xr loader.conf 5 , +.Xr xo_options 7 , .Xr geom 8 , .Xr growfs 8 , .Xr mount 8 , diff --git a/lib/geom/eli/geli.8 b/lib/geom/eli/geli.8 index b38f54d82293..398eeed93f60 100644 --- a/lib/geom/eli/geli.8 +++ b/lib/geom/eli/geli.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd April 24, 2024 +.Dd September 28, 2026 .Dt GELI 8 .Os .Sh NAME @@ -144,8 +144,10 @@ utility: .Op Fl v .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -781,6 +783,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options include: @@ -1244,6 +1253,7 @@ initialized in this way. .Xr crypto 4 , .Xr geom 4 , .Xr loader.conf 5 , +.Xr xo_options 7 , .Xr geom 8 , .Xr crypto 9 .Sh HISTORY diff --git a/lib/geom/journal/gjournal.8 b/lib/geom/journal/gjournal.8 index f9959ffa0f3f..910216014c50 100644 --- a/lib/geom/journal/gjournal.8 +++ b/lib/geom/journal/gjournal.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd February 17, 2009 +.Dd September 28, 2026 .Dt GJOURNAL 8 .Os .Sh NAME @@ -50,8 +50,10 @@ .Cm dump .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -192,6 +194,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options include: @@ -330,6 +339,7 @@ The number of times the low_mem hook was called. .El .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr geom 8 , .Xr mount 8 , .Xr newfs 8 , diff --git a/lib/geom/label/glabel.8 b/lib/geom/label/glabel.8 index c77545593970..f6c46e145aed 100644 --- a/lib/geom/label/glabel.8 +++ b/lib/geom/label/glabel.8 @@ -25,7 +25,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd September 13, 2026 +.Dd September 28, 2026 .Dt GLABEL 8 .Os .Sh NAME @@ -61,8 +61,10 @@ .Cm refresh .Ar dev ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -229,6 +231,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -311,6 +320,7 @@ makefs -t cd9660 -o volid=MYDISC .Sh SEE ALSO .Xr geom 4 , .Xr loader.conf 5 , +.Xr xo_options 7 , .Xr e2label 8 , .Xr geom 8 , .Xr gpart 8 , diff --git a/lib/geom/mirror/gmirror.8 b/lib/geom/mirror/gmirror.8 index aeffb2d948b1..89d7e3a5940e 100644 --- a/lib/geom/mirror/gmirror.8 +++ b/lib/geom/mirror/gmirror.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 23, 2025 +.Dd September 28, 2026 .Dt GMIRROR 8 .Os .Sh NAME @@ -122,8 +122,10 @@ utility: .Cm dump .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -293,6 +295,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options include: @@ -434,6 +443,7 @@ the prefer balance algorithm will read from the next one, thus will find nothing there. .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr dumpon 8 , .Xr geom 8 , .Xr mount 8 , diff --git a/lib/geom/mountver/gmountver.8 b/lib/geom/mountver/gmountver.8 index 70cdf83a8896..40ccb89087de 100644 --- a/lib/geom/mountver/gmountver.8 +++ b/lib/geom/mountver/gmountver.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd May 18, 2015 +.Dd September 28, 2026 .Dt GMOUNTVER 8 .Os .Sh NAME @@ -38,8 +38,10 @@ .Op Fl fv .Ar name .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Op Fl s Ar name .Nm @@ -86,6 +88,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -120,6 +129,7 @@ will reattach to the device even if the device reports a different disk ID. Exit status is 0 on success, and 1 if the command fails. .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr geom 8 .Sh HISTORY The diff --git a/lib/geom/multipath/gmultipath.8 b/lib/geom/multipath/gmultipath.8 index 0f007196f7d4..9f3bc58424d8 100644 --- a/lib/geom/multipath/gmultipath.8 +++ b/lib/geom/multipath/gmultipath.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd March 17, 2022 +.Dd September 28, 2026 .Dt GMULTIPATH 8 .Os .Sh NAME @@ -85,8 +85,10 @@ .Op Fl v .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -197,6 +199,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Sh SYSCTL VARIABLES The following @@ -360,6 +369,7 @@ geom_multipath_load="YES" .Xr isp 4 , .Xr mpt 4 , .Xr loader.conf 5 , +.Xr xo_options 7 , .Xr camcontrol 8 , .Xr geom 8 , .Xr mount 8 , diff --git a/lib/geom/nop/gnop.8 b/lib/geom/nop/gnop.8 index 24293d143058..c063e4b227fe 100644 --- a/lib/geom/nop/gnop.8 +++ b/lib/geom/nop/gnop.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd December 29, 2019 +.Dd September 28, 2026 .Dt GNOP 8 .Os .Sh NAME @@ -67,8 +67,10 @@ .Op Fl v .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -116,6 +118,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -201,6 +210,7 @@ gnop list .Ed .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr geom 8 .Sh HISTORY The diff --git a/lib/geom/part/gpart.8 b/lib/geom/part/gpart.8 index 887a07932f60..5c18531d2a2c 100644 --- a/lib/geom/part/gpart.8 +++ b/lib/geom/part/gpart.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd May 12, 2026 +.Dd September 28, 2026 .Dt GPART 8 .Os .Sh NAME @@ -130,8 +130,10 @@ .Ar geom .\" .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load diff --git a/lib/geom/raid/graid.8 b/lib/geom/raid/graid.8 index 4ef0cd22e703..7464b8213ddd 100644 --- a/lib/geom/raid/graid.8 +++ b/lib/geom/raid/graid.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 23, 2025 +.Dd September 28, 2026 .Dt GRAID 8 .Os .Sh NAME @@ -69,8 +69,10 @@ .Op Fl fv .Ar name ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -189,6 +191,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options include: @@ -307,6 +316,7 @@ Enable taste for specific metadata or transformation module. Exit status is 0 on success, and non-zero if the command fails. .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr geom 8 .Sh HISTORY The diff --git a/lib/geom/raid3/graid3.8 b/lib/geom/raid3/graid3.8 index e1bcdac17f99..f3f8d49d2f39 100644 --- a/lib/geom/raid3/graid3.8 +++ b/lib/geom/raid3/graid3.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 23, 2025 +.Dd September 28, 2026 .Dt GRAID3 8 .Os .Sh NAME @@ -64,8 +64,10 @@ .Op Fl fv .Ar name ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -199,6 +201,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options include: @@ -235,6 +244,7 @@ graid3 insert -n 0 data da5 .Ed .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr geom 8 , .Xr mount 8 , .Xr newfs 8 , diff --git a/lib/geom/shsec/gshsec.8 b/lib/geom/shsec/gshsec.8 index f80ab9384fe3..c8b3b27b8e6f 100644 --- a/lib/geom/shsec/gshsec.8 +++ b/lib/geom/shsec/gshsec.8 @@ -25,7 +25,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd October 1, 2013 +.Dd September 28, 2026 .Dt GSHSEC 8 .Os .Sh NAME @@ -49,8 +49,10 @@ .Cm dump .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -92,6 +94,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -119,6 +128,7 @@ detected and connected, making the secret available via the device. .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr geom 8 , .Xr newfs 8 .Sh HISTORY diff --git a/lib/geom/stripe/gstripe.8 b/lib/geom/stripe/gstripe.8 index 6fd486355a2e..262d9e898288 100644 --- a/lib/geom/stripe/gstripe.8 +++ b/lib/geom/stripe/gstripe.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 23, 2025 +.Dd September 28, 2026 .Dt GSTRIPE 8 .Os .Sh NAME @@ -57,8 +57,10 @@ .Cm dump .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -129,6 +131,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -225,6 +234,7 @@ for .Sh SEE ALSO .Xr geom 4 , .Xr loader.conf 5 , +.Xr xo_options 7 , .Xr ccdconfig 8 , .Xr geom 8 , .Xr mount 8 , diff --git a/lib/geom/union/gunion.8 b/lib/geom/union/gunion.8 index 5cb20e975b21..e25b059bcbe9 100644 --- a/lib/geom/union/gunion.8 +++ b/lib/geom/union/gunion.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 19, 2022 +.Dd September 28, 2026 .Dt GUNION 8 .Os .Sh NAME @@ -54,8 +54,10 @@ .Op Fl frv .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -225,6 +227,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Sh EXIT STATUS Exit status is 0 on success, and 1 if the command fails. @@ -308,6 +317,7 @@ If set to 4, the maximum amount of debug information is printed. .El .Sh SEE ALSO .Xr geom 4 , +.Xr xo_options 7 , .Xr geom 8 .Sh HISTORY The diff --git a/lib/geom/virstor/gvirstor.8 b/lib/geom/virstor/gvirstor.8 index 436b60bef02c..7bff0ca4d32c 100644 --- a/lib/geom/virstor/gvirstor.8 +++ b/lib/geom/virstor/gvirstor.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd October 1, 2013 +.Dd September 28, 2026 .Dt GVIRSTOR 8 .Os .Sh NAME @@ -60,8 +60,10 @@ .Cm dump .Ar prov ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -139,6 +141,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -247,6 +256,7 @@ sysctls. .Sh SEE ALSO .Xr geom 4 , .Xr fstab 5 , +.Xr xo_options 7 , .Xr geom 8 , .Xr glabel 8 , .Xr newfs 8 diff --git a/lib/geom/zoned/gzoned.8 b/lib/geom/zoned/gzoned.8 index 854eeed74854..8e6d7cc92419 100644 --- a/lib/geom/zoned/gzoned.8 +++ b/lib/geom/zoned/gzoned.8 @@ -2,7 +2,7 @@ .\" .\" Copyright (c) 2026 voidanix <[email protected]> .\" -.Dd August 4, 2026 +.Dd September 28, 2026 .Dt GZONED 8 .Os .Sh NAME @@ -35,8 +35,10 @@ .Op Fl v .Ar dev ... .Nm +.Op Fl -libxo .Cm list .Nm +.Op Fl -libxo .Cm status .Nm .Cm load @@ -153,6 +155,13 @@ See .It Cm unload See .Xr geom 8 . +.It Fl -libxo +Generate output via +.Xr libxo 3 +in a selection of different human and machine readable formats. +See +.Xr xo_options 7 +for details on command line arguments. .El .Pp Additional options: @@ -248,6 +257,7 @@ geom zoned clear /dev/da0 .Sh SEE ALSO .Xr geom 4 , .Xr md 4 , +.Xr xo_options 7 , .Xr geom 8 , .Xr mdconfig 8 , .Xr zonectl 8 diff --git a/sbin/geom/core/geom.8 b/sbin/geom/core/geom.8 index ad50334d324f..69c5851ccf62 100644 --- a/sbin/geom/core/geom.8 +++ b/sbin/geom/core/geom.8 @@ -25,7 +25,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd February 5, 2026 +.Dd September 28, 2026 .Dt GEOM 8 .Os .Sh NAME @@ -56,6 +56,7 @@ .Cm unload .Op Fl v .Nm +.Op Fl -libxo .Fl p .Ar provider-name .Nm
