نام (NAME)

typst-watch - پایش فایل ورودی و کامپایل مجدد آن هنگام اعمال تغییرات

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

typst-watch [-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] [--no-serve] [--no-reload] [--port] [-h|--help] <INPUT> [OUTPUT]

توضیحات (DESCRIPTION)

فایل ورودی را پایش می‌کند و در صورت ایجاد تغییرات، آن را مجدداً کامپایل می‌نماید.

گزینه‌ها (OPTIONS)

-f, --format <FORMAT>: قالب فایل خروجی؛ به‌طور پیش‌فرض از روی پسوند نام فایل تشخیص داده می‌شود.
مقادیر ممکن:

pdf
png
svg
html
bundle

--root <DIR>: ریشه پروژه را پیکربندی می‌کند (برای مسیرهای مطلق)

همچنین می‌تواند از طریق متغیر محیطی TYPST_ROOT تعیین شود.

--input <key=value>: یک جفت کلید-مقدار رشته‌ای که از طریق `sys.inputs` قابل دستیابی است اضافه می‌کند
--font-path <DIR>: پوشه‌های بیشتری را اضافه می‌کند که به‌صورت بازگشتی برای یافتن قلم‌ها جستجو می‌شوند.
اگر چند مسیر مشخص شوند، با جداکننده مسیر سیستم (در سیستم‌های شبه‌یونیکس `:` و در ویندوز `;`) از یکدیگر جدا می‌شوند.

همچنین می‌تواند از طریق متغیر محیطی TYPST_FONT_PATHS تعیین شود.

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

همچنین می‌تواند از طریق متغیر محیطی TYPST_IGNORE_SYSTEM_FONTS تعیین شود.

--ignore-embedded-fonts: تضمین می‌کند که قلم‌های تعبیه‌شده در Typst در نظر گرفته نشوند

همچنین می‌تواند از طریق متغیر محیطی TYPST_IGNORE_EMBEDDED_FONTS تعیین شود.

--package-path <DIR>: مسیر سفارشی بسته‌های محلی؛ پیش‌فرض به مکان وابسته به سیستم است

همچنین می‌تواند از طریق متغیر محیطی TYPST_PACKAGE_PATH تعیین شود.

--package-cache-path <DIR>: مسیر سفارشی حافظه پنهان بسته‌ها؛ پیش‌فرض به مکان وابسته به سیستم است

همچنین می‌تواند از طریق متغیر محیطی TYPST_PACKAGE_CACHE_PATH تعیین شود.

--creation-timestamp <UNIX_TIMESTAMP>: تاریخ ایجاد سند در قالب برچسب زمانی یونیکس (UNIX timestamp).
برای اطلاعات بیشتر، https://reproducible-builds.org/specs/source-date-epoch را ببینید.

همچنین می‌تواند از طریق متغیر محیطی SOURCE_DATE_EPOCH تعیین شود.

--pretty

آیا خروجی تولیدشده به شکل مرتب و خوانا (pretty-print) قالب‌بندی شود یا خیر.

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

--pages <PAGES>

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

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

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

--pdf-standard <PDF_STANDARD>

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

مقادیر ممکن:

1.4: PDF 1.4
1.5: PDF 1.5
1.6: PDF 1.6
1.7: PDF 1.7
2.0: PDF 2.0
a-1b: PDF/A-1b
a-1a: PDF/A-1a
a-2b: PDF/A-2b
a-2u: PDF/A-2u
a-2a: PDF/A-2a
a-3b: PDF/A-3b
a-3u: PDF/A-3u
a-3a: PDF/A-3a
a-4: PDF/A-4
a-4f: PDF/A-4f
a-4e: PDF/A-4e
ua-1: PDF/UA-1

--no-pdf-tags: به‌طور پیش‌فرض، حتی در صورت عدم تولید سند `PDF/UA-1`، یک سند PDF برچسب‌گذاری‌شده (tagged PDF) ایجاد می‌شود تا سطح پایه‌ای از دسترسی‌پذیری فراهم گردد. در برخی شرایط (برای نمونه هنگام تلاش برای کاهش حجم سند) ممکن است غیرفعال کردن PDF برچسب‌گذاری‌شده مطلوب باشد
--ppi <PPI> [پیش‌فرض: 144]: مقدار PPI (پیکسل بر اینچ) مورد استفاده برای صدور PNG
--deps <PATH>: مسیر فایلی که فهرستی از وابستگی‌های کامپایل فعلی در آن نوشته خواهد شد. برای نوشتن در stdout از `-` استفاده کنید
--deps-format <DEPS_FORMAT> [پیش‌فرض: json]: قالب فایل مورد استفاده برای وابستگی‌ها
مقادیر ممکن:

json: کدگذاری به‌صورت JSON؛ برای مسیرهای غیر یونیکد ناموفق خواهد بود
zero: مسیرها را با بایت‌های NULL جدا می‌کند و قادر است تمامی مسیرها را نمایش دهد
make: در قالب Make خروجی می‌دهد و مسیرهای غیرقابل‌بیان را نادیده می‌گیرد

-j, --jobs <JOBS>: تعداد پردازش‌های موازی ایجادشده هنگام کامپایل. پیش‌فرض برابر با تعداد پردازنده‌ها است. تنظیم آن روی ۱ پردازش موازی را غیرفعال می‌کند
--features <FEATURES>: ویژگی‌های در حال توسعه را فعال می‌کند که ممکن است هر زمانی تغییر کنند یا حذف شوند
مقادیر ممکن:

html
bundle
a11y-extras

همچنین می‌تواند از طریق متغیر محیطی TYPST_FEATURES تعیین شود.

--diagnostic-format <DIAGNOSTIC_FORMAT> [پیش‌فرض: human]: قالبی که پیام‌های تشخیصی در آن صادر می‌شوند
مقادیر ممکن:

human
short

--open [<VIEWER>]: پس از کامپایل، فایل خروجی را با نمایشگر پیش‌فرض یا برنامه‌ای خاص باز می‌کند. در صورتی که خروجی stdout باشد نادیده گرفته می‌شود
--timings <OUTPUT_JSON>: زمان‌بندی‌های کارایی فرایند کامپایل را تولید می‌کند. (آزمایشی)
فایل JSON حاصل را می‌توان در یک ابزار ردگیری مانند https://ui.perfetto.dev بارگذاری کرد. این فایل به جز نام فایل‌ها و شماره خطوط، حاوی هیچ اطلاعات حساسی نیست.
--no-serve: سرور HTTP داخلی را برای صدور HTML غیرفعال می‌کند
--no-reload: اسکریپت تزریق‌شده برای بارگذاری مجدد زنده (live reload) را برای صدور HTML غیرفعال می‌کند. در هر صورت، فایل HTML ذخیره‌شده بر روی دیسک تحت تأثیر قرار نمی‌گیرد
--port <PORT>: درگاهی که HTML روی آن ارائه می‌شود.
به‌طور پیش‌فرض اولین درگاه آزاد در بازه 3000-3005 انتخاب می‌شود.
-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` و مانند آن را ایجاد می‌کند.

typst-watch