.TH "BATPIPE" 1
.SH "نام (NAME)"
batpipe \- پیشپردازنده ورودی برای ابزار less با استفاده از bat
.SH "توضیحات (DESCRIPTION)"
.SH "نحوه استفاده (USAGE)"
.P
مانند lesspipe، ابزار \fR\fIbatpipe\fR برای کار با برنامه‌هایی طراحی شده است که از پیش‌پردازش با متغیر محیطی \fR\fILESSOPEN\fR پشتیبانی می‌کنند. راه‌اندازی \fR\fIbatpipe\fR به پوسته شما بستگی خواهد داشت:
.P
\fR\fBBash:\fR
.P
    eval "$(batpipe)"
.P
\fR\fBFish:\fR
.P
    eval (batpipe)
.SH "متغیرهای محیطی (ENVIRONMENT)"
.TS
tab(|) box;
| cB | cB |
| _ | _ |
| l0 |1 l |.
متغیر | توضیحات
|
.SP
 \fR\fIBATPIPE_TERM_WIDTH\fR | عرض ترمینال ارائه‌شده به \fR\fIbat\fR را تعیین می‌کند. اگر این متغیر با یک خط تیره (\fR\fI\-\fR) شروع شود، مقدار داده‌شده نسبت به اندازه ترمینال شناسایی‌شده خواهد بود.
.TE

.SH "نمایش‌دهنده‌های توکار (BUILT-IN VIEWERS)"
.TS
tab(|) box;
| cB | cB |
| _ | _ |
| l0 |1 l |.
فایل‌ها | برنامه
|
.SP
 دایرکتوری‌ها | \fR\fIeza\fR, \fR\fIls\fR 
 \fR\fI\fR\fI\fI.tar\fR\fI, \fR\fI\fI\fR\fI.tar.gz\fR | \fR\fItar\fR 
 \fR\fI\fR\fI\fI.zip\fR\fI, \fR\fI\fI\fR\fI.jar\fR | \fR\fIunzip\fR 
 \fR\fI\fR\fI\fI.gz\fR\fI | \fR\fI\fIgunzip\fR\fI 
 \fR\fI\fR\fI\fI.xz\fR\fI | \fR\fI\fIxz\fR\fI 
.TE

.SH "نمایش‌دهنده‌های خارجی (EXTERNAL VIEWERS)"
.P
برای قالب‌های فایلی که به‌طور پیش‌فرض پشتیبانی نمی‌شوند، می‌توان با استفاده از رابط برنامه‌نویسی (API) نمایش‌دهنده خارجی، یک نمایش‌دهنده فایل خارجی به \fR\fIbatpipe\fR اضافه کرد.
.P
نمایش‌دهنده‌های خارجی با ایجاد اسکریپت‌های bash درون دایرکتوری \fR\fI~/.config/batpipe/viewers.d/\fR به batpipe اضافه می‌شوند.
.SS "ایجاد نمایش‌دهنده‌ها (Creating Viewers)"
.P
نمایش‌دهنده‌ها باید دو تابع تعریف کنند و نام نمایش‌دهنده را به آرایه \fR\fI$BATPIPE_VIEWERS\fR بیافزایند.
.P
 - \fR\fIviewer_${viewer}_supports [file_basename] [file_path] [inner_file_path]\fR
.br
 - \fR\fIviewer_${viewer}_process [file_path] [inner_file_path]\fR
.P
تابع \fR\fIviewer_${viewer}_supports\fR برای تعیین این‌که آیا نمایش‌دهنده خارجی توانایی مشاهده فایل داده‌شده را دارد یا خیر فراخوانی می‌شود. اگر این تابع با موفقیت پایان یابد، تابع متناظر \fR\fIprocess\fR فراخوانی خواهد شد.
.SS "رابط برنامه‌نویسی (API)"
.P
    $BATPIPE_VIEWERS      -- آرایه‌ای از نمایش‌دهنده‌های فایل بارگذاری‌شده.
.br
    $BATPIPE_ENABLE_COLOR -- فعال بودن یا نبودن رنگ. (\fR\fItrue\fR|\fR\fIfalse\fR)
.br
    $BATPIPE_INSIDE_LESS  -- آیا batpipe درون less اجرا می‌شود یا خیر. (\fR\fItrue\fR|\fR\fIfalse\fR)
.P
    batpipe_header [pattern] [...]    -- چاپ یک خط سربرگ نمایش‌دهنده.
.br
    batpipe_subheader [pattern] [...] -- چاپ یک خط زیرسربرگ نمایش‌دهنده.
.P
    strip_trailing_slashes [path]     -- حذف اسلش‌های پایانی از یک مسیر.
.SH "نکات و محدودیت‌ها (CAVEATS)"
.P
- به‌طور پیش‌فرض، \fR\fIbatpipe\fR هنگام پیش‌نمایش درون \fR\fIless\fR از رنگ‌ها استفاده نمی‌کند.
.br
  رنگ‌ها باید به‌صورت صریح با \fR\fIBATPIPE=color\fR فعال شوند.