summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-lockdown.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-lockdown.txt')
-rw-r--r--Documentation/nvme-lockdown.txt25
1 files changed, 17 insertions, 8 deletions
diff --git a/Documentation/nvme-lockdown.txt b/Documentation/nvme-lockdown.txt
index cf8a48f..e17ac70 100644
--- a/Documentation/nvme-lockdown.txt
+++ b/Documentation/nvme-lockdown.txt
@@ -8,11 +8,12 @@ nvme-lockdown - Send an NVMe Lockdown command to prohibit or allow the execution
SYNOPSIS
--------
[verse]
-'nvme-lockdown' <device> [--ofi=<ofi> | -o <ofi>]
+'nvme-lockdown' <device> [--ofi=<ofi> | -O <ofi>]
[--ifc=<ifc> | -f <ifc>]
[--prhbt=<prhbt> | -p <prhbt>]
[--scp=<scp> | -s <scp>]
[--uuid=<UUID_Index> | -U <UUID_Index>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
@@ -23,34 +24,42 @@ Identifier.
OPTIONS
-------
+-O <ofi>::
--ofi=<ofi>::
--o <ofi>::
Opcode or Feature Identifier(OFI) specifies the command opcode or Set
Features Feature Identifier identified by the Scope field.
---ifc=<ifc>::
-f <ifc>::
+--ifc=<ifc>::
Interface (INF) field identifies the interfaces affected by this command.
---prhbt=<prhbt>::
-p <prhbt>::
+--prhbt=<prhbt>::
Prohibit (PRHBT) bit specifies whether to prohibit or allow the command
opcode or Set Features Feature Identifier specified by this command.
---scp=<scp>::
-s <scp>::
+--scp=<scp>::
Scope (SCP) field specifies the contents of the Opcode or Feature Identifier field.
-
---uuid=<UUID_Index>::
-U <UUID_Index>::
+--uuid=<UUID_Index>::
UUID Index - If this field is set to a non-zero value, then the value of
this field is the index of a UUID in the UUID List that is used by the command.
If this field is cleared to 0h,then no UUID index is specified.
+-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
--------
No examples yet.
NVME
----
-Part of the nvme-user suite \ No newline at end of file
+Part of the nvme-user suite