نام (NAME)

opam-admin-index - تولید یک فایل نمایهٔ جامع برای ارائه از طریق HTTP

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

opam admin index [--full-urls-txt] [--minimal-urls-txt] [--no-urls-txt] [OPTION]…

توضیحات (DESCRIPTION)

یک مخزن opam می‌تواند با استفاده از هر وب‌سروری از طریق HTTP یا HTTPS ارائه شود. برای این منظور، ابتدا باید یک نمایهٔ جامع تولید شود: این دستور فایل‌هایی را تولید می‌کند که کلاینت opam هنگام واکشی از یک ریموت HTTP انتظار دارد، و باید پس از اعمال هرگونه تغییر در محتویات مخزن اجرا شود.

گزینه‌ها (OPTIONS)

--full-urls-txt: تولید یک فایل 'urls.txt' جامع، برای مخزنی که توسط نسخه‌های opam قدیمی‌تر از 2.0 استفاده خواهد شد.
--minimal-urls-txt: تولید یک فایل 'urls.txt' کمینه، که فقط شامل فایل 'repo' است. این گزینه به نسخه‌های opam قدیمی‌تر از 2.0 اجازه می‌دهد تا به جای مواجهه با خطا، آن فایل را خوانده و با فرض تعریف فیلد مناسب 'redirect:'، به درستی به مخزن اختصاص‌یافته به نسخهٔ خود هدایت شوند. این حالت پیش‌فرض است.
--no-urls-txt: عدم تولید فایل 'urls.txt'. این فایل نمایه از نسخهٔ opam 2.0 به بعد دیگر مورد نیاز نیست، اما همچنان توسط نسخه‌های قدیمی‌تر استفاده می‌شود.

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

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

--best-effort: اگر همهٔ بسته‌های درخواستی قابل نصب نباشند با خطا متوقف نشو: تلاش برای نصب بیشترین تعداد ممکن. توجه داشته باشید که ممکن است همهٔ حل‌کننده‌های خارجی از این گزینه پشتیبانی نکنند (نسخه‌های اخیر aspcud یا mccs باید پشتیبانی کنند). این معادل با تنظیم متغیر محیطی $OPAMBESTEFFORT است.
--cli=MAJOR.MINOR (پیش‌فرض=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] (پیش‌فرض=auto): نمایش این راهنما در قالب FMT. مقدار FMT باید یکی از auto، pager، groff یا plain باشد. با انتخاب auto، هرگاه متغیر محیطی TERM برابر با dumb یا تعریف‌نشده باشد، قالب به pager یا plain تنظیم می‌شود.
--ignore-pin-depends: نادیده گرفتن پین‌های اضافی مورد نیاز بسته‌هایی که چه به‌صورت دستی با opam pin یا از طریق opam install DIR پین می‌شوند. این معادل با تنظیم IGNOREPINDEPENDS=true است.
--json=FILENAME: ذخیرهٔ نتایج اجرای opam در یک فایل با ساختار ماشین‌خوان. اگر نام فایل شامل نویسهٔ `%' باشد، با نمایه‌ای جایگزین می‌شود که فایلی از پیش موجود را بازنویسی نکند. مشابه با تنظیم متغیر $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] به‌صورت دستی ارتقا دهید.
-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: غیرفعال کردن هرگونه حل‌کنندهٔ خارجی و استفاده از حل‌کنندهٔ داخلی (این امر نیازمند کامپایل شدن opam با یک حل‌کنندهٔ توکار است). این معادل با تنظیم $OPAMNOASPCUD یا $OPAMUSEINTERNALSOLVER است.
-v, --verbose: خروجی با جزئیات بیشتر. یک بار -v تمام دستورهای بسته را نشان می‌دهد؛ تکرار آن همچنین دستورهایی را که به‌صورت داخلی فراخوانی می‌شوند نمایش می‌دهد (مانند tar، curl، patch و غیره). تکرار n بار معادل با تنظیم $OPAMVERBOSE به "n" است.
--version: نمایش اطلاعات نسخه.
-w, --working-dir: هرگاه بسته‌هایی به‌روزرسانی شوند که به یک دایرکتوری محلی تحت کنترل نسخه متصل هستند، به جای آخرین وضعیت ثبت‌شده (commit) یا مرجعی که به آن اشاره می‌کنند، به وضعیت کاری فعلی منبع آن‌ها به‌روزرسانی شود. از آنجا که دایرکتوری منبع همان‌گونه که هست کپی می‌شود، تمیز نبودن آن ممکن است منجر به شکست در ساخت opam شود. این گزینه فقط بر بسته‌هایی اثر می‌گذارد که صریحاً در خط فرمان مشخص شده‌اند. همچنین می‌تواند از طریق $OPAMWORKINGDIR تنظیم شود.
-y, --yes: پاسخ بله (yes) به تمام پرسش‌های بله/خیر opam بدون پرسیدن از کاربر. همچنین ببینید --confirm-level. این معادل با تنظیم $OPAMYES به "true" است.

محیط (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، اما مخصوص اصلاح و نصب مجدد.

OPAMIGNORECONSTRAINTS به گزینه نصب `--ignore-constraints-on' رجوع کنید.

OPAMIGNOREPINDEPENDS به گزینه `--ignore-pin-depends' رجوع کنید.

OPAMINPLACEBUILD به گزینه `--inplace-build' رجوع کنید.

OPAMJOBS بیشینه تعداد فرآیندهای موازی برای اجرا را تعیین می‌کند.

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

OPAMKEEPBUILDDIR به گزینه نصب `--keep-build-dir' رجوع کنید.

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

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 مشخص می‌کند که آیا هنگام سنجاق کردن به یک مسیر محلی، سیستم‌های کنترل نسخه شناسایی شوند یا خیر. از نسخه 1.3.0 به طور پیش‌فرض فعال است.

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

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

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') به برخی حل‌کننده‌ها اجازه می‌دهد در صورت اتمام مهلت زمانی، همچنان پاسخی ارائه دهند؛ اگرچه تضمین می‌شود که پاسخ سازگار بماند، اما در این حالت هیچ تضمینی وجود ندارد که با معیارهای بهینه‌سازی مورد انتظار مطابقت داشته باشد. در صورت `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}%` در فایل‌های `opam`، محتوای متغیر var را بازنویسی می‌کند.

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

نسخه رابط خط فرمان (CLI VERSION)

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

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

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

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

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

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

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