'\" t
.\"     Title: nvme-read
.\"    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\-READ" "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-read \- ارسال دستور خواندن NVMe و بازگرداندن نتایج
.SH "خلاصه دستور (SYNOPSIS)"
.sp
.nf
\fInvme\-read\fR <device> [\-\-start\-block=<slba> | \-s <slba>]
                        [\-\-block\-count=<nlb> | \-c <nlb>]
                        [\-\-block\-size=<size> | \-b <size>]
                        [\-\-data\-size=<size> | \-z <size>]
                        [\-\-metadata\-size=<size> | \-y <size>]
                        [\-\-ref\-tag=<reftag> | \-r <reftag>]
                        [\-\-data=<data\-file> | \-d <data\-file>]
                        [\-\-metadata=<metadata\-file> | \-M <metadata\-file>]
                        [\-\-prinfo=<prinfo> | \-p <prinfo>]
                        [\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
                        [\-\-app\-tag=<apptag> | \-a <apptag>]
                        [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f]
                        [\-\-dir\-type=<type> | \-T <type>]
                        [\-\-dir\-spec=<spec> | \-S <spec>] [\-\-dsm=<dsm> | \-D <dsm>]
                        [\-\-show\-command | \-V] [\-\-dry\-run | \-w] [\-\-latency | \-t]
                        [\-\-storage\-tag<storage\-tag> | \-g <storage\-tag>]
                        [\-\-storage\-tag\-check | \-C] [\-\-force]
                        [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
                        [\-\-timeout=<timeout>]
.fi
.SH "توضیحات (DESCRIPTION)"
.sp
دستور Read بلوک‌های منطقی مشخص‌شده توسط دستور را از رسانه ذخیره‌سازی خوانده و در بافر داده ارائه‌شده کپی می‌کند. در صورت عدم ارائه فایل، به طور پیش‌فرض از stdout استفاده خواهد شد.
.SH "گزینه‌ها (OPTIONS)"
.PP
\-s <slba>, \-\-start\-block=<slba>
.RS 4
بلوک آغازین.
.RE
.PP
\-c, \-\-block\-count
.RS 4
تعداد بلوک‌ها برای انتقال. این یک مقدار مبتنی بر صفر است تا با نحوه استفاده هسته (kernel) از این فیلد هماهنگ باشد (یعنی 0 به معنی انتقال ۱ بلوک است).
.RE
.PP
\-b <size>, \-\-block\-size=<size>
.RS 4
در صورت تعیین، اندازه بلوک منطقی بر حسب بایت، که در آن metasize نیز اندازه فراداده (متادیتا) را برای یک بلوک مجزا شرح می‌دهد. در غیر این صورت از طریق identify namespace شناسایی می‌شود.
.RE
.PP
\-z <size>, \-\-data\-size=<size>
.RS 4
اندازه داده‌ها، بر حسب بایت.
.RE
.PP
\-y <size>, \-\-metadata\-size=<size>
.RS 4
اندازه متادیتا (فراداده) بر حسب بایت.
.RE
.PP
\-d <data\-file>, \-\-data=<data\-file>
.RS 4
فایل داده. اگر فایلی ارائه نشود، محتویات به STDOUT فرستاده می‌شود.
.RE
.PP
\-M <metadata\-file>, \-\-metadata=<metadata\-file>
.RS 4
فایل متادیتا، در صورت لزوم.
.RE
.PP
\-p <prinfo>, \-\-prinfo=<prinfo>
.RS 4
تعریف فیلد اطلاعات حفاظت (Protection Information).
.TS
allbox tab(:);
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt.
T{
بیت
T}:T{
توضیحات
T}
T{
3
T}:T{
عملیات اطلاعات حفاظت (PRACT): هنگامی که روی ۱ تنظیم شود، چنانچه اندازه متادیتای قالب بلوک برابر با ۸ باشد، PI هنگام خواندن/نوشتن حذف یا درج می‌شود. هنگامی که روی ۰ تنظیم شود، متادیتا عبور داده می‌شود.
T}
T{
2:0
T}:T{
بررسی اطلاعات حفاظت (PRCHK):
T}
T{
2
T}:T{
تنظیم روی ۱، بررسی تگ محافظ (guard tag) را فعال می‌کند
T}
T{
1
T}:T{
تنظیم روی ۱، بررسی تگ برنامه (application tag) را فعال می‌کند
T}
T{
0
T}:T{
تنظیم روی ۱، بررسی تگ مرجع (reference tag) را فعال می‌کند
T}
.TE
.sp 1
.RE
.PP
\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
تگ مرجع (reftag) اختیاری هنگام استفاده به همراه اطلاعات حفاظت.
.RE
.PP
\-m <appmask>, \-\-app\-tag\-mask=<appmask>
.RS 4
ماسک اختیاری تگ برنامه هنگام استفاده به همراه اطلاعات حفاظت.
.RE
.PP
\-f, \-\-force\-unit\-access
.RS 4
تنظیم فلگ دستیابی اجباری به واحد (force\-unit access).
.RE
.PP
\-T <type>, \-\-dir\-type=<type>
.RS 4
نوع دایرکتیو (directive type) اختیاری. ابزار nvme\-cli تنها بررسی می‌کند که مقدار در محدوده تعریف‌شده برای نوع دایرکتیو باشد، هرچند مشخصات NVMe (نسخه 1.3a) تنها یک دایرکتیو (01h) را برای شناسه‌های جریان نوشتن (write stream identifiers) تعریف کرده است.
.RE
.PP
\-S <spec>, \-\-dir\-spec=<spec>
.RS 4
فیلد اختیاری برای مشخصات دایرکتیو. هنگام استفاده با جریان‌های نوشتن، این مقدار به عنوان شناسه جریان نوشتن تعریف می‌شود. ابزار nvme\-cli بررسی نمی‌کند که آیا جریان درخواستی در محدوده توانمندی‌های کنترلر هست یا خیر.
.RE
.PP
\-D <dsm>, \-\-dsm=<dsm>
.RS 4
ویژگی‌های اختیاری مدیریت مجموعه‌داده (data set management) برای این دستور. آرگومان مربوط به این گزینه، ۸ بیت کم‌ارزش‌تر فیلد DSM در دستور نوشتن است؛ ۱۶ بیت باارزش‌تر این فیلد، در صورت استفاده، از فیلد directive specific به دست می‌آید. از این گزینه می‌توان برای تنظیم ویژگی‌های LBAهای در حال نوشتن مانند بسامد دسترسی، نوع، تأخیر و موارد دیگر، و همچنین انواع تعریف‌نشده استفاده کرد. لطفاً برای جزئیات کامل نحوه استفاده از این فیلد به مشخصات NVMe مراجعه کنید.
.RE
.PP
\-V, \-\-show\-cmd
.RS 4
دستوری که قرار است ارسال شود را چاپ می‌کند.
.RE
.PP
\-w, \-\-dry\-run
.RS 4
دستور را در عمل ارسال نمی‌کند. در صورت تمایل به استفاده از گزینه \-\-dry\-run، گزینه \-\-show\-cmd
\fIباید\fR
تنظیم شده باشد. در غیر این صورت گزینه \-\-dry\-run
\fIنادیده گرفته خواهد شد\fR\&.
.RE
.PP
\-t, \-\-latency
.RS 4
میزان تأخیری که IOCTL طول کشید (بر حسب میکروثانیه) را چاپ می‌کند.
.RE
.PP
\-g <storage\-tag>, \-\-storage\-tag=<storage\-tag>
.RS 4
تگ ذخیره‌سازی بلوک منطقی مورد انتظار با اندازه متغیر (ELBST).
.RE
.PP
\-C, \-\-storage\-tag\-check
.RS 4
این فلگ بررسی فیلد تگ ذخیره‌سازی (Storage Tag) را به عنوان بخشی از پردازش حفاظت داده سرتاسری (end\-to\-end) فعال می‌کند.
.RE
.PP
\-\-force
.RS 4
مشغول بودن فضای نام (namespace) را نادیده گرفته و عملیات را در هر حالتی انجام می‌دهد.
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
تنظیم قالب گزارش‌دهی روی
\fInormal\fR،
\fIjson\fR
یا
\fIbinary\fR\&. تنها می‌توان از یک قالب خروجی در یک زمان استفاده کرد.
.RE
.PP
\-v, \-\-verbose
.RS 4
افزایش جزئیات اطلاعات در خروجی.
.RE
.PP
\-\-timeout=<timeout>
.RS 4
بازنویسی مقدار مهلت زمانی (timeout) پیش‌فرض. بر حسب میلی‌ثانیه.
.RE
.SH "مثال‌ها (EXAMPLES)"
.sp
هنوز مثالی ثبت نشده است\&.
.SH "NVME"
.sp
بخشی از مجموعه nvme\-user