From: Tokunori Ikegami <ikegami.t@gmail.com>
Date: Tue, 11 Feb 2025 14:09:08 +0000 (+0900)
Subject: doc: add reachability-groups-log command
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=3df1e29544356ae192e57fd5171a803e482b2f82;p=users%2Fsagi%2Fnvme-cli.git

doc: add reachability-groups-log command

Added the nvme-reachability-groups-log.txt file.

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

diff --git a/Documentation/nvme-reachability-groups-log.txt b/Documentation/nvme-reachability-groups-log.txt
new file mode 100644
index 00000000..6d5379ee
--- /dev/null
+++ b/Documentation/nvme-reachability-groups-log.txt
@@ -0,0 +1,56 @@
+nvme-reachability-groups-log(1)
+===============================
+
+NAME
+----
+nvme-reachability-groups-log - Retrieve Reachability Groups Log, show it
+
+SYNOPSIS
+--------
+[verse]
+'nvme reachability-groups-log' <device> [--groups-only | -g] [--rae | -r]
+			[--verbose | -v] [--output-format=<fmt> | -o <fmt>]
+			[--timeout=<timeout>]
+
+DESCRIPTION
+-----------
+Retrieve Reachability Groups Log, show it
+
+The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-g::
+--groups-only::
+	Return Groups Only.
+
+-r::
+--rae::
+	Retain an Asynchronous Event.
+
+-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 reachability-groups-log
++
+------------
+# nvme reachability-groups-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.