linux/nvme-cli
1
0
Fork 0
Code Issues Activity

Merging upstream version 2.0.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 12:15:45 +01:00
parent 888be815c6
commit e4376063b0
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
521 changed files with 21541 additions and 21644 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
.github/workflows/c-cpp.yml vendored
View file

@ -1,18 +0,0 @@
gname: C/C++ CI
on:
push:
branches: [ master nvme-cli-monolithic ]
pull_request:
branches: [ master nvme-cli-monolithic ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: make
run: sudo apt-get install gcc-10-powerpc* && make clean && make && make clean && make LD=powerpc64le-linux-gnu-ld CC=powerpc64le-linux-gnu-gcc-10 CFLAGS='-O2 -g -Wall -Wformat-security -Werror -m64 -mcpu=power8 -mtune=power8 -I -I/usr/powerpc64-linux-gnu/include/'

27
.github/workflows/meson.yml vendored Normal file
View file

@ -0,0 +1,27 @@
name: nvme-cli meson CI
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
workflow_dispatch:
jobs:
meson-build:
runs-on: ubuntu-latest
steps:
- name: install libraries
run: sudo apt-get install libjson-c-dev libhugetlbfs-dev
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
# - name: install python dependencies
# run: |
# python -m pip install --upgrade pip
# pip install nose nose2
- uses: BSFishy/meson-build@v1.0.3
with:
setup-options: --werror
action: build

13
.gitignore vendored
View file

@ -4,18 +4,15 @@ a.out
*.o
*~
*.swp
NVME-VERSION-FILE
nvme.spec
nvme-*.tar.gz
version
subprojects/*
!subprojects/*.wrap
cscope.*
/debian/files
/debian/nvme-cli.debhelper.log
/debian/nvme-cli.substvars
/debian/nvme-cli
tests/__pycache__
tests/nvmetests
tests/*.pyc
.build

0
.gitmodules vendored Normal file
View file

265
Documentation/Makefile
View file

@ -1,265 +0,0 @@
# Guard against environment variables
MAN1_TXT =
TECH_DOCS =
ARTICLES =
SP_ARTICLES =
MAN1_TXT += $(filter-out \
$(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
$(wildcard nvme-*.txt))
MAN1_TXT += nvme.txt
MAN_TXT = $(MAN1_TXT)
MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)
API_DOCS =
SP_ARTICLES += $(API_DOCS)
SP_ARTICLES += $(TECH_DOCS)
ifneq ($(findstring $(MAKEFLAGS),s),s)
ifndef V
QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
QUIET_XMLTO = @echo ' ' XMLTO $@;
QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
QUIET_DBLATEX = @echo ' ' DBLATEX $@;
QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
QUIET_GEN = @echo ' ' GEN $@;
QUIET_LINT = @echo ' ' LINT $@;
QUIET_STDERR = 2> /dev/null
QUIET_SUBDIR0 = +@subdir=
QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
$(MAKE) $(PRINT_DIR) -C $$subdir
export V
endif
endif
DOC_MAN1 = $(patsubst %.txt,%.1,$(MAN1_TXT))
ASCIIDOC = asciidoc
ASCIIDOC_EXTRA =
ASCIIDOC_DOCBOOK = docbook
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA)
TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
MANPAGE_XSL = manpage-normal.xsl
XMLTO = xmlto
XMLTO_EXTRA = --skip-validation
INSTALL ?= install
RM ?= rm -f
MAN_REPO = ../../nvme-manpages
ASCIIDOC_HTML = xhtml11
ASCIIDOC_CONF = -f asciidoc.conf
ifdef USE_ASCIIDOCTOR
ASCIIDOC = asciidoctor
ASCIIDOC_CONF =
ASCIIDOC_HTML = xhtml5
ASCIIDOC_DOCBOOK = docbook5
ASCIIDOC_EXTRA += -acompat-mode
ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
ASCIIDOC_EXTRA += -amansource='NVMe'
ASCIIDOC_EXTRA += -amanmanual='NVMe Manual'
endif
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF)
TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
MAKEINFO = makeinfo
INSTALL_INFO = install-info
DOCBOOK2X_TEXI = docbook2x-texi
DBLATEX = dblatex
ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
ifndef PERL_PATH
PERL_PATH = /usr/bin/perl
endif
ifdef DOCBOOK_XSL_172
MANPAGE_XSL = manpage-1.72.xsl
else
ifndef ASCIIDOC_ROFF
endif
endif
ifdef MAN_BOLD_LITERAL
XMLTO_EXTRA += -m manpage-bold-literal.xsl
endif
ifdef DOCBOOK_SUPPRESS_SP
XMLTO_EXTRA += -m manpage-suppress-sp.xsl
endif
ifndef MAN_BASE_URL
MAN_BASE_URL = file://$(htmldir)/
endif
XMLTO_EXTRA +=
ifdef GNU_ROFF
XMLTO_EXTRA +=
endif
SHELL_PATH ?= $(SHELL)
# Shell quote;
SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
ifdef DEFAULT_PAGER
DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
endif
ifdef DEFAULT_EDITOR
DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
endif
QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
QUIET_SUBDIR1 =
ifneq ($(findstring $(MAKEFLAGS),w),w)
PRINT_DIR = --no-print-directory
else # "make -w"
NO_SUBDIR = :
endif
DESTDIR =
PREFIX ?= /usr/local
all: man html
html: $(DOC_HTML)
man: man1
man1: $(DOC_MAN1)
install-no-build:
$(INSTALL) -d -m 755 $(DESTDIR)$(PREFIX)/share/man/man1
$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(PREFIX)/share/man/man1
install: install-man
install-man: man
$(INSTALL) -d -m 755 $(DESTDIR)$(PREFIX)/share/man/man1
$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(PREFIX)/share/man/man1
docdep_prereqs = \
cmd-list.made $(cmds_txt)
doc.dep : $(docdep_prereqs) $(wildcard *.txt) build-docdep.perl
$(QUIET_GEN)$(RM) $@+ $@ && \
$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
mv $@+ $@
-include doc.dep
cmds_txt = cmds-ancillaryinterrogators.txt \
cmds-ancillarymanipulators.txt \
cmds-mainporcelain.txt \
cmds-plumbinginterrogators.txt \
cmds-plumbingmanipulators.txt \
cmds-synchingrepositories.txt \
cmds-synchelpers.txt \
cmds-purehelpers.txt \
cmds-foreignscminterface.txt
$(cmds_txt): cmd-list.made
cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
$(QUIET_GEN)$(RM) $@ && \
$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
date >$@
clean:
$(RM) *.xml *.xml+ *.html+
$(RM) *.texi *.texi+ *.texi++ nvme.info nvmeman.info
$(RM) *.pdf
$(RM) howto-index.txt howto/*.html doc.dep
$(RM) technical/*.html technical/api-index.txt
$(RM) $(cmds_txt) *.made
$(RM) manpage-base-url.xsl
$(RM) *~
clobber: clean
$(RM) *.html *.1
%.1 : %.xml
$(QUIET_XMLTO)$(RM) $@ && \
$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
%.xml : %.txt
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
$(TXT_TO_XML) -d manpage -o $@+ $< && \
mv $@+ $@
user-manual.xml: user-manual.txt user-manual.conf
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
$(TXT_TO_XML) -d article -o $@+ $< && \
mv $@+ $@
technical/api-index.txt: technical/api-index-skel.txt \
technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
XSLT = docbook.xsl
XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
nvme.info: user-manual.texi
$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
user-manual.texi: user-manual.xml
$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
rm $@++ && \
mv $@+ $@
user-manual.pdf: user-manual.xml
$(QUIET_DBLATEX)$(RM) $@+ $@ && \
$(DBLATEX) -o $@+ -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty $< && \
mv $@+ $@
nvmeman.texi: $(MAN_XML) cat-texi.perl
$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
--to-stdout $(xml) &&) true) > $@++ && \
$(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
rm $@++ && \
mv $@+ $@
nvmeman.info: nvmeman.texi
$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
mv $@+ $@
howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
$(QUIET_GEN)$(RM) $@+ $@ && \
'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
mv $@+ $@
WEBDOC_DEST = /pub/software/scm/nvme/docs
$(MAN_HTML): %.html : %.txt
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
$(TXT_TO_HTML) -d manpage -o $@+ $< && \
mv $@+ $@
quick-install: quick-install-man
$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
install-webdoc : html
'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
require-manrepo::
@if test ! -d $(MAN_REPO); \
then echo "nvme-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
quick-install-man: require-manrepo
'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir)
print-man1:
@for i in $(MAN1_TXT); do echo $$i; done
.PHONY: FORCE

200
Documentation/cmd-plugins.txt Normal file
View file

@ -0,0 +1,200 @@
linknvme:nvme-intel-id-ctrl[1]::
Intel - NVMe Identify Controller
linknvme:nvme-intel-internal-log[1]::
Retrieve Intel device's internal log and save to file
linknvme:nvme-intel-lat-stats[1]::
Retrieve NVMe Identify Controller, return result and structure
linknvme:nvme-intel-market-name[1]::
Intel vendor specific marketing name log page
linknvme:nvme-intel-smart-log-add[1]::
NVMe Intel Additional SMART log page
linknvme:nvme-intel-temp-stats[1]::
NVMe Intel Additional SMART log page for temp stats
linknvme:nvme-huawei-id-ctrl[1]::
NVMe huawei Identify Controller
linknvme:nvme-huawei-list[1]::
List all recognized Huawei NVMe devices
linknvme:nvme-dera-stat[1]::
NVMe Dera Device status and Additional SMART log page request
linknvme:nvme-micron-clear-pcie-errors[1]::
Clears correctable PCIe correctable errors of given Micron device
linknvme:nvme-micron-internal-log[1]::
Retrieve Micron device's internal logs and save to given zip file
linknvme:nvme-micron-nand-stats[1]::
Retrieves NAND statistics of given micron device
linknvme:nvme-micron-pcie-stats[1]::
Retrieves pcie error statistics for given micron device
linknvme:nvme-micron-selective-download[1]::
Performs selective firmware download
linknvme:nvme-micron-smart-add-log[1]::
Retrieves NAND statistics
linknvme:nvme-micron-temperature-stats[1]::
Retrieves temperature information of given micron device
linknvme:nvme-netapp-ontapdevices[1]::
Display information about ONTAP devices
linknvme:nvme-netapp-smdevices[1]::
Display information for each NVMe path to an E-Series volume
linknvme:nvme-toshiba-clear-pcie-correctable-errors[1]::
Reset the PCIe correctable errors count to zero
linknvme:nvme-toshiba-vs-internal-log[1]::
Retrieve a Toshiba device's vendor specific internal log
linknvme:nvme-toshiba-vs-smart-add-log[1]::
Retrieve a Toshiba device's vendor specific extended SMART log page
linknvme:nvme-transcend-badblock[1]::
Retrieve Transcend NVMe device's bad blocks
linknvme:nvme-transcend-healthvalue[1]::
Use NVMe SMART table to analyse the health value of Transcend device
linknvme:nvme-virtium-show-identify[1]::
Show a complete detail of identify device information in json format
linknvme:nvme-virtium-save-smart-to-vtview-log[1]::
Periodically save smart attributes into a log file
linknvme:nvme-wdc-cap-diag[1]::
Retrieve WDC device's diagnostic log and save to file
linknvme:nvme-wdc-capabilities[1]::
Display WDC plugin command capabilities
linknvme:nvme-wdc-clear-assert-dump[1]::
Clears the assert dump (if present)
linknvme:nvme-wdc-clear-fw-activate-history[1]::
Clears the firmware activate history table
linknvme:nvme-wdc-clear-pcie-corr[1]::
Clears the pcie correctable errors field
linknvme:nvme-wdc-clear-pcie-correctable-errors[1]::
Clears the pcie correctable errors returned in the smart-log-add command
linknvme:nvme-wdc-cloud-SSD-plugin-version[1]::
Display WDC plugin Cloud SSD Plugin Version
linknvme:nvme-wdc-drive-essentials[1]::
Retrieve WDC device's drive essentials bin files
linknvme:nvme-wdc-drive-log[1]::
Retrieve WDC device's drive log and save to file
linknvme:nvme-wdc-drive-resize[1]::
Send NVMe WDC Resize Vendor Unique Command
linknvme:nvme-wdc-enc-get-log[1]::
Send NVMe WDC enc-get-log Vendor Unique Command
linknvme:nvme-wdc-get-crash-dump[1]::
Retrieve WDC device's crash dump
linknvme:nvme-wdc-get-drive-status[1]::
Send the NVMe WDC get-drive-status command
linknvme:nvme-wdc-get-latency-monitor-log[1]::
Display latency monitor log page data in human readable format
linknvme:nvme-wdc-get-pfail-dump[1]::
Retrieve WDC device's pfail crash dump
linknvme:nvme-wdc-id-ctrl[1]::
Send NVMe Identify Controller, return result and structure
linknvme:nvme-wdc-log-page-directory[1]::
Retrieves the list of Log IDs supported by the drive
linknvme:nvme-wdc-namespace-resize[1]::
Resizes the device's namespace
linknvme:nvme-wdc-purge-monitor[1]::
Send NVMe WDC Purge-Monitor Vendor Unique Command
linknvme:nvme-wdc-purge[1]::
Send NVMe WDC Purge Vendor Unique Command
linknvme:nvme-wdc-smart-add-log[1]::
Send NVMe WDC smart add log Vendor Unique Command
linknvme:nvme-wdc-vs-drive-info[1]::
Send the NVMe WDC vs-drive-info command
linknvme:nvme-wdc-vs-error-reason-identifier[1]::
Retrieve WDC device's telemetry log error reason identifier field
linknvme:nvme-wdc-vs-fw-activate-history[1]::
Execute NVMe WDC vs-fw-activate-history Vendor Unique Command
linknvme:nvme-wdc-vs-internal-log[1]::
Retrieve WDC device's internal firmware log and save to file
linknvme:nvme-wdc-vs-nand-stats[1]::
Send NVMe WDC vs-nand-stats Vendor Unique Command
linknvme:nvme-wdc-vs-telemetry-controller-option[1]::
Disable/Enable the controller initiated option of the telemetry log page
linknvme:nvme-wdc-vs-temperature-stats[1]::
Display temperature-related statistics
linknvme:nvme-zns-changed-zone-list[1]::
Retrieve Changed Zone log for the given device
linknvme:nvme-zns-close-zone[1]::
Closes one or all zones
linknvme:nvme-zns-finish-zone[1]::
Finishes one or all zones
linknvme:nvme-zns-id-ctrl[1]::
Send NVMe Zoned Command Set Identify Controller
linknvme:nvme-zns-id-ns[1]::
Send NVMe Zoned Command Set Identify Namespace
linknvme:nvme-zns-offline-zone[1]::
Offlines one or all zones
linknvme:nvme-zns-open-zone[1]::
Opens one or all zones
linknvme:nvme-zns-report-zones[1]::
Retrieve and display the Report Zones data structure
linknvme:nvme-zns-reset-zone[1]::
Resets one or all zones
linknvme:nvme-zns-set-zone-desc[1]::
Set extended descriptor data for a zone
linknvme:nvme-zns-zone-append[1]::
Send an NVMe write command, provide results
linknvme:nvme-zns-zone-mgmt-recv[1]::
Zone Management Receive command
linknvme:nvme-zns-zone-mgmt-send[1]::
Zone Management Send command
linknvme:nvme-zns-zrwa-flush-zone[1]::
Flush LBAs associated with a ZRWA to a zone

104
Documentation/cmds-main.txt
View file

@ -10,7 +10,7 @@ linknvme:nvme-error-log[1]::
linknvme:nvme-flush[1]::
Submit flush
linknvme:nvme-dms[1]::
linknvme:nvme-dsm[1]::
Submit Data Set Management
linknvme:nvme-format[1]::
@ -160,6 +160,9 @@ linknvme:nvme-connect-all[1]::
linknvme:nvme-connect[1]::
Connect to an NVMe-over-Fabrics subsystem
linknvme:nvme-dim[1]::
Send Discovery Information Management command to a Discovery Controller
linknvme:nvme-disconnect[1]::
Disconnect from an NVMe-over-Fabrics subsystem
@ -168,3 +171,102 @@ linknvme:nvme-disconnect-all[1]::
linknvme:nvme-get-property[1]::
Reads and shows NVMe-over-Fabrics controller property
linknvme:nvme-media-unit-stat-log[1]::
Retrieve and show the configuration and wear of media units
linknvme:nvme-supported-cap-config-log[1]::
Retrieve and show the list of Supported Capacity Configuration Descriptors
linknvme:nvme-boot-part-log[1]::
Retrieve Boot Partition Log
linknvme:nvme-capacity-mgmt[1]::
Capacity Management Command
linknvme:nvme-check-dhchap-key[1]::
Generate NVMeoF DH-HMAC-CHAP host key
linknvme:nvme-check-tls-key[1]::
Validate NVMeoF TLS PSK
linknvme:nvme-cmdset-ind-id-ns[1]::
I/O Command Set Independent Identify Namespace
linknvme:nvme-endurance-event-agg-log[1]::
Retrieve Endurance Group Event Aggregate Log
linknvme:nvme-fid-support-effects-log[1]::
Retrieve FID Support and Effects log
linknvme:nvme-gen-dhchap-key[1]::
Generate NVMeoF DH-HMAC-CHAP host key
linknvme:nvme-gen-hostnqn[1]::
Generate NVMeoF host NQN
linknvme:nvme-gen-tls-key[1]::
Generate NVMeoF TLS PSK
linknvme:nvme-get-lba-status[1]::
Get LBA Status command
linknvme:nvme-id-domain[1]::
NVMe Identify Domain List
linknvme:nvme-id-ns-lba-format[1]::
NVMe Identify Namespace for the specified LBA Format index
linknvme:nvme-lba-status-log[1]::
Retrieve LBA Status Information Log
linknvme:nvme-list-endgrp[1]::
NVMe Identify Endurance Group List
linknvme:nvme-ns-rescan[1]::
Rescans the NVME namespaces
linknvme:nvme-nvm-id-ctrl[1]::
NVMe Identify Controller NVM Command Set
linknvme:nvme-nvm-id-ns[1]::
NVMe Identify Namespace NVM Command Set
linknvme:nvme-nvm-id-ns-lba-format[1]::
NVMe Identify Namespace NVM Command Set for the specified LBA Format index
linknvme:nvme-persistent-event-log[1]::
Retrieve Presistent Event Log
linknvme:nvme-predictable-lat-log[1]::
Retrieve Predictable Latency per Nvmset Log
linknvme:nvme-pred-lat-event-agg-log[1]::
Retrieve Predictable Latency Event Aggregate Log
linknvme:nvme-primary-ctrl-caps[1]::
NVMe Identify Primary Controller Capabilities
linknvme:nvme-reset[1]::
Resets the controller
linknvme:nvme-rpmb[1]::
Replay Protection Memory Block commands
linknvme:nvme-sanitize-log[1]::
Retrieve sanitize log
linknvme:nvme-set-property[1]::
Set a property and show the resulting value
linknvme:nvme-show-hostnqn[1]::
Show NVMeoF host NQN
linknvme:nvme-subsystem-reset[1]::
Resets the subsystem
linknvme:nvme-supported-log-pages[1]::
Retrieve the Supported Log pages details
linknvme:nvme-verify[1]::
verify command

257
Documentation/meson.build Normal file
View file

@ -0,0 +1,257 @@
adoc_sources = [
'nvme',
'nvme-admin-passthru',
'nvme-ana-log',
'nvme-attach-ns',
'nvme-boot-part-log',
'nvme-capacity-mgmt',
'nvme-changed-ns-list-log',
'nvme-cmdset-ind-id-ns',
'nvme-compare',
'nvme-connect',
'nvme-connect-all',
'nvme-copy',
'nvme-create-ns',
'nvme-delete-ns',
'nvme-dera-stat',
'nvme-detach-ns',
'nvme-device-self-test',
'nvme-dim',
'nvme-dir-receive',
'nvme-dir-send',
'nvme-disconnect',
'nvme-disconnect-all',
'nvme-discover',
'nvme-dsm',
'nvme-effects-log',
'nvme-endurance-event-agg-log',
'nvme-endurance-log',
'nvme-error-log',
'nvme-fid-support-effects-log',
'nvme-mi-cmd-support-effects-log',
'nvme-flush',
'nvme-format',
'nvme-fw-commit',
'nvme-fw-download',
'nvme-fw-log',
'nvme-gen-hostnqn',
'nvme-get-feature',
'nvme-get-lba-status',
'nvme-get-log',
'nvme-get-ns-id',
'nvme-get-property',
'nvme-help',
'nvme-huawei-id-ctrl',
'nvme-huawei-list',
'nvme-id-ctrl',
'nvme-id-domain',
'nvme-id-iocs',
'nvme-id-ns',
'nvme-id-nvmset',
'nvme-intel-id-ctrl',
'nvme-intel-internal-log',
'nvme-intel-lat-stats',
'nvme-intel-market-name',
'nvme-intel-smart-log-add',
'nvme-intel-temp-stats',
'nvme-io-passthru',
'nvme-lba-status-log',
'nvme-list',
'nvme-list-ctrl',
'nvme-list-endgrp',
'nvme-list-ns',
'nvme-list-subsys',
'nvme-lockdown',
'nvme-micron-clear-pcie-errors',
'nvme-micron-internal-log',
'nvme-micron-nand-stats',
'nvme-micron-pcie-stats',
'nvme-micron-selective-download',
'nvme-micron-smart-add-log',
'nvme-micron-temperature-stats',
'nvme-netapp-ontapdevices',
'nvme-netapp-smdevices',
'nvme-ns-descs',
'nvme-ns-rescan',
'nvme-nvm-id-ctrl',
'nvme-ocp-latency-monitor-log',
'nvme-ocp-smart-add-log',
'nvme-persistent-event-log',
'nvme-pred-lat-event-agg-log',
'nvme-predictable-lat-log',
'nvme-primary-ctrl-caps',
'nvme-read',
'nvme-reset',
'nvme-resv-acquire',
'nvme-resv-notif-log',
'nvme-resv-register',
'nvme-resv-release',
'nvme-resv-report',
'nvme-rpmb',
'nvme-sanitize',
'nvme-sanitize-log',
'nvme-security-recv',
'nvme-security-send',
'nvme-self-test-log',
'nvme-set-feature',
'nvme-set-property',
'nvme-show-hostnqn',
'nvme-show-regs',
'nvme-smart-log',
'nvme-subsystem-reset',
'nvme-supported-log-pages',
'nvme-telemetry-log',
'nvme-toshiba-clear-pcie-correctable-errors',
'nvme-toshiba-vs-internal-log',
'nvme-toshiba-vs-smart-add-log',
'nvme-transcend-badblock',
'nvme-transcend-healthvalue',
'nvme-verify',
'nvme-virtium-save-smart-to-vtview-log',
'nvme-virtium-show-identify',
'nvme-wdc-cap-diag',
'nvme-wdc-capabilities',
'nvme-wdc-clear-assert-dump',
'nvme-wdc-clear-fw-activate-history',
'nvme-wdc-clear-pcie-correctable-errors',
'nvme-wdc-cloud-SSD-plugin-version',
'nvme-wdc-drive-essentials',
'nvme-wdc-drive-log',
'nvme-wdc-drive-resize',
'nvme-wdc-enc-get-log',
'nvme-wdc-get-crash-dump',
'nvme-wdc-get-dev-capabilities-log',
'nvme-wdc-get-drive-status',
'nvme-wdc-get-error-recovery-log',
'nvme-wdc-get-latency-monitor-log',
'nvme-wdc-get-pfail-dump',
'nvme-wdc-get-unsupported-reqs-log',
'nvme-wdc-id-ctrl',
'nvme-wdc-log-page-directory',
'nvme-wdc-namespace-resize',
'nvme-wdc-purge',
'nvme-wdc-purge-monitor',
'nvme-wdc-vs-drive-info',
'nvme-wdc-vs-error-reason-identifier',
'nvme-wdc-vs-fw-activate-history',
'nvme-wdc-vs-internal-log',
'nvme-wdc-vs-nand-stats',
'nvme-wdc-vs-smart-add-log',
'nvme-wdc-vs-telemetry-controller-option',
'nvme-wdc-vs-temperature-stats',
'nvme-write',
'nvme-write-uncor',
'nvme-write-zeroes',
'nvme-zns-changed-zone-list',
'nvme-zns-close-zone',
'nvme-zns-finish-zone',
'nvme-zns-id-ctrl',
'nvme-zns-id-ns',
'nvme-zns-offline-zone',
'nvme-zns-open-zone',
'nvme-zns-report-zones',
'nvme-zns-reset-zone',
'nvme-zns-set-zone-desc',
'nvme-zns-zone-append',
'nvme-zns-zone-mgmt-recv',
'nvme-zns-zone-mgmt-send',
]
adoc_includes = [
'cmd-plugins.txt',
'cmds-main.txt',
]
want_docs = get_option('docs')
want_docs_build = get_option('docs-build')
if want_docs != 'false'
mandir = join_paths(get_option('mandir'), 'man1')
htmldir = join_paths(get_option('htmldir'), 'nvme')
asciidoctor = find_program('asciidoc', required : false)
if want_docs_build and asciidoctor.found()
# Build documentation before installing
foreach file : adoc_includes
configure_file(
input: file,
output: file,
copy: true)
endforeach
# man pages
if want_docs == 'all' or want_docs == 'man'
xmlto = find_program('xmlto', required: false)
if xmlto.found()
foreach adoc : adoc_sources
input = adoc + '.txt'
subst = configure_file(
input: adoc + '.txt',
output: adoc + '.msubst',
configuration: substs)
xml = custom_target(
adoc.underscorify() + '_xml',
input: subst,
output: '@BASENAME@.xml',
command: [asciidoctor,
'-f', files('asciidoc.conf'),
'-b', 'docbook',
'-d', 'manpage',
'-o', '@OUTPUT@',
'@INPUT@'],
)
custom_target(
adoc.underscorify() + '_man',
input: xml,
output: '@BASENAME@.1',
command: [xmlto,
'-m', files('manpage-normal.xsl'),
'-o', '@OUTDIR@',
'--skip-validation',
'man',
'@INPUT@'],
install: true,
install_dir: mandir)
endforeach
endif
endif
# html
if want_docs == 'all' or want_docs == 'html'
foreach adoc : adoc_sources
input = adoc + '.txt'
subst = configure_file(
input: adoc + '.txt',
output: adoc + '.hsubst',
configuration: substs)
custom_target(
adoc.underscorify() + '_html',
input: subst,
output: '@BASENAME@.html',
command: [asciidoctor,
'-f', files('asciidoc.conf'),
'-b', 'xhtml11',
'-d', 'manpage',
'-o', '@OUTPUT@',
'@INPUT@'],
install: true,
install_dir: htmldir)
endforeach
endif
else
# asciidoctor not found, install pre compiled documetationx
foreach adoc : adoc_sources
if want_docs == 'all' or want_docs == 'man'
man = files(adoc + '.1')
install_data(man, install_dir: mandir)
endif
if want_docs == 'all' or want_docs == 'html'
html = files(adoc + '.html')
install_data(html, install_dir: htmldir)
endif
endforeach
endif
endif

4
Documentation/nvme-admin-passthru.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-admin-passthru
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ADMIN\-PASSTHR" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-ADMIN\-PASSTHR" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-admin-passthru.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-admin-passthru(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -998,7 +998,7 @@ Or if you want to save that structure to a file:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-ana-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-ana-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ANA\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-ANA\-LOG" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-ana-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-ana-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -812,7 +812,7 @@ Print the ANA log page in a human readable format:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-attach-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-attach-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ATTACH\-NS" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-ATTACH\-NS" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-attach-ns.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-attach-ns(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -817,7 +817,7 @@ controller identifiers.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-boot-part-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-boot-part-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-BOOT\-PART\-LO" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-BOOT\-PART\-LO" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-boot-part-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-boot-part-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -835,7 +835,7 @@ Retrieve Boot Partition data to boot_part_log.bin
<div id="footer">
<div id="footer-text">
Last updated
2021-08-11 09:38:58 IST
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-capacity-mgmt.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-capacity-mgmt
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CAPACITY\-MGMT" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-CAPACITY\-MGMT" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

15
Documentation/nvme-capacity-mgmt.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-capacity-mgmt(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -760,10 +760,11 @@ nvme-capacity-mgmt(1) Manual Page
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>For the NVMe device given, sends a capacity management command to configure/create/delete
the Endurance Groups or NVM Sets with the requested operation and element_id. On success,
if the Operation is Create Endurance group or NVM Set, CQE CDW0 contains Created element
identifier else CQE CDW0 is reserved.</p></div>
<div class="paragraph"><p>For the NVMe device given, sends a capacity management command to
configure/create/delete the Endurance Groups or NVM Sets with the requested
operation and element_id. On success, if the Operation is Create Endurance
group or NVM Set, CQE CDW0 contains Created element identifier else CQE CDW0 is
reserved.</p></div>
<div class="paragraph"><p>The &lt;device&gt; parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></div>
</div>
@ -838,7 +839,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
<div id="footer">
<div id="footer-text">
Last updated
2021-07-02 09:55:05 IST
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-changed-ns-list-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-changed-ns-list-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CHANGED\-NS\-L" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-CHANGED\-NS\-L" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-changed-ns-list-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-changed-ns-list-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -835,7 +835,7 @@ Print the raw Changed Namespace List log to a file:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

25
Documentation/nvme-lnvm-info.1 → Documentation/nvme-check-dhchap-key.1
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: nvme-lnvm-info
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Title: nvme-check-dhchap-key
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 11/25/2021
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-LNVM\-INFO" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-CHECK\-DHCHAP\" "1" "11/25/2021" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -28,21 +28,24 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-lnvm-info \- Show general information and registered target types with LightNVM
nvme-check-dhchap-key \- Check a generated host DH\-HMAC\-CHAP key
.SH "SYNOPSIS"
.sp
.nf
\fInvme lnvm\-info\fR
\fInvme check\-dhchap\-key\fR [\-\-key=<key> ]
.fi
.SH "DESCRIPTION"
.sp
Show general information and registered target types with LightNVM\&.
Checks if the key is a valid DH\-HMAC\-CHAP host key of the form: DHHC\-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: and prints it to stdout\&.
.SH "OPTIONS"
.sp
No options yet\&.
.PP
\-k <key>, \-\-key=<key>
.RS 4
Key to be checked\&.
.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
No Examples
.SH "NVME"
.sp
Part of the nvme\-user suite

42
Documentation/nvme-lnvm-info.html → Documentation/nvme-check-dhchap-key.html
View file

@ -1,11 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<title>nvme-lnvm-info(1)</title>
<meta name="generator" content="AsciiDoc 8.6.8" />
<title>nvme-check-dhchap-key(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -95,9 +94,7 @@ ul > li > * { color: black; }
padding: 0;
margin: 0;
}
pre {
white-space: pre-wrap;
}
#author {
color: #527bbd;
@ -226,7 +223,7 @@ div.exampleblock > div.content {
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
@ -735,12 +732,12 @@ asciidoc.install();
<body class="manpage">
<div id="header">
<h1>
nvme-lnvm-info(1) Manual Page
nvme-check-dhchap-key(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>nvme-lnvm-info -
Show general information and registered target types with LightNVM
<p>nvme-check-dhchap-key -
Check a generated host DH-HMAC-CHAP key
</p>
</div>
</div>
@ -749,7 +746,7 @@ nvme-lnvm-info(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme lnvm-info</em></pre>
<pre class="content"><em>nvme check-dhchap-key</em> [--key=&lt;key&gt; ]</pre>
<div class="attribution">
</div></div>
</div>
@ -757,19 +754,33 @@ nvme-lnvm-info(1) Manual Page
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Show general information and registered target types with LightNVM.</p></div>
<div class="paragraph"><p>Checks if the key is a valid DH-HMAC-CHAP host key of the form:
DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:
and prints it to stdout.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>No options yet.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
-k &lt;key&gt;
</dt>
<dt class="hdlist1">
--key=&lt;key&gt;
</dt>
<dd>
<p>
Key to be checked.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="paragraph"><p>No examples yet.</p></div>
<div class="paragraph"><p>No Examples</p></div>
</div>
</div>
<div class="sect1">
@ -782,8 +793,7 @@ nvme-lnvm-info(1) Manual Page
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
Last updated 2021-11-25 14:13:07 KST
</div>
</div>
</body>

31
Documentation/nvme-check-dhchap-key.txt Normal file
View file

@ -0,0 +1,31 @@
nvme-check-dhchap-key(1)
========================
NAME
----
nvme-check-dhchap-key - Check a generated host DH-HMAC-CHAP key
SYNOPSIS
--------
[verse]
'nvme check-dhchap-key' [--key=<key> ]
DESCRIPTION
-----------
Checks if the key is a valid DH-HMAC-CHAP host key of the form:
DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:
and prints it to stdout.
OPTIONS
-------
-k <key>::
--key=<key>::
Key to be checked.
EXAMPLES
--------
No Examples
NVME
----
Part of the nvme-user suite

31
Documentation/nvme-check-tls-key.txt Normal file
View file

@ -0,0 +1,31 @@
nvme-check-tls-key(1)
========================
NAME
----
nvme-check-tls-key - Check a generated NVMe TLS PSK
SYNOPSIS
--------
[verse]
'nvme check-tls-key' [--key=<key> ]
DESCRIPTION
-----------
Checks if the key is a valid NVMe TLS PSK in the PSK interchange format
NVMeTLSkey-1:01:VRLbtnN9AQb2WXW3c9+wEf/DRLz0QuLdbYvEhwtdWwNf9LrZ:
OPTIONS
-------
-k <key>::
--key=<key>::
Key to be checked.
EXAMPLES
--------
No Examples
NVME
----
Part of the nvme-user suite

4
Documentation/nvme-cmdset-ind-id-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-cmdset-ind-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CMDSET\-IND\-I" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-CMDSET\-IND\-I" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

14
Documentation/nvme-cmdset-ind-id-ns.html
View file

@ -1,9 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.8" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-cmdset-ind-id-ns(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -94,7 +95,9 @@ ul > li > * { color: black; }
padding: 0;
margin: 0;
}
pre {
white-space: pre-wrap;
}
#author {
color: #527bbd;
@ -223,7 +226,7 @@ div.exampleblock > div.content {
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }
dl {
@ -433,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -875,7 +878,8 @@ Have the program return the raw structure in binary:
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2021-08-25 18:30:10 KST
Last updated
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

12
Documentation/nvme-compare.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-compare
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-COMPARE" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-COMPARE" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -51,6 +51,7 @@ nvme-compare \- Send an NVMe Compare command, provide results
[\-\-dry\-run | \-w]
[\-\-latency | \-t]
[\-\-storage\-tag\-check<storage\-tag\-check> | \-C <storage\-tag\-check>]
[\-\-force]
.fi
.SH "DESCRIPTION"
.sp
@ -183,7 +184,7 @@ Optional field for directive specifics\&. When used with write streams, this val
.PP
\-D <dsm>, \-\-dsm=<dsm>
.RS 4
The optional data set management attributes for this command\&. The argument for this is the lower 16 bits of the DSM field in a write command; the upper 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&.
The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&.
.RE
.PP
\-v, \-\-show\-cmd
@ -208,6 +209,11 @@ Print out the latency the IOCTL took (in us)\&.
.RS 4
This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&.
.RE
.PP
\-\-force
.RS 4
Ignore namespace is currently busy and perfome the operation even though\&.
.RE
.SH "EXAMPLES"
.sp
No examples yet\&.

24
Documentation/nvme-compare.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-compare(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -767,7 +767,8 @@ nvme-compare(1) Manual Page
[--show-command | -v]
[--dry-run | -w]
[--latency | -t]
[--storage-tag-check&lt;storage-tag-check&gt; | -C &lt;storage-tag-check&gt;]</pre>
[--storage-tag-check&lt;storage-tag-check&gt; | -C &lt;storage-tag-check&gt;]
[--force]</pre>
<div class="attribution">
</div></div>
</div>
@ -996,9 +997,9 @@ metadata is passes.</p></td>
</dt>
<dd>
<p>
The optional data set management attributes for this command. The
argument for this is the lower 16 bits of the DSM field in a write
command; the upper 16 bits of the field come from the directive
The optional data set management attributes for this command. The argument
for this is the least significant 8 bits of the DSM field in a write
command; the most significant 16 bits of the field come from the directive
specific field, if used. This may be used to set attributes for
the LBAs being written, like access frequency, type, latency,
among other things, as well as yet to be defined types. Please
@ -1053,6 +1054,15 @@ metadata is passes.</p></td>
data protection processing.
</p>
</dd>
<dt class="hdlist1">
--force
</dt>
<dd>
<p>
Ignore namespace is currently busy and perfome the operation
even though.
</p>
</dd>
</dl></div>
</div>
</div>
@ -1073,7 +1083,7 @@ metadata is passes.</p></td>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-09 14:16:50 IST
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

12
Documentation/nvme-compare.txt
View file

@ -27,6 +27,7 @@ SYNOPSIS
[--dry-run | -w]
[--latency | -t]
[--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
[--force]
DESCRIPTION
-----------
@ -117,15 +118,14 @@ metadata is passes.
-D <dsm>::
--dsm=<dsm>::
The optional data set management attributes for this command. The
argument for this is the lower 16 bits of the DSM field in a write
command; the upper 16 bits of the field come from the directive
The optional data set management attributes for this command. The argument
for this is the least significant 8 bits of the DSM field in a write
command; the most significant 16 bits of the field come from the directive
specific field, if used. This may be used to set attributes for
the LBAs being written, like access frequency, type, latency,
among other things, as well as yet to be defined types. Please
consult the NVMe specification for detailed breakdown of how to
use this field.
-v::
--show-cmd::
Print out the command to be sent.
@ -145,6 +145,10 @@ metadata is passes.
This bit specifies the Storage Tag field shall be checked as part of end-to-end
data protection processing.
--force::
Ignore namespace is currently busy and perfome the operation
even though.
EXAMPLES
--------
No examples yet.

210
Documentation/nvme-config.txt Normal file
View file

@ -0,0 +1,210 @@
nvme-config(1)
===============
NAME
----
nvme-config - NVMe-over-Fabrics configuration.
SYNOPSIS
--------
[verse]
'nvme config'
[--scan | -R]
[--modify | -M]
[--update | -U]
[--dump | -O]
[--config=<cfg> | -J <cfg> ]
[--transport=<trtype> | -t <trtype>]
[--nqn=<subnqn> | -n <subnqn>]
[--traddr=<traddr> | -a <traddr>]
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
[--host-iface=<iface> | -f <iface>]
[--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostid=<hostid> | -I <hostid>]
[--dhchap-secret=<secret> | -S <secret>]
[--dhchap-ctrl-secret=<secret> | -C <secret>]
[--nr-io-queues=<#> | -i <#>]
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>]
[--keep-alive-tmo=<#> | -k <#>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
[--duplicate-connect | -D]
[--disable-sqflow | -d]
[--hdr-digest | -g]
[--data-digest | -G]
DESCRIPTION
-----------
Read in the NVMe over Fabrics configuration from the specified JSON
configuration file and allow to update or modify the contents.
The JSON configuration file format is documented in
https://github.com/linux-nvme/libnvme/doc/config-schema.json
OPTIONS
-------
-R::
--scan::
Additionally read the current configuration from sysfs.
-M::
--modify::
Add or modify entries in the configuration based on the values from
the commandline.
-U::
--update::
Write updated configuration into the JSON configuration file.
-O::
--dump::
Print out resulting JSON configuration file to stdout.
-J <cfg>::
--config=<cfg>::
Use the specified JSON configuration file instead of the
default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in
an existing configuration file.
-t <trtype>::
--transport=<trtype>::
This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include:
+
[]
|=================
|Value|Definition
|rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc)
|fc |The network fabric is a Fibre Channel network.
|tcp |The network fabric is a TCP/IP network.
|loop|Connect to a NVMe over Fabrics target on the local host
|=================
-n <subnqn>::
--nqn <subnqn>::
This field specifies the name for the NVMe subsystem to connect to.
-a <traddr>::
--traddr=<traddr>::
This field specifies the network address of the Controller.
For transports using IP addressing (e.g. rdma) this should be an
IP-based address (ex. IPv4).
-s <trsvcid>::
--trsvcid=<trsvcid>::
This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420.
-w <traddr>::
--host-traddr=<traddr>::
This field specifies the network address used on the host to connect
to the Controller. For TCP, this sets the source address on the socket.
-f <iface>::
--host-iface=<iface>::
This field specifies the network interface used on the host to connect
to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces
the connection to be made on a specific interface instead of letting
the system decide.
-q <hostnqn>::
--hostnqn=<hostnqn>::
Overrides the default Host NQN that identifies the NVMe Host.
If this option is not specified, the default is read from
@SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the autogenerated
NQN value from the NVMe Host kernel module is used next.
The Host NQN uniquely identifies the NVMe Host.
-I <hostid>::
--hostid=<hostid>::
UUID(Universally Unique Identifier) to be discovered which should be
formatted.
-S <secret>::
--dhchap-secret=<secret>::
NVMe In-band authentication secret; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 'Secret representation'.
If this option is not specified, the default is read from
@SYSCONFDIR@/nvme/hostkey. If that does not exist no in-band authentication
is attempted.
-C <secret>::
--dhchap-ctrl-secret=<secret>::
NVMe In-band authentication controller secret for bi-directional
authentication; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 'Secret representation'.
If not present bi-directional authentication is not attempted.
-i <#>::
--nr-io-queues=<#>::
Overrides the default number of I/O queues create by the driver.
-W <#>::
--nr-write-queues=<#>::
Adds additional queues that will be used for write I/O.
-P <#>::
--nr-poll-queues=<#>::
Adds additional queues that will be used for polling latency sensitive I/O.
-Q <#>::
--queue-size=<#>::
Overrides the default number of elements in the I/O queues created
by the driver.
-k <#>::
--keep-alive-tmo=<#>::
Overrides the default keep alive timeout (in seconds).
-c <#>::
--reconnect-delay=<#>::
Overrides the default delay (in seconds) before reconnect is attempted
after a connect loss.
-l <#>::
--ctrl-loss-tmo=<#>::
Overrides the default controller loss timeout period (in seconds).
-D::
--duplicate-connect::
Allows duplicated connections between same transport host and subsystem
port.
-d::
--disable-sqflow::
Disables SQ flow control to omit head doorbell update for submission
queues when sending nvme completions.
-g::
--hdr-digest::
Generates/verifies header digest (TCP).
-G::
--data-digest::
Generates/verifies data digest (TCP).
EXAMPLES
--------
* Read the current system configuration and write the contents to /tmp/config.json:
+
------------
# nvme config --config /tmp/config.json --scan --update
------------
SEE ALSO
--------
nvme-discover(1)
nvme-connect(1)
https://github.com/linux-nvme/libnvme/doc/config-schema.json
AUTHORS
-------
This was written by mailto:hare@suse.com[Hannes Reinecke]
NVME
----
Part of the nvme-user suite

31
Documentation/nvme-connect-all.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-connect-all
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CONNECT\-ALL" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-CONNECT\-ALL" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -34,6 +34,7 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
.nf
\fInvme connect\-all\fR
[\-\-transport=<trtype> | \-t <trtype>]
[\-\-nqn=<subnqn> | \-n <subnqn>]
[\-\-traddr=<traddr> | \-a <traddr>]
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
[\-\-host\-traddr=<traddr> | \-w <traddr>]
@ -41,6 +42,7 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
[\-\-hostid=<hostid> | \-I <hostid>]
[\-\-raw=<filename> | \-r <filename>]
[\-\-cfg\-file=<cfg> | \-C <cfg>]
[\-\-keep\-alive\-tmo=<#> | \-k <#>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
@ -50,9 +52,9 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
[\-\-nr\-write\-queues=<#> | \-W <#>]
[\-\-nr\-poll\-queues=<#> | \-P <#>]
[\-\-queue\-size=<#> | \-Q <#>]
[\-\-matching | \-m]
[\-\-persistent | \-p]
[\-\-quiet | \-S]
[\-\-dump\-config | \-O]
.fi
.SH "DESCRIPTION"
.sp
@ -105,6 +107,11 @@ T}
.sp 1
.RE
.PP
\-n <subnqn>, \-\-nqn <subnqn>
.RS 4
This field specifies the name for the NVMe subsystem to connect to\&.
.RE
.PP
\-a <traddr>, \-\-traddr=<traddr>
.RS 4
This field specifies the network address of the Discovery Controller\&. For transports using IP addressing (e\&.g\&. rdma) this should be an IP\-based address (ex\&. IPv4)\&.
@ -144,6 +151,14 @@ command and dump it to a raw binary file\&. By default
will dump the output to stdout\&.
.RE
.PP
\-C <cfg>, \-\-config\-file=<cfg>
.RS 4
Use the specified JSON configuration file instead of the default /etc/nvme/config\&.json file or
\fInone\fR
to not read in an existing configuration file\&. The JSON configuration file format is documented in
\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/doc/config\-schema\&.json\fR\m[]
.RE
.PP
\-k <#>, \-\-keep\-alive\-tmo=<#>
.RS 4
Overrides the default keep alive timeout (in seconds)\&. This option will be ignored for discovery, but will be passed on to the subsequent connect call\&.
@ -189,11 +204,6 @@ Adds additional queues that will be used for polling latency sensitive I/O\&.
Overrides the default number of elements in the I/O queues created by the driver\&. This option will be ignored for discovery, but will be passed on to the subsequent connect call\&.
.RE
.PP
\-m, \-\-matching
.RS 4
If a traddr was specified on the command line or in the configuration file, only create controllers for discovery records that match the given traddr, rather than for all entries in the discovery log page\&.
.RE
.PP
\-p, \-\-persistent
.RS 4
Don\(cqt remove the discovery controller after retrieving the discovery log page\&.
@ -203,6 +213,11 @@ Don\(cqt remove the discovery controller after retrieving the discovery log page
.RS 4
Suppress error messages\&.
.RE
.PP
\-O, \-\-dump\-config
.RS 4
Print out resulting JSON configuration file to stdout\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4

70
Documentation/nvme-connect-all.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-connect-all(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -751,6 +751,7 @@ nvme-connect-all(1) Manual Page
<div class="verseblock">
<pre class="content"><em>nvme connect-all</em>
[--transport=&lt;trtype&gt; | -t &lt;trtype&gt;]
[--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;]
[--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;]
[--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;]
[--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;]
@ -758,6 +759,7 @@ nvme-connect-all(1) Manual Page
[--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;]
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--raw=&lt;filename&gt; | -r &lt;filename&gt;]
[--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt;]
[--keep-alive-tmo=&lt;#&gt; | -k &lt;#&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
@ -767,9 +769,9 @@ nvme-connect-all(1) Manual Page
[--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;]
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;]
[--matching | -m]
[--persistent | -p]
[--quiet | -S]</pre>
[--quiet | -S]
[--dump-config | -O]</pre>
<div class="attribution">
</div></div>
</div>
@ -781,8 +783,8 @@ nvme-connect-all(1) Manual Page
Controller, and create controllers for the returned discovery records.</p></div>
<div class="paragraph"><p>If no parameters are given, then <em>nvme connect-all</em> will attempt to
find a /etc/nvme/discovery.conf file to use to supply a list of
connect-all commands to run. If no /etc/nvme/discovery.conf file exists,
the command will quit with an error.</p></div>
connect-all commands to run. If no /etc/nvme/discovery.conf file
exists, the command will quit with an error.</p></div>
<div class="paragraph"><p>Otherwise a specific Discovery Controller should be specified using the
--transport, --traddr and if necessary the --trsvcid and a Diѕcovery
request will be sent to the specified Discovery Controller.</p></div>
@ -838,6 +840,17 @@ cellspacing="0" cellpadding="4">
</div>
</dd>
<dt class="hdlist1">
-n &lt;subnqn&gt;
</dt>
<dt class="hdlist1">
--nqn &lt;subnqn&gt;
</dt>
<dd>
<p>
This field specifies the name for the NVMe subsystem to connect to.
</p>
</dd>
<dt class="hdlist1">
-a &lt;traddr&gt;
</dt>
<dt class="hdlist1">
@ -899,8 +912,8 @@ cellspacing="0" cellpadding="4">
<p>
Overrides the default Host NQN that identifies the NVMe Host.
If this option is not specified, the default is read from
/etc/nvme/hostnqn first. If that does not exist, the autogenerated
NQN value from the NVMe Host kernel module is used next.
/etc/nvme/hostnqn first. If that does not exist, the
autogenerated NQN value from the NVMe Host kernel module is used next.
The Host NQN uniquely identifies the NVMe Host, and may be used by the
the Discovery Controller to control what NVMe Target resources are
allocated to the NVMe Host for a connection.
@ -932,6 +945,21 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-C &lt;cfg&gt;
</dt>
<dt class="hdlist1">
--config-file=&lt;cfg&gt;
</dt>
<dd>
<p>
Use the specified JSON configuration file instead of the
default /etc/nvme/config.json file or <em>none</em> to not read in
an existing configuration file. The JSON configuration file
format is documented in
<a href="https://github.com/linux-nvme/libnvme/doc/config-schema.json">https://github.com/linux-nvme/libnvme/doc/config-schema.json</a>
</p>
</dd>
<dt class="hdlist1">
-k &lt;#&gt;
</dt>
<dt class="hdlist1">
@ -1038,19 +1066,6 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-m
</dt>
<dt class="hdlist1">
--matching
</dt>
<dd>
<p>
If a traddr was specified on the command line or in the configuration
file, only create controllers for discovery records that match the
given traddr, rather than for all entries in the discovery log page.
</p>
</dd>
<dt class="hdlist1">
-p
</dt>
<dt class="hdlist1">
@ -1073,6 +1088,17 @@ cellspacing="0" cellpadding="4">
Suppress error messages.
</p>
</dd>
<dt class="hdlist1">
-O
</dt>
<dt class="hdlist1">
--dump-config
</dt>
<dd>
<p>
Print out resulting JSON configuration file to stdout.
</p>
</dd>
</dl></div>
</div>
</div>
@ -1130,7 +1156,7 @@ nvme-connect(1)</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

38
Documentation/nvme-connect-all.txt
View file

@ -10,6 +10,7 @@ SYNOPSIS
[verse]
'nvme connect-all'
[--transport=<trtype> | -t <trtype>]
[--nqn=<subnqn> | -n <subnqn>]
[--traddr=<traddr> | -a <traddr>]
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
@ -17,6 +18,7 @@ SYNOPSIS
[--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
[--cfg-file=<cfg> | -C <cfg>]
[--keep-alive-tmo=<#> | -k <#>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
@ -26,9 +28,9 @@ SYNOPSIS
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>]
[--matching | -m]
[--persistent | -p]
[--quiet | -S]
[--dump-config | -O]
DESCRIPTION
-----------
@ -36,9 +38,9 @@ Send one or more Discovery requests to a NVMe over Fabrics Discovery
Controller, and create controllers for the returned discovery records.
If no parameters are given, then 'nvme connect-all' will attempt to
find a /etc/nvme/discovery.conf file to use to supply a list of
connect-all commands to run. If no /etc/nvme/discovery.conf file exists,
the command will quit with an error.
find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of
connect-all commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file
exists, the command will quit with an error.
Otherwise a specific Discovery Controller should be specified using the
--transport, --traddr and if necessary the --trsvcid and a Diѕcovery
@ -63,6 +65,10 @@ OPTIONS
|loop|Connect to a NVMe over Fabrics target on the local host
|=================
-n <subnqn>::
--nqn <subnqn>::
This field specifies the name for the NVMe subsystem to connect to.
-a <traddr>::
--traddr=<traddr>::
This field specifies the network address of the Discovery Controller.
@ -91,8 +97,8 @@ OPTIONS
--hostnqn=<hostnqn>::
Overrides the default Host NQN that identifies the NVMe Host.
If this option is not specified, the default is read from
/etc/nvme/hostnqn first. If that does not exist, the autogenerated
NQN value from the NVMe Host kernel module is used next.
@SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the
autogenerated NQN value from the NVMe Host kernel module is used next.
The Host NQN uniquely identifies the NVMe Host, and may be used by the
the Discovery Controller to control what NVMe Target resources are
allocated to the NVMe Host for a connection.
@ -108,6 +114,14 @@ OPTIONS
and dump it to a raw binary file. By default 'nvme connect-all' will
dump the output to stdout.
-C <cfg>::
--config-file=<cfg>::
Use the specified JSON configuration file instead of the
default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in
an existing configuration file. The JSON configuration file
format is documented in
https://github.com/linux-nvme/libnvme/doc/config-schema.json
-k <#>::
--keep-alive-tmo=<#>::
Overrides the default keep alive timeout (in seconds). This
@ -151,12 +165,6 @@ OPTIONS
by the driver. This option will be ignored for discovery, but will be
passed on to the subsequent connect call.
-m::
--matching::
If a traddr was specified on the command line or in the configuration
file, only create controllers for discovery records that match the
given traddr, rather than for all entries in the discovery log page.
-p::
--persistent::
Don't remove the discovery controller after retrieving the discovery
@ -166,6 +174,10 @@ OPTIONS
--quiet::
Suppress error messages.
-O::
--dump-config::
Print out resulting JSON configuration file to stdout.
EXAMPLES
--------
@ -178,7 +190,7 @@ the RDMA network. Port 4420 is used by default:
--hostnqn=host1-rogue-nqn
------------
+
* Issue a 'nvme connect-all' command using a /etc/nvme/discovery.conf file:
* Issue a 'nvme connect-all' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+
-----------
# Machine default 'nvme discover' commands. Query the

35
Documentation/nvme-connect.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-connect
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CONNECT" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-CONNECT" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -41,6 +41,9 @@ nvme-connect \- Connect to a Fabrics controller\&.
[\-\-host\-iface=<iface> | \-f <iface>]
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
[\-\-hostid=<hostid> | \-I <hostid>]
[\-\-config\-file=<cfg> | \-J <cfg> ]
[\-\-dhchap\-secret=<secret> | \-S <secret>]
[\-\-dhchap\-ctrl\-secret=<secret> | \-C <secret>]
[\-\-nr\-io\-queues=<#> | \-i <#>]
[\-\-nr\-write\-queues=<#> | \-W <#>]
[\-\-nr\-poll\-queues=<#> | \-P <#>]
@ -52,6 +55,7 @@ nvme-connect \- Connect to a Fabrics controller\&.
[\-\-disable\-sqflow | \-d]
[\-\-hdr\-digest | \-g]
[\-\-data\-digest | \-G]
[\-\-dump\-config | \-O]
[\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
@ -134,6 +138,26 @@ Overrides the default Host NQN that identifies the NVMe Host\&. If this option i
UUID(Universally Unique Identifier) to be discovered which should be formatted\&.
.RE
.PP
\-J <cfg>, \-\-config\-file=<cfg>
.RS 4
Use the specified JSON configuration file instead of the default /etc/nvme/config\&.json file or
\fInone\fR
to not read in an existing configuration file\&. The JSON configuration file format is documented in
\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/doc/config\-schema\&.json\fR\m[]
.RE
.PP
\-S <secret>, \-\-dhchap\-secret=<secret>
.RS 4
NVMe In\-band authentication secret; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8
\fISecret representation\fR\&. If this option is not specified, the default is read from /etc/nvme/hostkey\&. If that does not exist no in\-band authentication is attempted\&.
.RE
.PP
\-C <secret>, \-\-dhchap\-ctrl\-secret=<secret>
.RS 4
NVMe In\-band authentication controller secret for bi\-directional authentication; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8
\fISecret representation\fR\&. If not present bi\-directional authentication is not attempted\&.
.RE
.PP
\-i <#>, \-\-nr\-io\-queues=<#>
.RS 4
Overrides the default number of I/O queues create by the driver\&.
@ -171,7 +195,7 @@ Overrides the default controller loss timeout period (in seconds)\&.
.PP
\-D, \-\-duplicate\-connect
.RS 4
Allows duplicated connections between same trnsport host and subsystem port\&.
Allows duplicated connections between same transport host and subsystem port\&.
.RE
.PP
\-d, \-\-disable\-sqflow
@ -189,6 +213,11 @@ Generates/verifies header digest (TCP)\&.
Generates/verifies data digest (TCP)\&.
.RE
.PP
\-O, \-\-dump\-config
.RS 4
Print out resulting JSON configuration file to stdout\&.
.RE
.PP
\-o <format>, \-\-output\-format=<format>
.RS 4
Set the reporting format to

98
Documentation/nvme-connect.html
View file

@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -755,8 +755,12 @@ nvme-connect(1) Manual Page
[--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;]
[--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;]
[--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;]
[--host-iface=&lt;iface&gt; | -f &lt;iface&gt;]
[--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;]
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--config-file=&lt;cfg&gt; | -J &lt;cfg&gt; ]
[--dhchap-secret=&lt;secret&gt; | -S &lt;secret&gt;]
[--dhchap-ctrl-secret=&lt;secret&gt; | -C &lt;secret&gt;]
[--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;]
[--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;]
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
@ -767,7 +771,9 @@ nvme-connect(1) Manual Page
[--duplicate-connect | -D]
[--disable-sqflow | -d]
[--hdr-digest | -g]
[--data-digest | -G]</pre>
[--data-digest | -G]
[--dump-config | -O]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
<div class="attribution">
</div></div>
</div>
@ -873,7 +879,21 @@ cellspacing="0" cellpadding="4">
<dd>
<p>
This field specifies the network address used on the host to connect
to the Controller.
to the Controller. For TCP, this sets the source address on the socket.
</p>
</dd>
<dt class="hdlist1">
-f &lt;iface&gt;
</dt>
<dt class="hdlist1">
--host-iface=&lt;iface&gt;
</dt>
<dd>
<p>
This field specifies the network interface used on the host to connect
to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces
the connection to be made on a specific interface instead of letting
the system decide.
</p>
</dd>
<dt class="hdlist1">
@ -904,6 +924,50 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-J &lt;cfg&gt;
</dt>
<dt class="hdlist1">
--config-file=&lt;cfg&gt;
</dt>
<dd>
<p>
Use the specified JSON configuration file instead of the
default /etc/nvme/config.json file or <em>none</em> to not read in
an existing configuration file. The JSON configuration file
format is documented in
<a href="https://github.com/linux-nvme/libnvme/doc/config-schema.json">https://github.com/linux-nvme/libnvme/doc/config-schema.json</a>
</p>
</dd>
<dt class="hdlist1">
-S &lt;secret&gt;
</dt>
<dt class="hdlist1">
--dhchap-secret=&lt;secret&gt;
</dt>
<dd>
<p>
NVMe In-band authentication secret; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 <em>Secret representation</em>.
If this option is not specified, the default is read from
/etc/nvme/hostkey. If that does not exist no in-band authentication
is attempted.
</p>
</dd>
<dt class="hdlist1">
-C &lt;secret&gt;
</dt>
<dt class="hdlist1">
--dhchap-ctrl-secret=&lt;secret&gt;
</dt>
<dd>
<p>
NVMe In-band authentication controller secret for bi-directional
authentication; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 <em>Secret representation</em>.
If not present bi-directional authentication is not attempted.
</p>
</dd>
<dt class="hdlist1">
-i &lt;#&gt;
</dt>
<dt class="hdlist1">
@ -990,7 +1054,7 @@ cellspacing="0" cellpadding="4">
</dt>
<dd>
<p>
Allows duplicated connections between same trnsport host and subsystem
Allows duplicated connections between same transport host and subsystem
port.
</p>
</dd>
@ -1028,6 +1092,30 @@ cellspacing="0" cellpadding="4">
Generates/verifies data digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-O
</dt>
<dt class="hdlist1">
--dump-config
</dt>
<dd>
<p>
Print out resulting JSON configuration file to stdout.
</p>
</dd>
<dt class="hdlist1">
-o &lt;format&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;format&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em> or <em>json</em>. Only one output format can
be used at a time. When this option is specified, the device associated with
the connection will be printed. Nothing is printed otherwise.
</p>
</dd>
</dl></div>
</div>
</div>
@ -1074,7 +1162,7 @@ and <a href="mailto:hch@lst.de">Christoph Hellwig</a></p></div>
<div id="footer">
<div id="footer-text">
Last updated
2020-07-14 17:50:40 -03
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

35
Documentation/nvme-connect.txt
View file

@ -17,6 +17,9 @@ SYNOPSIS
[--host-iface=<iface> | -f <iface>]
[--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostid=<hostid> | -I <hostid>]
[--config-file=<cfg> | -J <cfg> ]
[--dhchap-secret=<secret> | -S <secret>]
[--dhchap-ctrl-secret=<secret> | -C <secret>]
[--nr-io-queues=<#> | -i <#>]
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
@ -28,6 +31,7 @@ SYNOPSIS
[--disable-sqflow | -d]
[--hdr-digest | -g]
[--data-digest | -G]
[--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
DESCRIPTION
@ -84,7 +88,7 @@ OPTIONS
--hostnqn=<hostnqn>::
Overrides the default Host NQN that identifies the NVMe Host.
If this option is not specified, the default is read from
/etc/nvme/hostnqn first. If that does not exist, the autogenerated
@SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the autogenerated
NQN value from the NVMe Host kernel module is used next.
The Host NQN uniquely identifies the NVMe Host.
@ -93,6 +97,29 @@ OPTIONS
UUID(Universally Unique Identifier) to be discovered which should be
formatted.
-J <cfg>::
--config-file=<cfg>::
Use the specified JSON configuration file instead of the
default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in
an existing configuration file. The JSON configuration file
format is documented in
https://github.com/linux-nvme/libnvme/doc/config-schema.json
-S <secret>::
--dhchap-secret=<secret>::
NVMe In-band authentication secret; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 'Secret representation'.
If this option is not specified, the default is read from
@SYSCONFDIR@/nvme/hostkey. If that does not exist no in-band authentication
is attempted.
-C <secret>::
--dhchap-ctrl-secret=<secret>::
NVMe In-band authentication controller secret for bi-directional
authentication; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 'Secret representation'.
If not present bi-directional authentication is not attempted.
-i <#>::
--nr-io-queues=<#>::
Overrides the default number of I/O queues create by the driver.
@ -125,7 +152,7 @@ OPTIONS
-D::
--duplicate-connect::
Allows duplicated connections between same trnsport host and subsystem
Allows duplicated connections between same transport host and subsystem
port.
-d::
@ -141,6 +168,10 @@ OPTIONS
--data-digest::
Generates/verifies data digest (TCP).
-O::
--dump-config::
Print out resulting JSON configuration file to stdout.
-o <format>::
--output-format=<format>::
Set the reporting format to 'normal' or 'json'. Only one output format can

4
Documentation/nvme-copy.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-copy
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-COPY" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-COPY" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-copy.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-copy(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -982,7 +982,7 @@ logical block ranges to a single consecutive destination logical block range.</p
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

10
Documentation/nvme-create-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-create-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CREATE\-NS" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-CREATE\-NS" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -40,6 +40,7 @@ nvme-create-ns \- Send NVMe Namespace management command to create namespace, re
[\-\-anagrp\-id=<anagrpid> | \-a <anagrpid>]
[\-\-nvmset\-id=<nvmsetid> | \-i <nvmsetid>]
[\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
[\-\-lbstm=<lbstm> | \-l <lbstm>]
[\-\-block\-size=<block\-size> | \-b <block\-size>]
[\-\-timeout=<timeout> | \-t <timeout>]
DESCRIPTION
@ -96,6 +97,11 @@ This field specifies the identifier of the NVM Set\&.
This field specifies the identifier of command set\&. if not issued, NVM Command Set will be selected\&.
.RE
.PP
\-l <lbstm>, \-\-lbstm=<lbstm>
.RS 4
Logical Block Storage Tag Mask for end\-to\-end protection\&.
.RE
.PP
\-b, \-\-block\-size
.RS 4
Target block size the new namespace should be formatted as\&. Potential FLBAS values will be values will be scanned and the lowest numbered will be selected for the create\-ns operation\&. Conflicts with \-\-flbas argument\&.

18
Documentation/nvme-create-ns.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-create-ns(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -757,6 +757,7 @@ nvme-create-ns(1) Manual Page
[--anagrp-id=&lt;anagrpid&gt; | -a &lt;anagrpid&gt;]
[--nvmset-id=&lt;nvmsetid&gt; | -i &lt;nvmsetid&gt;]
[--csi=&lt;command_set_identifier&gt; | -y &lt;command_set_identifier&gt;]
[--lbstm=&lt;lbstm&gt; | -l &lt;lbstm&gt;]
[--block-size=&lt;block-size&gt; | -b &lt;block-size&gt;]
[--timeout=&lt;timeout&gt; | -t &lt;timeout&gt;]
DESCRIPTION</pre>
@ -866,6 +867,17 @@ OPTIONS</code></pre>
</p>
</dd>
<dt class="hdlist1">
-l &lt;lbstm&gt;
</dt>
<dt class="hdlist1">
--lbstm=&lt;lbstm&gt;
</dt>
<dd>
<p>
Logical Block Storage Tag Mask for end-to-end protection.
</p>
</dd>
<dt class="hdlist1">
-b
</dt>
<dt class="hdlist1">
@ -898,7 +910,7 @@ OPTIONS</code></pre>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

5
Documentation/nvme-create-ns.txt
View file

@ -16,6 +16,7 @@ SYNOPSIS
[--anagrp-id=<anagrpid> | -a <anagrpid>]
[--nvmset-id=<nvmsetid> | -i <nvmsetid>]
[--csi=<command_set_identifier> | -y <command_set_identifier>]
[--lbstm=<lbstm> | -l <lbstm>]
[--block-size=<block-size> | -b <block-size>]
[--timeout=<timeout> | -t <timeout>]
DESCRIPTION
@ -64,6 +65,10 @@ OPTIONS
This field specifies the identifier of command set.
if not issued, NVM Command Set will be selected.
-l <lbstm>::
--lbstm=<lbstm>::
Logical Block Storage Tag Mask for end-to-end protection.
-b::
--block-size::
Target block size the new namespace should be formatted as. Potential FLBAS

4
Documentation/nvme-delete-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ID\-NS" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-ID\-NS" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-delete-ns.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-id-ns(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -799,7 +799,7 @@ The <code>'--namespace-id'</code> option is mandatory.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-dera-stat.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dera-stat
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DERA\-STAT" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DERA\-STAT" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-dera-stat.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-dera-stat(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -797,7 +797,7 @@ Print the Dera Device status and Additional SMART log page in a human readable f
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-detach-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-detach-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DETACH\-NS" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DETACH\-NS" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-detach-ns.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-detach-ns(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -810,7 +810,7 @@ controller identifiers.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-device-self-test.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-device-self-test
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DEVICE\-SELF\-" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DEVICE\-SELF\-" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-device-self-test.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-device-self-test(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -833,7 +833,7 @@ Abort the device self-test operation in the namespace-id 1:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

113
Documentation/nvme-dim.1 Normal file
View file

@ -0,0 +1,113 @@
'\" t
.\" Title: nvme-dim
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DIM" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-dim \- Send Discovery Information Management command to one or more Discovery Controllers\&.
.SH "SYNOPSIS"
.sp
.nf
\fInvme dim\fR
[\-\-task=<task> | \-t <task>]
[\-\-nqn=<nqn> | \-n <nqn>]
[\-\-device=<device> | \-d <device>]
.fi
.SH "DESCRIPTION"
.sp
Send Discovery Information Management (DIM) command to one or more Discovery Controllers\&. The DIM command allows performing two types of tasks: register or deregister\&.
.sp
The DIM command is used to explicitly register with Discovery Controllers (DC), especially with Central Discovery Controllers (CDC)\&. CDCs maintain a database (DB) of all the Hosts and Storage Susbsystems in a network\&. The register task is used to add a host to the CDC\(cqs DB\&. The deregister task is used to remove a host from the CDC\(cqs DB\&.
.sp
During a register operation the host will send mandatory information such as the Host\(cqs NQN and ID, as well as the Host\(cqs hostname and the Operating System\(cqs version that it is running on\&. There is also an optional Host Symbolic Name that can be registered with the CDC\&.
.sp
This command can only be applied to existing DC connections previously created with the nvme\-discover(1) command using the \-\-persistent option\&.
.SH "OPTIONS"
.PP
\-t <task>, \-\-task <task>
.RS 4
The task to perform: "register" or "deregister"\&.
.RE
.PP
\-n <subnqn>, \-\-nqn <nqn>
.RS 4
The DIM command will be sent to the Discovery Controller (DC) matching this NQN\&. A list of comma\-separated NQNs can be supplied to apply the command to more than one DC\&.
.RE
.PP
\-d <device>, \-\-device <device>
.RS 4
The DIM command will be sent to the Discovery Controllers (DC) associated with this NVMe device handle\&. A list of comma\-separated device handles can be supplied to apply the command to more than one DC\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Register with the Central Discovery Controller (CDC) named nqn\&.1988\-11\&.com\&.dell:SFSS:1:20220118125153e8:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme dim \-\-task=register \-\-nqn=nqn\&.1988\-11\&.com\&.dell:SFSS:1:20220118125153e8
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Deregister from Central Discovery Controller (CDC) associated with nvme4
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme dim \-\-task=deregister \-\-device=nvme4
.fi
.if n \{\
.RE
.\}
.RE
.SH "SEE ALSO"
.sp
nvme\-discover(1)
.SH "NVME"
.sp
Part of the nvme\-user suite

115
Documentation/nvme-lnvm-diag-set-bbtbl.html → Documentation/nvme-dim.html
View file

@ -4,8 +4,8 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<title>nvme-lnvm-diag-set-bbtbl(1)</title>
<meta name="generator" content="AsciiDoc" />
<title>nvme-dim(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -735,12 +735,12 @@ asciidoc.install();
<body class="manpage">
<div id="header">
<h1>
nvme-lnvm-diag-set-bbtbl(1) Manual Page
nvme-dim(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>nvme-lnvm-diag-set-bbtbl -
Set a block state in the bad block table
<p>nvme-dim -
Send Discovery Information Management command to one or more Discovery Controllers.
</p>
</div>
</div>
@ -749,12 +749,10 @@ nvme-lnvm-diag-set-bbtbl(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme lnvm-diag-set-bbtbl</em> [--namespace-id=&lt;NUM&gt; | -n &lt;NUM&gt;]
[--channel-id=&lt;CHID&gt; | -c &lt;CHID&gt;]
[--lun-id=&lt;LUNID&gt; | -l &lt;LUNID&gt;]
[--plane-id=&lt;PLANEID&gt; | -p &lt;PLANEID&gt;]
[--block-id=&lt;BLKID&gt; | -b &lt;BLKID&gt;]
[--value=&lt;NUM&gt; | -v &lt;NUM&gt;]</pre>
<pre class="content"><em>nvme dim</em>
[--task=&lt;task&gt; | -t &lt;task&gt;]
[--nqn=&lt;nqn&gt; | -n &lt;nqn&gt;]
[--device=&lt;device&gt; | -d &lt;device&gt;]</pre>
<div class="attribution">
</div></div>
</div>
@ -762,14 +760,20 @@ nvme-lnvm-diag-set-bbtbl(1) Manual Page
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Set the bad block table for a given channel, lun, plane and block with value v.</p></div>
<div class="paragraph"><p>For each block available, the status byte is read as follows:</p></div>
<div class="paragraph"><p>0: Good block
1: Bad block
2: Grown bad block
4: Device reserved block
8: Host-side reserved block
16: Media managed reserved block</p></div>
<div class="paragraph"><p>Send Discovery Information Management (DIM) command to one or more Discovery
Controllers. The DIM command allows performing two types of tasks: register or
deregister.</p></div>
<div class="paragraph"><p>The DIM command is used to explicitly register with Discovery Controllers (DC),
especially with Central Discovery Controllers (CDC). CDCs maintain a database (DB)
of all the Hosts and Storage Susbsystems in a network. The register task is used
to add a host to the CDC&#8217;s DB. The deregister task is used to remove a host from
the CDC&#8217;s DB.</p></div>
<div class="paragraph"><p>During a register operation the host will send mandatory information such as the
Host&#8217;s NQN and ID, as well as the Host&#8217;s hostname and the Operating System&#8217;s
version that it is running on. There is also an optional Host Symbolic Name
that can be registered with the CDC.</p></div>
<div class="paragraph"><p>This command can only be applied to existing DC connections previously created
with the nvme-discover(1) command using the --persistent option.</p></div>
</div>
</div>
<div class="sect1">
@ -777,58 +781,40 @@ nvme-lnvm-diag-set-bbtbl(1) Manual Page
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--namespace-id=&lt;NUM&gt;
-t &lt;task&gt;
</dt>
<dt class="hdlist1">
-n &lt;NUM&gt;
--task &lt;task&gt;
</dt>
<dd>
<p>
Namespace id to use
The task to perform: "register" or "deregister".
</p>
</dd>
<dt class="hdlist1">
--channel-id
-n &lt;subnqn&gt;
</dt>
<dt class="hdlist1">
-c
--nqn &lt;nqn&gt;
</dt>
<dd>
<p>
Channel id
The DIM command will be sent to the Discovery Controller (DC) matching this
NQN. A list of comma-separated NQNs can be supplied to apply the command to
more than one DC.
</p>
</dd>
<dt class="hdlist1">
--lun-id
-d &lt;device&gt;
</dt>
<dt class="hdlist1">
-l
--device &lt;device&gt;
</dt>
<dd>
<p>
LUN id
</p>
</dd>
<dt class="hdlist1">
--plane-id
</dt>
<dt class="hdlist1">
-p
</dt>
<dd>
<p>
Plane id
</p>
</dd>
<dt class="hdlist1">
--block-id
</dt>
<dt class="hdlist1">
-b
</dt>
<dd>
<p>
Block id
The DIM command will be sent to the Discovery Controllers (DC) associated
with this NVMe device handle. A list of comma-separated device handles can
be supplied to apply the command to more than one DC.
</p>
</dd>
</dl></div>
@ -840,15 +826,30 @@ nvme-lnvm-diag-set-bbtbl(1) Manual Page
<div class="ulist"><ul>
<li>
<p>
Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad)
on physical device /dev/nvme0
Register with the Central Discovery Controller (CDC) named
nqn.1988-11.com.dell:SFSS:1:20220118125153e8:
</p>
</li>
</ul></div>
<div class="listingblock">
<div class="content">
<pre><code># nvme lnvm-diag-set-bbtbl /dev/nvme0 -c 0 -l 0 -p 0 -b 10 -v 2</code></pre>
<pre><code># nvme dim --task=register --nqn=nqn.1988-11.com.dell:SFSS:1:20220118125153e8</code></pre>
</div></div>
</li>
<li>
<p>
Deregister from Central Discovery Controller (CDC) associated with nvme4
</p>
<div class="listingblock">
<div class="content">
<pre><code># nvme dim --task=deregister --device=nvme4</code></pre>
</div></div>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph"><p>nvme-discover(1)</p></div>
</div>
</div>
<div class="sect1">
@ -862,7 +863,7 @@ Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad)
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

75
Documentation/nvme-dim.txt Normal file
View file

@ -0,0 +1,75 @@
nvme-dim(1)
===========
NAME
----
nvme-dim - Send Discovery Information Management command to one or more Discovery Controllers.
SYNOPSIS
--------
[verse]
'nvme dim'
[--task=<task> | -t <task>]
[--nqn=<nqn> | -n <nqn>]
[--device=<device> | -d <device>]
DESCRIPTION
-----------
Send Discovery Information Management (DIM) command to one or more Discovery
Controllers. The DIM command allows performing two types of tasks: register or
deregister.
The DIM command is used to explicitly register with Discovery Controllers (DC),
especially with Central Discovery Controllers (CDC). CDCs maintain a database (DB)
of all the Hosts and Storage Susbsystems in a network. The register task is used
to add a host to the CDC's DB. The deregister task is used to remove a host from
the CDC's DB.
During a register operation the host will send mandatory information such as the
Host's NQN and ID, as well as the Host's hostname and the Operating System's
version that it is running on. There is also an optional Host Symbolic Name
that can be registered with the CDC.
This command can only be applied to existing DC connections previously created
with the nvme-discover(1) command using the --persistent option.
OPTIONS
-------
-t <task>::
--task <task>::
The task to perform: "register" or "deregister".
-n <subnqn>::
--nqn <nqn>::
The DIM command will be sent to the Discovery Controller (DC) matching this
NQN. A list of comma-separated NQNs can be supplied to apply the command to
more than one DC.
-d <device>::
--device <device>::
The DIM command will be sent to the Discovery Controllers (DC) associated
with this NVMe device handle. A list of comma-separated device handles can
be supplied to apply the command to more than one DC.
EXAMPLES
--------
* Register with the Central Discovery Controller (CDC) named
nqn.1988-11.com.dell:SFSS:1:20220118125153e8:
+
------------
# nvme dim --task=register --nqn=nqn.1988-11.com.dell:SFSS:1:20220118125153e8
------------
* Deregister from Central Discovery Controller (CDC) associated with nvme4
+
------------
# nvme dim --task=deregister --device=nvme4
------------
SEE ALSO
--------
nvme-discover(1)
NVME
----
Part of the nvme-user suite

4
Documentation/nvme-dir-receive.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dir-receive
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DIR\-RECEIVE" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DIR\-RECEIVE" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-dir-receive.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-dir-receive(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -969,7 +969,7 @@ Get streams directive status :
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-dir-send.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dir-send
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DIR\-SEND" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DIR\-SEND" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-dir-send.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-dir-send(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -982,7 +982,7 @@ Release stream ID 3 :
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-disconnect-all.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-disconnect-all
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DISCONNECT\-AL" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DISCONNECT\-AL" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-disconnect-all.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-disconnect-all(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -795,7 +795,7 @@ Disconnect all existing nvme controllers:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-disconnect.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-disconnect
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DISCONNECT" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DISCONNECT" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-disconnect.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-disconnect(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -839,7 +839,7 @@ Disconnect the controller nvme4
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

31
Documentation/nvme-discover.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-discover
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DISCOVER" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DISCOVER" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -34,6 +34,7 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
.nf
\fInvme discover\fR
[\-\-transport=<trtype> | \-t <trtype>]
[\-\-nqn=<subnqn> | \-n <subnqn>]
[\-\-traddr=<traddr> | \-a <traddr>]
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
[\-\-host\-traddr=<traddr> | \-w <traddr>]
@ -42,6 +43,7 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
[\-\-hostid=<hostid> | \-I <hostid>]
[\-\-raw=<filename> | \-r <filename>]
[\-\-device=<device> | \-d <device>]
[\-\-cfg\-file=<cfg> | \-C <cfg> ]
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
@ -53,7 +55,9 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
[\-\-queue\-size=<#> | \-Q <#>]
[\-\-persistent | \-p]
[\-\-quiet | \-S]
[\-\-dump\-config | \-O]
[\-\-output\-format=<fmt> | \-o <fmt>]
[\-\-force]
.fi
.SH "DESCRIPTION"
.sp
@ -111,6 +115,11 @@ T}
.sp 1
.RE
.PP
\-n <subnqn>, \-\-nqn <subnqn>
.RS 4
This field specifies the name for the NVMe subsystem to connect to\&.
.RE
.PP
\-a <traddr>, \-\-traddr=<traddr>
.RS 4
This field specifies the network address of the Discovery Controller\&. For transports using IP addressing (e\&.g\&. rdma) this should be an IP\-based (ex\&. IPv4) address\&.
@ -155,6 +164,14 @@ will dump the output to stdout\&.
This field takes a device as input\&. Device is in the format of nvme*, eg\&. nvme0, nvme1
.RE
.PP
\-C <cfg>, \-\-config\-file=<cfg>
.RS 4
Use the specified JSON configuration file instead of the default /etc/nvme/config\&.json file or
\fInone\fR
to not read in an existing configuration file\&. The JSON configuration file format is documented in
\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/doc/config\-schema\&.json\fR\m[]
.RE
.PP
\-k <#>, \-\-keep\-alive\-tmo=<#>
.RS 4
Overrides the default dealy (in seconds) for keep alive\&. This option will be ignored for the discovery, and it is only implemented for completeness\&.
@ -210,6 +227,11 @@ Persistent discovery connection\&.
Suppress already connected errors\&.
.RE
.PP
\-O, \-\-dump\-config
.RS 4
Print out resulting JSON configuration file to stdout\&.
.RE
.PP
\-o <format>, \-\-output\-format=<format>
.RS 4
Set the reporting format to
@ -217,6 +239,11 @@ Set the reporting format to
\fIjson\fR, or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-\-force
.RS 4
Disable the built\-in persitent discover connection rules\&. Combined with \-\-persistent flag, always create new persistent discovery connection\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4

63
Documentation/nvme-discover.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-discover(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -751,6 +751,7 @@ nvme-discover(1) Manual Page
<div class="verseblock">
<pre class="content"><em>nvme discover</em>
[--transport=&lt;trtype&gt; | -t &lt;trtype&gt;]
[--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;]
[--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;]
[--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;]
[--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;]
@ -759,6 +760,7 @@ nvme-discover(1) Manual Page
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--raw=&lt;filename&gt; | -r &lt;filename&gt;]
[--device=&lt;device&gt; | -d &lt;device&gt;]
[--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt; ]
[--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
@ -770,7 +772,9 @@ nvme-discover(1) Manual Page
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;]
[--persistent | -p]
[--quiet | -S]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
[--dump-config | -O]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]
[--force]</pre>
<div class="attribution">
</div></div>
</div>
@ -861,6 +865,17 @@ cellspacing="0" cellpadding="4">
</div>
</dd>
<dt class="hdlist1">
-n &lt;subnqn&gt;
</dt>
<dt class="hdlist1">
--nqn &lt;subnqn&gt;
</dt>
<dd>
<p>
This field specifies the name for the NVMe subsystem to connect to.
</p>
</dd>
<dt class="hdlist1">
-a &lt;traddr&gt;
</dt>
<dt class="hdlist1">
@ -922,8 +937,8 @@ cellspacing="0" cellpadding="4">
<p>
Overrides the default host NQN that identifies the NVMe Host.
If this option is not specified, the default is read from
/etc/nvme/hostnqn first. If that does not exist, the autogenerated
NQN value from the NVMe Host kernel module is used next.
/etc/nvme/hostnqn first. If that does not exist, the
autogenerated NQN value from the NVMe Host kernel module is used next.
</p>
</dd>
<dt class="hdlist1">
@ -964,6 +979,21 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-C &lt;cfg&gt;
</dt>
<dt class="hdlist1">
--config-file=&lt;cfg&gt;
</dt>
<dd>
<p>
Use the specified JSON configuration file instead of the
default /etc/nvme/config.json file or <em>none</em> to not read in
an existing configuration file. The JSON configuration file
format is documented in
<a href="https://github.com/linux-nvme/libnvme/doc/config-schema.json">https://github.com/linux-nvme/libnvme/doc/config-schema.json</a>
</p>
</dd>
<dt class="hdlist1">
-k &lt;#&gt;
</dt>
<dt class="hdlist1">
@ -1093,6 +1123,17 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-O
</dt>
<dt class="hdlist1">
--dump-config
</dt>
<dd>
<p>
Print out resulting JSON configuration file to stdout.
</p>
</dd>
<dt class="hdlist1">
-o &lt;format&gt;
</dt>
<dt class="hdlist1">
@ -1104,6 +1145,16 @@ cellspacing="0" cellpadding="4">
<em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
--force
</dt>
<dd>
<p>
Disable the built-in persitent discover connection rules.
Combined with --persistent flag, always create new
persistent discovery connection.
</p>
</dd>
</dl></div>
</div>
</div>
@ -1167,7 +1218,7 @@ nvme-connect-all(1)</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

35
Documentation/nvme-discover.txt
View file

@ -10,6 +10,7 @@ SYNOPSIS
[verse]
'nvme discover'
[--transport=<trtype> | -t <trtype>]
[--nqn=<subnqn> | -n <subnqn>]
[--traddr=<traddr> | -a <traddr>]
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
@ -18,6 +19,7 @@ SYNOPSIS
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
[--device=<device> | -d <device>]
[--cfg-file=<cfg> | -C <cfg> ]
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
@ -29,7 +31,9 @@ SYNOPSIS
[--queue-size=<#> | -Q <#>]
[--persistent | -p]
[--quiet | -S]
[--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
[--force]
DESCRIPTION
-----------
@ -37,8 +41,8 @@ Send one or more Get Log Page requests to a NVMe-over-Fabrics Discovery
Controller.
If no parameters are given, then 'nvme discover' will attempt to
find a /etc/nvme/discovery.conf file to use to supply a list of
Discovery commands to run. If no /etc/nvme/discovery.conf file
find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of
Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file
exists, the command will quit with an error.
Otherwise, a specific Discovery Controller should be specified using the
@ -85,6 +89,10 @@ OPTIONS
|loop|Connect to a NVMe over Fabrics target on the local host
|=================
-n <subnqn>::
--nqn <subnqn>::
This field specifies the name for the NVMe subsystem to connect to.
-a <traddr>::
--traddr=<traddr>::
This field specifies the network address of the Discovery Controller.
@ -113,8 +121,8 @@ OPTIONS
--hostnqn=<hostnqn>::
Overrides the default host NQN that identifies the NVMe Host.
If this option is not specified, the default is read from
/etc/nvme/hostnqn first. If that does not exist, the autogenerated
NQN value from the NVMe Host kernel module is used next.
@SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the
autogenerated NQN value from the NVMe Host kernel module is used next.
-I <hostid>::
--hostid=<hostid>::
@ -132,6 +140,14 @@ OPTIONS
This field takes a device as input. Device is in the format of nvme*,
eg. nvme0, nvme1
-C <cfg>::
--config-file=<cfg>::
Use the specified JSON configuration file instead of the
default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in
an existing configuration file. The JSON configuration file
format is documented in
https://github.com/linux-nvme/libnvme/doc/config-schema.json
-k <#>::
--keep-alive-tmo=<#>::
Overrides the default dealy (in seconds) for keep alive.
@ -184,11 +200,20 @@ OPTIONS
--quiet::
Suppress already connected errors.
-O::
--dump-config::
Print out resulting JSON configuration file to stdout.
-o <format>::
--output-format=<format>::
Set the reporting format to 'normal', 'json', or
'binary'. Only one output format can be used at a time.
--force::
Disable the built-in persitent discover connection rules.
Combined with --persistent flag, always create new
persistent discovery connection.
EXAMPLES
--------
* Query the Discover Controller with IP4 address 192.168.1.3 for all
@ -200,7 +225,7 @@ Port 4420 is used by default:
--hostnqn=host1-rogue-nqn
------------
+
* Issue a 'nvme discover' command using a /etc/nvme/discovery.conf file:
* Issue a 'nvme discover' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+
-----------
# Machine default 'nvme discover' commands. Query the

4
Documentation/nvme-dsm.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dsm
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DSM" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DSM" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-dsm.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-dsm(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -893,7 +893,7 @@ any settings from the flags may have provided.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-effects-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-effects-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-EFFECTS\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-EFFECTS\-LOG" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-effects-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-effects-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -847,7 +847,7 @@ Have the program return the raw structure in binary:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-endurance-event-agg-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-endurance-event-agg-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ENDURANCE\-EVE" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-ENDURANCE\-EVE" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-endurance-event-agg-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-endurance-event-agg-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -851,7 +851,7 @@ Print the raw Endurance log to a file:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-endurance-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-endurance-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ENDURANCE\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-ENDURANCE\-LOG" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-endurance-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-endurance-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -834,7 +834,7 @@ Print the raw Endurance log to a file:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-error-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-error-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ERROR\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-ERROR\-LOG" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-error-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-error-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -849,7 +849,7 @@ Print the raw output to a file:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-fid-support-effects-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fid-support-effects-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FID\-SUPPORT\-" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-FID\-SUPPORT\-" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-fid-support-effects-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-fid-support-effects-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -814,7 +814,7 @@ raw buffer may be printed to stdout.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-08-26 10:36:30 IST
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-flush.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-flush
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FLUSH" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-FLUSH" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-flush.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-flush(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -800,7 +800,7 @@ any namespace.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

8
Documentation/nvme-format.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-format
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FORMAT" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-FORMAT" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -40,7 +40,7 @@ nvme-format \- Format an NVMe device
[\-\-pi=<pi> | \-i <pi>]
[\-\-ms=<ms> | \-m <ms>]
[\-\-reset | \-r ]
[\-\-force | \-f ]
[\-\-force ]
[\-\-timeout=<timeout> | \-t <timeout> ]
.fi
.SH "DESCRIPTION"
@ -168,7 +168,7 @@ Metadata Settings: This field is set to \(oq1\(cq if the metadata is transferred
Issue a reset after successful format\&. Must use the character device for this\&.
.RE
.PP
\-f, \-\-force
\-\-force
.RS 4
Just send the command immediately without warning of the implications\&.
.RE

11
Documentation/nvme-format.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-format(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -757,7 +757,7 @@ nvme-format(1) Manual Page
[--pi=&lt;pi&gt; | -i &lt;pi&gt;]
[--ms=&lt;ms&gt; | -m &lt;ms&gt;]
[--reset | -r ]
[--force | -f ]
[--force ]
[--timeout=&lt;timeout&gt; | -t &lt;timeout&gt; ]</pre>
<div class="attribution">
</div></div>
@ -977,9 +977,6 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-f
</dt>
<dt class="hdlist1">
--force
</dt>
<dd>
@ -1038,7 +1035,7 @@ information:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

3
Documentation/nvme-format.txt
View file

@ -16,7 +16,7 @@ SYNOPSIS
[--pi=<pi> | -i <pi>]
[--ms=<ms> | -m <ms>]
[--reset | -r ]
[--force | -f ]
[--force ]
[--timeout=<timeout> | -t <timeout> ]
DESCRIPTION
@ -128,7 +128,6 @@ cryptographically. This is accomplished by deleting the encryption key.
Issue a reset after successful format. Must use the character
device for this.
-f::
--force::
Just send the command immediately without warning of the implications.

4
Documentation/nvme-fw-commit.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fw-commit
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FW\-COMMIT" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-FW\-COMMIT" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-fw-commit.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-fw-commit(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -905,7 +905,7 @@ commit the last downloaded fw to slot 1.
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-fw-download.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fw-download
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FW\-DOWNLOAD" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-FW\-DOWNLOAD" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-fw-download.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-fw-download(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -852,7 +852,7 @@ Transfer a firmware size 128KiB at a time:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-fw-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fw-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FW\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-FW\-LOG" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-fw-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-fw-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -835,7 +835,7 @@ Print the log firmware to a file:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

69
Documentation/nvme-gen-dhchap-key.1 Normal file
View file

@ -0,0 +1,69 @@
'\" t
.\" Title: nvme-gen-dhchap-key
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 11/25/2021
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GEN\-DHCHAP\-K" "1" "11/25/2021" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-gen-dhchap-key \- Generate a host DH\-HMAC\-CHAP key
.SH "SYNOPSIS"
.sp
.nf
\fInvme gen\-dhchap\-key\fR [\-\-hmac=<hmac\-id> | \-h <hmac\-id>]
[\-\-secret=<secret> | \-s <secret> ]
[\-\-key\-length=<len> | \-l <len> ]
[\-\-nqn=<host\-nqn> | \-n <host\-nqn> ]
.fi
.SH "DESCRIPTION"
.sp
Generate a base64\-encoded DH\-HMAC\-CHAP host key in the form: DHHC\-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: and prints it to stdout\&.
.SH "OPTIONS"
.PP
\-h <hmac\-id>, \-\-hmac=<hmac\-id>
.RS 4
Select a HMAC algorithm to use\&. Possible values are: 0 \- No HMAC algorithm 1 \- SHA\-256 2 \- SHA\-384 3 \- SHA\-512
.RE
.PP
\-s <secret>, \-\-secret=<secret>
.RS 4
Secret value (in hexadecimal) to be used for the key\&. If none are provided a random value is used\&.
.RE
.PP
\-l <len>, \-\-key\-length=<len>
.RS 4
Length of the resulting key\&. Possible values are 32, 48, or 64\&.
.RE
.PP
\-n <hostnqn>, \-\-nqn=<hostnqn>
.RS 4
Host\-NQN to be used for the transformation\&. This parameter is only valid if a non\-zero HMAC function has been specified\&.
.RE
.SH "EXAMPLES"
.sp
No Examples
.SH "NVME"
.sp
Part of the nvme\-user suite

842
Documentation/nvme-gen-dhchap-key.html Normal file
View file

@ -0,0 +1,842 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.8" />
<title>nvme-gen-dhchap-key(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
.monospaced, code, pre {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
padding: 0;
margin: 0;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = { // Namespace.
/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////
/* Author: Mihai Bazon, September 2002
* http://students.infoiasi.ro/~mishoo
*
* Table Of Content generator
* Version: 0.4
*
* Feel free to use this script under the terms of the GNU General Public
* License, as long as you do not remove or alter this notice.
*/
/* modified by Troy D. Hanson, September 2006. License: GPL */
/* modified by Stuart Rackham, 2006, 2009. License: GPL */
// toclevels = 1..4.
toc: function (toclevels) {
function getText(el) {
var text = "";
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
text += i.data;
else if (i.firstChild != null)
text += getText(i);
}
return text;
}
function TocEntry(el, text, toclevel) {
this.element = el;
this.text = text;
this.toclevel = toclevel;
}
function tocEntries(el, toclevels) {
var result = new Array;
var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="manpage">
<div id="header">
<h1>
nvme-gen-dhchap-key(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>nvme-gen-dhchap-key -
Generate a host DH-HMAC-CHAP key
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme gen-dhchap-key</em> [--hmac=&lt;hmac-id&gt; | -h &lt;hmac-id&gt;]
[--secret=&lt;secret&gt; | -s &lt;secret&gt; ]
[--key-length=&lt;len&gt; | -l &lt;len&gt; ]
[--nqn=&lt;host-nqn&gt; | -n &lt;host-nqn&gt; ]</pre>
<div class="attribution">
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Generate a base64-encoded DH-HMAC-CHAP host key in the form:
DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:
and prints it to stdout.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
-h &lt;hmac-id&gt;
</dt>
<dt class="hdlist1">
--hmac=&lt;hmac-id&gt;
</dt>
<dd>
<p>
Select a HMAC algorithm to use. Possible values are:
0 - No HMAC algorithm
1 - SHA-256
2 - SHA-384
3 - SHA-512
</p>
</dd>
<dt class="hdlist1">
-s &lt;secret&gt;
</dt>
<dt class="hdlist1">
--secret=&lt;secret&gt;
</dt>
<dd>
<p>
Secret value (in hexadecimal) to be used for the key. If none are
provided a random value is used.
</p>
</dd>
<dt class="hdlist1">
-l &lt;len&gt;
</dt>
<dt class="hdlist1">
--key-length=&lt;len&gt;
</dt>
<dd>
<p>
Length of the resulting key. Possible values are 32, 48, or 64.
</p>
</dd>
<dt class="hdlist1">
-n &lt;hostnqn&gt;
</dt>
<dt class="hdlist1">
--nqn=&lt;hostnqn&gt;
</dt>
<dd>
<p>
Host-NQN to be used for the transformation. This parameter is only
valid if a non-zero HMAC function has been specified.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="paragraph"><p>No Examples</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_nvme">NVME</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the nvme-user suite</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2021-11-25 14:12:38 KST
</div>
</div>
</body>
</html>

52
Documentation/nvme-gen-dhchap-key.txt Normal file
View file

@ -0,0 +1,52 @@
nvme-gen-dhchap-key(1)
======================
NAME
----
nvme-gen-dhchap-key - Generate a host DH-HMAC-CHAP key
SYNOPSIS
--------
[verse]
'nvme gen-dhchap-key' [--hmac=<hmac-id> | -h <hmac-id>]
[--secret=<secret> | -s <secret> ]
[--key-length=<len> | -l <len> ]
[--nqn=<host-nqn> | -n <host-nqn> ]
DESCRIPTION
-----------
Generate a base64-encoded DH-HMAC-CHAP host key in the form:
DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:
and prints it to stdout.
OPTIONS
-------
-h <hmac-id>::
--hmac=<hmac-id>::
Select a HMAC algorithm to use. Possible values are:
0 - No HMAC algorithm
1 - SHA-256
2 - SHA-384
3 - SHA-512
-s <secret>::
--secret=<secret>::
Secret value (in hexadecimal) to be used for the key. If none are
provided a random value is used.
-l <len>::
--key-length=<len>::
Length of the resulting key. Possible values are 32, 48, or 64.
-n <hostnqn>::
--nqn=<hostnqn>::
Host-NQN to be used for the transformation. This parameter is only
valid if a non-zero HMAC function has been specified.
EXAMPLES
--------
No Examples
NVME
----
Part of the nvme-user suite

4
Documentation/nvme-gen-hostnqn.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-gen-hostnqn
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GEN\-HOSTNQN" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-GEN\-HOSTNQN" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-gen-hostnqn.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-gen-hostnqn(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -785,7 +785,7 @@ and prints it to stdout.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

40
Documentation/nvme-gen-tls-key.txt Normal file
View file

@ -0,0 +1,40 @@
nvme-gen-tls-key(1)
======================
NAME
----
nvme-gen-tls-key - Generate a NVMe TLS PSK
SYNOPSIS
--------
[verse]
'nvme gen-tls-key' [--hmac=<hmac-id> | -h <hmac-id>]
[--secret=<secret> | -s <secret> ]
DESCRIPTION
-----------
Generate a base64-encoded NVMe TLS pre-shared key (PSK) in
the PSK interchange format
NVMeTLSkey-1:01:VRLbtnN9AQb2WXW3c9+wEf/DRLz0QuLdbYvEhwtdWwNf9LrZ:
and prints it to stdout.
OPTIONS
-------
-h <hmac-id>::
--hmac=<hmac-id>::
Select a HMAC algorithm to use. Possible values are:
1 - SHA-256 (default)
2 - SHA-384
-s <secret>::
--secret=<secret>::
Secret value (in hexadecimal) to be used for the key. If none are
provided a random value is used.
EXAMPLES
--------
No Examples
NVME
----
Part of the nvme-user suite

4
Documentation/nvme-get-feature.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-feature
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-FEATURE" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-FEATURE" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-get-feature.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-get-feature(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -977,7 +977,7 @@ format:
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

4
Documentation/nvme-get-lba-status.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-lba-status
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-LBA\-STAT" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-LBA\-STAT" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

6
Documentation/nvme-get-lba-status.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-get-lba-status(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -896,7 +896,7 @@ Get LBA Status of the namespace 1 from SLBA 10 for the max Dwords of 0x1000
<div id="footer">
<div id="footer-text">
Last updated
2021-07-19 10:10:19 PDT
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

26
Documentation/nvme-get-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-LOG" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -33,16 +33,16 @@ nvme-get-log \- Retrieves a log page from an NVMe device
.sp
.nf
\fInvme get\-log\fR <device> [\-\-log\-id=<log\-id> | \-i <log\-id>]
[\-\-log\-len=<log\-len> | \-l <log\-len>]
[\-\-aen=<aen> | \-a <aen>]
[\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-raw\-binary | \-b]
[\-\-lpo=<offset> | \-o <offset>]
[\-\-lsp=<field> | \-s <field>]
[\-\-lsi=<field> | \-S <field>]
[\-\-rae | \-r]
[\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
[\-\-ot | \-O]
[\-\-log\-len=<log\-len> | \-l <log\-len>]
[\-\-aen=<aen> | \-a <aen>]
[\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-raw\-binary | \-b]
[\-\-lpo=<offset> | \-o <offset>]
[\-\-lsp=<field> | \-s <field>]
[\-\-lsi=<field> | \-S <field>]
[\-\-rae | \-r]
[\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
[\-\-ot=<offset_type> | \-O <offset_type>]
.fi
.SH "DESCRIPTION"
.sp
@ -105,7 +105,7 @@ This field specifies the identifier of command set\&. if not issued, NVM Command
.PP
\-O, \-\-ot
.RS 4
Offset Type
This field specifies the offset type\&. If set to false, the Log Page Offset Lower field and the Log Page Offset Upper field specify the byte offset into the log page to be returned\&. If set to true, the Log Page Offset Lower field and the Log Page Offset Upper field specify the index into the list of data structures in the log page to be returned\&. The default is byte offset\&. If the option is specified the index mode is used\&.
.RE
.SH "EXAMPLES"
.sp

35
Documentation/nvme-get-log.html
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<meta name="generator" content="AsciiDoc" />
<title>nvme-get-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@ -750,16 +750,16 @@ nvme-get-log(1) Manual Page
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme get-log</em> &lt;device&gt; [--log-id=&lt;log-id&gt; | -i &lt;log-id&gt;]
[--log-len=&lt;log-len&gt; | -l &lt;log-len&gt;]
[--aen=&lt;aen&gt; | -a &lt;aen&gt;]
[--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[--raw-binary | -b]
[--lpo=&lt;offset&gt; | -o &lt;offset&gt;]
[--lsp=&lt;field&gt; | -s &lt;field&gt;]
[--lsi=&lt;field&gt; | -S &lt;field&gt;]
[--rae | -r]
[--csi=&lt;command_set_identifier&gt; | -y &lt;command_set_identifier&gt;]
[--ot | -O]</pre>
[--log-len=&lt;log-len&gt; | -l &lt;log-len&gt;]
[--aen=&lt;aen&gt; | -a &lt;aen&gt;]
[--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[--raw-binary | -b]
[--lpo=&lt;offset&gt; | -o &lt;offset&gt;]
[--lsp=&lt;field&gt; | -s &lt;field&gt;]
[--lsi=&lt;field&gt; | -S &lt;field&gt;]
[--rae | -r]
[--csi=&lt;command_set_identifier&gt; | -y &lt;command_set_identifier&gt;]
[--ot=&lt;offset_type&gt; | -O &lt;offset_type&gt;]</pre>
<div class="attribution">
</div></div>
</div>
@ -908,7 +908,14 @@ program to parse.</p></div>
</dt>
<dd>
<p>
Offset Type
This field specifies the offset type. If set to false, the
Log Page Offset Lower field and the Log Page Offset Upper
field specify the byte offset into the log page to be returned.
If set to true, the Log Page Offset Lower field and the Log
Page Offset Upper field specify the index into the list of
data structures in the log page to be returned.
The default is byte offset. If the option is specified
the index mode is used.
</p>
</dd>
</dl></div>
@ -955,7 +962,7 @@ Have the program return the raw log page in binary:
<div id="footer">
<div id="footer-text">
Last updated
2021-06-12 14:47:50 IST
2022-04-08 18:46:59 CEST
</div>
</div>
</body>

29
Documentation/nvme-get-log.txt
View file

@ -9,16 +9,16 @@ SYNOPSIS
--------
[verse]
'nvme get-log' <device> [--log-id=<log-id> | -i <log-id>]
[--log-len=<log-len> | -l <log-len>]
[--aen=<aen> | -a <aen>]
[--namespace-id=<nsid> | -n <nsid>]
[--raw-binary | -b]
[--lpo=<offset> | -o <offset>]
[--lsp=<field> | -s <field>]
[--lsi=<field> | -S <field>]
[--rae | -r]
[--csi=<command_set_identifier> | -y <command_set_identifier>]
[--ot | -O]
[--log-len=<log-len> | -l <log-len>]
[--aen=<aen> | -a <aen>]
[--namespace-id=<nsid> | -n <nsid>]
[--raw-binary | -b]
[--lpo=<offset> | -o <offset>]
[--lsp=<field> | -s <field>]
[--lsi=<field> | -S <field>]
[--rae | -r]
[--csi=<command_set_identifier> | -y <command_set_identifier>]
[--ot=<offset_type> | -O <offset_type>]
DESCRIPTION
-----------
@ -86,7 +86,14 @@ OPTIONS
-O::
--ot::
Offset Type
This field specifies the offset type. If set to false, the
Log Page Offset Lower field and the Log Page Offset Upper
field specify the byte offset into the log page to be returned.
If set to true, the Log Page Offset Lower field and the Log
Page Offset Upper field specify the index into the list of
data structures in the log page to be returned.
The default is byte offset. If the option is specified
the index mode is used.
EXAMPLES
--------

4
Documentation/nvme-get-ns-id.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-ns-id
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-NS\-ID" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-NS\-ID" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

Some files were not shown because too many files have changed in this diff Show more