OPAM-LIST(1) Opam Manual OPAM-LIST(1)

opam-list - نمایش فهرست بسته‌های موجود.

opam list [--check] [--no-depexts] [--silent] [OPTION]… [PATTERNS]…

فهرست کردن بسته‌های گزینش‌شده opam.

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

مگر در صورت استفاده از گزینه --short، قالب خروجی در هر سطر یک بسته را نمایش می‌دهد و هر سطر شامل نام بسته، نسخه نصب‌شده یا `--' در صورت نصب نبودن بسته، و یک توضیح کوتاه است. در حالت رنگی، زیر نام بسته‌هایی که به‌صورت دستی نصب شده‌اند (برخلاف بسته‌هایی که به‌دلیل وابستگی‌ها به‌طور خودکار نصب شده‌اند) خط کشیده می‌شود.

برای مشاهده تمام روش‌های انتخاب بسته‌ها جهت نمایش، بخش گزینه‌های انتخاب بسته (PACKAGE SELECTION OPTIONS) و برای شخصی‌سازی قالب خروجی، بخش OUTPUT FORMAT OPTIONS را ببینید.

برای توضیحات دقیق‌تر درباره بسته‌ها، دستور opam show را ببینید. برای قابلیت‌های جستجوی پیشرفته درون فرا‌داده‌های بسته‌ها، دستور opam search را ببینید.

الگوهای بسته با نویسه‌های عام (globs). مگر اینکه --search مشخص شده باشد، این الگوها با NAME یا NAME.VERSION مطابقت داده می‌شوند.

این گزینه‌ها به ترتیبی که به دستور داده می‌شوند حساس هستند. برای مثال: --available --latests-only ابتدا همه بسته‌های موجود را فهرست کرده و سپس تنها آخرین نسخه از بسته‌ها را در آن مجموعه برمی‌گزیند؛ در حالی که --latests-only --available ابتدا همه آخرین نسخه‌های بسته‌ها را فهرست می‌کند و سپس تنها مواردی را که در آن مجموعه در دسترس هستند نشان می‌دهد.

-a, --available
تنها بسته‌هایی را فهرست می‌کند که در سیستم فعلی موجود هستند
-A, --all
شامل همه بسته‌ها، حتی بسته‌های نصب‌نشده یا ناموجود
--base
در نسخه 2.1 حذف شده است، به جای آن از --invariant استفاده کنید.
-i, --installed
تنها بسته‌های نصب‌شده را فهرست می‌کند. در صورتی که هیچ آرگومان دیگری داده نشود، این حالت پیش‌فرض است
--installable
تنها بسته‌هایی را فهرست می‌کند که روی switch فعلی قابل نصب هستند (این گزینه حل‌کننده وابستگی‌ها را فراخوانی می‌کند و ممکن است هزینه‌برتر باشد؛ بسته‌ای که به یک بسته ناموجود وابسته است ممکن است در دسترس باشد، اما هرگز قابل نصب نیست)
--invariant
تنها پایه تغییرناپذیر switch فعلی (یعنی بسته‌های invariant) را فهرست می‌کند
--latests-only
تنها آخرین نسخه از هر بسته را فهرست می‌کند.
--pinned
تنها بسته‌های پین‌شده (pinned) را فهرست می‌کند
--roots, --installed-roots
تنها بسته‌هایی را فهرست می‌کند که صراحتاً نصب شده‌اند، بدون در نظر گرفتن بسته‌هایی که به عنوان وابستگی نصب شده‌اند

این گزینه‌ها بدون توجه به ترتیبی که به دستور داده شده‌اند، همیشه با یک ترتیب مشخص و ثابت به دستور اعمال می‌شوند.

--coinstallable-with=PACKAGES
تنها بسته‌هایی را فهرست می‌کند که با تمام PACKAGES سازگار باشند.
--conflicts-with=PACKAGES
بسته‌هایی را فهرست می‌کند که با حداقل یکی از بسته‌های موجود در فهرست داده‌شده تعارض اعلان کرده‌اند. این مورد شامل تعارض‌های تعریف‌شده از طرف بسته‌های درون فهرست، از طرف بسته دیگر، یا توسط یک فیلد مشترک conflict-class: می‌شود.
--depends-on=PACKAGES
تنها بسته‌هایی را فهرست می‌کند که به یکی از بسته‌های PACKAGES (جداشده با کاما) وابسته هستند.
--depopts
شامل کردن وابستگی‌های اختیاری در درخواست‌های وابستگی.
--dev
شامل کردن بسته‌های توسعه در وابستگی‌ها.
--field-match=FIELD:PATTERN
فیلتر کردن بسته‌ها بر اساس مطابقت PATTERN در FIELD داده‌شده
--has-flag=FLAG
تنها شامل بسته‌هایی می‌شود که پرچم مشخص‌شده را دارا باشند. پرچم‌های بسته یکی از این موارد هستند: light-uninstall verbose plugin compiler conf
--has-tag=TAG
تنها شامل بسته‌هایی می‌شود که برچسب داده‌شده را دارا باشند
--no-switch
فهرست کردن مواردی که از مخازن در دسترس هستند، بدون در نظر گرفتن وضعیت switch فعلی (یا هر switch دیگری) (بسته‌های نصب‌شده، پین‌شده و غیره.)
--nobuild
مستثنی کردن وابستگی‌های ساخت (این وابستگی‌ها به‌طور پیش‌فرض لحاظ می‌شوند).
--or
به جای انتخاب بسته‌هایی که با تمام معیارها مطابقت دارند، بسته‌هایی را انتخاب می‌کند که با هر یک از آن‌ها مطابقت داشته باشند
--owns-file=FILE
بسته‌های نصب‌شده‌ای را پیدا می‌کند که مسئول نصب فایل داده‌شده بوده‌اند
--post
شامل کردن وابستگی‌هایی که به عنوان post برچسب خورده‌اند.
--recursive
همراه با `--depends-on' و `--required-by'، تمام وابستگی‌های متعدی (transitive) را به جای تنها وابستگی‌های مستقیم نمایش می‌دهد.
--repos=REPOS
تنها شامل بسته‌هایی می‌شود که مبدأ آن‌ها یکی از مخازن داده‌شده باشد (مگر اینکه no-switch نیز مشخص شده باشد، این گزینه بسته‌های پین‌شده را مستثنی می‌کند).
--required-by=PACKAGES
تنها وابستگی‌های بسته‌های PACKAGES (جداشده با کاما) را فهرست می‌کند.
--resolve=PACKAGES
محدود کردن خروجی به یک راهکار معتبر برای نصب بسته‌های PACKAGES (جداشده با کاما)، یعنی یک مجموعه سازگار از بسته‌ها که شامل این موارد باشد. این گزینه تفاوتی ظریف با `--required-by --recursive` دارد؛ گزینه دوم قابل پیش‌بینی‌تر است و شکست نمی‌خورد، اما همه وابستگی‌ها را به طور مستقل و بدون تضمین سازگاری فهرست می‌کند. بدون `--installed`، پاسخ به‌صورت خودکفا و مستقل از وضعیت نصب فعلی ارائه می‌شود. با گزینه `--installed'، پاسخ بر اساس مجموعه بسته‌های نصب‌شده فعلی محاسبه می‌شود. گزینه `--no-switch` راهکار را به‌علاوه از بسته‌های پین‌شده فعلی، معماری و نسخه کامپایلر نیز مستقل می‌کند. استفاده هم‌زمان این گزینه با `--depopts' پشتیبانی نمی‌شود.
--search
الگوهای PATTERNS را با توضیحات کامل بسته‌ها مطابقت می‌دهد و تطابق همه آن‌ها را الزامی می‌کند، به جای اینکه حداقل یکی از آن‌ها با نام بسته مطابقت داشته باشد (مگر اینکه --or نیز مشخص شده باشد).
-t, --with-test, --test
شامل کردن وابستگی‌های فقط آزمایشی (test-only).
--with-dev-setup
شامل کردن وابستگی‌های مخصوص توسعه‌دهنده (dev-only).
--with-doc, --doc
شامل کردن وابستگی‌های فقط مستنداتی (doc-only)..SH "گزینه‌های قالب خروجی (OUTPUT FORMAT OPTIONS)"
--columns=COLUMNS
انتخاب ستون‌ها برای نمایش از میان: name، version، package، synopsis، synopsis-or-target، description، <field>:، installed-version، pin، source-hash، opam-file، all-installed-versions، available-versions، all-versions، repository، installed-files، vc-ref، depexts. مقدار پیش‌فرض در صورت حضور --short برابر با name، و در غیر این صورت name، installed-version و synopsis-or-target است.
-e، --external، --depexts
به‌جای نمایش بسته‌ها، وابستگی‌های خارجی آن‌ها که با سیستم فعلی مرتبط هستند را نمایش می‌دهد. این گزینه سایر گزینه‌های نمایش را مستثنی می‌کند. به‌جای استفاده مستقیم از این گزینه، احتمالاً بهتر است به سراغ افزونه‌ی `depext' بروید که از مدیر بسته‌ی سیستم شما برای مدیریت نصب وابستگی‌ها استفاده خواهد کرد. دستور `opam depext' را اجرا کنید.
--normalise
چاپ مقادیر فیلدهای opam به‌صورت استانداردسازی‌شده (نرمال‌شده).
-S، --sort
مرتب‌سازی بسته‌ها به ترتیب وابستگی (یعنی ترتیبی که در آن بتوان آن‌ها را به‌صورت جداگانه نصب کرد).
-s، --short
سرایند را چاپ نمی‌کند و ستون‌های پیش‌فرض را تنها به name تنظیم می‌کند. اگر به گنجاندن نگارش‌های بسته نیاز دارید، به‌جای آن از --columns=package استفاده کنید.
--separator=STRING (absent= )
تنظیم رشته‌ی جداکننده‌ی ستون‌ها.
-V، --all-versions
به‌طور معمول، هنگامی که چندین نگارش از یک بسته مطابقت داشته باشند، تنها یک نگارش در خروجی نمایش داده می‌شود (نگارش نصب‌شده، نگارش سنجاق‌شده (pinned)، یا در صورت عدم وجود، بالاترین نگارش در دسترس یا بالاترین نگارش). این پرچم این رفتار را غیرفعال کرده و همه‌ی نگارش‌های منطبق را نشان می‌دهد. همچنین قالب پیش‌فرض نمایش را تغییر می‌دهد تا به‌جای تنها نام بسته‌ها، نگارش‌های بسته را نیز شامل شود (حتی هنگامی که --short تنظیم شده باشد). هنگامی که یک نام بسته‌ی منفرد و بدون الگو در خط فرمان ارائه شود، این پرچم به‌طور خودکار فعال می‌شود.
--vars=[VAR=STR,...]
تعریف مقیدسازی‌های متغیر داده‌شده. معمولاً همراه با --external برای بازنویسی مقادیر arch، os، os-distribution، os-version و os-family کاربرد دارد.
--wrap
شکستن خطوط طولانی (wrap)؛ حالت پیش‌فرض، کوتاه‌سازی (truncate) هنگام نمایش در ترمینال، یا حفظ آن به همان شکل در غیر این صورت است.

