'\" t
.\"     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: 02/16/2026
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-FORMAT" "1" "02/16/2026" "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-format \- قالببندی فضای نام NVMe
.SH "خلاصه دستور (SYNOPSIS)"
.sp
.nf
\fInvme format\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
                        [\-\-lbaf=<lbaf> | \-l <lbaf>]
                        [\-\-block\-size=<block size | \-b <block size>]
                        [\-\-ses=<ses> | \-s <ses>] [\-\-pil=<pil> | \-p <pil>]
                        [\-\-pi=<pi> | \-i <pi>] [\-\-ms=<ms> | \-m <ms>]
                        [\-\-reset | \-r] [\-\-force]
                        [\-\-timeout=<timeout> | \-t <timeout>]
                        [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "توضیحات (DESCRIPTION)"
.sp
دستور مدیریتی Format Namespace را برای دستگاه NVMe مشخص‌شده ارسال کرده و نتایج را ارائه می‌دهد\&.
.sp
پارامتر <device> الزامی است و می‌تواند یک دستگاه کاراکتری NVMe (مانند /dev/nvme0) یا یک دستگاه بلوکی فضای نام (مانند /dev/nvme0n1) باشد\&. اگر دستگاه کاراکتری داده شود و کنترلر از قالب‌بندی فضاهای نام خاص پشتیبانی نکند (بیت ۰ از ID_CTRL\&.FNA فعال باشد)، آن‌گاه همهٔ فضاهای نام قالب‌بندی خواهند شد\&. اگر FNA غیرفعال باشد، شناسهٔ فضای نام باید با گزینهٔ \fInamespace\-id\fR مشخص شود؛ برای ارسال فرمان قالب‌بندی به تمامی فضاهای نام، مقدار 0xffffffff را تعیین کنید\&. اگر دستگاه بلوکی داده شود، شناسهٔ فضای نام به‌طور پیش‌فرض همان شناسهٔ فضای نام دستگاه بلوکی ارائه‌شده خواهد بود، اما با همان گزینه می‌توان آن را بازنویسی کرد\&.
.sp
توجه داشته باشید که پسوند عددی روی دستگاه کاراکتری، برای مثال \fI0\fR در /dev/nvme0، نشان‌دهندهٔ این نیست که این شناسهٔ دستگاه، کنترلر والد هر فضای نامی با همان پسوند است\&. ممکن است عدد شناسهٔ فضای نام از شناسهٔ زیرسیستم باشد که مستقل از شناسهٔ کنترلر است\&. بر اساس نام دستگاه‌ها هیچ رابطهٔ خاصی میان آن‌ها فرض نکنید؛ در غیر این صورت ممکن است داده‌های روی یک دستگاه دیگر را به شکل غیرقابل‌بازگشتی پاک کنید\&.
.sp
در صورت موفقیت، برنامه به‌طور خودکار فراخوان ioctl با نام BLKRRPART را برای وادار کردن به پویش مجدد فضاهای نام صادر می‌کند\&. اگر درایور به اندازهٔ کافی جدید باشد، این کار به‌طور خودکار اندازهٔ فیزیکی بلوک را به‌روزرسانی می‌کند\&. در صورتی که درایور به اندازهٔ کافی جدید نباشد و اندازهٔ بلوک با این دستور تغییر کرده باشد، لازم است دستگاه خود را به روش دیگری حذف و دوباره پویش کنید تا اندازهٔ بلوک جدید قابل مشاهده باشد\&.
.SH "گزینه‌ها (OPTIONS)"
.PP
\-n <nsid>, \-\-namespace\-id=<nsid>
.RS 4
فرمان قالب‌بندی را برای nsid مشخص‌شده ارسال می‌کند\&. این گزینه می‌تواند برای بازنویسی مقدار پیش‌فرض چه برای دستگاه کاراکتری (نامشخص) یا دستگاه بلوکی (حاصل از NVME_IOCTL_ID) استفاده شود\&.
.RE
.PP
\-l <lbaf>, \-\-lbaf=<lbaf>
.RS 4
قالب LBA: این فیلد قالب LBA را برای اعمال روی رسانهٔ NVM مشخص می‌کند\&. این فیلد با قالب‌های LBA نشان‌داده‌شده در دستور Identify Namespace مطابقت دارد\&. با آرگومان \-\-block\-size تداخل دارد\&. مقدار پیش‌فرض 0 است\&.
.RE
.PP
\-b <block size>, \-\-block\-size=<block size>
.RS 4
اندازهٔ بلوک: این فیلد برای مشخص کردن اندازهٔ بلوک هدف جهت قالب‌بندی استفاده می‌شود\&. مقادیر بالقوه lbaf بررسی شده و کمترین شماره برای عملیات قالب‌بندی انتخاب خواهد شد\&. با آرگومان \-\-lbaf تداخل دارد\&.
.RE
.PP
\-s <ses>, \-\-ses=<ses>
.RS 4
تنظیمات پاک‌سازی امن: این فیلد مشخص می‌کند که آیا پاک‌سازی امن باید به عنوان بخشی از قالب‌بندی انجام شود یا خیر، و همچنین نوع عملیات پاک‌سازی امن را تعیین می‌کند\&. پاک‌سازی روی تمام داده‌های کاربر، صرف‌نظر از مکان آن‌ها (مانند درون یک LBA در دسترس، درون حافظهٔ نهان، درون LBAهای تخصیص‌نیافته و غیره) اعمال می‌شود\&. مقدار پیش‌فرض 0 است\&.
.TS
allbox tab(:);
lt lt
lt lt
lt lt
lt lt
lt lt.
T{
مقدار
T}:T{
تعریف
T}
T{
0
T}:T{
هیچ عملیات پاک‌سازی امنی درخواست نشده است
T}
T{
1
T}:T{
پاک‌سازی داده‌های کاربر: تمام داده‌های کاربر باید پاک شوند؛ محتوای داده‌های کاربر پس از پاک‌سازی نامشخص است (مثلاً ممکن است با صفر پر شود، با یک پر شود، و غیره)\&. اگر تمام داده‌های کاربر رمزگذاری شده باشد، کنترلر ممکن است هنگام درخواست پاک‌سازی داده‌های کاربر، یک پاک‌سازی رمزنگارانه انجام دهد\&.
T}
T{
2
T}:T{
پاک‌سازی رمزنگارانه: تمام داده‌های کاربر باید به صورت رمزنگاری‌شده پاک شوند\&. این کار با حذف کلید رمزگذاری انجام می‌شود\&.
T}
T{
3\(en7
T}:T{
رزرو شده
T}
.TE
.sp 1
.RE
.PP
\-p <pil>, \-\-pil=<pil>
.RS 4
مکان اطلاعات حفاظتی: اگر روی \(oq1\(cq تنظیم شود و اطلاعات حفاظتی فعال باشد، اطلاعات حفاظتی به عنوان نخستین بایت‌های فراداده منتقل می‌شود\&. اگر روی \(oq0\(cq تنظیم شود و اطلاعات حفاظتی فعال باشد، اطلاعات حفاظتی به عنوان آخرین بایت‌های فراداده منتقل می‌شود\&. مقدار پیش‌فرض 0 است\&.
.RE
.PP
\-i <pi>, \-\-pi=<pi>
.RS 4
اطلاعات حفاظتی: این فیلد مشخص می‌کند که آیا حفاظت سرتاسری از داده‌ها فعال است یا خیر، و همچنین نوع اطلاعات حفاظتی را تعیین می‌کند\&. مقدار پیش‌فرض 0 است\&.
.TS
allbox tab(:);
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt.
T{
مقدار
T}:T{
تعریف
T}
T{
0
T}:T{
اطلاعات حفاظتی فعال نیست
T}
T{
1
T}:T{
اطلاعات حفاظتی فعال است، نوع ۱
T}
T{
2
T}:T{
اطلاعات حفاظتی فعال است، نوع ۲
T}
T{
3
T}:T{
اطلاعات حفاظتی فعال است، نوع ۳
T}
T{
4\(en7
T}:T{
رزرو شده
T}
.TE
.sp 1
.RE
.PP
\-m <ms>, \-\-ms=<ms>
.RS 4
تنظیمات فراداده: اگر فراداده به عنوان بخشی از یک LBA دادهٔ گسترش‌یافته منتقل شود، این فیلد روی \(oq1\(cq تنظیم می‌شود\&. اگر فراداده به عنوان بخشی از یک بافر جداگانه منتقل شود، این فیلد روی \(oq0\(cq پاک می‌شود\&. فراداده ممکن است بر اساس فیلد اطلاعات حفاظتی (PI)، شامل اطلاعات حفاظتی باشد\&. مقدار پیش‌فرض 0 است\&.
.RE
.PP
\-r, \-\-reset
.RS 4
پس از قالب‌بندی موفقیت‌آمیز، یک بازنشانی صادر می‌کند\&. برای این کار باید از دستگاه کاراکتری استفاده شود\&.
.RE
.PP
\-\-force
.RS 4
فرمان را بلافاصله و بدون هشدار دربارهٔ پیامدهای آن ارسال می‌کند\&.
.RE
.PP
\-t <timeout>, \-\-timeout=<timeout>
.RS 4
مقدار مهلت زمانی پیش‌فرض ۶۰۰٬۰۰۰ را بازنویسی می‌کند\&. بر حسب میلی‌ثانیه\&.
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
قالب گزارش‌دهی را روی
\fInormal\fR،
\fIjson\fR
یا
\fIbinary\fR
تنظیم می‌کند\&. در هر زمان تنها یک قالب خروجی می‌تواند استفاده شود\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
میزان جزئیات اطلاعات را در خروجی افزایش می‌دهد\&.
.RE
.SH "مثال‌ها (EXAMPLES)"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
قالب‌بندی دستگاه با استفاده از تمامی مقادیر پیش‌فرض:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme format /dev/nvme0n1
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
قالب‌بندی فضای نام ۱ با تنظیمات پاک‌سازی امن داده‌های کاربر و اطلاعات حفاظتی:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme format /dev/nvme0 \-\-namespace\-id=1 \-\-ses=1 \-\-pi=1
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
بخشی از مجموعهٔ nvme\-user