'\" t
.\"     Title: nheko
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net>
.\"      Date: 2022-01-27
.\"    Manual: General Commands Manual
.\"    Source: nheko 0.12.1-dc910109
.\"  Language: Persian
.\"
.TH "NHEKO" "1" "2022\-01\-27" "nheko 0\&.12\&.1\-dc910109" "General Commands Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "نام (NAME)"
nheko \- کلاینت دسکتاپ برای Matrix با استفاده از Qt و C++17
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBnheko\fR [\fIOPTIONS\fR]
.SH "توضیحات (DESCRIPTION)"
.sp
انگیزهٔ پشت این پروژه، ارائهٔ یک برنامهٔ دسکتاپ بومی برای Matrix است که بیشتر شبیه به یک برنامهٔ پیام‌رسان رایج (مانند Element، Telegram و غیره) باشد و کمتر به یک کلاینت IRC شباهت داشته باشد\&.
.SH "گزینه‌ها (OPTIONS)"
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
راهنمای مربوط به گزینه‌های خط فرمان را نمایش می‌دهد\&.
.RE
.PP
\fB\-\-help\-all\fR
.RS 4
راهنما را به همراه گزینه‌های مختص Qt نمایش می‌دهد\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
اطلاعات نسخه را نمایش می‌دهد\&.
.RE
.PP
\fB\-\-debug\fR
.RS 4
نام مستعاری برای
\fI\-\-log\-level trace\fR\&.
.RE
.PP
\fB\-l\fR, \fB\-\-log\-level\fR \fI<level>\fR
.RS 4
سطح گزارش‌گیری سراسری، یا فهرستی جداشده با کاما از جفت‌های
\fI<component>=<level>\fR،
یا هر دو را تعیین می‌کند\&. برای مثال، جهت تنظیم سطح گزارش‌گیری پیش‌فرض روی
\fIwarn\fR
اما غیرفعال کردن گزارش‌گیری برای مؤلفهٔ
\fIui\fR،
مقدار
\fIwarn,ui=off\fR
را ارسال کنید\&.
.sp
سطوح:
\fItrace\fR
\fIdebug\fR
\fIinfo\fR
\fIwarning\fR
\fIerror\fR
\fIcritical\fR
\fIoff\fR
.sp
مؤلفه‌ها:
\fIcrypto\fR
\fIdb\fR
\fImtx\fR
\fInet\fR
\fIqml\fR
\fIui\fR
.sp
سطوح گزارش‌گیری را می‌توان در متغیر محیطی NHEKO_LOG_LEVEL نیز با استفاده از همان نحو تنظیم کرد\&. این گزینهٔ خط فرمان آن را بازنویسی خواهد کرد\&.
.RE
.PP
\fB\-L\fR, \fB\-\-log\-type\fR \fI<type>\fR
.RS 4
نوع خروجی گزارش‌گیری را تعیین می‌کند\&. استفاده از فهرستی جداشده با کاما مجاز است\&. پیش‌فرض
\fIfile,stderr\fR
است\&.
.sp
انواع:
\fIfile\fR
\fIstderr\fR
\fInone\fR
.sp
نوع گزارش‌گیری را می‌توان در متغیر محیطی NHEKO_LOG_TYPE نیز تعیین کرد که توسط این گزینهٔ خط فرمان بازنویسی خواهد شد\&.
.RE
.PP
\fB\-p\fR \fI<profile>\fR, \fB\-\-profile\fR \fI<profile>\fR
.RS 4
یک نمایهٔ یکتا ایجاد می‌کند که به شما امکان می‌دهد به‌طور هم‌زمان وارد چندین حساب کاربری شوید و چندین نمونه از nheko را اجرا کنید\&. از
\fIdefault\fR
برای شروع با نمایهٔ پیش‌فرض استفاده کنید\&.
.RE
.PP
\fB\-C\fR, \fB\-\-compact\fR
.RS 4
امکان کاهش حجم و فشرده‌سازی پایگاه‌داده را فراهم می‌کند، زیرا پایگاه‌های دادهٔ LMDB هنگام حذف داده‌ها به‌طور خودکار کوچک نمی‌شوند\&. احتمالاً امکان بازیابی داده‌ها را در صورت خرابی پایگاه‌داده فراهم می‌سازد\&.
.RE.SH "پرسش‌های متداول (FAQ)"
.SS "چگونه استیکرها و اموجی‌های سفارشی را اضافه کنم؟"
.sp
استیکرها و اموجی‌های سفارشی در بسته‌های تصویر سازمان‌دهی شده‌اند\&. یک بسته تصویر کاربر وجود دارد که تنها حساب کاربری شما به آن دسترسی دارد و بسته‌های تصویر اتاق نیز وجود دارند که برای تمام افراد حاضر در اتاقی که در آن تعریف شده‌اند، در دسترس هستند\&. شما می‌توانید یک بسته تصویر اتاق را به‌صورت سراسری فعال کنید تا در هر اتاقی قابل استفاده باشد\&.
.sp
برای مدیریت بسته‌های تصویر در nheko، به تنظیمات اتاق رفته و وارد Sticker & Emote Settings شوید\&. بسته Private (بسته تصویر کاربری شما) را مشاهده خواهید کرد و می‌توانید آن را در آنجا ویرایش کنید\&. شناسه Shortcode یک شناسه یکتا است که برای انتخاب تصویر از آن استفاده می‌کنید و Body متن جایگزینی است که در کلاینت‌هایی که از تصاویر پشتیبانی نمی‌کنند نمایش داده می‌شود (مانند برچسب alt در تصاویر HTML)\&.
.sp
اگر مجوزهای لازم را داشته باشید، می‌توانید با دکمه موجود در پایین فهرست بسته‌های تصویر، بسته‌های اتاق جدیدی ایجاد کنید\&. این بسته‌ها همانند بسته کاربری هستند، اما می‌توانید هر تعداد که مایلید ایجاد کنید و تمام افراد حاضر در اتاق می‌توانند از آن‌ها استفاده کنند\&. ممکن است ایجاد یک اتاق اضافه صرفاً برای بسته‌های تصویر شما، ایده خوبی برای آسان‌تر کردن اشتراک‌گذاری باشد\&.
.SH "تکمیل‌کننده‌ها (COMPLETERS)"
.sp
تکمیل‌کننده‌ها هنگامی که آن‌ها را در خط ورودی تایپ می‌کنید، پنجره‌ای بازشو حاوی گزینه‌های پیشنهادی برای تکمیل باز می‌کنند\&.
.PP
\fB@\fR
.RS 4
باز کردن تکمیل‌کننده نام کاربری\&.
.RE
.PP
\fB#\fR
.RS 4
باز کردن تکمیل‌کننده اتاق\&.
.RE
.PP
\fB:\fR
.RS 4
باز کردن انتخاب‌گر اموجی\&. اموجی‌های Unicode مستقیماً درج می‌شوند\&. برای اموجی‌های سفارشی، کد HTML آن‌ها در خط ورودی درج می‌شود\&. می‌توانید اموجی‌های سفارشی را در تنظیمات اتاق پیکربندی کنید\&.
.RE
.SH "میانبرهای صفحه‌کلید (KEYBOARD SHORTCUTS)"
.SS "فهرست اتاق‌ها"
.PP
\fBCtrl\-Up/Ctrl\-Down\fR
.RS 4
پیمایش در فهرست اتاق‌ها\&.
.RE
.PP
\fBCtrl\-W\fR
.RS 4
بستن اتاق باز فعلی\&.
.RE
.PP
\fBCtrl\-K\fR
.RS 4
جستجو و انتخاب اتاق‌ها از فهرست اتاق‌ها\&.
.RE
.PP
\fBAlt\-A\fR, \fBCtrl\-Shift\-A\fR
.RS 4
انتخاب اتاق بعدی دارای فعالیت\&.
.RE
.SS "خط زمانی/پیام‌رسانی"
.PP
\fBPgUp/PgDn\fR
.RS 4
پیمایش صفحه به صفحه در خط زمانی\&.
.RE
.PP
\fBAlt\-Up/Alt\-Down\fR
.RS 4
پاسخ به یک پیام\&.
.RE
.PP
\fBUp/Down\fR
.RS 4
ویرایش یک پیام\&.
.RE
.PP
\fBCtrl\-E\fR
.RS 4
ویرایش پیامی که در حال حاضر برای پاسخ انتخاب شده است\&.
.RE
.PP
\fBAlt\-F\fR
.RS 4
هدایت کردن (فوروارد) پیامی که در حال حاضر برای پاسخ انتخاب شده است\&.
.RE
.PP
\fBCtrl\-P/Ctrl\-N\fR
.RS 4
ورود مجدد پیام قبلی/بعدی\&.
.RE
.PP
\fBCtrl\-U\fR
.RS 4
پاک کردن تمام محتوای خط ورودی\&.
.RE
.PP
\fBCtrl\-Left/Ctrl\-Right\fR
.RS 4
پرش یک کلمه به چپ/راست در خط ورودی\&.
.RE
.PP
\fBShift\-Enter\fR
.RS 4
درج شکست خط (خط جدید)\&.
.RE
.PP
\fBEnter\fR
.RS 4
ارسال پیام\&.
.RE.SH "دستورها (COMMANDS)"
.sp
دستورها تنها زمانی کار می‌کنند که در ابتدای متن استفاده شوند\&.
.SS "پیام‌های سفارشی"
.PP
\fB/me\fR \fI<message>\fR
.RS 4
ارسال پیام به‌صورت یک emote که نام کاربری شما در ابتدای آن قرار می‌گیرد\&.
.RE
.PP
\fB/react\fR \fI<text>\fR
.RS 4
ارسال پیام به‌عنوان واکنش (reaction) هنگامی که در حال پاسخ دادن به یک پیام هستید\&.
.RE
.PP
\fB/md\fR \fI<message>\fR
.RS 4
اجبار به استفاده از Markdown هنگام ارسال پیام فعلی\&.
.RE
.PP
\fB/cmark\fR \fI<message>\fR
.RS 4
بیشتر افزونه‌های ما برای cmark (CommonMark) را غیرفعال می‌کند؛ از جمله رفتار newline\-in\-input = newline\-in\-output، خط‌خوردگی (strikethrough) و اسپویلرها\&. همچنان می‌توانید با ۲ فاصله یا یک بک‌اسلش پیش از انتهای خط، خط جدید ایجاد کنید یا عناصر HTML درج نمایید\&.
.RE
.PP
\fB/plain\fR \fI<message>\fR
.RS 4
اجبار به استفاده از متن ساده (plain text) هنگام ارسال پیام فعلی\&.
.RE
.PP
\fB/rainbow\fR \fI<message>\fR
.RS 4
ارسال پیام با رنگ‌های رنگین‌کمانی\&.
.RE
.PP
\fB/rainbowme\fR \fI<message>\fR
.RS 4
ارسال پیام به‌صورت یک emote رنگین‌کمانی که نام کاربری شما در ابتدای آن قرار می‌گیرد\&.
.RE
.PP
\fB/notice\fR \fI<message>\fR
.RS 4
ارسال پیام در قالب یک اعلان (notice)\&.
.RE
.PP
\fB/rainbownotice\fR \fI<notice>\fR
.RS 4
ارسال پیام در قالب یک اعلان رنگین‌کمانی\&.
.RE
.SS "مدیریت اتاق"
.PP
\fB/join\fR \fI<roomname>\fR \fI[reason]\fR
.RS 4
پیوستن به یک اتاق\&.
\fIreason\fR
اختیاری است\&.
.RE
.PP
\fB/knock\fR \fI<roomname>\fR \fI[reason]\fR
.RS 4
درخواست برای پیوستن به یک اتاق\&.
\fIreason\fR
اختیاری است\&.
.RE
.PP
\fB/part\fR, \fB/leave\fR \fI[reason]\fR
.RS 4
ترک کردن اتاق فعلی\&.
\fIreason\fR
اختیاری است\&.
.RE
.PP
\fB/invite\fR \fI<username>\fR \fI[reason]\fR
.RS 4
دعوت از یک کاربر به اتاق فعلی\&.
\fIreason\fR
اختیاری است\&.
.RE
.PP
\fB/kick\fR \fI<username>\fR \fI[reason]\fR
.RS 4
اخراج یک کاربر از اتاق فعلی\&.
\fIreason\fR
اختیاری است\&. همچنین می‌توانید با مشخص نکردن
\fIusername\fR\&،
کاربری را که به او پاسخ می‌دهید اخراج کنید\&.
.RE
.PP
\fB/ban\fR \fI<username>\fR \fI[reason]\fR
.RS 4
مسدود کردن یک کاربر از اتاق فعلی\&.
\fIreason\fR
اختیاری است\&. همچنین می‌توانید با مشخص نکردن
\fIusername\fR\&،
کاربری را که به او پاسخ می‌دهید مسدود کنید\&.
.RE
.PP
\fB/unban\fR \fI<username>\fR \fI[reason]\fR
.RS 4
رفع مسدودیت یک کاربر\&.
\fIreason\fR
اختیاری است\&. همچنین می‌توانید با مشخص نکردن
\fIusername\fR\&،
کاربری را که به او پاسخ می‌دهید رفع مسدودیت کنید\&.
.RE
.PP
\fB/redact\fR \fI<username>\fR \fI[reason]\fR
.RS 4
تمام پیام‌های قابل مشاهده کاربر مشخص‌شده را حذف (redact) می‌کند\&. خیلی سریع با محدودیت نرخ درخواست مواجه خواهید شد\&.
.RE
.PP
\fB/redact\fR \fI<eventid>\fR \fI[reason]\fR
.RS 4
یک رویداد خاص را حذف (redact) می‌کند\&. همچنین می‌توانید با مشخص نکردن هیچ‌یک از
\fIeventid\fR
یا
\fIusername\fR\&،
رویدادی را که به آن پاسخ می‌دهید حذف کنید\&.
.RE
.PP
\fB/roomnick\fR \fI<roomname>\fR
.RS 4
تغییر نام مستعار خود در یک اتاق مشخص\&.
.RE
.PP
\fB/glitch\fR \fI<message>\fR
.RS 4
یک جلوه گلیچ (glitch) بر روی
\fImessage\fR
داده‌شده اعمال می‌کند\&. توجه داشته باشید که این کار منشن‌ها، HTML و برخی قالب‌بندی‌های Markdown را در پیام شما مختل می‌کند\&.
.RE
.PP
\fB/gradualglitch\fR \fI<message>\fR
.RS 4
یک جلوه گلیچ به‌مرور شدیدتر بر روی
\fImessage\fR
اعمال می‌کند\&. مجدداً، این کار منشن‌ها، HTML و برخی قالب‌بندی‌های Markdown را مختل خواهد کرد\&.
.RE.SS "شکلک‌ها (Emoticons)"
.PP
\fB/shrug\fR \fI[message]\fR
.RS 4
عبارت
\(a-\e_(ツ)_/\(a-
را به همراه یک
\fImessage\fR
اختیاری در ادامه درج می‌کند\&.
.RE
.PP
\fB/fliptable\fR
.RS 4
عبارت
(╯\(de□\(de)╯︵ ┻━┻
را درج می‌کند\&.
.RE
.PP
\fB/unfliptable\fR
.RS 4
عبارت
┯━┯╭( \(Om _ \(Om╭)
را درج می‌کند\&.
.RE
.PP
\fB/sovietflip\fR
.RS 4
عبارت
ノ┬─┬ノ ︵ ( \e\eo\(deo)\e\e
را درج می‌کند\&.
.RE
.SS "مدیریت کاربران (User management)"
.PP
\fB/ignore\fR \fI<username>\fR
.RS 4
یک کاربر را نادیده می‌گیرد؛ دعوت‌های ارسال‌شده از سوی او نیز رد می‌شوند\&.
.RE
.PP
\fB/unignore\fR \fI<username>\fR
.RS 4
نادیده‌گرفتن یک کاربر را متوقف می‌کند\&.
.RE
.SS "مدیریت مجوزهای دعوت (Invite permission management)"
.PP
\fB/blockinvites\fR \fI<username>\fR|\fI<roomid>\fR|\fI<servername>\fR|all
.RS 4
تمامی دعوت‌ها را یا به‌صورت پیش‌فرض ("all") یا از سوی یک کاربر یا سرور خاص یا به یک اتاق خاص مسدود می‌کند\&.
.RE
.PP
\fB/allowinvites\fR \fI<username>\fR|\fI<roomid>\fR|\fI<servername>\fR|all
.RS 4
تمامی دعوت‌ها را یا به‌صورت پیش‌فرض ("all") یا از سوی یک کاربر یا سرور خاص یا به یک اتاق خاص مجاز می‌کند\&.
.RE
.SS "پیشرفته (Advanced)"
.PP
\fB/clear\-timeline\fR
.RS 4
همه‌ی پیام‌ها به جز جدیدترین پیام‌ها را از خط زمانی رندرشده‌ی فعلی پاک کرده و سپس آن را دوباره از سرور واکشی می‌کند؛ می‌تواند برای رفع برخی از مشکلات حافظه‌ی موقت (cache) به کار رود\&.
.RE
.PP
\fB/reset\-state\fR
.RS 4
تمام رویدادهای وضعیت در اتاق فعلی را دوباره واکشی می‌کند؛ می‌تواند برای رفع برخی از مشکلات حافظه‌ی موقت (cache) به کار رود\&.
.RE
.PP
\fB/rotate\-megolm\-session\fR
.RS 4
کلید رمزگذاری مورد استفاده برای ارسال پیام‌های رمزگذاری‌شده در یک اتاق را تعویض می‌کند (rotate)\&.
.RE
.PP
\fB/goto\fR \fI<address>\fR
.RS 4
\fIaddress\fR
می‌تواند یکی از موارد زیر باشد:
.PP
\fI<event ID>\fR
.RS 4
به رویدادی با شناسه‌ی مشخص‌شده پرش کرده و آن را برجسته می‌کند\&.
.RE
.PP
\fI<message index>\fR
.RS 4
به پیامی با نمایه‌ی (index) مشخص‌شده پرش کرده و آن را برجسته می‌کند\&.
.RE
.PP
\fI<Matrix URI>\fR
.RS 4
با Matrix URI به‌گونه‌ای رفتار می‌کند که گویی روی آن کلیک کرده‌اید\&.
.RE
.RE
.PP
\fB/converttodm\fR
.RS 4
یک اتاق را به یک گفتگوی مستقیم تبدیل می‌کند\&.
.RE
.PP
\fB/converttoroom\fR
.RS 4
یک گفتگوی مستقیم را به یک اتاق عادی تبدیل می‌کند\&.
.RE.SH "افزونه‌های مارک‌داون (MARKDOWN EXTENSIONS)"
.PP
\fBخط جدید (\fR\fB\en\fR\fB)\fR
.RS 4
یک خط جدیدِ تکی، به‌جای فاصله، به
<br>
تبدیل خواهد شد\&.
.RE
.PP
\fB~text~\fR
.RS 4
متن را خط‌خورده می‌کند\&. خروجی HTML:
<del>text</del>
.RE
.PP
\fB||spoiler warning|text||\fR
.RS 4
متن را پنهان کرده و یک هشدار اسپویلر اختیاری تنظیم می‌کند\&. توجه داشته باشید که Nheko در حال حاضر هشدار اسپویلر را نمایش نمی‌دهد\&. خروجی HTML:
<span data\-mx\-spoiler="spoiler">text</span>
.RE
.SH "محیط (ENVIRONMENT)"
.PP
\fBNHEKO_ALLOW_QML_DISK_CACHE\fR
.RS 4
برنامه Nheko به‌طور پیش‌فرض حافظه نهان (کش) دیسک qml را برای جلوگیری از کرش کردن غیرفعال می‌کند\&. این متغیر به شما امکان می‌دهد آن را با مسئولیت خودتان دوباره فعال کنید\&.
.RE
.SH "فایل‌ها (FILES)"
.PP
\fBفایل پیکربندی\fR
.RS 4
${XDG_CONFIG_HOME:\-~/\&.config}/nheko/nheko\&.conf
.RE
.PP
\fBفایل لاگ\fR
.RS 4
${XDG_CACHE_HOME:\-~/\&.cache}/nheko/nheko/nheko\&.log
.RE
.PP
\fBپایگاه‌داده\fR
.RS 4
${XDG_DATA_HOME:\-~/\&.local/share}/nheko/nheko/*/data\&.mdb
.RE
.PP
\fBکش رسانه\fR
.RS 4
${XDG_CACHE_HOME:\-~/\&.cache}/nheko/nheko/media_cache
.RE
.SH "گزارش باگ‌ها (REPORTING BUGS)"
.sp
لطفاً مشکلات را در سامانه ردیابی باگ ما در https://github\&.com/Nheko\-Reborn/nheko/issues گزارش دهید\&.