نام (NAME)

source-highlight - تبدیل کد منبع به سندی با نحو برجسته‌شده

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

source-highlight [OPTIONS]... < INPUT_FILE > OUTPUT_FILE

توضیحات (DESCRIPTION)

GNU GNU source-highlight 3.1.9

برجسته‌سازی نحو یک فایل منبع (مانند Java) و تبدیل آن به یک قالب مشخص (مانند HTML)

: source-highlight [OPTIONS]... -i INPUT_FILE -o OUTPUT_FILE source-highlight [OPTIONS]... [FILES]...

-h, --help: نمایش راهنما و خروج
--detailed-help: نمایش راهنما، شامل تمام جزئیات و گزینه‌های پنهان، و خروج
-V, --version: نمایش نسخه و خروج
-i, --input=FILENAME: فایل ورودی (پیش‌فرض=stdin)
-o, --output=FILENAME: فایل خروجی (در صورت استفاده از روش فراخوانی سوم، پیش‌فرض=stdout). اگر 'STDOUT' مشخص شود، خروجی به خروجی استاندارد هدایت می‌شود

می‌توانید به‌سادگی چند فایل را در خط فرمان مشخص کنید و همچنین از عبارات باقاعده (برای نمونه *.java) استفاده نمایید. در این حالت، نام فایل‌های خروجی با افزودن .EXT به نام فایل منبع تشکیل خواهد شد، که در آن EXT پسوندی است که متناسب با قالب خروجی مشخص‌شده انتخاب می‌شود (برای نمونه .html).

-s, --src-lang=STRING: زبان منبع (برای دریافت فهرست کامل از --lang-list استفاده کنید). در صورت عدم تعیین، زبان منبع از روی پسوند فایل حدس زده خواهد شد.
--lang-list: فهرست کردن تمام زبان‌های پشتیبانی‌شده و فایل تعریف زبان مرتبط
--outlang-list: فهرست کردن تمام زبان‌های خروجی پشتیبانی‌شده و فایل تعریف زبان مرتبط
-f, --out-format=STRING: قالب خروجی (برای دریافت فهرست کامل از --outlang-list استفاده کنید) (پیش‌فرض='html')
-d, --doc: ایجاد یک فایل خروجی که بتواند به عنوان یک سند مستقل استفاده شود (برای نمونه درون سند دیگری گنجانده نشود)
--no-doc: لغو گزینهٔ --doc حتی اگر به‌طور ضمنی فعال شده باشد (مثلاً هنگام تعیین css)
-c, --css=FILENAME: نام فایل شیوه‌نامهٔ خارجی (style sheet). گزینهٔ --doc را به‌طور ضمنی فعال می‌کند
-T, --title=STRING: تعیین عنوان برای سند خروجی. گزینهٔ --doc را به‌طور ضمنی فعال می‌کند
-t, --tab=INT: تعیین طول تب (tab). (پیش‌فرض='8')
-H, --header=FILENAME: فایلی که باید به‌عنوان سرآیند (header) درج شود
-F, --footer=FILENAME: فایلی که باید به‌عنوان پانویس (footer) درج شود
--style-file=FILENAME: تعیین فایل حاوی گزینه‌های قالب‌بندی (پیش‌فرض='default.style')
--style-css-file=FILENAME: تعیین فایل حاوی گزینه‌های قالب‌بندی (با نحو css)
--style-defaults=FILENAME: تعیین فایل حاوی مقادیر پیش‌فرض برای گزینه‌های قالب‌بندی (پیش‌فرض='style.defaults')
--outlang-def=FILENAME: فایل تعریف زبان خروجی
--outlang-map=FILENAME: فایل نگاشت زبان خروجی (پیش‌فرض='outlang.map')
--data-dir=PATH: پوشه‌ای که فایل‌های تعریف زبان و نگاشت‌های زبان در آن جستجو می‌شوند. در صورت عدم تعیین، این فایل‌ها در پوشهٔ جاری و در پوشهٔ دادهٔ (data dir) محل نصب برنامه جستجو خواهند شد
--output-dir=PATH: پوشهٔ خروجی
--lang-def=FILENAME: فایل تعریف زبان
--lang-map=FILENAME: فایل نگاشت زبان (پیش‌فرض='lang.map')
--show-lang-elements=FILENAME: چاپ عناصر زبانی که در فایل تعریف زبان

: تعریف شده‌اند

