71 lines
2.1 KiB
Groff
71 lines
2.1 KiB
Groff
|
'\" t
|
||
|
|
.\" Title: nvme-show-topology
|
||
|
|
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
|
||
|
|
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
|
||
|
|
.\" Date: 11/02/2022
|
||
|
|
.\" Manual: NVMe Manual
|
||
|
|
.\" Source: NVMe
|
||
|
|
.\" Language: English
|
||
|
|
.\"
|
||
|
|
.TH "NVME\-SHOW\-TOPOLOGY" "1" "11/02/2022" "NVMe" "NVMe Manual"
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * Define some portability stuff
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.\" http://bugs.debian.org/507673
|
||
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * set default formatting
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" disable hyphenation
|
||
|
|
.nh
|
||
|
|
.\" disable justification (adjust text to left margin only)
|
||
|
|
.ad l
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * MAIN CONTENT STARTS HERE *
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.SH "NAME"
|
||
|
|
nvme-show-topology \- Show topology of all NVMe subsystems
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.sp
|
||
|
|
.nf
|
||
|
|
\fInvme show\-topology\fR
|
||
|
|
.fi
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.sp
|
||
|
|
Show the topology of all NVMe subsystems\&.
|
||
|
|
.SH "OPTIONS"
|
||
|
|
.PP
|
||
|
|
\-o <format>, \-\-output\-format=<format>
|
||
|
|
.RS 4
|
||
|
|
Set the reporting format to
|
||
|
|
\fInormal\fR
|
||
|
|
or
|
||
|
|
\fIjson\fR\&. Only one output format can be used at a time\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\-v, \-\-verbose
|
||
|
|
.RS 4
|
||
|
|
Increase the information in the output, showing nvme subsystems, controllers and namespaces separately and how they\(cqre related to each other\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\-r <order>, \-\-ranking=<order>
|
||
|
|
.RS 4
|
||
|
|
Set the ranking orer to
|
||
|
|
\fInamespace\fR
|
||
|
|
(default) or
|
||
|
|
\fIctrl\fR\&. This option has only an effect for output format
|
||
|
|
\fInormal\fR\&. The JSON output is always
|
||
|
|
\fInamespace\fR
|
||
|
|
ordered\&.
|
||
|
|
.RE
|
||
|
|
.SH "EXAMPLES"
|
||
|
|
.sp
|
||
|
|
nvme show\-topology
|
||
|
|
.SH "NVME"
|
||
|
|
.sp
|
||
|
|
Part of the nvme\-user suite
|