نام (NAME)

cmdliner-install-tool-manpages - نصب صفحات راهنمای ابزارهای مبتنی بر cmdliner

خلاصه دستور (SYNOPSIS)

cmdliner install tool-manpages [--dry-run] [--update-opam-install=PKG.install] [گزینه‌ها]… TOOLEXEC[:NAME]… MANDIR

توضیحات (DESCRIPTION)

دستور cmdliner install tool-manpages صفحات راهنمای ابزار و زیردستورهای آن را در دایرکتوری‌های پوشه man نصب می‌کند. در صورت نیاز، دایرکتوری‌ها ایجاد می‌شوند. از گزینه --dry-run برای مشاهده مسیرهایی که نوشته خواهند شد استفاده کنید. مثال:

cmdliner install tool-manpages ./mytool /usr/local/share/man

توجه داشته باشید که دستور install tool-support نیز همانند این دستور صفحات راهنما را نصب می‌کند.

شناسه‌ها (ARGUMENTS)

MANDIR (اجباری): مسیر ریشه دایرکتوری man برای نصب صفحات راهنما.
TOOLEXEC[:NAME] (اجباری): فایل اجرایی ابزار (TOOLEXEC). در صورتی که مسیر صریح فایل مشخص نشده باشد، در متغیر PATH جستجو می‌شود. مقدار NAME نام ابزار است؛ در صورت عدم تعیین، از نام پایه TOOLEXEC با حذف پسوند .exe استخراج می‌شود. قابل تکرار است.

گزینه‌ها (OPTIONS)

--dry-run: فایل‌ها را نصب نکن، فقط مسیرهایی را که نوشته خواهند شد نمایش بده.
--update-opam-install=PKG.install: فایل PKG.install در opam را به‌روزرسانی یا ایجاد کن و انتقال‌های نصب را از فایل‌های نصب‌شده به بخش‌های متناظر opam install اضافه کن. در صورت مشخص شدن --dry-run نیز انجام می‌شود.

گزینه‌های عمومی (COMMON OPTIONS)

--help[=FMT] (پیش‌فرض=auto): نمایش این راهنما در قالب FMT. مقدار FMT باید یکی از مقادیر auto، pager، groff یا plain باشد. با مقدار auto، هرگاه متغیر محیطی TERM برابر dumb یا تعریف‌نشده باشد، قالب به‌صورت pager یا plain خواهد بود.
--version: نمایش اطلاعات نسخه.

وضعیت خروج (EXIT STATUS)

دستور cmdliner install tool-manpages با مقادیر زیر خارج می‌شود:

0: در صورت موفقیت.
123: در صورت بروز خطاهای کلی گزارش‌شده در خروجی استاندارد خطا.
124: در صورت بروز خطاهای تجزیه خط فرمان.
125: در صورت بروز خطاهای داخلی غیرمنتظره (باگ‌ها).

همچنین ببینید (SEE ALSO)

cmdliner(1)