.Dd $Mdocdate$
.Dt d2 1
.Os
.Sh "نام (NAME)"
.Nm d2
.Nd کامپایل و رندر دیاگرام‌های d2 به svg
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm d2
.Op Fl -watch Ar false
.Op Fl -theme Em 0
.Op Fl -salt Ar string
.Ar file.d2
.Op Ar file.svg | file.png | file.pdf | file.pptx | file.gif | file.txt
.Nm d2
.Ar layout Op Ar name
.Nm d2
.Ar fmt Ar file.d2 ...
.Nm d2
.Ar play Ar file.d2
.Nm d2
.Ar validate Ar file.d2
.Sh "توضیحات (DESCRIPTION)"
دستور
.Nm
فایل
.Ar file.d2
را به
.Ar file.svg
|
.Ar file.png
|
.Ar file.pdf
|
.Ar file.pptx
|
.Ar file.gif
|
.Ar file.txt
کامپایل و رندر می‌کند.
.Pp
اگر مسیر خروجی داده نشود، پیش‌فرض
.Ar file.svg
است.
.Pp
برای خواندن از stdin یا نوشتن در stdout، مقدار - را ارسال کنید.
.Pp
هرگز از وجود فایل خروجی برای بررسی موفقیت استفاده نکنید. همیشه از وضعیت خروج
.Nm d2
استفاده کنید. دلیل این امر این است که گاهی اوقات هنگام بروز خطا در زمان رندر، d2 همچنان خروجی رندر جزئی را می‌نویسد تا امکان اصلاح و تکرار روی دیاگرام خراب فراهم شود.
.Pp
مستندات بیشتر، کد منبع و مجوز را در
.Lk https://github.com/d2lang/d2
ببینید.
.Pp
آیکون‌های میزبانی‌شده در
.Lk https://icons.d2lang.com
.Pp
محیط اجرای آنلاین (Playground) در
.Lk https://play.d2lang.com
.Sh "گزینه‌ها (OPTIONS)"
.Bl -tag -width Fl
.It Fl w , -watch Ar false
پایش تغییرات فایل ورودی و بارگذاری مجدد زنده. از
.Ev $PORT
و
.Ev $HOST
برای تعیین آدرس گوش دادن استفاده کنید.
.It Fl h , -host Ar localhost
آدرس گوش دادن میزبان در هنگام استفاده به همراه
.Ar watch
.Ns .
.It Fl p , -port Ar 0
پورت گوش دادن در هنگام استفاده به همراه
.Ar watch
.Ns .
.It Fl t , -theme Ar 0
تنظیم شناسه پوسته (تم) دیاگرام.
.It Fl -dark-theme Ar -1
پوسته‌ای که در صورت فعال بودن حالت تاریک در مرورگر بیننده استفاده می‌شود. اگر تنظیم نشود،
.Fl -theme
هم برای حالت روشن و هم تاریک استفاده خواهد شد. توجه داشته باشید که استایل‌های صریح تنظیم‌شده در کد D2 همچنان اعمال می‌شوند و ممکن است نتایج غیرمنتظره‌ای ایجاد کنند. ما قصد داریم این مشکل را با اختصاصی‌سازی نقشه‌های استایل در حالت روشن/تاریک D2 حل کنیم. ببینید:
.Lk https://github.com/d2lang/d2/issues/831
.Ns .
.It Fl s , -sketch Ar false
رندر کردن دیاگرام به شکلی که انگار با دست طراحی شده است.
.It Fl -center Ar flag
قرار دادن SVG در مرکز کادر نمایش ظرف (viewbox)، مانند صفحه مرورگر شما.
.It Fl -scale Ar -1
مقیاس‌بندی خروجی. برای نمونه، 0.5 برای نصف کردن اندازه پیش‌فرض. مقدار پیش‌فرض -1 به این معنی است که SVGها با صفحه تطبیق داده می‌شوند و سایر فرمت‌ها از اندازه پیش‌فرض رندر خود استفاده خواهند کرد. تنظیم روی 1 تطبیق SVG با اندازه صفحه را خاموش می‌کند.
.It Fl -font-regular
مسیر فایل .ttf برای قلم عادی (regular). در صورت عدم ارائه، از Source Sans Pro Regular استفاده می‌شود.
.It Fl -font-italic
مسیر فایل .ttf برای قلم مورب (italic). در صورت عدم ارائه، از Source Sans Pro Regular-Italic استفاده می‌شود.
.It Fl -font-bold
مسیر فایل .ttf برای قلم توپر (bold). در صورت عدم ارائه، از Source Sans Pro Bold استفاده می‌شود.
.It Fl -font-semibold
مسیر فایل .ttf برای قلم نیمه‌توپر (semibold). در صورت عدم ارائه، از Source Sans Pro Semibold استفاده می‌شود.
.It Fl -font-mono
مسیر فایل .ttf برای قلم تک‌فاصله (monospace). در صورت عدم ارائه، از Source Code Pro Regular استفاده می‌شود.
.It Fl -font-mono-bold
مسیر فایل .ttf برای قلم تک‌فاصله توپر (monospace bold). در صورت عدم ارائه، از Source Code Pro Bold استفاده می‌شود.
.It Fl -font-mono-italic
مسیر فایل .ttf برای قلم تک‌فاصله مورب (monospace italic). در صورت عدم ارائه، از Source Code Pro Italic استفاده می‌شود.
.It Fl -font-mono-semibold
مسیر فایل .ttf برای قلم تک‌فاصله نیمه‌توپر (monospace semibold). در صورت عدم ارائه، از Source Code Pro Semibold استفاده می‌شود.
.It Fl -pad Ar 100
فاصله درونی (حاشیه امن به پیکسل) پیرامون دیاگرام رندرشده.
.It Fl -animate-interval Ar 0
در صورت تعیین، چندین برد به صورت یک فایل SVG بسته‌بندی می‌شوند که با این فاصله زمانی (به میلی‌ثانیه) بین هر برد جابجا می‌شود. فقط با خروجی‌های SVG یا GIF قابل استفاده است. برای خروجی‌های GIF، در صورت عدم تعیین، مقدار پیش‌فرض ۱۰۰۰ میلی‌ثانیه است.
.It Fl -browser Ar true
فایل اجرایی مرورگری که دستور پایش باز می‌کند. تنظیم روی 0 هیچ مرورگری را باز نمی‌کند.
.It Fl l , -layout Ar dagre
تنظیم موتور چیدمان دیاگرام به رشته ارائه‌شده. برای مشاهده فهرست گزینه‌های موجود، دستور
.Ar layout
را اجرا کنید.
.It Fl b , -bundle Ar true
بسته‌بندی تمام دارایی‌ها و لایه‌ها در فایل خروجی svg.
.It Fl -force-appendix Ar false
پیوستی برای نکات ابزار (tooltips) و پیوندها به خروجی‌های PNG اضافه می‌شود زیرا تعاملی نیستند. تنظیم این گزینه روی true، پیوست را به خروجی‌های SVG نیز اضافه می‌کند.
.It Fl -target
برد هدف برای رندر کردن. برای هدف قرار دادن برد ریشه، یک رشته خالی ارسال کنید. اگر هدف با '*' خاتمه یابد، همراه با تمام سناریوها، مراحل و لایه‌هایش رندر می‌شود. در غیر این صورت، تنها برد هدف رندر خواهد شد. برای مثال --target='' فقط برای رندر کردن برد ریشه یا --target='layers.x.*' برای رندر لایهٔ 'x' همراه با تمام فرزندان آن.
.It Fl d , -debug
چاپ گزارش‌های اشکال‌زدایی.
.It Fl -img-cache Ar true
در حالت پایش، تصاویر استفاده‌شده در آیکون‌ها برای کامپایل‌های بعدی ذخیره می‌شوند (cache). اگر احتمال تغییر تصاویر وجود دارد، این گزینه باید غیرفعال شود.
.It Fl -timeout Ar 120
حداکثر زمان اجرا (به ثانیه) برای D2 پیش از اتمام مهلت و خروج. هنگام رندر دیاگرام‌های بزرگ، افزایش این مقدار توصیه می‌شود.
.It Fl -check Ar false
بررسی اینکه آیا فایل‌های مشخص‌شده به درستی قالب‌بندی شده‌اند یا خیر.
.It Fl -salt Ar string
افزودن مقدار سالت (salt) برای اطمینان از استفاده خروجی از شناسه‌های یکتا. این گزینه هنگام تولید چندین دیاگرام مشابه برای قرار گرفتن در یک سند HTML کاربرد دارد تا شناسه‌های تکراری باعث نامعتبر شدن HTML نشوند. مقدار سالت رشته‌ای است که به شناسه‌ها در خروجی اضافه خواهد شد.
.It Fl h , -help
چاپ اطلاعات نحوه استفاده و خروج.
.It Fl v , -version
چاپ اطلاعات نسخه و خروج.
.It Fl -stdout-format Ar string
تنظیم قالب خروجی هنگام نوشتن در خروجی استاندارد (stdout). قالب‌های پشتیبانی‌شده: png, svg, ascii, txt, pdf, pptx, gif. فقط زمانی استفاده می‌شود که خروجی روی stdout (-) تنظیم شده باشد.
.It Fl -no-xml-tag Ar false
حذف تگ XML (مانند <?xml ...?>) از فایل‌های خروجی SVG. برای تولید SVG جهت قرار دادن مستقیم در HTML مفید است.
.It Fl -omit-version Ar false
حذف نسخه D2 از تصویر تولیدشده.
.It Fl -ascii-mode Ar extended
حالت رندر ASCII برای خروجی‌های متنی. گزینه‌ها: 'standard' (کاراکترهای پایه ASCII) یا 'extended' (کاراکترهای یونیکد).
.El
.Sh "زیردستورها (SUBCOMMANDS)"
.Bl -tag -width Fl
.It Ar layout
فهرست کردن گزینه‌های موجود موتورهای چیدمان همراه با راهنمای کوتاه.
.It Ar layout Op Ar name
نمایش راهنمای کامل برای یک موتور چیدمان خاص، شامل گزینه‌های پیکربندی آن.
.It Ar themes
فهرست کردن پوسته‌های در دسترس.
.It Ar fmt Ar file.d2 ...
قالب‌بندی تمام فایل‌های ارسال‌شده.
.It Ar play Ar file.d2
باز کردن فایل در playground، یک نمایشگر وب آنلاین (https://play.d2lang.com)
.It Ar validate Ar file.d2
اعتبارسنجی فایل file.d2.
.El
.Sh "متغیرهای محیطی (ENVIRONMENT VARIABLES)"
بسیاری از فلگ‌ها را می‌توان با متغیرهای محیطی نیز تنظیم کرد.
.Bl -tag -width Ds
.It Ev Sy D2_WATCH
فلگ -w[atch] را ببینید.
.It Ev Sy D2_LAYOUT
فلگ -l[ayout] را ببینید.
.It Ev Sy D2_THEME
فلگ -t[heme] را ببینید.
.It Ev Sy D2_DARK_THEME
فلگ --dark-theme را ببینید.
.It Ev Sy D2_PAD
فلگ --pad را ببینید.
.It Ev Sy D2_CENTER
فلگ --center را ببینید.
.It Ev Sy D2_SKETCH
فلگ -s[ketch] را ببینید.
.It Ev Sy D2_BUNDLE
فلگ -b[undle] را ببینید.
.It Ev Sy D2_FORCE_APPENDIX
فلگ --force-appendix را ببینید.
.It Ev Sy D2_FONT_REGULAR
فلگ --font-regular را ببینید.
.It Ev Sy D2_FONT_ITALIC
فلگ --font-italic را ببینید.
.It Ev Sy D2_FONT_BOLD
فلگ --font-bold را ببینید.
.It Ev Sy D2_FONT_SEMIBOLD
فلگ --font-semibold را ببینید.
.It Ev Sy D2_FONT_MONO
فلگ --font-mono را ببینید.
.It Ev Sy D2_FONT_MONO_BOLD
فلگ --font-mono-bold را ببینید.
.It Ev Sy D2_FONT_MONO_ITALIC
فلگ --font-mono-italic را ببینید.
.It Ev Sy D2_FONT_MONO_SEMIBOLD
فلگ --font-mono-semibold را ببینید.
.It Ev Sy D2_ANIMATE_INTERVAL
فلگ --animate-interval را ببینید.
.It Ev Sy D2_TIMEOUT
فلگ --timeout را ببینید.
.It Ev Sy D2_CHECK
فلگ --check را ببینید.
.It Ev Sy D2_ASCII_MODE
فلگ --ascii-mode را ببینید.
.El
.Bl -tag -width Ds
.It Ev Sy DEBUG
فلگ -d[ebug] را ببینید.
.It Ev Sy IMG_CACHE
فلگ --img-cache را ببینید.
.It Ev Sy HOST
فلگ -h[ost] را ببینید.
.It Ev Sy PORT
فلگ -p[ort] را ببینید.
.It Ev Sy BROWSER
فلگ --browser را ببینید.
.It Ev Sy D2_STDOUT_FORMAT
فلگ --stdout-format را ببینید.
.It Ev Sy D2_NO_XML_TAG
فلگ --no-xml-tag را ببینید.
.It Ev Sy OMIT_VERSION
فلگ --omit-version را ببینید.
.El
.Sh "همچنین ببینید (SEE ALSO)"
.Xr d2plugin-tala 1
.Sh "نویسندگان (AUTHORS)"
.An "D2 contributors"