نام (NAME)

ocamlbuild - ابزار کامپایل و ساخت پروژه‌های OCaml

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

ocamlbuild [ -Is dir1,... ] [ -libs lib1,... ] [ -lflags flag1,... ] [ -pp flags ] [ -tags tag1,... ] [ -j parallel-jobs ] target.native [ -- arg1 arg2 ... ]

(همان گزینه‌ها)

توضیحات (DESCRIPTION)

ocamlbuild(1) فرآیند کامپایل پروژه OCaml شما را مدیریت و هماهنگ می‌کند. عملکرد آن مشابه make(1) است، با این تفاوت که به‌طور اختصاصی برای کامپایل خودکار بیشتر پروژه‌های OCaml با کمترین ورودی از سوی کاربر طراحی شده است.

ocamlbuild باید در ریشه درخت یک پروژه پاک (به‌عنوان مثال، بدون فایل‌های کامپایل باقی‌مانده) اجرا شود. با مشخص کردن یک یا چند هدف برای کامپایل، زیرپوشه‌های لازم را جهت جمع‌آوری اطلاعات درباره فایل‌های مختلف موجود پویش می‌کند، ابزارهایی مانند ocamldep(1) را برای استخراج اطلاعات وابستگی اجرا می‌نماید، و فایل‌های اختیاری را که رفتار آن را دقیق‌تر تنظیم می‌کنند گردآوری می‌کند. نام‌های هدف بسیار بااهمیت هستند.

نام‌های هدف (TARGET NAMES)

ocamlbuild از مجموعه‌ای از قراردادهای نام‌گذاری هدف برای تعیین نوع اشیای تولیدی استفاده می‌کند. نام‌های هدف به شکل base.extension هستند که در آن base معمولاً نام ماژول پایه OCaml است و extension نوع شیئی را که قرار است از آن فایل تولید شود مشخص می‌کند -- یک فایل اجرایی بایت‌کد، یک فایل اجرایی نیتیو (native)، مستندات و غیره. البته پسوندهایی مانند .cmo, .cma, .cmi... به معادل‌های معمول خود نگاشت می‌شوند. در اینجا فهرستی از مهم‌ترین پسوندهای ویژه ocamlbuild آورده شده است:

