نام (NAME)

opam-search - نام مستعاری برای list --search

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

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

توضیحات (DESCRIPTION)

دستور opam search یک نام مستعار برای opam list --search است.

برای جزئیات بیشتر، opam list --help را ببینید.

گزینه‌های انتخاب بسته (PACKAGE SELECTION OPTIONS)

--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'، به‌جای وابستگی‌های مستقیم، تمام وابستگی‌های متعدی (انتقالی) را نمایش می‌دهد.
--repos=REPOS: تنها بسته‌هایی را شامل می‌شود که مبدأ آن‌ها یکی از مخازن داده‌شده باشد (مگر اینکه no-switch نیز مشخص شده باشد، این گزینه بسته‌های پین‌شده را مستثنی می‌کند).
--required-by=PACKAGES: تنها وابستگی‌های PACKAGES (جداشده با کاما) را فهرست می‌کند.
--resolve=PACKAGES: محدود کردن به یک راه‌حل برای نصب PACKAGES (جداشده با کاما)، یعنی یک مجموعهٔ سازگار از بسته‌ها شامل این موارد. این گزینه تفاوت ظریفی با `--required-by --recursive` دارد که قابل پیش‌بینی‌تر است و با شکست مواجه نمی‌شود، اما تمام وابستگی‌ها را مستقل و بدون تضمین سازگاری فهرست می‌کند. بدون `--installed`، پاسخ خودکفا و مستقل از نصب فعلی است. همراه با `--installed'، از مجموعه بسته‌های در حال حاضر نصب‌شده محاسبه می‌شود. گزینهٔ `--no-switch` علاوه بر این، راه‌حل را از بسته‌های پین‌شدهٔ فعلی، معماری و نگارش کامپایلر مستقل می‌سازد. ترکیب این گزینه با `--depopts' پشتیبانی نمی‌شود.
-t, --with-test, --test: گنجاندن وابستگی‌های مختص آزمایش.
--with-dev-setup: گنجاندن وابستگی‌های مختص راه‌اندازی توسعه‌دهنده.
--with-doc, --doc: گنجاندن وابستگی‌های مختص مستندات.

گزینه‌های قالب خروجی (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: به‌طور معمول، هنگامی که چند نگارش از یک بسته مطابقت دارند، تنها یک نگارش در خروجی نشان داده می‌شود (نگارش نصب‌شده، نگارش پین‌شده، یا در غیر این صورت، بالاترین نگارش موجود یا بالاترین نگارش). این پرچم این رفتار را غیرفعال می‌کند و تمام نگارش‌های منطبق را نشان می‌دهد. همچنین قالب نمایش پیش‌فرض را تغییر می‌دهد تا به‌جای تنها نام بسته‌ها، نگارش‌های بسته را نیز شامل شود (حتی زمانی که --short تنظیم شده باشد). این گزینه به‌طور خودکار هنگامی که یک نام بستهٔ منفرد و بدون الگو در خط فرمان ارائه شود فعال می‌گردد.
--vars=[VAR=STR,...]: تعریف مقادیر متغیر داده‌شده. معمولاً همراه با --external برای بازنویسی مقادیر arch، os، os-distribution، os-version و os-family مفید است.
--wrap: شکستن خطوط طولانی؛ پیش‌فرض هنگام نمایش در پایانه کوتاه کردن (truncate) و در غیر این صورت حفظ آن به‌صورت دست‌نخورده است

انتخاب‌گرهای وابسته به ترتیب (ORDER-SENSIBLE SELECTORS)

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

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

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

گزینه‌ها (OPTIONS)

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

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

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

--best-effort: اگر امکان نصب تمام بسته‌های درخواستی وجود نداشت، با شکست متوقف نشو: تلاش کن تا جای ممکن بیشترین تعداد بسته نصب شوند. توجه داشته باشید که ممکن است همه حل‌کننده‌های خارجی از این گزینه پشتیبانی نکنند (نگارش‌های اخیر aspcud یا mccs باید پشتیبانی کنند). این معادل تنظیم متغیر محیطی $OPAMBESTEFFORT است.
--cli=MAJOR.MINOR (absent=2.5): استفاده از نحو و معناشناسی رابط خط فرمان MAJOR.MINOR. برای هرگونه استفاده ماندگار از opam (اسکریپت‌ها، پست‌های وبلاگ و غیره) در نظر گرفته شده است؛ هر نگارشی از opam در همان سری MAJOR مانند نگارش MINOR تعیین‌شده رفتار خواهد کرد. این پرچم در opam 2.0 در دسترس نبود، بنابراین برای انتخاب رابط خط فرمان 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: تعیین ترجیحات کاربر برای حل وابستگی در این اجرا. بر $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 آن را روی ۱ تنظیم می‌کند). معادل تنظیم $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 در یک فایل ماشینی-خوان. اگر نام فایل شامل نویسه `%' باشد، با شاخصی جایگزین می‌شود که فایل موجود را رونویسی نکند. مشابه با تنظیم متغیر $OPAMJSON.
--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) مفید است. هر زمانی که چنین عملیاتی نیاز باشد با شکست مواجه می‌شود؛ همچنین از انتظار برای قفل‌ها جلوگیری می‌کند، پرسش‌های تعاملی را نادیده می‌گیرد و بر متغیر $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 به عنوان 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: پاسخ مثبت (بله) به تمام پرسش‌های بله/خیر 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 اعلام می‌کند که برخی از لاگ‌های موقت دستورها و برخی نسخه‌های پشتیبان را حذف نکند. این کار اجرای برخی از نهایی‌سازها را نادیده می‌گیرد و ممکن است به دریافت ردگیری‌های معکوس (backtrace) قابل‌اعتمادتر نیز کمک کند.

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

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

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

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

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