نام (NAME)

opam-var - نمایش و به‌روزرسانی مقدار مرتبط با یک متغیر مشخص

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

opam var [--global] [--package=PACKAGE] [OPTION]… [VAR[=[VALUE]]]

توضیحات (DESCRIPTION)

بدون آرگومان، متغیرهای opam را که در حال حاضر تعریف شده‌اند فهرست می‌کند. با یک آرگومان VAR، مقدار مرتبط با VAR را چاپ می‌کند. در غیر این صورت، مقدار VAR را تنظیم یا به‌روزرسانی می‌کند. در صورتی که دامنه‌ای تعیین نشود، به‌طور پیش‌فرض بر متغیرهای switch اعمال می‌شود. این دستور هیچ‌گونه بسط متغیری انجام نمی‌دهد.

آرگومان‌ها (ARGUMENTS)

VAR[=[VALUE]]: اگر تنها VAR داده شود، مقدار مرتبط با آن را نمایش می‌دهد. اگر VALUE داده نشود، مقدار VAR حذف می‌شود. در غیر این صورت، مقدار آن بازنویسی خواهد شد.

گزینه‌ها (OPTIONS)

--global: اعمال بر پیکربندی سراسری
--package=PACKAGE: فهرست کردن تمام متغیرهای تعریف‌شده برای بسته مشخص

گزینه‌های عمومی (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] ترجیح دارد.
--no-self-upgrade: در صورت وجود، opam خود را با باینری جدیدتری که در OPAMROOT/opam یافت شود جایگزین می‌کند. این گزینه، این رفتار را غیرفعال می‌کند.
-q, --quiet: گزینه --verbose را غیرفعال می‌کند.
--root=ROOT: استفاده از ROOT به‌عنوان مسیر ریشه فعلی. این معادل با تنظیم $OPAMROOT روی ROOT است.
--safe, --readonly: اطمینان حاصل می‌کند که هیچ چیزی به‌طور خودکار به‌روزرسانی یا بازنویسی نخواهد شد. برای مثال هنگام فراخوانی از اسکریپت‌های تکمیل دستور (completion scripts) مفید است. هرگاه چنین عملیاتی مورد نیاز باشد با شکست مواجه می‌شود؛ همچنین از انتظار برای قفل‌ها جلوگیری می‌کند، پرسش‌های تعاملی را رد می‌کند و متغیر $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) یا مرجعی (ref) که به آن اشاره دارند، به وضعیت کاری فعلی کد منبع آن‌ها به‌روزرسانی می‌کند. از آنجا که دایرکتوری منبع دقیقاً به همان صورت کپی می‌شود، تمیز نبودن آن ممکن است منجر به شکست ساخت 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، اما مختص به اصلاح (fixup) و نصب مجدد.

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

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

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

OPAMJOBS حداکثر تعداد کارگران موازی برای اجرا را تعیین می‌کند.

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

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

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

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

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

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

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

OPAMNO به هر سؤالی پاسخ no می‌دهد؛ به گزینه‌های `--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 تنظیم کنید. بازدهی کمتری دارد، اما ممکن است به اشکال‌زدایی مشکلات حل‌کننده (solver) کمک کند.

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' باشد، اتمام مهلت زمانی خطا تلقی می‌شود. در حال حاضر فقط backend توکار 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 صرفاً آن را نادیده می‌گیرد)، و برای نسخه‌های 2.1 (یا بالاتر) از `--cli=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). حل‌کننده نتوانست پاسخی معتبر بازگرداند. این ممکن است به دلیل خرابی حل‌کننده خارجی یا خطایی در پیکربندی حل‌کننده باشد.
99: خطای داخلی. مشکلی رخ داده است، احتمالاً به دلیل وجود باگ در خود opam.
130: وقفه کاربر. سیگنال SIGINT دریافت شد، که معمولاً به دلیل فشردن کلید‌های Ctrl-C توسط کاربر است.
0: در صورت موفقیت.
123: در صورت بروز خطاهای تفکیک‌نشده گزارش‌شده در خطای استاندارد.
124: در صورت خطاهای تجزیه خط فرمان.
125: در صورت خطاهای داخلی غیرمنتظره (باگ‌ها).