'\" t
.\"     Title: rink
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.26
.\"      Date: 2026-08-30
.\"    Manual: Rink Manual
.\"    Source: Rink Manual
.\"  Language: Persian
.\"
.TH "RINK" "5" "2026-08-30" "Rink Manual" "Rink Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "نام (NAME)"
rink \- قالب فایل پیکربندی TOML
.SH "توضیحات (DESCRIPTION)"
.sp
فایل پیکربندی Rink از قالب TOML استفاده می‌کند.
.sp
انواع مدت‌زمان پسوندهای متداول مانند \f(CRms\fP، \f(CRs\fP، \f(CRh\fP، \f(CRd\fP، \f(CRy\fP را می‌پذیرند.
انواع اندازه پسوندهایی مانند \f(CRMB\fP را می‌پذیرند.
.sp
رشته‌های رنگ مجموعه‌ای از کلیدواژه‌ها هستند که با فاصله از یکدیگر جدا می‌شوند. کلیدواژه‌های
زیر شناخته‌شده و معتبر هستند:
.sp
\fBblack\fP, \fBred\fP, \fBgreen\fP, \fByellow\fP, \fBblue\fP, \fBpurple\fP, \fBcyan\fP, \fBwhite\fP, \fBdark_gray\fP, \fBlight_red\fP, \fBlight_green\fP, \fBlight_yellow\fP, \fBlight_blue\fP, \fBlight_purple\fP, \fBmagenta\fP, \fBlight_magenta\fP, \fBlight_cyan\fP, \fBlight_gray\fP
.RS 4
رنگ را روی آن رنگ ANSI تنظیم می‌کند.
.RE
.sp
\fBdim\fP/\fBdimmed\fP
.RS 4
به‌جای حالت روشن، از یک گونه‌ی کم‌نورتر رنگ استفاده می‌کند.
.RE
.sp
\fBbold\fP, \fBitalic\fP, \fBunderline\fP/\fBunder\fP, \fBstrikethrough\fP
.RS 4
قالب‌بندی.
.RE
.sp
\fBhidden\fP/\fBnone\fP
.RS 4
متن را نامرئی می‌کند.
.RE
.sp
\fBon\fP
.RS 4
کلیدواژه رنگ پس از این، به‌جای پیش‌زمینه بر روی پس‌زمینه اعمال خواهد شد.
مثال: \f(CRblack on red\fP.
.RE
.sp
\fBdefault\fP/\fBplain\fP
.RS 4
منجر به متن ساده و بدون استایل می‌شود.
.RE
.sp
اعداد صحیح 0 تا 255
.RS 4
کدهای جدول رنگ گسترده پایانه.
.RE
.sp
\fB#\fP <\fI6 hex letters\fP>
.RS 4
کدهای هگزادسیمال می‌توانند برای تعیین رنگ واقعی (truecolor) استفاده شوند.
مثال: \f(CR#000000\fP
.RE
.sp
\fBrgb(\fP <\fIred\fP> \fB,\fP <\fIgreen\fP> \fB,\fP <\fIblue\fP> \fB)\fP
.RS 4
مقادیر RGB می‌توانند برای تعیین رنگ واقعی (truecolor) استفاده شوند. درج فاصله مجاز نیست.
مثال: \f(CRrgb(10,10,10)\fP
.RE
.SS "Rink"
.sp
بخش \f(CR[rink]\fP.
.sp
\fBprompt\fP = <\fIstring\fP>
.RS 4
متنی که برای نشان دادن حالت تعاملی پیش از مکان‌نما نمایش داده می‌شود. باید شامل نویسه فاصله باشد.
پیش‌فرض: \f(CR"> "\fP
.RE
.sp
\fBlong_output\fP = <\fIbool\fP>
.RS 4
فهرست‌ها، مانند نتایج جستجو، را در چند خط می‌شکند. نیازمند پایانه‌ای با قابلیت پشتیبانی از یونیکد (Unicode) است.
پیش‌فرض: \f(CRfalse\fP
.RE
.sp
\fBshow_interpretation\fP = <\fIbool\fP>
.RS 4
پرس‌وجوی ورودی را بازقالب‌بندی‌شده بر اساس نحوه تفسیر آن توسط Rink نمایش می‌دهد.
از برجسته‌سازی نحو پشتیبانی می‌کند.
پیش‌فرض: \f(CRtrue\fP
.RE
.SS "ارز (Currency)"
.sp
بخش \f(CR[currency]\fP.
.sp
\fBenabled\fP = <\fIbool\fP>
.RS 4
پشتیبانی از ارز می‌تواند به طور کامل غیرفعال شود. وقتی روی false تنظیم شود،
\f(CRcurrency.json\fP بارگذاری نخواهد شد و تلاش برای استفاده از واحدهای ارزی
خطای "یافت نشد" را برمی‌گرداند.
پیش‌فرض: \f(CRtrue\fP
.RE
.sp
\fBbehavior\fP = <\fI"prompt"\fP | \fI"always"\fP>
.RS 4
پیش‌فرض: \f(CR"prompt"\fP. هنگام تلاش برای استفاده از یک واحد ارزی، Rink
می‌پرسد که آیا مایل به بارگیری داده‌های ارزی هستید یا خیر.
.sp
تنظیم آن روی \f(CR"always"\fP باعث می‌شود به محض استفاده از یک واحد ارزی،
بارگیری بی‌درنگ انجام شود.
.RE
.sp
\fBcache_expiration_enabled\fP = <\fIbool\fP>
.RS 4
پیش‌فرض: \f(CRtrue\fP. تنظیم این مقدار روی \f(CRfalse\fP باعث می‌شود rink طوری عمل کند که گویا
\f(CRcache_duration\fP بی‌نهایت است. اگر فایل ارز وجود نداشته باشد، آن را
دریافت می‌کند؛ در غیر این صورت، نامحدود از آن استفاده خواهد کرد. Rink می‌تواند
با \f(CR\-\-fetch\-currency\fP برای بارگیری تازه‌ترین نسخه فراخوانی شود.
.sp
این تنظیم ممکن است برای دسترسی مقطعی و ناپیوسته به اینترنت مفید باشد. می‌توانید
یک کرون‌جاب (cron job) تنظیم کنید تا داده‌های ارزی را در زمان برقراری اتصال شبکه دریافت کند،
تا بعداً هنگام استفاده آفلاین از rink در دسترس باشند.
.RE
.sp
\fBendpoint\fP = <\fIurl\fP>
.RS 4
امکان اشاره به نمونه‌های جایگزین Rink\-Web یا هر API دیگری را که قالبی سازگار ارائه می‌دهد فراهم می‌کند.
پیش‌فرض: \f(CR"https://rinkcalc.app/data/currency.json"\fP
.RE
.sp
\fBtimeout\fP = <\fIduration\fP>
.RS 4
مدت‌زمانی که پیش از انصراف باید برای دریافت داده‌های ارزی منتظر ماند.
پیش‌فرض: \f(CR"15s"\fP
.RE
.sp
\fBcache_duration\fP = <\fIduration\fP>
.RS 4
مدت‌زمانی که پیش از کهنه در نظر گرفتن داده‌های ارزی ذخیره‌شده در حافظه پنهان باید سپری شود.
پیش‌فرض: \f(CR"1h"\fP
.RE
.SS "رنگ‌ها (Colors)"
.sp
بخش \f(CR[colors]\fP.
.sp
\fBenabled\fP = <\fIbool\fP>
.RS 4
برای فعال کردن خروجی رنگی روی true تنظیم کنید.
پیش‌فرض: \f(CRtrue\fP، یا اگر متغیر محیطی \f(CRNO_COLOR\fP تنظیم شده باشد، \f(CRfalse\fP.
.RE
.sp
\fBtheme\fP = <\fIstring\fP>
.RS 4
پوسته فعال را تعیین می‌کند. بخش "پوسته‌ها (Themes)" را ببینید.
پیش‌فرض: \f(CR"default"\fP
.RE
.SS "پوسته‌ها (Themes)"
.sp
بخش \f(CR[themes]\fP. این بخش یک دیکشنری است؛ هر پوسته باید
به صورت \f(CR[themes.my_theme]\fP ایجاد شود. این گزینه‌ها مختص هر پوسته هستند.
.sp
\fBplain\fP = <\fIcolor\fP>
.RS 4
متن عمومی. این گزینه بسیار استفاده خواهد شد.
پیش‌فرض: \f(CR"default"\fP
.RE
.sp
\fBerror\fP = <\fIcolor\fP>
.RS 4
پیام‌های خطا.
پیش‌فرض: \f(CR"red"\fP
.RE
.sp
\fBunit\fP = <\fIcolor\fP>
.RS 4
نام واحدها، مانند \f(CRkilogram\fP.
پیش‌فرض: \f(CR"cyan"\fP
.RE
.sp
\fBquantity\fP = <\fIcolor\fP>
.RS 4
نام کمیت‌های فیزیکی، مانند \f(CRlength\fP و \f(CRtime\fP. این نام‌ها
در هر پرس‌وجو داخل پرانتز نمایش داده می‌شوند.
پیش‌فرض: \f(CR"dimmed cyan"\fP
.RE
.sp
\fBnumber\fP = <\fIcolor\fP>
.RS 4
اعدادی که در خروجی‌ها ظاهر می‌شوند.
پیش‌فرض: \f(CR"default"\fP
.RE
.sp
\fBuser_input\fP = <\fIcolor\fP>
.RS 4
هنگامی استفاده می‌شود که rink ورودی کاربر را بازگو می‌کند، مانند خطاهای پیدا نشدن واحد.
پیش‌فرض: \f(CR"bold"\fP
.RE
.sp
\fBdoc_string\fP = <\fIcolor\fP>
.RS 4
هنگامی استفاده می‌شود که rink متن توضیحی مربوط به تعریف یک واحد، مانند \f(CRmeter\fP، را نمایش می‌دهد.
پیش‌فرض: \f(CR"italic"\fP
.RE
.sp
\fBpow\fP = <\fIcolor\fP>
.RS 4
بخش \f(CR^2\fP در \f(CRm/s^2\fP.
پیش‌فرض: \f(CR"default"\fP
.RE
.sp
\fBprop_name\fP = <\fIcolor\fP>
.RS 4
نام ویژگی‌ها در مواد، مانند \f(CRspeed\fP در \f(CRspeed of light\fP.
پیش‌فرض: \f(CR"cyan"\fP
.RE
.sp
\fBdate_time\fP = <\fIcolor\fP>
.RS 4
اشیای تاریخ و زمان، که می‌توان با نماد هش (#) یا \f(CRnow\fP به آن‌ها دست یافت.
پیش‌فرض: \f(CR"default"\fP
.RE
.sp
\fBlink\fP = <\fIcolor\fP>
.RS 4
یک ابرپیوند، که معمولاً داخل رشته‌های مستندات یافت می‌شود.
پیش‌فرض: \f(CR"cyan"\fP
.RE
.sp
\fBkeyword\fP = <\fIcolor\fP>
.RS 4
کلمات کلیدی در زبان پرس‌وجوی Rink، مانند \f(CRof\fP، \f(CRdigits\fP و غیره.
پیش‌فرض: \f(CR"yellow"\fP
.RE
.sp
\fBtimezone\fP = <\fIcolor\fP>
.RS 4
منطقه‌های زمانی، مانند \f(CR[US/Pacific]\fP.
پیش‌فرض: \f(CR"cyan"\fP
.RE
.SH "فایل‌ها (FILES)"
.sp
لینوکس (Linux)
.RS 4
__$XDG_CONFIG_DIR__/rink/config.toml
.RE
.sp
ویندوز (Windows)
.RS 4
__{FOLDERID_RoamingAppData}__\(rsrink\(rsconfig.toml
.RE
.sp
مک‌اواس (macOS)
.RS 4
__$HOME__/Library/Application Support/rink/config.toml
.RE
.SH "همچنین ببینید (SEE ALSO)"
.sp
rink(1), rink(7),
rink\-defs(5),
rink\-dates(5)