.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH mqttui 1  "mqttui 0.24.0"
.SH "نام (NAME)"
mqttui \- رابط کاربری متنی برای اشتراک و انتشار پیام‌های MQTT
.SH "خلاصه دستور (SYNOPSIS)"
\fBmqttui\fR [\fB\-\-qos\fR] [\fB\-\-payload\-size\-limit\fR] [\fB\-b\fR|\fB\-\-broker\fR] [\fB\-u\fR|\fB\-\-username\fR] [\fB\-\-password\fR] [\fB\-i\fR|\fB\-\-client\-id\fR] [\fB\-\-ca\-cert\fR] [\fB\-\-client\-cert\fR] [\fB\-\-client\-private\-key\fR] [\fB\-\-insecure\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fIموضوع\fR] [\fIزیردستورها\fR]
.SH "توضیحات (DESCRIPTION)"
اشتراک در موضوعات (Topics) پروتکل MQTT یا انتشار سریع داده‌ها از طریق ترمینال.
.SH "گزینه‌ها (OPTIONS)"
.TP
\fB\-\-qos\fR \fI<LEVEL>\fR [پیش‌فرض: 2]
حداکثر سطح کیفیت خدمات (`QoS`) برای اشتراک‌ها و انتشار پیام.

سطح پایین‌تر کیفیت خدمات میان ناشر و مشترک، توسط کارگزار (Broker) به مشترک تحویل داده می‌شود. بنابراین اشتراک با سطح 0 هرگز پیام‌های با سطح 1 یا 2 را دریافت نمی‌کند. انتشار پیام با سطح 2 هنگام اشتراک با سطح 1، به‌صورت سطح 1 تحویل گرفته می‌شود.

\- 0: حداکثر یک‌بار (fire and forget)

\- 1: حداقل یک‌بار (تحویل تاییدشده همراه با احتمال تکرار)

\- 2: دقیقاً یک‌بار (تحویل تضمین‌شده بدون تکرار)
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_QOS\fR نیز مشخص شود.
.RE
.TP
\fB\-\-payload\-size\-limit\fR \fI<PAYLOAD_SIZE_LIMIT>\fR [پیش‌فرض: 8000]
کوتاه‌سازی و برش حجم داده‌های بار مفید (Payload) ذخیره‌شده به اندازه مشخص‌شده.

بارهای مفید بزرگ‌تر از این مقدار بریده شده و از نظر قالب‌هایی مانند JSON یا MessagePack بررسی نمی‌شوند. تنها بخش ابتدایی آن‌ها تا سقف بایت تعیین‌شده قابل‌مشاهده خواهد بود. افزایش این مقدار ممکن است به‌ویژه در طول زمان منجر به مصرف حافظه بیشتر شود.
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_PAYLOAD_SIZE_LIMIT\fR نیز مشخص شود.
.RE
.TP
\fB\-h\fR, \fB\-\-help\fR
نمایش راهنما (مشاهده خلاصه با \*(Aq\-h\*(Aq)
.TP
\fB\-V\fR, \fB\-\-version\fR
نمایش نسخه
.TP
[\fIموضوع\fR] [پیش‌فرض: #]
موضوع (Topic) مورد نظر برای پایش و رصد
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_TOPIC\fR نیز مشخص شود.
.RE
.SH "اتصال به کارگزار (MQTT CONNECTION)"
.TP
\fB\-b\fR, \fB\-\-broker\fR \fI<URL>\fR [پیش‌فرض: mqtt://localhost]
نشانی اینترنتی (URL) نحوه اتصال به کارگزار MQTT.

مثال‌ها: `mqtt://localhost` `mqtt://localhost:1883` `mqtts://localhost` `mqtts://localhost:8883` `ws://localhost/path` `ws://localhost:9001/path` `wss://localhost/path` `wss://localhost:9001/path`
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_BROKER\fR نیز مشخص شود.
.RE
.TP
\fB\-u\fR, \fB\-\-username\fR \fI<STRING>\fR
نام کاربری برای دسترسی به کارگزار MQTT.

در صورت عدم ارائه، دسترسی ناشناس (Anonymous) استفاده می‌شود.
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_USERNAME\fR نیز مشخص شود.
.RE
.TP
\fB\-\-password\fR \fI<STRING>\fR
گذرواژه برای دسترسی به کارگزار MQTT.

استفاده از اتصال امن TLS به کارگزار را مد نظر داشته باشید؛ در غیر این صورت گذرواژه به‌صورت متن ساده (Plaintext) منتقل خواهد شد.

ارسال گذرواژه از طریق خط فرمان ناامن است زیرا گذرواژه از تاریخچه دستورات قابل‌خواندن خواهد بود! توصیه می‌شود آن را از طریق متغیر محیطی منتقل کنید.
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_PASSWORD\fR نیز مشخص شود.
.RE
.TP
\fB\-i\fR, \fB\-\-client\-id\fR \fI<STRING>\fR
مشخص کردن شناسه کلاینت (Client ID) برای اتصال
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_CLIENTID\fR نیز مشخص شود.
.RE
.TP
\fB\-\-ca\-cert\fR \fI<FILEPATH>\fR
مسیر فایل PEM گواهی صادرکننده مورد اعتماد (CA) برای اعتبارسنجی کارگزار.

گواهی CA باید از نوع گواهی X.509 v3 باشد، زیرا rustls از گواهی‌های نسخه v1 با امنیت کمتر پشتیبانی نمی‌کند. ببینید: <https://github.com/rustls/rustls/issues/2364>
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_CA_CERTIFICATE\fR نیز مشخص شود.
.RE
.TP
\fB\-\-client\-cert\fR \fI<FILEPATH>\fR
مسیر فایل گواهی کلاینت TLS.

همراه با \-\-client\-private\-key برای فعال‌سازی احراز هویت کلاینت در TLS استفاده می‌شود. فایل باید گواهی X.509 با کدگذاری DER و سریال‌شده در قالب PEM باشد.
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_CLIENT_CERTIFICATE\fR نیز مشخص شود.
.RE
.TP
\fB\-\-client\-private\-key\fR \fI<FILEPATH>\fR
مسیر فایل کلید خصوصی کلاینت TLS.

همراه با \-\-client\-cert برای فعال‌سازی احراز هویت کلاینت در TLS استفاده می‌شود. فایل باید ساختار ASN.1 با کدگذاری DER در قالب PKCS#8 و سریال‌شده در قالب PEM باشد.
.RS
می‌تواند از طریق متغیر محیطی \fBMQTTUI_CLIENT_PRIVATE_KEY\fR نیز مشخص شود.
.RE
.TP
\fB\-\-insecure\fR
اجازه به اتصالات TLS ناامن
.SH "زیردستورها (SUBCOMMANDS)"
.TP
mqttui\-clean\-retained(1)
پاک‌سازی پیام‌های نگه‌داشته‌شده (Retained) از کارگزار
.TP
mqttui\-log(1)
ثبت وقایع و مقادیر موضوعات مشترک‌شده در خروجی استاندارد (stdout)
.TP
mqttui\-read\-one(1)
انتظار برای دریافت اولین پیام روی موضوع(های) مشخص‌شده و بازگرداندن داده بار مفید آن به خروجی استاندارد
.TP
mqttui\-publish(1)
انتشار سریع یک مقدار
.SH "نسخه (VERSION)"
v0.24.0