From: Tokunori Ikegami <ikegami.t@gmail.com>
Date: Sun, 9 Feb 2025 02:33:07 +0000 (+0900)
Subject: doc: add dispersed-ns-participating-nss-log command
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=cffe60748d7bc1fe4fc04bd4db361f8a7ca3606c;p=users%2Fsagi%2Fnvme-cli.git

doc: add dispersed-ns-participating-nss-log command

Added the nvme-dispersed-ns-participating-nss-log.txt file.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
---

diff --git a/Documentation/nvme-dispersed-ns-participating-nss-log.txt b/Documentation/nvme-dispersed-ns-participating-nss-log.txt
new file mode 100644
index 00000000..93b00623
--- /dev/null
+++ b/Documentation/nvme-dispersed-ns-participating-nss-log.txt
@@ -0,0 +1,55 @@
+nvme-dispersed-ns-participating-nss-log(1)
+==========================================
+
+NAME
+----
+nvme-dispersed-ns-participating-nss-log - Retrieve Dispersed Namespace
+Participating NVM Subsystems Log, show it
+
+SYNOPSIS
+--------
+[verse]
+'nvme dispersed-ns-participating-nss-log' <device>
+			[--namespace-id=<nsid> | -n <nsid>] [--verbose | -v]
+			[--output-format=<fmt> | -o <fmt>] [--timeout=<timeout>]
+
+DESCRIPTION
+-----------
+Retrieve Dispersed Namespace Participating NVM Subsystems Log, show it
+
+The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-n <nsid>::
+--namespace-id=<nsid>::
+	The namespace identifier to delete.
+	Retrieve the dispersed namespace participating NVM subsystems log for
+	the given nsid.
+
+-v::
+--verbose::
+	Increase the information detail in the output.
+
+-o <fmt>::
+--output-format=<fmt>::
+	Set the reporting format to 'normal', 'json' or 'binary'. Only one
+	output format can be used at a time.
+
+-t <timeout>::
+--timeout=<timeout>::
+	Override default timeout value. In milliseconds.
+
+EXAMPLES
+--------
+* Has the program issue a dispersed-ns-participating-nss-log
++
+------------
+# nvme dispersed-ns-participating-nss-log /dev/nvme0 --namespace-id=2
+------------
+
+NVME
+----
+Part of the nvme-user suite.