.TH RUSTDOC "1" "July 2018" "rustdoc 1.98.1 (48a229cea 2026-09-01)" "User Commands"
.SH "نام (NAME)"
rustdoc \- تولید مستندات از کد منبع Rust
.SH "خلاصه دستور (SYNOPSIS)"
.B rustdoc
[\fIOPTIONS\fR] \fIINPUT\fR

.SH "توضیحات (DESCRIPTION)"
این ابزار با استخراج کامنت‌ها از کد منبع نوشته‌شده به زبان Rust (موجود در
<\fBhttps://www.rust-lang.org\fR>)، مستندات مرجع API را تولید می‌کند. این ابزار چندین قالب ورودی را می‌پذیرد و قالب‌های خروجی گوناگونی را برای مستندات تولیدشده ارائه می‌دهد.

.SH "گزینه‌ها (OPTIONS)"

.TP
\fB\-r\fR, \fB\-\-input\-format\fR \fIFORMAT\fR
rust
.TP
\fB\-w\fR, \fB\-\-output\-format\fR \fIFORMAT\fR
html
.TP
\fB\-o\fR, \fB\-\-output\fR \fIOUTPUT\fR,
محل قرارگیری خروجی (پیش‌فرض: \fIdoc/\fR برای html)
.TP
\fB\-\-passes\fR \fILIST\fR
فهرستی از گذرهای جداشده با فاصله برای اجرا (پیش‌فرض: '')
.TP
\fB\-\-no\-defaults\fR
گذرهای پیش‌فرض اجرا نشوند
.TP
\fB\-\-plugins\fR \fILIST\fR
فهرستی از افزونه‌های جداشده با فاصله برای اجرا (پیش‌فرض: '')
.TP
\fB\-\-plugin\-path\fR \fIDIR\fR
دایرکتوری بارگذاری افزونه‌ها (پیش‌فرض: \fI/tmp/rustdoc_ng/plugins\fR)
.TP
\fB\-\-target\fR \fITRIPLE\fR
سه‌گانه هدف (target triple) برای مستندسازی
.TP
\fB\-\-crate\-name\fR \fINAME\fR
مشخص کردن نام این crate
.TP
\fB\-L\fR, \fB\-\-library\-path\fR \fIDIR\fR
دایرکتوری برای افزودن به مسیر جستجوی crate
.TP
\fB\-\-cfg\fR \fISPEC\fR
ارسال یک \fI\-\-cfg\fR به rustc
.TP
\fB\-\-extern\fR \fIVAL\fR
ارسال یک \fI\-\-extern\fR به rustc
.TP
\fB\-\-test\fR
اجرای مثال‌های کد به عنوان آزمون
.TP
\fB\-\-test\-args\fR \fIARGS\fR
ارسال آرگومان‌ها به اجراکننده آزمون
.TP
\fB\-\-html\-in\-header\fR \fIFILE\fR
فایلی برای افزودن به <head>
.TP
\fB\-\-html\-before\-content\fR \fIFILES\fR
فایل‌هایی برای قرارگیری به‌صورت درون‌خطی بین <body> و محتوای یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
.TP
\fB\-\-markdown\-before\-content\fR \fIFILES\fR
فایل‌هایی برای قرارگیری به‌صورت درون‌خطی بین <body> و محتوای یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
.TP
\fB\-\-html\-after\-content\fR \fIFILES\fR
فایل‌هایی برای قرارگیری به‌صورت درون‌خطی بین محتوا و </body> یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
.TP
\fB\-\-markdown\-after\-content\fR \fIFILES\fR
فایل‌هایی برای قرارگیری به‌صورت درون‌خطی بین محتوا و </body> یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
.TP
\fB\-\-markdown\-css\fR \fIFILES\fR
فایل‌های CSS برای گنجاندن از طریق <link> در یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
.TP
\fB\-\-markdown\-playground\-url\fR \fIURL\fR
نشانی URL برای ارسال قطعه‌کدها به آن
.TP
\fB\-\-markdown\-no\-toc\fR
فهرست مطالب گنجانده نشود
.TP
\fB\-h\fR, \fB\-\-extend\-css\fR
بازتعریف برخی قوانین css با یک فایل مشخص جهت تولید مستندات با پوسته سفارشی
.TP
\fB\-V\fR, \fB\-\-version\fR
چاپ نسخه rustdoc

.SH "قالب‌های خروجی (OUTPUT FORMATS)"

ابزار rustdoc می‌تواند خروجی را در قالب HTML تولید کند.

در صورت استفاده از قالب HTML، مقصد خروجیِ مشخص‌شده دایرکتوری ریشه یک ساختار HTML برای تمام مستندات خواهد بود. صفحه‌ها در این دایرکتوری قرار می‌گیرند و ممکن است فایل‌های منبع نیز در آن پردازش و درج شوند.

.SH "مثال‌ها (EXAMPLES)"

برای تولید مستندات برای کد منبع در دایرکتوری فعلی:
    $ rustdoc hello.rs

فهرست کردن تمام گذرهای دردسترس در rustdoc، به همراه گذرهای پیش‌فرض:
    $ rustdoc \-\-passes list

فایل HTML تولیدشده با هر مرورگر وب استانداردی قابل مشاهده است.

.SH "همچنین ببینید (SEE ALSO)"

.BR rustc (1)

.SH "گزارش باگ‌ها (BUGS)"
برای گزارش اشکالات به <\fBhttps://github.com/rust-lang/rust/issues\fR> مراجعه کنید.

.SH "نویسندگان (AUTHORS)"
تاریخچه کنترل نسخه یا <\fBhttps://thanks.rust-lang.org\fR> را ببینید.

.SH "کپی‌رایت و تکثیر (COPYRIGHT)"
این اثر تحت شرایط مجوز دوگانه Apache\ 2.0 و MIT قرار دارد.
فایل \fICOPYRIGHT\fR را در توزیع منبع rust مشاهده کنید.