--check
چیزی در خروجی نمی‌نویسد، در صورتی که فهرست خالی نباشد با کد بازگشتی 0 و در غیر این صورت با 1 خارج می‌شود.
--no-depexts
غیرفعال کردن مدیریت وابستگی‌های خارجی برای پرس‌وجو. این گزینه می‌تواند برای گنجاندن بسته‌هایی که به دلیل عدم دسترسی به یک وابستگی سیستمی، به‌عنوان غیرقابل‌دسترس علامت‌گذاری شده‌اند استفاده شود.
--silent
در نگارش 2.1 حذف شد، به‌جای آن از --check استفاده کنید.

این گزینه‌ها میان تمامی دستورها مشترک هستند.

--best-effort
اگر امکان نصب تمام بسته‌های درخواستی وجود نداشت، با شکست مواجه نشو: تلاش کن تا جای ممکن بیشترین تعداد بسته نصب شوند. توجه داشته باشید که ممکن است همه‌ی حل‌کننده‌های خارجی از این گزینه پشتیبانی نکنند (نگارش‌های اخیر aspcud یا mccs باید پشتیبانی کنند). این معادل با تنظیم متغیر محیطی $OPAMBESTEFFORT است.
--cli=MAJOR.MINOR (absent=2.5)
استفاده از نحو و معانی رابط خط فرمان نگارش MAJOR.MINOR. این ویژگی برای هرگونه استفاده‌ی پایدار از opam (اسکریپت‌ها، پست‌های وبلاگ و غیره) در نظر گرفته شده است؛ هر نگارشی از opam در همان سری MAJOR مانند نگارش MINOR مشخص‌شده رفتار خواهد کرد. این پرچم در opam 2.0 در دسترس نبود، بنابراین برای انتخاب CLI نسخه 2.0، به‌جای استفاده از این پارامتر، متغیر محیطی OPAMCLI را روی 2.0 تنظیم کنید.
--color=WHEN
رنگی‌سازی خروجی. مقدار WHEN باید یکی از always، never یا auto باشد.
--confirm-level=LEVEL
سطح تأیید، LEVEL باید یکی از مقادیر ask، no، yes یا unsafe-yes باشد. می‌تواند بیش از یک بار مشخص شود. اگر --yes یا --no نیز داده شوند، مقدار آخرین --confirm-level در نظر گرفته می‌شود. این معادل با تنظیم متغیر محیطی $OPAMCONFIRMLEVEL است.
--criteria=CRITERIA
تعیین ترجیحات (preferences) کاربر برای حل وابستگی در این اجرا. بر مقادیر متغیرهای $OPAMCRITERIA، $OPAMFIXUPCRITERIA و $OPAMUPGRADECRITERIA اولویت دارد. برای جزئیات مربوط به زبان پشتیبانی‌شده و حل‌کننده‌های خارجی موجود، ببینید: http://opam.ocaml.org/doc/External_solvers.html. یک راهنمای کلی برای استفاده از ترجیحات حل‌کننده را می‌توان در http://www.dicosmo.org/Articles/usercriteria.pdf یافت.
--cudf=FILENAME
گزینه‌ی اشکال‌زدایی: ذخیره‌ی درخواست‌های CUDF ارسال‌شده به حل‌کننده در FILENAME-<n>.cudf که در آن <n> نشان‌دهنده‌ی n-امین فراخوانی حل‌کننده در طول اجرای opam است.
--debug
چاپ پیام‌های اشکال‌زدایی در stderr. این معادل با تنظیم $OPAMDEBUG روی "true" است.
--debug-level=LEVEL
مشابه --debug، اما امکان تعیین سطح اشکال‌زدایی را فراهم می‌کند (--debug آن را به 1 تنظیم می‌کند). معادل با تنظیم $OPAMDEBUG روی یک عدد صحیح مثبت.
--git-version
چاپ نگارش git مربوط به opam، در صورت تنظیم بودن (یعنی در صورتی که از یک نگارش توسعه استفاده می‌کنید)، و خروج.
--help[=FMT] (default=auto)
نمایش این راهنما در قالب FMT. مقدار FMT باید یکی از auto، pager، groff یا plain باشد. با انتخاب auto، هرگاه متغیر محیطی TERM برابر با dumb یا تعریف‌نشده باشد، قالب به‌صورت pager یا plain خواهد بود.
--ignore-pin-depends
نادیده گرفتن سنجاق‌های (pins) اضافی مورد نیاز بسته‌هایی که چه به‌صورت دستی از طریق opam pin و چه از طریق opam install DIR سنجاق می‌شوند. این معادل با تنظیم IGNOREPINDEPENDS=true است.
--json=FILENAME
ذخیره‌ی نتایج اجرای opam در یک فایل ماشین‌خوان (computer-readable). اگر نام فایل شامل نویسه‌ی `%' باشد، با شاخصی جایگزین می‌شود که فایل موجود را بازنویسی نکند. مشابه با تنظیم متغیر $OPAMJSON.
--no
پاسخ منفی (no) به تمام پرسش‌های بله/خیر opam بدون پرسش از کاربر. همچنین ببینید --confirm-level. این معادل با تنظیم $OPAMNO روی "true" است.
--no-aspcud
در نگارش 2.1 حذف شد.
--no-auto-upgrade
هنگام پیکربندی یا به‌روزرسانی مخزنی که برای نگارش پیشین opam (نگارش 1.2) نوشته شده است، opam آن را به‌طور درونی به قالب فعلی تبدیل می‌کند. این گزینه این رفتار را غیرفعال می‌کند. توجه داشته باشید که مخازن باید نگارش قالب خود را در یک فایل 'repo' در ریشه‌ی خود مشخص کنند، در غیر این صورت فرض می‌شود که در قالب قدیمی‌تر هستند. در هر صورت، ترجیح داده می‌شود که در صورت امکان مخازن را با استفاده از opam admin upgrade [--mirror URL] به‌صورت دستی ارتقا دهید.
--no-self-upgrade
در صورت وجود، opam خود را با فایل باینری جدیدتری که در OPAMROOT/opam یافت شود جایگزین می‌کند. این گزینه این رفتار را غیرفعال می‌کند.
-q، --quiet
گزینه‌ی --verbose را غیرفعال می‌کند.
--root=ROOT
استفاده از ROOT به‌عنوان مسیر ریشه‌ی فعلی. این معادل با تنظیم $OPAMROOT روی ROOT است.
--safe، --readonly
اطمینان حاصل می‌کند که هیچ چیزی به‌طور خودکار به‌روزرسانی یا بازنویسی نخواهد شد. برای مثال، برای فراخوانی از اسکریپت‌های تکمیل خودکار مناسب است. هرگاه چنین عملیاتی لازم باشد با شکست مواجه می‌شود؛ همچنین از انتظار برای قفل‌ها جلوگیری کرده، پرسش‌های تعاملی را نادیده می‌گیرد و متغیر $OPAMDEBUG را بازنویسی می‌کند. این معادل با تنظیم متغیر محیطی $OPAMSAFE است.
--solver=CMD
مشخص کردن حل‌کننده‌ی CUDF برای حل مسائل نصب بسته‌ها. این می‌تواند یک حل‌کننده‌ی از پیش‌تعریف‌شده باشد (این نگارش از opam از builtin-mccs+lp()، builtin-mccs+glpk، builtin-dummy-z3-solver، builtin-0install، aspcud، mccs، aspcud-old و packup پشتیبانی می‌کند) یا یک دستور سفارشی که باید شامل متغیرهای %{input}%، %{output}%، %{criteria}% و در صورت تمایل %{timeout}% باشد. این معادل با تنظیم متغیر محیطی $OPAMEXTERNALSOLVER است.
--strict
هر زمان که خطایی در تعریف یک بسته یا در یک فایل پیکربندی یافت شود با شکست متوقف می‌شود. حالت پیش‌فرض ادامه‌ی کار در سکوت و در صورت امکان است.
--switch=SWITCH
استفاده از SWITCH به‌عنوان سوییچ کامپایلر فعلی. این معادل با تنظیم $OPAMSWITCH روی SWITCH است.
--use-internal-solver
غیرفعال کردن تمامی حل‌کننده‌های خارجی و استفاده از حل‌کننده‌ی توکار (built-in) (این امر مستلزم آن است که opam با یک حل‌کننده‌ی توکار کامپایل شده باشد). این معادل با تنظیم $OPAMNOASPCUD یا $OPAMUSEINTERNALSOLVER است.
-v، --verbose
افزایش میزان جزئیات پیام‌ها. درج یک -v تمام دستورهای بسته‌ها را نشان می‌دهد؛ برای نمایش دستورهایی که به‌طور درونی فراخوانی می‌شوند (مانند tar، curl، patch و غیره) آن را تکرار کنید. تکرار به تعداد n بار معادل با تنظیم $OPAMVERBOSE روی "n" است.
--version
نمایش اطلاعات نگارش.
-w، --working-dir
هنگام به‌روزرسانی بسته‌هایی که به یک دایرکتوری محلی تحت کنترل نگارش مقید هستند، به‌جای آخرین وضعیت کامیت‌شده یا ارجاعی که به آن اشاره دارند، به وضعیت کاری فعلی کد منبع آن‌ها به‌روزرسانی می‌کند. از آنجا که دایرکتوری منبع دقیقاً به همان شکلی که هست کپی می‌شود، در صورت تمیز نبودن آن ممکن است منجر به شکست در ساخت opam شود. این گزینه فقط بر بسته‌هایی تأثیر می‌گذارد که صریحاً در خط فرمان مشخص شده باشند. همچنین می‌تواند از طریق $OPAMWORKINGDIR تنظیم شود.
-y، --yes
پاسخ مثبت (yes) به تمام پرسش‌های بله/خیر opam بدون پرسش از کاربر. همچنین ببینید --confirm-level. این معادل با تنظیم $OPAMYES روی "true" است..SH "محیط (ENVIRONMENT)"

دستور opam از متغیرهای محیطی فهرست‌شده در اینجا استفاده می‌کند. متغیرهای بولی (Boolean) برای غیرفعال‌سازی باید روی "0"، "no"، "false" یا یک رشته خالی، و برای فعال‌سازی روی "1"، "yes" یا "true" تنظیم شوند.

OPAMALLPARENS تمام فیلترها را درون پرانتز قرار می‌دهد.

OPAMASSUMEDEPEXTS گزینه `--assume-depexts' را ببینید.