--infer-lang: استنتاج اجباری زبان اسکریپت منبع (نادیده گرفتن زبان مشخص‌شده)

سطرها (Lines):

-n, --line-number[=PADDING]: شماره‌گذاری تمام سطرهای خروجی با استفاده از نویسهٔ پرکنندهٔ (padding) مشخص‌شده (پیش‌فرض='0')
--line-number-ref[=PREFIX]: شماره‌گذاری تمام سطرهای خروجی و تولید یک لنگر،
ساخته‌شده از پیشوند مشخص‌شده + شمارهٔ سطر (پیش‌فرض='line')

فیلتر کردن خروجی:

: حالت: linerange
: تعیین محدوده‌های سطری

--line-range=STRING: تنها تولید سطرهایی که در محدوده(های) مشخص‌شده قرار دارند
--range-separator=STRING: جداکنندهٔ اختیاری برای چاپ میان محدوده‌ها (برای نمونه "...")
--range-context=INT: تعداد سطرهای متنی (زمینه) که حتی در صورت نبودن در محدوده تولید می‌شوند

: حالت: regexrange
: تعیین محدوده‌های محدودشده با عبارات باقاعده

--regex-range=STRING: تنها تولید سطرهایی که در محدودهٔ عبارات باقاعدهٔ مشخص‌شده قرار دارند

تولید ارجاعات (reference generation):

--gen-references=STRING: تولید مراجع (مقادیر ممکن: "inline"، "postline"، "postdoc"؛ پیش‌فرض='inline')
--ctags-file=FILENAME: تعیین فایل تولیدشده توسط ctags که برای تولید مراجع استفاده خواهد شد (پیش‌فرض='tags')
--ctags=CMD: نحوهٔ اجرای دستور ctags. اگر این گزینه مشخص نشود، ctags با مقدار پیش‌فرض اجرا خواهد شد. در صورتی که با یک رشتهٔ خالی مشخص شود، ctags اصلاً اجرا نخواهد شد (پیش‌فرض='ctags --excmd=n --tag-relative=yes')

آزمایش (testing):

-v, --verbose: روشن کردن حالت پرگو (verbose)
-q, --quiet: عدم چاپ اطلاعات پیشرفت
--binary-output: نوشتن فایل‌های خروجی در حالت دودویی (binary)
--statistics: چاپ برخی آمارها (مانند زمان سپری‌شده)
--gen-version: درج نسخهٔ source-highlight در فایل تولیدشده (پیش‌فرض=on)
--check-lang=FILENAME: تنها بررسی درستی یک فایل تعریف زبان
--check-outlang=FILENAME: تنها بررسی درستی یک فایل تعریف زبان خروجی
--failsafe: اگر هیچ تعریفی برای زبان ورودی یافت نشود، ورودی به‌سادگی به خروجی رونوشت می‌شود
-g, --debug-langdef[=TYPE]: اشکال‌زدایی یک تعریف زبان. در حالت dump صرفاً تمام مراحل را تخلیه (dump) می‌کند؛ در حالت interactive در هر مرحله منتظر ورودی می‌ماند (برای رفتن به گام بعدی ENTER را فشار دهید) (مقادیر ممکن: "interactive"، "dump"؛ پیش‌فرض='dump')
--show-regex=FILENAME: نمایش خودکارهٔ (اتوماتون) عبارت باقاعده متناظر با یک فایل تعریف زبان

نگهداری‌شده توسط Lorenzo Bettini http://www.lorenzobettini.it

گزارش باگ‌ها (BUGS)

گزارش باگ‌ها به <bug-source-highlight at gnu.org>

کپی‌رایت و تکثیر (COPYRIGHT)

حق نشر © 1999-2008 Lorenzo Bettini http://www.lorenzobettini.it این برنامه کاملاً بدون هیچ‌گونه ضمانتی ارائه می‌شود.
این یک نرم‌افزار آزاد است؛ شما می‌توانید نسخه‌های آن را تحت شرایط GNU General Public License بازتوزیع کنید. برای اطلاعات بیشتر در مورد این موارد، فایل با نام COPYING را ببینید.

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

مستندات کامل برای Source-highlight به صورت یک راهنمای Texinfo نگهداری می‌شود. اگر برنامه‌های info و Source-highlight به‌درستی روی سیستم شما نصب شده باشند، دستور

: info Source-highlight

باید دسترسی شما را به راهنمای کامل فراهم کند.