]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: add changed-alloc-ns-list-log command
authorTokunori Ikegami <ikegami.t@gmail.com>
Sun, 26 Jan 2025 00:59:16 +0000 (09:59 +0900)
committerDaniel Wagner <wagi@monom.org>
Mon, 10 Feb 2025 12:46:38 +0000 (13:46 +0100)
Added the nvme-changed-alloc-ns-list-log.txt file.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
Documentation/nvme-changed-alloc-ns-list-log.txt [new file with mode: 0644]

diff --git a/Documentation/nvme-changed-alloc-ns-list-log.txt b/Documentation/nvme-changed-alloc-ns-list-log.txt
new file mode 100644 (file)
index 0000000..3a7f2e8
--- /dev/null
@@ -0,0 +1,67 @@
+nvme-changed-alloc-ns-list-log(1)
+=================================
+
+NAME
+----
+nvme-changed-alloc-ns-list-log - Send NVMe Changed Allocated Namespace List
+log page request, returns result and log.
+
+SYNOPSIS
+--------
+[verse]
+'nvme changed-alloc-ns-list-log' <device> [--raw-binary | -b]
+                       [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+                       [--timeout=<timeout>]
+
+DESCRIPTION
+-----------
+Retrieves the NVMe Changed Allocated Namespace List log page from an NVMe
+device and provides the returned structure.
+
+The <device> parameter is mandatory and must be a NVMe character device
+(ex: /dev/nvme0).
+
+On success, the returned Changed Allocated Namespace List log structure may
+be returned in one of several ways depending on the option flags; the
+structure may parsed by the program and printed in a readable format or
+the raw buffer may be printed to stdout for another program to parse.
+
+OPTIONS
+-------
+-b::
+--raw-binary::
+       Print the raw Changed Namespace List log buffer to stdout.
+
+-o <fmt>::
+--output-format=<fmt>::
+       Set the reporting format to 'normal', 'json' or 'binary'. Only one
+       output format can be used at a time.
+
+-v::
+--verbose::
+       Increase the information detail in the output.
+
+-t <timeout>::
+--timeout=<timeout>::
+       Override default timeout value. In milliseconds.
+
+EXAMPLES
+--------
+* Print the Changed Allocated Namespace List Log page in a human readable format:
++
+------------
+# nvme changed-alloc-ns-list-log /dev/nvme0
+------------
++
+
+* Print the raw Changed Allocated Namespace List log to a file:
++
+------------
+# nvme changed-alloc-ns-list-log /dev/nvme0 --raw-binary > log.raw
+------------
++
+It is probably a bad idea to not redirect stdout when using this mode.
+
+NVME
+----
+Part of the nvme-user suite