CARGO-HELP(1) General Commands Manual CARGO-HELP(1)

cargo-help - دریافت راهنما برای یکی از دستورات Cargo

cargo help [subcommand]

پیام راهنما را برای دستور مشخص‌شده چاپ می‌کند.

برای دستورهایی که دارای زیردستور هستند، سطوح مختلف دستور را با فاصله از یکدیگر جدا کنید. برای نمونه، cargo help report future-incompatibilities راهنمای دستور cargo report future-incompatibilities را نمایش می‌دهد.

فاصله‌ها تنها سطوح سلسله‌مراتبی میان یک دستور والد و زیردستورهای آن را جدا می‌کنند. خط تیره‌هایی که بخشی از نام یک دستور هستند، مانند generate-lockfile، همیشه باید حفظ شوند.

سطوح چندگانه یک دستور را می‌توان به صورت یک واژه متصل با خط تیره نیز نوشت. برای نمونه، cargo help report-future-incompatibilities معادل با cargo help report future-incompatibilities است.

-v, --verbose

استفاده از خروجی پرگو. می‌تواند دو بار مشخص شود تا خروجی «بسیار پرگو» تولید شود که شامل اطلاعات اضافی مانند هشدارهای وابستگی و خروجی اسکریپت ساخت است. همچنین می‌تواند با مقدار پیکربندی term.verbose https://doc.rust-lang.org/cargo/reference/config.html مشخص شود.

-q, --quiet

پیام‌های لاگ cargo را چاپ نمی‌کند. همچنین می‌تواند با مقدار پیکربندی term.quiet https://doc.rust-lang.org/cargo/reference/config.html مشخص شود.

--color when

کنترل زمان استفاده از خروجی رنگی. مقادیر معتبر:
•auto (پیش‌فرض): تشخیص خودکار در دسترس بودن پشتیبانی از رنگ در ترمینال.
•always: همیشه رنگ‌ها را نمایش می‌دهد.
•never: هرگز رنگ‌ها را نمایش نمی‌دهد.

همچنین می‌تواند با مقدار پیکربندی term.color https://doc.rust-lang.org/cargo/reference/config.html مشخص شود.

--locked

تضمین می‌کند که دقیقاً همان وابستگی‌ها و نسخه‌هایی استفاده شوند که هنگام ایجاد اولیه فایل موجود Cargo.lock استفاده شده بودند. در صورت بروز هر یک از شرایط زیر، Cargo با یک خطا خارج خواهد شد:
•فایل lock موجود نباشد.
•برنامه Cargo به دلیل حل وابستگی متفاوت، برای تغییر فایل lock تلاش کند.

این گزینه می‌تواند در محیط‌هایی که ساخت‌های قطعی و تکرارپذیر مد نظر است، مانند خطوط لوله CI استفاده شود.

--offline

از دسترسی Cargo به شبکه به هر دلیلی جلوگیری می‌کند. بدون این پرچم، اگر Cargo نیاز به دسترسی به شبکه داشته باشد و شبکه در دسترس نباشد، با خطا متوقف خواهد شد. با این پرچم، Cargo در صورت امکان تلاش می‌کند کار را بدون شبکه پیش ببرد.

توجه داشته باشید که این کار ممکن است منجر به حل وابستگی متفاوتی نسبت به حالت برخط شود. Cargo خود را به crateهایی که به صورت محلی دانلود شده‌اند محدود می‌کند، حتی اگر طبق نسخه محلی شاخص، نسخه جدیدتری موجود باشد. برای دانلود وابستگی‌ها پیش از رفتن به حالت آفلاین، دستور cargo-fetch(1) را ببینید.

همچنین می‌تواند با مقدار پیکربندی net.offline https://doc.rust-lang.org/cargo/reference/config.html مشخص شود.

--frozen

معادل با مشخص کردن هم‌زمان هر دو گزینه --locked و --offline است.

+toolchain

اگر Cargo با rustup نصب شده باشد و نخستین آرگومان cargo با + آغاز شود، به عنوان نام زنجیره ابزار rustup تفسیر خواهد شد (مانند +stable یا +nightly). برای اطلاعات بیشتر در مورد نحوه عملکرد بازنویسی‌های زنجیره ابزار، مستندات rustup https://rust-lang.github.io/rustup/overrides.html را ببینید.

--config KEY=VALUE یا PATH

یک مقدار پیکربندی Cargo را بازنویسی می‌کند. آرگومان باید در نحو TOML به صورت KEY=VALUE باشد، یا به عنوان مسیری به یک فایل پیکربندی اضافی ارائه شود. این پرچم می‌تواند چندین بار مشخص شود. برای اطلاعات بیشتر، بخش بازنویسی‌های خط فرمان https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides را ببینید.

-C PATH

دایرکتوری کاری فعلی را پیش از اجرای هرگونه عملیات مشخص‌شده تغییر می‌دهد. این گزینه بر مواردی مانند جایی که cargo به طور پیش‌فرض برای مانیفست پروژه (Cargo.toml) جستجو می‌کند، و همچنین دایرکتوری‌های مورد جستجو برای یافتن .cargo/config.toml تأثیر می‌گذارد. این گزینه باید پیش از نام دستور قرار گیرد، برای نمونه cargo -C path/to/my-project build.

این گزینه تنها در کانال nightly https://doc.rust-lang.org/book/appendix-07-nightly-rust.html در دسترس است و برای فعال‌سازی به پرچم -Z unstable-options نیاز دارد (موضوع #10098 https://github.com/rust-lang/cargo/issues/10098 را ببینید).

-h, --help

اطلاعات راهنما را چاپ می‌کند.

-Z flag

پرچم‌های ناپایدار (تنها در نسخه nightly) برای Cargo. برای جزئیات cargo -Z help را اجرا کنید.

برای جزئیات درباره متغیرهای محیطی که Cargo می‌خواند، به مرجع https://doc.rust-lang.org/cargo/reference/environment-variables.html مراجعه کنید.

•0: کار با موفقیت انجام شد.
•101: برنامه Cargo نتوانست عملیات را به پایان برساند.

1.دریافت راهنما برای یک دستور: 
cargo help build
2.دریافت راهنما برای یک دستور تو در تو: 
cargo help report future-incompatibilities
3.حالت متصل با خط تیره نیز کار می‌کند: 
cargo help report-future-incompatibilities
4.راهنما با استفاده از پرچم --help نیز در دسترس است: 
cargo build --help

cargo(1)