OPAMAUTOANSWER فقط برای استفاده داخلی.

OPAMAUTOREMOVE گزینه حذف `--auto-remove' را ببینید.

OPAMBESTEFFORT گزینه `--best-effort' را ببینید.

OPAMBESTEFFORTPREFIXCRITERIA رشته‌ای را تعیین می‌کند که در صورت تنظیم گزینه `--best-effort' باید به ابتدای معیارها اضافه شود، و انتظار می‌رود ویژگی `opam-query' را در پاسخ به بیشترین مقدار برساند.

OPAMBUILDDOC در 2.1 حذف شد.

OPAMBUILDTEST در 2.1 حذف شد.

OPAMCLI گزینه `--cli' را ببینید.

OPAMCOLOR هنگامی که روی always یا never تنظیم شود، مقدار پیش‌فرضی برای گزینه `--color' تعیین می‌کند.

OPAMCONFIRMLEVEL گزینه `--confirm-level` را ببینید. متغیر OPAMCONFIRMLEVEL بر OPAMYES و OPAMNO اولویت دارد.

OPAMCRITERIA اولویت‌های کاربر (preferences) را برای حل وابستگی‌ها مشخص می‌کند. مقدار پیش‌فرض به نسخه حل‌کننده بستگی دارد؛ برای اطلاع از تنظیمات فعلی از `config report' استفاده کنید. همچنین گزینه --criteria را ببینید.

OPAMCUDFFILE گراف cudf را در file-actions-explicit.dot ذخیره می‌کند.

OPAMCUDFTRIM پالایش بسته‌های غیرمرتبط را در طول پیش‌پردازش CUDF کنترل می‌کند.

OPAMCURL می‌تواند برای انتخاب یک برنامه 'curl' خاص به کار رود. برای گزینه‌های بیشتر OPAMFETCH را ببینید.

OPAMDEBUG گزینه‌های `--debug' و `--debug-level' را ببینید.

