1NDCTL(1) NDCTL(1)
2
3
4
6 ndctl - Manage "libnvdimm" subsystem devices (Non-volatile Memory)
7
9 ndctl [--version] [--help] [OPTIONS] COMMAND [ARGS]
10
12 -v, --version
13 Display ndctl version.
14
15 -h, --help
16 Run ndctl help command.
17
19 ndctl is utility for managing the "libnvdimm" kernel subsystem. The
20 "libnvdimm" subsystem defines a kernel device model and control message
21 interface for platform NVDIMM resources like those defined by the ACPI
22 6.0 NFIT (NVDIMM Firmware Interface Table). Operations supported by the
23 tool include, provisioning capacity (namespaces), as well as
24 enumerating/enabling/disabling the devices (dimms, regions, namespaces)
25 associated with an NVDIMM bus.
26
28 Copyright © 2016 - 2022, Intel Corporation. License GPLv2: GNU GPL
29 version 2 http://gnu.org/licenses/gpl.html. This is free software: you
30 are free to change and redistribute it. There is NO WARRANTY, to the
31 extent permitted by law.
32
34 linkndctl:ndctl-create-namespace[1],
35 linkndctl:ndctl-destroy-namespace[1],
36 linkndctl:ndctl-check-namespace[1], linkndctl:ndctl-enable-region[1],
37 linkndctl:ndctl-disable-region[1], linkndctl:ndctl-enable-dimm[1],
38 linkndctl:ndctl-disable-dimm[1], linkndctl:ndctl-enable-namespace[1],
39 linkndctl:ndctl-disable-namespace[1], linkndctl:ndctl-zero-labels[1],
40 linkndctl:ndctl-read-labels[1], linkndctl:ndctl-inject-error[1],
41 linkndctl:ndctl-list[1], LIBNVDIMM Overview[1], NVDIMM Driver Writer’s
42 Guide[2]
43
45 1. LIBNVDIMM Overview
46 https://www.kernel.org/doc/Documentation/nvdimm/nvdimm.txt
47
48 2. NVDIMM Driver Writer’s Guide
49 http://pmem.io/documents/NVDIMM_Driver_Writers_Guide.pdf
50
51
52
53 08/03/2023 NDCTL(1)