.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "wayvncctl" "1" "2026\-07\-19"
.PP
.SH "نام (NAME)"
.PP
wayvncctl \- یک کلاینت خط فرمان برای کنترل wayvnc(1)
.PP
.SH "خلاصه دستور (SYNOPSIS)"
.PP
\fBwayvncctl\fR [options] [command [\-\-parameter value .\&.\&.\&]]
.PP
.SH "گزینه‌ها (OPTIONS)"
.PP
\fB\-S, \-\-socket=<path>\fR
.RS 4
مسیر سوکت کنترلی wayvnc را تعیین می‌کند.\& پیش‌فرض: $XDG_RUNTIME_DIR/wayvncctl
یا /tmp/wayvncctl\-$UID
.PP
.RE
\fB\-w, \-\-wait\fR
.RS 4
اگر wayvnc هنوز در حال اجرا نیست، منتظر راه‌اندازی آن می‌ماند.\& پیش‌فرض: در صورت
در حال اجرا نبودن wayvnc، بلافاصله با یک خطا خارج می‌شود.\&
.PP
.RE
\fB\-r, \-\-reconnect\fR
.RS 4
اگر هنگام انتظار برای رویدادها اتصال قطع شود، منتظر راه‌اندازی مجدد wayvnc می‌ماند
و دوباره برای رویدادها ثبت‌نام می‌کند.\& پیش‌فرض: هنگام خروج wayvnc خارج می‌شود.\&
.PP
.RE
\fB\-j, \-\-json\fR
.RS 4
خروجی JSON را در stdout تولید می‌کند.\&
.PP
.RE
\fB\-V, \-\-version\fR
.RS 4
اطلاعات نسخه را نشان می‌دهد.\&
.PP
.RE
\fB\-v, \-\-verbose\fR
.RS 4
توضیحات و جزئیات بیشتری نمایش می‌دهد.\&
.PP
.RE
\fB\-h, \-\-help\fR
.RS 4
راهنمایی درباره خود دستور wayvncctl دریافت می‌کند (این گزینه‌ها را فهرست می‌کند).\& به
سوکت کنترلی wayvncctl متصل نمی‌شود.\&
.PP
.RE
.SH "توضیحات (DESCRIPTION)"
.PP
دستور \fBwayvnc(1)\fR امکان تعامل در زمان اجرا را از طریق سازوکار json\-ipc سوکت یونیکس فراهم می‌کند.\&
این ابزار خط فرمان، تعامل آسان با آن دستورها را میسر می‌سازد.\&
.PP
این دستور تا حد زیادی خودتوصیف‌گر (self\-documenting) است:
.PP
.PD 0
.IP \(bu 4
اجرای \fBwayvncctl \-\-help\fR تمامی دستورهای IPC پشتیبانی‌شده را فهرست می‌کند.\&
.IP \(bu 4
اجرای \fBwayvncctl command\-name \-\-help\fR توضیحی از دستور داده‌شده و پارامترهای
دردسترس آن را بازمی‌گرداند.\&
.IP \(bu 4
اجرای \fBwayvncctl event\-receive \-\-help\fR فهرستی از تمام نام‌های رویدادهای
پشتیبانی‌شده را ارائه می‌دهد.\&
.IP \(bu 4
اجرای \fBwayvncctl event\-receive \-\-show=event\-name\fR توضیحی درباره
رویداد داده‌شده و فیلدهای داده مورد انتظار بازمی‌گرداند.\&
.PD
.PP
.SH "رویدادهای ناهمگام (ASYNCHRONOUS EVENTS)"
.PP
در حالی که \fBwayvncctl\fR به طور معمول پس از ارسال یک درخواست و دریافت
پاسخ مربوطه خاتمه می‌یابد، دستور \fBevent\-receive\fR به گونه دیگری عمل می‌کند.\&
به جای خروج فوری، \fBwayvncctl\fR منتظر هرگونه رویدادی از سرور می‌ماند و با رسیدن
هر کدام، آن را در stdout چاپ می‌کند.\& این حالت کاری تا زمانی که سیگنالی برای خاتمه دریافت
کند، یا تا زمانی که سرور wayvnc متوقف شود، مسدود می‌ماند.\&
.PP
در حالت \fI\-\-json\fR، برای تسهیل در اسکریپت‌نویسی، هر رویداد در یک خط همراه با یک نویسه
خط جدید در انتها چاپ می‌شود:
.PP
.nf
.RS 4
$ wayvncctl \-\-json event\-receive
{"method":"client\-connected","params":{"id":"0x10ef670","address":null,"username":null,"connection_count":1}}
{"method":"client\-disconnected","params":{"id":"0x10ef670","address":null,"username":null,"connection_count":0}}
.fi
.RE
.PP
خروجی پیش‌فرض و قابل خواندن برای انسان، یک قالب چندخطی شبیه به YAML است که دو
نویسه خط جدید میان هر رویداد قرار دارد:
.PP
.nf
.RS 4
$ wayvncctl event\-receive

client\-connected:
  id: 0x10ef670
  address: 192\&.168\&.1\&.18
  connection_count: 1

client\-disconnected:
  id: 0x10ef670
  address: 192\&.168\&.1\&.18
  connection_count: 0

.fi
.RE
.PP
.SS "انواع رویدادهای محلی ویژه (SPECIAL LOCAL EVENT TYPES)"
.PP
به‌ویژه هنگام استفاده از حالت \fI\-\-wait\fR یا \fI\-\-reconnect\fR، دستور wayvncctl دو رویداد
اضافی تولید خواهد کرد که در \fBwayvnc(1)\fR مستند نشده‌اند:
.PP
\fBwayvnc\-startup\fR
.RS 4
هنگامی ارسال می‌شود که یک اتصال کنترلی موفق به wayvnc برقرار شده و
ثبت رویداد با موفقیت انجام گرفته باشد؛ چه هنگام راه‌اندازی اولیه و چه در
ثبت‌های بعدی با \fI\-\-reconnect\fR.\&
.PP
بدون پارامتر.\&
.PP
.RE
\fBwayvnc\-shutdown\fR
.RS 4
هنگامی ارسال می‌شود که اتصال کنترلی wayvnc قطع شود، که معمولاً به دلیل
خروج wayvnc رخ می‌دهد.\&
.PP
بدون پارامتر.\&
.PP
.RE
.SH "مثال‌ها (EXAMPLES)"
.PP
دریافت راهنما برای دستور IPC به نام "output\-set":
.PP
.nf
.RS 4
$ wayvncctl output\-set \-\-help
Usage: wayvncctl [options] output\-set <output\-name> [params]
\&.\&.\&.
.fi
.RE
.PP
چرخش به خروجی فعال بعدی:
.PP
.nf
.RS 4
$ wayvncctl output\-cycle
.fi
.RE
.PP
دریافت اطلاعات نسخه با قالب JSON:
.PP
.nf
.RS 4
$ wayvncctl \-\-json version
{"wayvnc":"v0\&.5\&.0","neatvnc":"v0\&.5\&.1","aml":"v0\&.2\&.2"}
.fi
.RE
.PP
اسکریپتی که برای هر رویداد اتصال و قطع اتصال کلاینت، عملیاتی را انجام می‌دهد:
.PP
.nf
.RS 4
#!/bin/bash

connection_count_now() {
    echo "Total clients: $1"
}

while IFS= read \-r EVT; do
    case "$(jq \-r \&'\&.method\&' <<<"$EVT")" in
        client\-*onnected)
            count=$(jq \-r \&'\&.params\&.connection_count\&' <<<"$EVT")
            connection_count_now "$count"
            ;;
        wayvnc\-shutdown)
            connection_count_now 0
            ;;
    esac
done < <(wayvncctl \-\-wait \-\-reconnect \-\-json event\-receive)
.fi
.RE
.PP
.SH "محیط (ENVIRONMENT)"
.PP
متغیرهای محیطی زیر بر wayvncctl تأثیر می‌گذارند:
.PP
\fIXDG_RUNTIME_DIR\fR
.RS 4
مکان پیش‌فرض را برای سوکت کنترلی wayvncctl مشخص می‌کند.\&
.PP
.RE
.SH "همچنین ببینید (SEE ALSO)"
.PP
\fBwayvnc(1)\fR