نام (NAME)

typst-compile - کامپایل یک فایل ورودی به یکی از قالب‌های خروجی پشتیبانی‌شده

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

typst-compile [-f|--format] [--root] [--input] [--font-path] [--ignore-system-fonts] [--ignore-embedded-fonts] [--package-path] [--package-cache-path] [--creation-timestamp] [--pretty] [--pages] [--pdf-standard] [--no-pdf-tags] [--ppi] [--deps] [--deps-format] [-j|--jobs] [--features] [--diagnostic-format] [--open] [--timings] [-h|--help] <INPUT> [OUTPUT]

توضیحات (DESCRIPTION)

یک فایل ورودی را به یکی از قالب‌های خروجی پشتیبانی‌شده کامپایل می‌کند.

گزینه‌ها (OPTIONS)

-f, --format <FORMAT>

قالب فایل خروجی؛ به‌طور پیش‌فرض از پسوند فایل تشخیص داده می‌شود.

مقادیر ممکن:

--root <DIR>

ریشه پروژه را (برای مسیرهای مطلق) پیکربندی می‌کند.

--input <key=value>

یک جفت کلید-مقدار رشته‌ای اضافه می‌کند که از طریق `sys.inputs` قابل دسترسی است.

--font-path <DIR>

دایرکتوری‌های دیگری را اضافه می‌کند که قلم‌ها به‌صورت بازگشتی در آن‌ها جستجو می‌شوند.

اگر چند مسیر مشخص شده باشد، با جداکننده مسیر سیستم (در سیستم‌های شبه‌یونیکس `:` و در ویندوز `;`) از هم جدا می‌شوند.

--ignore-system-fonts

تضمین می‌کند که قلم‌های سیستم جستجو نخواهند شد، مگر اینکه صریحاً از طریق `--font-path` وارد شده باشند.

--ignore-embedded-fonts

تضمین می‌کند که قلم‌های تعبیه‌شده در Typst در نظر گرفته نخواهند شد.

--package-path <DIR>

مسیر سفارشی برای بسته‌های محلی؛ به‌طور پیش‌فرض به مکانی وابسته به سیستم تعیین می‌شود.

--package-cache-path <DIR>

مسیر سفارشی برای حافظه موقت (کَش) بسته‌ها؛ به‌طور پیش‌فرض به مکانی وابسته به سیستم تعیین می‌شود.

--creation-timestamp <UNIX_TIMESTAMP>

تاریخ ایجاد سند در قالب برچسب زمانی یونیکس (UNIX timestamp).

برای اطلاعات بیشتر، https://reproducible-builds.org/specs/source-date-epoch را ببینید.

--pretty

خروجی تولیدشده زیبانگاری (pretty-print) شود یا خیر.

این گزینه خروجی را به شیوه‌ای خواناتر برای انسان اما با بهره‌وری فضای کمتر قالب‌بندی می‌کند. بر صدور خروجی‌های HTML، SVG و PDF تأثیر می‌گذارد، اما بر صدور PNG بی‌تأثیر است.

--pages <PAGES>

صفحاتی که باید صادر شوند. در صورت عدم تعیین، تمام صفحات صادر می‌شوند.

صفحات برای صدور با کاما از هم جدا می‌شوند و می‌توانند شماره صفحات ساده باشند (مانند '2,5' تنها برای صادر کردن صفحات ۲ و ۵) یا بازه‌ای از صفحات (مانند '2,3-6,8-' برای صادر کردن صفحه ۲، صفحات ۳ تا ۶ (شامل خود آن‌ها)، صفحه ۸ و تمام صفحات پس از آن).

شماره صفحات از یک شروع می‌شوند و متناظر با شماره صفحات فیزیکی در سند هستند (بنابراین تحت تأثیر شمارنده صفحه داخلی سند قرار نمی‌گیرند).

--pdf-standard <PDF_STANDARD>

یک یا چند استاندارد PDF (جداشده با کاما) که Typst مطابقت با آن‌ها را اعمال می‌کند.

مقادیر ممکن:

--no-pdf-tags

به‌طور پیش‌فرض، حتی زمانی که یک سند `PDF/UA-1` تولید نمی‌شود، یک سند PDF برچسب‌دار (tagged) نوشته می‌شود تا پایه دسترسی‌پذیری فراهم گردد. در برخی شرایط (برای مثال هنگام تلاش برای کاهش حجم سند) ممکن است غیرفعال کردن PDF برچسب‌دار مطلوب باشد.

--ppi <PPI> [پیش‌فرض: 144]

میزان PPI (پیکسل بر اینچ) برای صدور خروجی PNG.

--deps <PATH>

مسیر فایلی که فهرستی از وابستگی‌های کامپایل فعلی در آن نوشته خواهد شد. برای نوشتن در stdout از `-` استفاده کنید.

--deps-format <DEPS_FORMAT> [پیش‌فرض: json]

قالب فایل مورد استفاده برای وابستگی‌ها.

مقادیر ممکن:

-j, --jobs <JOBS>

تعداد پردازش‌های موازی ایجادشده در طول کامپایل. مقدار پیش‌فرض تعداد پردازنده‌ها (CPU) است. مقدار 1 پردازش موازی را غیرفعال می‌کند.

--features <FEATURES>

قابلیت‌های در حال توسعه را فعال می‌کند که ممکن است در هر زمانی تغییر کرده یا حذف شوند.

مقادیر ممکن:

--diagnostic-format <DIAGNOSTIC_FORMAT> [پیش‌فرض: human]

قالبی که خطایابی‌ها در آن ارائه می‌شوند.

مقادیر ممکن:

--open [<VIEWER>]

پس از کامپایل، فایل خروجی را با نمایش‌دهنده پیش‌فرض یا برنامه‌ای خاص باز می‌کند. اگر خروجی stdout باشد نادیده گرفته می‌شود.

--timings <OUTPUT_JSON>

زمان‌بندی‌های کارایی فرایند کامپایل را تولید می‌کند. (آزمایشی)

فایل JSON حاصل را می‌توان در ابزارهای ردیابی مانند https://ui.perfetto.dev بارگذاری کرد. این فایل به جز نام فایل‌ها و شماره خطوط، حاوی هیچ اطلاعات حساسی نیست.

-h, --help

نمایش راهنما (مشاهده خلاصه با '-h').

<INPUT>

مسیر فایل ورودی Typst. برای خواندن ورودی از stdin از `-` استفاده کنید.

[OUTPUT]

مسیر فایل خروجی (PDF، PNG، SVG، یا HTML). برای نوشتن خروجی در stdout از `-` استفاده کنید.

برای قالب‌های خروجی که به ازای هر صفحه یک فایل تولید می‌کنند (PNG و SVG)، در صورتی که سند مبدأ به چندین صفحه تبدیل شود، باید یک الگوی شماره صفحه وجود داشته باشد. از `{p}` برای شماره صفحه، از `{0p}` برای شماره صفحه پر شده با صفر (zero padded) و از `{t}` برای تعداد کل صفحات استفاده کنید. برای مثال، `page-{0p}-of-{t}.png` فایل‌های `page-01-of-10.png`، `page-02-of-10.png` و غیره را ایجاد می‌کند.