OPAMDEBUGSECTIONS در صورت تنظیم، پیام‌های اشکال‌زدایی را به فهرست بخش‌های جداشده با فاصله محدود می‌کند. بخش‌ها می‌توانند اختیاری دارای سطح اشکال‌زدایی مشخصی باشند (برای مثال، CLIENT:2 یا CLIENT CUDF:2)، اما در غیر این صورت از `--debug-level' استفاده می‌کنند.

OPAMDIGDEPTH میزان سخت‌گیرانه بودن جستجوی تداخل‌ها را در طول پیش‌پردازش CUDF تعیین می‌کند.

OPAMDOWNLOADJOBS حداکثر تعداد دانلودهای هم‌زمان را تعیین می‌کند.

OPAMDROPWORKINGDIR بسته‌هایی را که پیش‌تر با --working-dir به‌روزرسانی شده‌اند، هنگام به‌روزرسانی بازنویسی می‌کند. بدون تنظیم این متغیر، opam آن‌ها را بدون تغییر حفظ می‌کند مگر اینکه صراحتاً در خط فرمان نام برده شوند.

OPAMDRYRUN گزینه `--dry-run' را ببینید.

OPAMEDITOR ویرایشگر مورد استفاده برای ویرایش فایل opam را تعیین می‌کند، و بر $EDITOR و $VISUAL اولویت دارد.

