Differential D32832 Diff 98045 sbin/nvmecontrol/nvmecontrol.8

Changeset View

Standalone View

sbin/nvmecontrol/nvmecontrol.8

	Show First 20 Lines • Show All 172 Lines • ▼ Show 20 Lines
	.Aq Ar device-id			.Aq Ar device-id
	.Nm			.Nm
	.Ic power			.Ic power
	.Op Fl l			.Op Fl l
	.Op Fl p power_state			.Op Fl p power_state
	.Op Fl w workload_hint			.Op Fl w workload_hint
	.Nm			.Nm
	.Ic selftest			.Ic selftest
	.Aq Fl c Ar code			.Aq Fl Ar s \| Fl Ar e \| Fl Ar a \| Fl c Ar code
				.Op Fl n Ar nsid
	.Aq Ar device-id \| Ar namespace-id			.Aq Ar device-id \| Ar namespace-id
	.Nm			.Nm
	.Ic wdc cap-diag			.Ic wdc cap-diag
	.Op Fl o path_template			.Op Fl o path_template
	.Aq Ar device-id			.Aq Ar device-id
	.Nm			.Nm
	.Ic wdc drive-log			.Ic wdc drive-log
	.Op Fl o path_template			.Op Fl o path_template
	Show All 39 Lines
	flag.			flag.
	Then that namespace's data is reported, if it exists.			Then that namespace's data is reported, if it exists.
	The command accepts the following parameters:			The command accepts the following parameters:
	.Bl -tag -width 6n			.Bl -tag -width 6n
	.It Fl n			.It Fl n
	The namespace			The namespace
	.Aq nsid			.Aq nsid
	to use instead of the namespace associated with the device.			to use instead of the namespace associated with the device.
	A			An
	.Ar nsid			.Ar nsid
	of			of
	.Dq 0			.Dq 0
	is used to retrieve the			is used to retrieve the
	.Dv IDENTIFY_CONTROLLER			.Dv IDENTIFY_CONTROLLER
	data associated with that drive.			data associated with that drive.
	.El			.El
	.Ss logpage			.Ss logpage
	▲ Show 20 Lines • Show All 253 Lines • ▼ Show 20 Lines
	.El			.El
	Please see the			Please see the
	.Dq NVM Subsystem Workloads			.Dq NVM Subsystem Workloads
	section of the relevant NVM Express Base Standard for details.			section of the relevant NVM Express Base Standard for details.
	.El			.El
	.Ss selftest			.Ss selftest
	Start the specified device self-test:			Start the specified device self-test:
	.Bl -tag -width 6n			.Bl -tag -width 6n
				.It Fl s
				Start a short device self-test operation
				.It Fl e
				Start an extended device self-test operation
				rpokalaUnsubmitted Not Done Inline Actions "an extended" rpokala: "an extended"
				.It Fl a
				Abort the device self-test operation
	.It Fl c Ar code			.It Fl c Ar code
	Specify the device self-test command code.			Specify the device self-test command code.
	Common codes are:			Common codes are:
	.Bl -tag -compact -width 6n			.Bl -tag -compact -width 6n
	.It Dv 0x1			.It Dv 0x1
	Start a short device self-test operation			Start a short device self-test operation
	.It Dv 0x2			.It Dv 0x2
	Start an extended device self-test operation			Start an extended device self-test operation
	.It Dv 0xe			.It Dv 0xe
	Start a vendor specific device self-test operation			Start a vendor specific device self-test operation
	.It Dv 0xf			.It Dv 0xf
	Abort the device self-test operation			Abort the device self-test operation
				.El
				.It Fl n
				.Bl -tag -width 6n
				The namespace
				.Aq nsid
				to use instead of the namespace associated with the device.
				An
				rpokalaUnsubmitted Not Done Inline Actions In English, "An nsid" sounds better than "A nsid". While the rule is usually "an :vowel::alpha:" / "a :consonant::alpha:", when the letter "n" is pronounced as a standalone letter (as in "N S I D" or "N SID"), the first sound is vowel-forward "en". rpokala: In English, "An nsid" sounds better than "A nsid". While the rule is usually "an [[:vowel:]]…
				wanpengqian_gmail.comAuthorUnsubmitted Done Inline Actions I seems OK for me, I copy this sentence from identify section. do I need to modify that one? -n The namespace ⟨nsid⟩ to use instead of the namespace associated with the device. A nsid of “0” is used to retrieve the IDENTIFY_CONTROLLER data associated with that drive. wanpengqian_gmail.com: I seems OK for me, I copy this sentence from identify section. do I need to modify that one?
				rpokalaUnsubmitted Not Done Inline Actions Yes, please update that one too. rpokala: Yes, please update that one too.
				.Ar nsid
				of
				.Dq 0
				specifies that the device self-test operation be run on the controller, independent of any namespaces.
				rpokalaUnsubmitted Not Done Inline Actions "specifies that the device self-test operation be run on the controller, independent of any namespaces." rpokala: "specifies that the device self-test operation be run on the controller, independent of any…
				A
				.Ar nsid
				of
				.Dq 0xFFFFFFFF
				specifies that the device self-test operation be run on all active namespaces.
				rpokalaUnsubmitted Not Done Inline Actions "specifies that the device self-test operation be run on all active namespaces." rpokala: "specifies that the device self-test operation be run on all active namespaces."
	.El			.El
	.El			.El
	.Ss wdc			.Ss wdc
	The various wdc command retrieve log data from the wdc/hgst drives.			The various wdc command retrieve log data from the wdc/hgst drives.
	The			The
	.Fl o			.Fl o
	flag specifies a path template to use to output the files.			flag specifies a path template to use to output the files.
	Each file takes the path template (which defaults to nothing), appends			Each file takes the path template (which defaults to nothing), appends
	▲ Show 20 Lines • Show All 221 Lines • Show Last 20 Lines