نام (NAME)

opam admin-list - فهرست کردن بسته‌ها از یک مخزن

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

opam admin list [--environment=VAR=VALUE[,VAR=VALUE]] [OPTION]… [PATTERNS]…

توضیحات (DESCRIPTION)

این دستور مشابه 'opam list' است، اما امکان فهرست کردن بسته‌ها را مستقیماً از یک مخزن به‌جای موارد موجود در یک نصب معین opam فراهم می‌کند.

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

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

گزینه‌ها (OPTIONS)

--environment=VAR=VALUE[,VAR=VALUE]: استفاده از محیط opam داده‌شده، در قالب فهرستی از پیوندهای 'var=value' جداشده با کاما، هنگام حل متغیرها. این گزینه برای نمونه هنگام محاسبهٔ بسته‌های در دسترس به کار می‌رود: اگر تعریف نشده باشد، به‌محض اینکه در دسترس بودن بسته‌ها صرفاً از طریق متغیرهای سراسری تعریف‌شده قابل حل نباشد، در دسترس بودن آن‌ها مفروض دانسته می‌شود. توجه داشته باشید که مگر در صورت بازنویسی، متغیرهایی مانند 'root' یا 'opam-version' ممکن است از نصب فعلی opam برداشته شوند. آنچه در ~/.opam/config تعریف شده است همیشه نادیده گرفته می‌شود.

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

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

-a, --available: فهرست کردن تنها بسته‌هایی که با توجه به environment تعریف‌شده در دسترس هستند. بدون --environment، این گزینه شامل هر بسته‌ای خواهد بود که در دسترس بودن آن در این نقطه قابل حل نباشد.
-A, --all: گنجاندن همه، حتی بسته‌های نصب‌نشده یا غیرقابل‌دسترس
--installable: فهرست کردن تنها بسته‌هایی که با توجه به environment تعریف‌شده قابل نصب هستند (این گزینه حل‌کننده را فراخوانی می‌کند و ممکن است هزینه‌برتر باشد؛ بسته‌ای که به یک بستهٔ غیرقابل‌دسترس وابسته است ممکن است در دسترس باشد، اما هرگز قابل نصب نیست)
--latests-only: فهرست کردن تنها آخرین نسخه از هر بسته.

گزینه‌های انتخاب بسته (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: تنها بسته‌هایی لحاظ شوند که برچسب داده‌شده برای آن‌ها تنظیم شده است
--nobuild: مستثنی کردن وابستگی‌های ساخت (به‌طور پیش‌فرض لحاظ می‌شوند).
--or: به‌جای انتخاب بسته‌هایی که با همهٔ معیارها مطابقت دارند، بسته‌هایی را انتخاب می‌کند که با هر کدام از آن‌ها مطابقت داشته باشند
--post: گنجاندن وابستگی‌های برچسب‌خورده به‌عنوان post.
--recursive: به همراه `--depends-on' و `--required-by'، به‌جای صرفاً وابستگی‌های مستقیم، تمام وابستگی‌های تراگذری را نمایش می‌دهد.
--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.
--normalise: چاپ مقادیر فیلدهای opam به‌صورت نرمال‌شده
-S, --sort: مرتب‌سازی بسته‌ها بر اساس ترتیب وابستگی (یعنی ترتیبی که در آن بتوان هر یک را به‌صورت جداگانه نصب کرد.)
-s, --short: سربرگ را چاپ نمی‌کند و ستون‌های پیش‌فرض را تنها روی name قرار می‌دهد. اگر به درج نسخه‌های بسته نیاز دارید، به‌جای آن از --columns=package استفاده کنید
--separator=STRING (absent= ): تنظیم رشتهٔ جداکنندهٔ ستون‌ها
-V, --all-versions: در حالت عادی، هنگامی که چند نسخه از یک بسته مطابقت داشته باشند، تنها یک نسخه در خروجی نشان داده می‌شود (نسخهٔ نصب‌شده، نسخهٔ پین‌شده، یا در صورت نبود آن‌ها، بالاترین نسخهٔ در دسترس یا بالاترین نسخه). این پرچم این رفتار را غیرفعال کرده و همهٔ نسخه‌های منطبق را نشان می‌دهد. همچنین قالب پیش‌فرض نمایش را تغییر می‌دهد تا به‌جای تنها نام بسته‌ها، نسخه‌های بسته را نیز در بر بگیرد (حتی زمانی که --short تنظیم شده باشد). این گزینه به‌طور خودکار در صورتی فعال می‌شود که یک نام بستهٔ منفرد و بدون الگو در خط فرمان وارد شود.
--wrap: شکستن خطوط طولانی؛ پیش‌فرض این است که هنگام نمایش در ترمینال بریده شود، یا در غیر این صورت همان‌گونه که هست نگه داشته شود

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

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

--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: مشخص کردن ترجیحات کاربر برای حل وابستگی‌ها در این اجرا. بر مقادیر $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: نادیده گرفتن پین‌های اضافی مورد نیاز بسته‌هایی که پین می‌شوند، چه به‌طور دستی از طریق 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: اطمینان از اینکه هیچ چیزی به‌طور خودکار به‌روزرسانی یا بازنویسی نخواهد شد. برای نمونه برای فراخوانی از اسکریپت‌های تکمیل خودکار (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 به‌عنوان سوئیچ کامپایلر فعلی. این معادل تنظیم $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" است..SH "محیط (ENVIRONMENT)"

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

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

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

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

OPAMAUTOREMOVE گزینه remove با عنوان `--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 حداکثر تعداد پردازش‌های موازی (workers) را برای اجرا مشخص می‌کند.

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

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

OPAMKEEPLOGS به opam اعلام می‌کند که برخی از گزارش‌های موقت دستورات و برخی نسخه‌های پشتیبان را حذف نکند. این کار اجرای برخی از بخش‌های نهایی‌ساز را نادیده می‌گیرد و ممکن است به دریافت ردگیری‌های معکوس (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 تعیین می‌کند که آیا هنگام پین کردن به یک مسیر محلی، سیستم‌های کنترل نسخه شناسایی شوند یا خیر. از نگارش 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') به برخی حل‌کننده‌ها اجازه می‌دهد پس از اتمام مهلت زمانی، همچنان یک راه‌حل ارائه دهند؛ هرچند تضمین می‌شود که راه‌حل سازگار است، اما هیچ تضمینی وجود ندارد که با معیارهای بهینه‌سازی مورد انتظار تطابق داشته باشد. اگر `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 را بازنویسی می‌کند..SH "نسخه خط فرمان (CLI VERSION)"

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

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

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