OPAMERRLOGLEN تعداد خطوط گزارش چاپ‌شده در زمان شکست یک زیرپردازش را مشخص می‌کند. مقدار 0 برای چاپ همه است.

OPAMEXTERNALSOLVER گزینه `--solver' را ببینید.

OPAMFAKE گزینه `--fake' را ببینید.

OPAMFETCH نحوه دانلود فایل‌ها را مشخص می‌کند: با `wget'، یا `curl' یا یک دستور سفارشی که در آن متغیرهای %{url}%، %{out}%، %{retry}%، %{compress}% و %{checksum}% جایگزین خواهند شد. بر مقدار 'download-command' در فایل پیکربندی اصلی اولویت دارد.

OPAMFIXUPCRITERIA مشابه OPAMUPGRADECRITERIA است، اما مختص به رفع اشکال (fixup) و نصب مجدد است.

OPAMIGNORECONSTRAINTS گزینه نصب `--ignore-constraints-on' را ببینید.

OPAMIGNOREPINDEPENDS گزینه `--ignore-pin-depends' را ببینید.

OPAMINPLACEBUILD گزینه `--inplace-build' را ببینید.

OPAMJOBS حداکثر تعداد کارگرهای موازی (parallel workers) برای اجرا را تعیین می‌کند.

OPAMJSON خروجی json را در فایل مشخص‌شده ثبت می‌کند (از نویسه `%' برای شماره‌گذاری فایل‌ها استفاده کنید).