.native: فایل اجرایی کد نیتیو (Native)
.byte: فایل اجرایی بایت‌کد (Bytecode)
.inferred.mli: رابط استنتاج‌شده با ocamlc-i
.docdir/index.html: مستندات HTML تولیدشده با ocamldoc
گزینه‌های خط فرمان زیر توسط ocamlbuild(1) شناخته می‌شوند.
-version: نمایش نسخه
--version: همانند -version
-vnum: نمایش شماره نسخه
--vnum: همانند -vnum
-quiet: به حداقل رساندن پیام‌های خروجی تا جای ممکن
-verbose <level>: تنظیم سطح پرگویی خروجی در مقیاسی از 0 تا 8 (شامل هر دو)
-documentation: نمایش قوانین و پرچم‌ها
-log <file>: تعیین فایل گزارش (log)
-no-log: بدون فایل گزارش
-clean: حذف دایرکتوری ساخت و سایر فایل‌ها، سپس خروج
-r: پیمایش دایرکتوری‌ها به‌صورت پیش‌فرض (درست: پیمایش)
-I <path>: افزودن به دایرکتوری‌های include
-Is <path,...>: (همانند بالا، اما فهرستی جداشده با کاما یا فاصله را می‌پذیرد)
-X <path>: دایرکتوری برای نادیده‌گرفتن
-Xs <path,...>: (همانند بالا)
-lib <flag>: پیوند به این کتابخانه ocaml
-libs <flag,...>: (همانند بالا)
-mod <module>: پیوند به این ماژول ocaml
-mods <module,...>: (همانند بالا)
-pkg <package>: پیوند به این بسته findlib ocaml
-pkgs <package,...>: (همانند بالا)
-package <package>: (همانند بالا)
-syntax <syntax>: مشخص‌کردن نحو با استفاده از ocamlfind
-lflag <flag>: افزودن به پرچم‌های پیونددهی ocamlc
-lflags <flag,...>: (همانند بالا)
-cflag <flag>: افزودن به پرچم‌های کامپایل ocamlc
-cflags <flag,...>: (همانند بالا)
-docflag <flag>: افزودن به پرچم‌های ocamldoc
-docflags <flag,...>: (همانند بالا)
-yaccflag <flag>: افزودن به پرچم‌های ocamlyacc
-yaccflags <flag,...>: (همانند بالا)
-lexflag <flag>: افزودن به پرچم‌های ocamllex
-lexflags <flag,...>: (همانند بالا)
-ppflag <flag>: افزودن به پرچم‌های پیش‌پردازش ocaml
-pp <flag,...>: (همانند بالا)
-tag <tag>: افزودن به برچسب‌های پیش‌فرض
-tags <tag,...>: (همانند بالا)
-plugin-tag <tag>: استفاده از این برچسب هنگام کامپایل افزونه myocamlbuild.ml
-plugin-tags <tag,...>: (همانند بالا)
-tag-line <tag>: استفاده از این سطر برچسب‌ها (مشابه فایل _tags)
-show-tags <path>: نمایش برچسب‌هایی که برای آن مسیر اعمال می‌شوند
-ignore <module,...>: عدم تلاش برای ساخت این ماژول‌ها
-no-links: عدم ایجاد پیوند برای هدف‌های نهایی تولیدشده
-no-skip: رد نکردن ماژول‌هایی که توسط ocamldep درخواست شده‌اند اما قابل ساخت نیستند
-no-hygiene: عدم اعمال قوانین بررسی سلامت (sanity-check)
-no-plugin: عدم ساخت myocamlbuild.ml
-no-stdlib: نادیده نگرفتن ماژول‌های stdlib
-dont-catch-errors: عدم گرفتن و نمایش استثناها (مفید برای نمایش پشته فراخوانی)
-just-plugin: تنها myocamlbuild.ml ساخته شود
-byte-plugin: استفاده از بایت‌کد به‌جای افزونه بومی (native)
-plugin-option: استفاده از این گزینه تنها در زمان اجرای افزونه
-sanitization-script: تغییر نام فایل اسکریپت پاک‌سازی ایجادشده
-no-sanitize: عدم ایجاد اسکریپت پاک‌سازی
-nothing-should-be-rebuilt: شکست در صورت نیاز به بازسازی هر چیزی
-classic-display: نمایش دستورهای اجراشده به روش قدیمی
-use-menhir: استفاده از menhir به‌جای ocamlyacc
-use-jocaml: استفاده از کامپایلرهای jocaml به‌جای کامپایلرهای ocaml
-use-ocamlfind: استفاده از پوشش‌دهنده 'ocamlfind' به‌جای استفاده مستقیم از Findlib برای تعیین آرگومان‌های خط فرمان. برای غیرفعال‌کردن از -no-ocamlfind استفاده کنید. مستلزم -plugin-use-ocamlfind است.
-no-ocamlfind: عدم استفاده از ocamlfind. مستلزم -plugin-no-ocamlfind است..TP -plugin-use-ocamlfind استفاده از لفاف 'ocamlfind' برای ساخت myocamlbuild.ml
-plugin-no-ocamlfind: عدم استفاده از ocamlfind برای ساخت myocamlbuild.ml
-toolchain <toolchain>: تنظیم زنجیره ابزار Findlib مورد استفاده. برای ساخت myocamlbuild.ml همواره از زنجیره ابزار پیش‌فرض استفاده می‌شود.
-j <N>: اجازه دادن به N کار به صورت هم‌زمان (۰ برای نامحدود)
-build-dir <path>: تنظیم دایرکتوری ساخت (مستلزم no-links)
-install-lib-dir <path>: تنظیم دایرکتوری کتابخانه‌های نصبی
-install-bin-dir <path>: تنظیم دایرکتوری باینری‌های نصبی
-where: نمایش دایرکتوری کتابخانه‌های نصبی
-which <command>: نمایش مسیر دستور ابزار
-ocamlc <command>: تنظیم کامپایلر بایت‌کد OCaml
-plugin-ocamlc <command>: تنظیم کامپایلر بایت‌کد OCaml مورد استفاده برای ساخت myocamlbuild.ml (فقط)
-ocamlopt <command>: تنظیم کامپایلر بومی OCaml
-plugin-ocamlopt <command>: تنظیم کامپایلر بومی OCaml مورد استفاده برای ساخت myocamlbuild.ml (فقط)
-ocamldep <command>: تنظیم ابزار وابستگی OCaml
-ocamldoc <command>: تنظیم تولیدکننده مستندات OCaml
-ocamlyacc <command>: تنظیم ابزار ocamlyacc
-menhir <command>: تنظیم ابزار menhir (پس از -use-menhir استفاده شود)
-ocamllex <command>: تنظیم ابزار ocamllex
-ocamlmklib <command>: تنظیم ابزار ocamlmklib
-ocamlmktop <command>: تنظیم ابزار ocamlmktop
-ocamlrun <command>: تنظیم ابزار ocamlrun
--: توقف پردازش آرگومان‌ها؛ آرگومان‌های باقی‌مانده به برنامه کاربر داده می‌شوند
-help: نمایش این فهرست از گزینه‌ها
--help: نمایش این فهرست از گزینه‌ها

همچنین ببینید (SEE ALSO)

راهنمای ocamlbuild، ocaml(1)، make(1).
راهنمای کاربر OCaml، فصل “Batch compilation”.