.Dd 7 ژانویه 2008
.Dt MARKDOWN 1
.Os MASTODON
.Sh "نام (NAME)"
.Nm markdown
.Nd ابزار تبدیل متن به HTML
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm
.Op Fl d
.Op Fl T
.Op Fl V
.Op Fl b Ar url-base
.Op Fl C Ar prefix
.Op Fl F Pa bitmap
.Op Fl f Ar flags
.Op Fl n
.Op Fl o Pa file
.Op Fl S
.Op Fl s Pa text
.Op Fl t Pa text
.Op Fl toc
.Op Pa textfile
.Sh "توضیحات (DESCRIPTION)"
ابزار
.Nm
فایل متنی
.Pa textfile
با قالب‌بندی
.Xr markdown 7
(یا در صورت عدم تعیین، ورودی استاندارد stdin) را خوانده، آن را کامپایل می‌کند و خروجی html را در stdout می‌نویسد.
.Pp
گزینه‌ها به شرح زیر هستند:
.Bl -tag -width "-o file"
.It Fl b Ar url-base
پیوندهای موجود در منبع که با / آغاز می‌شوند، در خروجی پیشوند
.Ar url-base
را دریافت خواهند کرد.
.It Fl C
هنگام پردازش پانویس‌های سبک markdown extra، به‌جای پیشوند پیش‌فرض
.Ar fn
از پیشوند ارائه‌شده استفاده کن.
.It Fl d
به‌جای نوشتن فایل html، درخت تجزیه (parse tree) را در خروجی استاندارد بنویس.
.It Fl f Ar flags
تنظیم یا پاک کردن فلگ‌های گوناگون ترجمه. فلگ‌ها در یک لیست با کاما جدا شده و هر فلگ می‌تواند پیشوند اختیاری
.Ar +
(فعال‌سازی)،
.Ar -
(غیرفعال‌سازی) یا
.Ar no
(غیرفعال‌سازی) داشته باشد.
.Bl -tag -width "definitionlist"
.It Ar links
اجازه به پیوندها.
.It Ar image
اجازه به تصاویر.
.It Ar smarty
فعال‌سازی smartypants.
.It Ar pants
فعال‌سازی smartypants.
.It Ar html
اجازه به کدهای خام html.
.It Ar strict
غیرفعال‌سازی بالانویس، خط‌خورده و تاکیدهای آزاد.
.It Ar ext
فعال‌سازی شبه‌پروتکل‌ها.
.It Ar cdata
تولید کد برای
.Em ![CDATA[...]]
در xml.
.It Ar superscript
فعال‌سازی پردازش بالانویس (superscript).
.It Ar emphasis
اعمال تاکید در
.Em همه‌جا .
.It Ar tables
پردازش نکردن جدول‌های سبک PHP Markdown Extra.
.It Ar del
فعال‌سازی
.Em ~~خط‌خورده~~ .
.It Ar strikethrough
فعال‌سازی
.Em ~~خط‌خورده~~ .
.It Ar toc
فعال‌سازی پردازش فهرست مطالب (table-of-contents).
.It Ar 1.0
سازگاری با MarkdownTest_1.0.
.It Ar autolink
تبدیل
.Pa http://foo.com
به پیوند حتی بدون
.Em <> .
.It Ar safelink
بررسی سخت‌گیرانه برای پروتکل پیوند.
.It Ar header
پردازش بلوک‌های عنوان به سبک pandoc.
.It Ar tabstop
بسط دادن تب‌ها به ۴ فاصله (spaces).
.It Ar divquote
اجازه دادن به بلوک‌های
.Pa >%class% .
.It Ar alphalist
اجازه دادن به لیست‌های الفبایی.
.It Ar definitionlist
اجازه به لیست‌های تعریفی (پیش‌فرض). استفاده از
.Em dldiscount
و
.Em dlextra
برای کنترل اینکه کدام نحوها پذیرفته شوند.
.It Ar dldiscount
فعال‌سازی لیست‌های تعریفی به سبک discount (پیش‌فرض).
.It Ar dlextra
فعال‌سازی لیست‌های تعریفی به سبک extra (غیر پیش‌فرض). هر دو سبک می‌توانند همزمان فعال باشند.
.It Ar footnote
اجازه به پانویس‌های سبک markdown extra.
.It Ar style
استخراج بلوک‌های <style> از خروجی.
.It Ar fencedcode
اجازه به بلوک‌های کد محصور (fenced code blocks) (غیر پیش‌فرض).
.It Ar idanchor
استفاده از لنگرهای id= برای پیوندهای فهرست مطالب به‌جای <a name=/> (غیر پیش‌فرض).
.It Ar githubtags
اجازه به خط زیر (underscore) و خط تیره (dash) در نام‌های عناصر عبور داده شده (غیر پیش‌فرض).
.It Ar urlencodedanchor
استفاده از نویسه‌های url-encoded برای نویسه‌های چندبایتی و غیرالفبایی-عددی به‌جای نقطه در پیوندهای فهرست مطالب.
.El
.Pp
به‌عنوان مثال، گزینه
.Fl f Ar nolinks,smarty
به
.Nm
می‌گوید که تگ‌های \<a را مجاز نداند و پردازش smartypants را انجام دهد.
.It Fl F Ar bitmap
تنظیم فلگ‌های تبدیل.
.Ar Bitmap
یک نگاشت بیتی از گزینه‌های مختلف پیکربندی است که در
.Xr markdown 3
توصیف شده‌اند (مقادیر فلگ در
.Pa mkdio.h
تعریف شده‌اند).
.It Fl n
کدهای html تولیدشده را ننویس.
.It Fl o Pa file
نوشتن کدهای html تولیدشده در
.Pa file .
.It Fl S
خروجی دادن بلوک‌های <style>.
.It Fl V
نمایش شماره نسخه و داده‌های پیکربندی زمان کامپایل.
.Pp
اگر نسخه شامل رشته
.Em DEBUG
باشد،
.Nm
با دیباگ تخصیص حافظه پیکربندی شده است.
.Pp
اگر نسخه شامل رشته
.Em TAB
باشد،
.Nm
برای استفاده از tabstop مشخص‌شده پیکربندی شده است.
.It Fl VV
نمایش شماره نسخه، پیکربندی زمان کامپایل و پیکربندی زمان اجرا.
.It Fl t Ar text
استفاده از
.Xr mkd_text 3
برای قالب‌بندی
.Ar text
به‌جای پردازش ورودی استاندارد با تابع
.Xr markdown 3 .
.It Fl T
اگر با فلگ فهرست مطالب اجرا شود، فهرست مطالب را قبل از متن قالب‌بندی‌شده درج کن.
.It Fl s Ar text
استفاده از تابع
.Xr markdown 3
برای قالب‌بندی
.Ar text .
.It Fl toc
تنظیم فلگ فهرست مطالب، سپس درج فهرست مطالب قبل از متن قالب‌بندی‌شده (میانبری برای
.Fl -T -toc
).
.El
.Sh "مقادیر بازگشتی (RETURN VALUES)"
ابزار
.Nm
در صورت موفقیت مقدار 0 و در صورت بروز خطا مقدار >0 را برمی‌گرداند.
.Sh "همچنین ببینید (SEE ALSO)"
.Xr markdown 3 ,
.Xr markdown 7 ,
.Xr mkd-extensions 7 .
.Sh "نویسنده (AUTHOR)"
.An David Parsons
.Pq Li orc@pell.portland.or.us