OPAMKEEPBUILDDIR گزینه نصب `--keep-build-dir' را ببینید.

OPAMKEEPLOGS به opam اعلام می‌کند که برخی گزارش‌های موقت دستورات و برخی پشتیبان‌ها را حذف نکند. این کار اجرای برخی از نهایی‌سازها را لغو می‌کند و همچنین ممکن است به دریافت ردگیری‌های پشته (backtraces) قابل‌اعتمادتر کمک کند.

OPAMLOCKED ترکیبی از گزینه‌های `--locked' و `--lock-suffix'.

OPAMLOGS logdir دایرکتوری گزارش‌ها را تعیین می‌کند، مقدار پیش‌فرض یک دایرکتوری موقت در /tmp است

OPAMMAKECMD دستور make سیستمی مورد استفاده را مشخص می‌کند.

OPAMMERGEOUT خروجی‌های فرایند را ادغام می‌کند، stderr روی stdout.

OPAMNO به هر سؤالی پاسخ خیر می‌دهد، گزینه‌های `--no` و `--confirm-level` را ببینید. در صورت تنظیم بودن هر یک از OPAMCONFIRMLEVEL یا OPAMYES، مقدار OPAMNO نادیده گرفته می‌شود.

OPAMNOAGGREGATE در دستور `opam admin check'، از تجمیع بسته‌ها جلوگیری می‌کند.

OPAMNOASPCUD منسوخ شده است.

OPAMNOAUTOUPGRADE ارتقای خودکار داخلی مخازن دارای قالب قدیمی به نسخه فعلی را هنگام 'update' یا 'init' غیرفعال می‌کند.

OPAMNOCHECKSUMS گزینه --no-checksums را در صورت در دسترس بودن فعال می‌کند.

OPAMNODEPEXTS مدیریت وابستگی‌های سیستمی را غیرفعال می‌کند، گزینه `--no-depexts' را ببینید.

OPAMNOENVNOTICE داخلی.

OPAMNOSELFUPGRADE گزینه `--no-self-upgrade' را ببینید

OPAMPINKINDAUTO تعیین می‌کند که آیا هنگام الصاق (pinning) به یک مسیر محلی، سیستم‌های کنترل نسخه شناسایی شوند یا خیر. از نسخه 1.3.0 به طور پیش‌فرض فعال است.

OPAMPRECISETRACKING ردیابی دقیق و ریزدانه‌ای دایرکتوری‌ها.

OPAMPREPRO برای غیرفعال کردن پیش‌پردازش CUDF این مقدار را روی false قرار دهید. کارایی کمتری دارد، اما ممکن است به اشکال‌زدایی مشکلات حل‌کننده کمک کند.

OPAMREPOSITORYTARRING مخازن را در داخل به صورت فایل‌های tar.gz ذخیره می‌کند. این ویژگی می‌تواند روی سیستم‌فایل‌هایی که در پیمایش درخت‌های بزرگ عملکرد خوبی ندارند اما دارای حافظه پنهان مناسب در /tmp هستند بسیار سریع‌تر باشد. با این حال در حالت کلی کندتر عمل می‌کند.

OPAMREQUIRECHECKSUMS گزینه `--require-checksums' را در صورت در دسترس بودن فعال می‌کند (مثلاً برای `opam install').

OPAMRETRIES تعداد دفعات تلاش مجدد قبل از شکست در دانلود را تعیین می‌کند.

OPAMREUSEBUILDDIR گزینه `--reuse-build-dir' را ببینید.

OPAMROOT گزینه `--root' را ببینید. این متغیر به طور خودکار توسط `opam env --root=DIR --set-root' تنظیم می‌شود.

OPAMROOTISOK هنگام اجرا با کاربر ریشه (root) هشداری نمی‌دهد.

OPAMSAFE گزینه `--safe' را ببینید.

OPAMSHOW گزینه `--show' را ببینید.

