نام (NAME)

pygmentize - برجسته‌سازی نحوی فایل ورودی

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

pygmentize [-l <lexer> | -g] [-F <filter>[:<options>]] [-f <formatter>] [-O <options>] [-P <option=value>] [-o <outfile>] [<infile>]
pygmentize -S <style> -f <formatter> [-a <arg>] [-O <options>] [-P <option=value>]
pygmentize -L [<which> ...]
pygmentize -N <filename>
pygmentize -C
pygmentize -H <type> <name>
pygmentize -h | -V

توضیحات (DESCRIPTION)

بسته Pygments یک ابزار عمومی برجسته‌سازی نحو (syntax highlighter) برای استفاده در انواع نرم‌افزارها مانند سامانه‌های انجمن، ویکی‌ها یا سایر برنامه‌هایی است که نیاز به زیباسازی کدهای منبع دارند.

ویژگی‌های برجستهٔ آن عبارتند از:
* پشتیبانی از طیف گسترده‌ای از زبان‌های رایج و قالب‌های نشانه‌گذاری
* توجه ویژه به جزئیات، که کیفیت را تا حد زیادی افزایش می‌دهد
* امکان افزودن آسان پشتیبانی از زبان‌ها و قالب‌های جدید
* چندین قالب خروجی؛ در حال حاضر HTML، LaTeX و توالی‌های ANSI
* قابلیت استفاده هم به‌عنوان ابزار خط فرمان و هم به‌عنوان یک کتابخانه
* ... و حتی نحو کد Brainfuck را هم برجسته می‌کند!

دستور pygmentize ابزاری است که از Pygments برای برجسته‌سازی فایل ورودی و نوشتن نتیجه در <outfile> استفاده می‌کند. اگر هیچ <infile> مشخص نشود، از stdin (ورودی استاندارد) استفاده خواهد شد.

گزینه‌ها (OPTIONS)

خلاصه‌ای از گزینه‌ها در ادامه آمده است:

-l <lexer>: تنظیم نام تحلیل‌گر لغوی (lexer). اگر مشخص نشود، lexer از روی پسوند نام فایل ورودی حدس زده می‌شود (این روش طبیعتاً در صورتی که ورودی stdin باشد کار نخواهد کرد).
-g: تلاش برای حدس زدن lexer از روی محتوای فایل، یا ارسال به صورت متن ساده (plain text) در صورت عدم موفقیت (این گزینه برای برجسته‌سازی ورودی استاندارد کاربرد دارد).
-F <filter>[:<options>]: افزودن یک پالایه (filter) به جریان نشانه‌ها (tokens). می‌توانید گزینه‌ها را مشابه با -O پس از یک دو‌نقطه وارد کنید (توجه: نباید در اطراف دو‌نقطه فاصله‌ای وجود داشته باشد). این گزینه را می‌توان چندین بار مشخص کرد.
-f <formatter>: تنظیم نام قالب‌بند (formatter). اگر مشخص نشود، از روی پسوند نام فایل خروجی حدس زده خواهد شد. در صورتی که هیچ فایل خروجی مشخص نشود، به‌طور پیش‌فرض از قالب‌بند ترمینال استفاده خواهد شد.
-o <outfile>: تنظیم فایل خروجی. اگر مشخص نشود، از stdout (خروجی استاندارد) استفاده می‌شود.
-O <options>: با این گزینه می‌توانید فهرستی از گزینه‌های جداشده با کاما را به lexer و formatter بدهید؛ مانند “-O bg=light,python=cool”. اینکه کدام گزینه‌ها برای کدام lexerها و formatterها معتبر هستند را می‌توان در مستندات پیدا کرد. این گزینه را می‌توان چندین بار مشخص کرد.
-P <option=value>: این گزینه مانند گزینهٔ -O گزینه‌های lexer و formatter را اضافه می‌کند، اما در هر -P فقط می‌توانید یک گزینه را مشخص کنید. بدین ترتیب، مقدار گزینه می‌تواند شامل کاما و علامت مساوی باشد، کاری که با -O امکان‌پذیر نیست.
-S <style>: چاپ تعاریف سبک برای سبک <style> و برای قالب‌بند <formatter>. مفهوم آرگومان ارائه‌شده با -a <arg> به قالب‌بند بستگی دارد و می‌توان آن را در مستندات یافت.
-L [<which> ...]: فهرست کردن lexerها، formatterها، سبک‌ها (styles) یا پالایه‌ها (filters). مقدار <which> را روی موردی که می‌خواهید فهرست شود تنظیم کنید (مانند “styles”)، یا برای فهرست کردن همه چیز آن را خالی بگذارید.
-N <filename>: حدس زدن و چاپ نام lexer صرفاً بر اساس نام فایل داده‌شده. این گزینه ورودی دریافت نمی‌کند و هیچ چیزی را برجسته نمی‌سازد. اگر هیچ lexer خاصی پیدا نشود، عبارت “text” چاپ می‌شود.
-C: مشابه -N، اما lexer را بر اساس محتوای خوانده‌شده از ورودی استاندارد حدس می‌زند.
-H <type> <name>: چاپ راهنمای تفصیلی برای شیء <name> از نوع <type>، که در آن <type> یکی از مقادیر “lexer”، “formatter” یا “filter” است.
-h: نمایش صفحهٔ راهنما.
-V: نمایش نسخهٔ بستهٔ Pygments.

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

/usr/share/doc/python-pygments/index.html

نویسندگان (AUTHORS)

ابزار pygmentize توسط Georg Brandl <g.brandl@gmx.net> نوشته شده است.

این صفحهٔ راهنما توسط Piotr Ozarowski <ozarow@gmail.com> برای پروژهٔ Debian نوشته شده است (اما ممکن است توسط دیگران نیز استفاده شود).