Skip to content

Commit 93f8b91

Browse files
committed
doc: add host-discovery-log command
Added the nvme-host-discovery-log.txt file. Signed-off-by: Tokunori Ikegami <[email protected]>
1 parent d4c508b commit 93f8b91

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
nvme-host-discovery-log(1)
2+
==========================
3+
4+
NAME
5+
----
6+
nvme-host-discovery-log - Retrieve Host Discovery Log, show it
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme host-discovery-log' <device> [--all-host-entries | -a] [--rae | -r]
12+
[--verbose | -v] [--output-format=<fmt> | -o <fmt>]
13+
[--timeout=<timeout>]
14+
15+
DESCRIPTION
16+
-----------
17+
Retrieve Host Discovery Log, show it
18+
19+
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
20+
21+
On success it returns 0, error code otherwise.
22+
23+
OPTIONS
24+
-------
25+
-a::
26+
--all-host-entries::
27+
All Host Entries.
28+
29+
-r::
30+
--rae::
31+
Retain an Asynchronous Event.
32+
33+
-v::
34+
--verbose::
35+
Increase the information detail in the output.
36+
37+
-o <fmt>::
38+
--output-format=<fmt>::
39+
Set the reporting format to 'normal', 'json' or 'binary'. Only one
40+
output format can be used at a time.
41+
42+
-t <timeout>::
43+
--timeout=<timeout>::
44+
Override default timeout value. In milliseconds.
45+
46+
EXAMPLES
47+
--------
48+
* Has the program issue a host-discovery-log
49+
+
50+
------------
51+
# nvme host-discovery-log /dev/nvme0
52+
------------
53+
54+
NVME
55+
----
56+
Part of the nvme-user suite.

0 commit comments

Comments
 (0)