From 22e8c445521be9968bd9830d7d288e96e9fb3813 Mon Sep 17 00:00:00 2001 From: Tokunori Ikegami Date: Fri, 31 Jan 2025 00:05:33 +0900 Subject: [PATCH] doc: add rotational-media-info-log command Added the nvme-rotational-media-info-log.txt file. Signed-off-by: Tokunori Ikegami --- .../nvme-rotational-media-info-log.txt | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 Documentation/nvme-rotational-media-info-log.txt diff --git a/Documentation/nvme-rotational-media-info-log.txt b/Documentation/nvme-rotational-media-info-log.txt new file mode 100644 index 00000000..981cf4fe --- /dev/null +++ b/Documentation/nvme-rotational-media-info-log.txt @@ -0,0 +1,52 @@ +nvme-rotational-media-info-log(1) +================================= + +NAME +---- +nvme-rotational-media-info-log - Retrieve Rotational Media Information Log, show it + +SYNOPSIS +-------- +[verse] +'nvme rotational-media-info-log' [--endg-id= | -e ] + [--verbose | -v] [--output-format= | -o ] + [--timeout=] + +DESCRIPTION +----------- +Retrieve Rotational Media Information Log, show it + +The parameter is mandatory NVMe character device (ex: /dev/nvme0). + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-e :: +--endg-id=:: + This field specifies the identifier of the endurance group. + +-v:: +--verbose:: + Increase the information detail in the output. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-t :: +--timeout=:: + Override default timeout value. In milliseconds. + +EXAMPLES +-------- +* Has the program issue a rotational-media-info-log ++ +------------ +# nvme rotational-media-info-log /dev/nvme0 --endg-id=1 +------------ + +NVME +---- +Part of the nvme-user suite. -- 2.50.1