نام (NAME)

cmdliner - ابزار کمکی برای ابزارهای مبتنی بر cmdliner

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

cmdliner [COMMAND] …

توضیحات (DESCRIPTION)

cmdliner ابزاری کمکی برای ابزارهایی است که از کتابخانه رابط خط فرمان cmdliner استفاده می‌کنند. این ابزار به نصب اسکریپت‌های تکمیل خط فرمان و صفحات راهنما کمک می‌کند. برای جزئیات بیشتر به مستندات کتابخانه مراجعه کنید یا زیردستورها را با --help فراخوانی نمایید.

دستورها (COMMANDS)

generic-completion [OPTION]… SHELL

خروجی دادن اسکریپت‌های تکمیل عمومی

install COMMAND …

نصب فایل‌های پشتیبانی برای ابزارهای cmdliner

tool-commands [OPTION]… TOOLEXEC

خروجی دادن تمام زیردستورهای یک ابزار cmdliner

tool-completion [--standalone-completion] [OPTION]… SHELL TOOLNAME

خروجی دادن اسکریپت‌های تکمیل ابزار

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

--help[=FMT] (پیش‌فرض=auto)

نمایش این راهنما در قالب FMT. مقدار FMT باید یکی از auto، pager، groff یا plain باشد. با مقدار auto، چنانچه متغیر محیطی TERM برابر با dumb یا تعریف‌نشده باشد، قالب برابر با plain و در غیر این صورت pager خواهد بود.

--version

نمایش اطلاعات نسخه.

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

cmdliner با این وضعیت‌ها خارج می‌شود:

0

در صورت موفقیت.

123

در صورت بروز خطاهای نامشخص گزارش‌شده در خطای استاندارد.

124

در صورت بروز خطاهای تجزیه خط فرمان.

125

در صورت بروز خطاهای داخلی غیرمنتظره (باگ‌ها).