summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-show-hostnqn.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-show-hostnqn.txt')
-rw-r--r--Documentation/nvme-show-hostnqn.txt36
1 files changed, 36 insertions, 0 deletions
diff --git a/Documentation/nvme-show-hostnqn.txt b/Documentation/nvme-show-hostnqn.txt
new file mode 100644
index 0000000..5074e2c
--- /dev/null
+++ b/Documentation/nvme-show-hostnqn.txt
@@ -0,0 +1,36 @@
+nvme-show-hostnqn(1)
+===================
+
+NAME
+----
+nvme-show-hostnqn - Show the host NQN configured for the system
+
+SYNOPSIS
+--------
+[verse]
+'nvme show-hostnqn' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Show the host NQN configured for the system. If @SYSCONFDIR@/nvme/hostnqn is
+not present and systemd application-specific machine IDs are available,
+this will show the systemd-generated host NQN for the system.
+
+OPTIONS
+-------
+-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.
+
+EXAMPLES
+--------
+nvme show-hostnqn
+
+NVME
+----
+Part of the nvme-user suite