OPAMSKIPUPDATE گزینه `--skip-updates' را ببینید.

OPAMSKIPVERSIONCHECKS برخی از بررسی‌های نسخه را نادیده می‌گیرد. ناامن است و صرفاً برای آزمایش سازگاری کاربرد دارد.

OPAMSOLVERALLOWSUBOPTIMAL (پیش‌فرض `true') به برخی از حل‌کننده‌ها اجازه می‌دهد در صورت رسیدن به مهلت زمانی (timeout) همچنان پاسخی ارائه دهند؛ هرچند تضمین می‌شود که راه‌حل سازگار بماند، اما تضمینی وجود ندارد که با معیارهای بهینه‌سازی مورد انتظار هم‌خوانی داشته باشد. اگر `true' باشد، opam با یک هشدار ادامه می‌دهد؛ اگر `false' باشد، پایان مهلت زمانی یک خطا تلقی می‌شود. در حال حاضر فقط موتور builtin-z3 این حالت تنزل‌یافته را مدیریت می‌کند.

OPAMSOLVERTIMEOUT زمان مجاز برای حل‌کننده را تغییر می‌دهد. مقدار پیش‌فرض 60.0 است، برای زمان نامحدود آن را روی 0 قرار دهید. توجه داشته باشید که ممکن است همه حل‌کننده‌ها از این گزینه پشتیبانی نکنند.

OPAMSOLVERTOLERANCE میزان تساهل نسبت به انتخاب یک راه‌حل غیربهینه توسط حل‌کننده (یعنی امکان دریافت بسته‌های قدیمی‌تر) را تغییر می‌دهد. مقادیر معمول بین 0.0 (بهترین راه‌حل شناخته‌شده برای حل‌کننده) تا 1.0 (راه‌حل بهینه‌نشده) متغیر است. مقدار پیش‌فرض 0.0 است. این گزینه در صورتی که حل‌کننده نتواند در زمانی معقول پاسخی بیابد مفید است ($OPAMSOLVERTIMEOUT را ببینید). توجه داشته باشید که ممکن است همه حل‌کننده‌ها از این گزینه پشتیبانی نکنند.

OPAMSTATS در 2.4 حذف شد.

OPAMSTATUSLINE یک نوار وضعیت پویا را در ترمینال نمایش می‌دهد که وضعیت فعلی را نشان می‌دهد. (یکی از مقادیر always، never یا auto)

OPAMSTRICT در صورت بروز ناهماهنگی‌ها (خواندن فایل، وارد کردن switch و غیره.) با خطا متوقف می‌شود.

OPAMSWITCH گزینه `--switch' را ببینید. به طور خودکار توسط `opam env --switch=SWITCH --set-switch' تنظیم می‌شود.

OPAMUNLOCKBASE گزینه نصب `--unlock-base' را ببینید.

OPAMUPGRADECRITERIA اولویت‌های کاربر (preferences) را برای حل وابستگی‌ها هنگام ارتقا مشخص می‌کند. در صورتی که هر دو تنظیم شده باشند، در زمان ارتقا بر OPAMCRITERIA اولویت دارد. همچنین گزینه --criteria را ببینید.

OPAMUSEINTERNALSOLVER گزینه `--use-internal-solver' را ببینید.

OPAMUSEOPENSSL در 2.2 حذف شد.

OPAMUTF8 استفاده از نویسه‌های UTF8 در خروجی (یکی از مقادیر always، never یا auto). پیش‌فرض `auto' است که بر اساس locale مشخص می‌شود).

OPAMUTF8MSGS استفاده از نویسه‌های گسترده UTF8 (شترها) در پیام‌های opam. مستلزم فعال بودن OPAMUTF8 است. این متغیر به طور پیش‌فرض فقط در macOS فعال است.

OPAMVALIDATIONHOOK در صورت تنظیم، از دستور `%{hook%}' برای اعتبارسنجی به‌روزرسانی مخزن opam استفاده می‌کند.

OPAMVERBOSE گزینه `--verbose' را ببینید.

OPAMVERBOSEON گزینه --verbose-on را ببینید

OPAMVERSIONLAGPOWER استفاده نشود.

OPAMWITHDEVSETUP گزینه نصب `--with-dev-setup' را ببینید.

OPAMWITHDOC گزینه نصب `--with-doc' را ببینید.

OPAMWITHTEST گزینه نصب `--with-test. را ببینید

OPAMWORKINGDIR گزینه `--working-dir' را ببینید.

OPAMYES گزینه‌های `--yes' و `--confirm-level` را ببینید. متغیر OPAMYES بر OPAMNO اولویت دارد و در صورت تنظیم بودن OPAMCONFIRMLEVEL نادیده گرفته می‌شود.

OPAMVAR_var محتوای متغیر var را هنگام جایگزینی رشته‌های `%{var}%` در فایل‌های `opam` بازنویسی می‌کند.

OPAMVAR_package_var محتوای متغیر package:var را هنگام جایگزینی رشته‌های `%{package:var}%` در فایل‌های `opam` بازنویسی می‌کند..SH "نسخه خط فرمان (CLI VERSION)"

