'\" t
.\"     Title: ndctl-write-labels
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.18
.\"      Date: 2023-05-03
.\"    Manual: ndctl Manual
.\"    Source: ndctl
.\"  Language: English
.\"
.TH "NDCTL\-WRITE\-LABELS" "1" "2023-05-03" "ndctl" "ndctl Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ndctl-write-labels \- write data to the label area on a dimm
.SH "SYNOPSIS"
.sp
.nf
\fIndctl write\-labels <nmem> [\-i <filename>]\fP
.fi
.br
.SH "DESCRIPTION"
.sp
The namespace label area is a small persistent partition of capacity
available on some NVDIMM devices.  The label area is used to provision
one, or more, namespaces from regions.
Read data from the input filename, or stdin, and write it to the given
<nmem> device. Note that the device must not be active in any region,
otherwise the kernel will not allow write access to the device\(cqs label
data area.
.SH "OPTIONS"
.sp
<memory device(s)>
.RS 4
A \fInmemX\fP device name, or a dimm id number. Restrict the operation to
the specified dimm(s). The keyword \fIall\fP can be specified to indicate
the lack of any restriction, however this is the same as not supplying
a \-\-dimm option at all.
.RE
.sp
\-s, \-\-size=
.RS 4
Limit the operation to the given number of bytes. A size of 0
indicates to operate over the entire label capacity.
.RE
.sp
\-O, \-\-offset=
.RS 4
Begin the operation at the given offset into the label area.
.RE
.sp
\-b, \-\-bus=
.RS 4
A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict the
operation to the specified bus(es). The keyword \fIall\fP can be specified
to indicate the lack of any restriction, however this is the same as
not supplying a \-\-bus option at all.
.RE
.sp
\-v
.RS 4
Turn on verbose debug messages in the library (if ndctl was built with
logging and debug enabled).
.RE
.sp
\-i, \-\-input
.RS 4
input file
.RE
.SH "SEE ALSO"
.sp
.URL "http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf" "UEFI NVDIMM Label Protocol" ""