.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH mqttui-clean-retained 1  "clean-retained " 
.SH "نام (NAME)"
mqttui\-clean\-retained \- پاک‌سازی پیام‌های ماندگار (retained) از کارگزار (broker)
.SH "خلاصه دستور (SYNOPSIS)"
\fBmqttui clean\-retained\fR [\fB\-\-timeout\fR] [\fB\-\-dry\-run\fR] [\fB\-\-qos\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] <\fITOPIC\fR> 
.SH "توضیحات (DESCRIPTION)"
پاک‌سازی پیام‌های ماندگار (retained) از broker.
.PP
این دستور با اشتراک در موضوع (topic) و انتظار برای دریافت پیام‌هایی با نشانگر retained کار می‌کند. سپس پیامی با محتوای داده‌ای (payload) خالی به‌صورت retained ارسال می‌شود که باعث پاک‌سازی موضوع روی broker می‌گردد. این فرایند با دریافت نخستین پیام غیرretained یا به پایان رسیدن مهلت زمانی (timeout) خاتمه می‌یابد.
.SH "گزینه‌ها (OPTIONS)"
.TP
\fB\-\-timeout\fR \fI<SECONDS>\fR [پیش‌فرض: 5]
چنانچه در بازه زمانی تعیین‌شده هیچ پیامی دریافت نشود، عملیات پایان‌یافته در نظر گرفته می‌شود.
.TP
\fB\-\-dry\-run\fR
موضوعات را پاک نمی‌کند، فقط آن‌ها را ثبت (log) می‌کند.
.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\-h\fR, \fB\-\-help\fR
چاپ راهنما (مشاهده خلاصه با \*(Aq\-h\*(Aq)
.TP
<\fITOPIC\fR>
موضوعی (topic) که پاک‌سازی می‌شود.

از فیلترهایی مانند \*(Aqfoo/bar/#\*(Aq پشتیبانی می‌کند.
.SH "اتصال MQTT (MQTT CONNECTION)"
.TP
\fB\-b\fR, \fB\-\-broker\fR \fI<URL>\fR [پیش‌فرض: mqtt://localhost]
آدرس URL که نحوه اتصال به broker پروتکل 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
نام کاربری برای دسترسی به broker پروتکل mqtt.

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

استفاده از اتصال TLS به broker را در نظر داشته باشید؛ در غیر این صورت گذرواژه به‌صورت متن آشکار (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 معتبر برای اعتبارسنجی broker.

گواهی 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