همه اسکریپت‌ها و فراخوانی‌های برنامه‌نویسی‌شده opam باید از `--cli' استفاده کنند تا اطمینان حاصل شود که با نسخه‌های بعدی کلاینت opam بدون مشکل کار می‌کنند. علاوه بر این، پست‌های وبلاگ یا سایر مستندات نیز می‌توانند از آن بهره‌مند شوند، زیرا مانع از منسوخ شدن اطلاعات می‌شود.

اگرچه opam تنها از ریشه‌ها (~/.opam/) برای نسخه فعلی پشتیبانی می‌کند، اما سازگاری عقبرو را برای واسط خط فرمان خود فراهم می‌سازد.

از آن‌جا که پشتیبانی از نسخه CLI تنها در opam 2.1 افزوده شده است، از OPAMCLI برای انتخاب پشتیبانی از 2.0 استفاده کنید (چرا که opam 2.0 صرفاً آن را نادیده می‌گیرد)، و از `--cli=2.1' برای نسخه‌های 2.1 (یا جدیدتر)، زیرا متغیر محیطی کنترل‌کننده تجزیه نحو شکننده است. برای این منظور، opam در صورتی که OPAMCLI نسخه‌ای معتبر به جز 2.0 را مشخص کند، و همچنین در صورتی که `--cli=2.0' مشخص شده باشد، هشداری نمایش می‌دهد.

نسخه خط فرمان با استفاده از گزینه `--cli' یا متغیر محیطی OPAMCLI انتخاب می‌شود. گزینه `--cli' ممکن است بیش از یک‌بار مشخص شود، که آخرین نمونه اولویت خواهد داشت. متغیر OPAMCLI تنها در صورتی بررسی می‌شود که `--cli' داده نشده باشد.

به عنوان استثنایی بر موارد زیر، دستور `exec' اگر دستور یافت نشود یا نتواند اجرا شود مقدار 127، و در غیر این صورت مقدار خروج دستور را بازمی‌گرداند.

0
موفقیت، یا true برای پرس‌وجوهای بولی.
1
مقدار False. هنگامی برگردانده می‌شود که یک مقدار بازگشتی بولی مورد انتظار است، برای نمونه هنگام اجرا با --check، یا برای پرس‌وجوهایی مانند opam lint.
2
آرگومان‌های نامعتبر خط فرمان، یا آرگومان‌های خط فرمانی که به یک زمینه نامعتبر اشاره دارند (مثلاً فایلی که از قالب مورد انتظار پیروی نمی‌کند).
5
یافت نشد. شما چیزی (بسته، نسخه، مخزن و غیره) درخواست کرده‌اید که پیدا نشد.
10
لغو شد. عملیات نیازمند تأیید بود، که داده نشد.
15
قفل‌های لازم برای عملیات به دست نیامد.
20
هیچ راه‌حلی برای درخواست کاربر وجود ندارد. این ممکن است برای نمونه به دلیل درخواست نصب دو بسته ناسازگار رخ دهد.
30
خطا در تعریف بسته، یا سایر فایل‌های متادیتا. استفاده از --strict این خطا را بیشتر ایجاد می‌کند.
31
خطای اسکریپت بسته. برخی از عملیات بسته ناموفق بودند. این ممکن است خطایی در بسته‌ها یا ناسازگاری با سیستم شما باشد. این می‌تواند یک خطای جزئی باشد.
40
خطای همگام‌سازی. دریافت برخی از موارد دوردست از شبکه ممکن نشد. این می‌تواند یک خطای جزئی باشد.
50
خطای پیکربندی. پیکربندی opam یا سیستم اجازه عملیات را نمی‌دهد، و نیاز به اصلاح دارد.
60
شکست حل‌کننده (Solver). حل‌کننده موفق به بازگرداندن پاسخی درست نشد. این امر می‌تواند ناشی از یک حل‌کننده خارجی معیوب، یا خطایی در پیکربندی حل‌کننده باشد.
99
خطای داخلی. مشکلی رخ داد، که احتمالاً ناشی از یک باگ در خود opam است.
130
وقفه کاربر. سیگنال SIGINT دریافت شد، که معمولاً به دلیل فشردن Ctrl-C توسط کاربر است.
0
در صورت موفقیت.
123
در صورت بروز خطاهای نامشخص گزارش‌شده در خطای استاندارد (standard error).
124
در صورت بروز خطاهای تجزیه خط فرمان.
125
در صورت بروز خطاهای داخلی غیرمنتظره (باگ‌ها).

به https://opam.ocaml.org/doc مراجعه کنید.

David Allsopp <david@tarides.com>

Vincent Bernardoff <vb@luminar.eu.org>

Raja Boujbel <raja.boujbel@ocamlpro.com>

Kate Deplaix <kit-ty-kate@outlook.com>

Roberto Di Cosmo <roberto@dicosmo.org>

Thomas Gazagnaire <thomas@gazagnaire.org>

Louis Gesbert <louis.gesbert@ocamlpro.com>

Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>

Anil Madhavapeddy <anil@recoil.org>

Guillem Rieu <guillem.rieu@ocamlpro.com>

Ralf Treinen <ralf.treinen@pps.jussieu.fr>

Frederic Tuong <tuong@users.gforge.inria.fr>.SH "همچنین ببینید (SEE ALSO)"

opam(1)

گزارش‌های باگ را در https://github.com/ocaml/opam/issues بررسی کنید.

Opam 2.5.2