نام (NAME)

batpipe - پیشپردازنده ورودی برای ابزار less با استفاده از bat

توضیحات (DESCRIPTION)

نحوه استفاده (USAGE)

مانند lesspipe، ابزار batpipe برای کار با برنامه‌هایی طراحی شده است که از پیش‌پردازش با متغیر محیطی LESSOPEN پشتیبانی می‌کنند. راه‌اندازی batpipe به پوسته شما بستگی خواهد داشت:

Bash:

eval "$(batpipe)"

Fish:

eval (batpipe)

متغیرهای محیطی (ENVIRONMENT)

متغیر	توضیحات

BATPIPE_TERM_WIDTH	عرض ترمینال ارائه‌شده به bat را تعیین می‌کند. اگر این متغیر با یک خط تیره (-) شروع شود، مقدار داده‌شده نسبت به اندازه ترمینال شناسایی‌شده خواهد بود.

نمایش‌دهنده‌های توکار (BUILT-IN VIEWERS)

فایل‌ها	برنامه

دایرکتوری‌ها	eza, ls
.tar, .tar.gz	tar
.zip, .jar	unzip
.gz	gunzip
.xz	xz

نمایش‌دهنده‌های خارجی (EXTERNAL VIEWERS)

برای قالب‌های فایلی که به‌طور پیش‌فرض پشتیبانی نمی‌شوند، می‌توان با استفاده از رابط برنامه‌نویسی (API) نمایش‌دهنده خارجی، یک نمایش‌دهنده فایل خارجی به batpipe اضافه کرد.

نمایش‌دهنده‌های خارجی با ایجاد اسکریپت‌های bash درون دایرکتوری ~/.config/batpipe/viewers.d/ به batpipe اضافه می‌شوند.

ایجاد نمایش‌دهنده‌ها (Creating Viewers)

نمایش‌دهنده‌ها باید دو تابع تعریف کنند و نام نمایش‌دهنده را به آرایه $BATPIPE_VIEWERS بیافزایند.

- viewer_${viewer}_supports [file_basename] [file_path] [inner_file_path]
- viewer_${viewer}_process [file_path] [inner_file_path]

تابع viewer_${viewer}_supports برای تعیین این‌که آیا نمایش‌دهنده خارجی توانایی مشاهده فایل داده‌شده را دارد یا خیر فراخوانی می‌شود. اگر این تابع با موفقیت پایان یابد، تابع متناظر process فراخوانی خواهد شد.

رابط برنامه‌نویسی (API)

$BATPIPE_VIEWERS -- آرایه‌ای از نمایش‌دهنده‌های فایل بارگذاری‌شده.
$BATPIPE_ENABLE_COLOR -- فعال بودن یا نبودن رنگ. (true|false)
$BATPIPE_INSIDE_LESS -- آیا batpipe درون less اجرا می‌شود یا خیر. (true|false)

batpipe_header [pattern] [...] -- چاپ یک خط سربرگ نمایش‌دهنده.
batpipe_subheader [pattern] [...] -- چاپ یک خط زیرسربرگ نمایش‌دهنده.

strip_trailing_slashes [path] -- حذف اسلش‌های پایانی از یک مسیر.

نکات و محدودیت‌ها (CAVEATS)

- به‌طور پیش‌فرض، batpipe هنگام پیش‌نمایش درون less از رنگ‌ها استفاده نمی‌کند.
رنگ‌ها باید به‌صورت صریح با BATPIPE=color فعال شوند.