.TH pulse-cli-syntax 5 User Manuals
.SH "نام (NAME)"
pulse-cli-syntax \- نحو رابط خط فرمان پالس‌آدیو
.SH "خلاصه دستور (SYNOPSIS)"
\fB\fI~/.config/pulse/default.pa\fB

\fI/etc/pulse/default.pa\fB

\fI/etc/pulse/system.pa\fB
\f1
.SH "توضیحات (DESCRIPTION)"
پالس‌آدیو (PulseAudio) یک زبان خط فرمان ساده ارائه می‌دهد که توسط اسکریپت‌های پیکربندی، پوسته تعاملی pacmd و ماژول‌های module-cli و module-cli-protocol-{unix,tcp} استفاده می‌شود. خطوط خالی و خطوطی که با علامت هش (#) آغاز می‌شوند، بدون اعلان نادیده گرفته می‌شوند. دستورات متعددی پشتیبانی می‌شوند.
.PP
توجه داشته باشید که هر آرگومان بولی (boolean) را می‌توان به صورت مثبت با '1'، 't'، 'y'، 'true'، 'yes' یا 'on' مشخص کرد. به همین ترتیب، مقادیر منفی را می‌توان با '0'، 'f'، 'n'، 'false'، 'no' یا 'off' تعیین نمود. بزرگی و کوچکی حروف نادیده گرفته می‌شود.
.SH "دستورات عمومی (GENERAL COMMANDS)"
.TP
\fBhelp\f1
نمایش راهنمای سریع درباره دستورات موجود.
.SH "دستورات وضعیت (STATUS COMMANDS)"
.TP
\fBlist-modules\f1
نمایش تمام ماژول‌های بارگذاری‌شده فعلی به همراه آرگومان‌های آن‌ها.
.TP
\fBlist-cards\f1
نمایش تمام کارت‌های ثبت‌شده فعلی.
.TP
\fBlist-sinks\f1 or \fBlist-sources\f1
نمایش تمام سینک‌ها (یا به ترتیب، سورس‌های) ثبت‌شده فعلی.
.TP
\fBlist-clients\f1
نمایش تمام کلاینت‌های فعال فعلی.
.TP
\fBlist-sink-inputs\f1 or \fBlist-source-outputs\f1
نمایش تمام ورودی‌های فعال به سینک‌ها (معروف به استریم‌های پخش) یا به ترتیب خروجی‌های سورس‌ها (معروف به استریم‌های ضبط).
.TP
\fBstat\f1
نمایش آمارهای ساده‌ای درباره بلوک‌های حافظه تخصیص‌یافته و فضای مصرف‌شده توسط آن‌ها.
.TP
\fBinfo\f1 or \fBls\f1 or \fBlist\f1
ترکیبی از تمام دستورات وضعیت شرح‌داده‌شده در بالا (هر سه دستور مترادف یکدیگرند).
.SH "مدیریت ماژول‌ها (MODULE MANAGEMENT)"
.TP
\fBload-module\f1 \fIname\f1 [\fIarguments...\f1]
بارگذاری یک ماژول مشخص‌شده با نام و آرگومان‌های آن. برای اکثر ماژول‌ها، بیش از یک بار بارگذاری شدن بلامانع است.
.TP
\fBunload-module\f1 \fIindex|name\f1
تخلیه یک ماژول که با نمایه (index) آن در فهرست ماژول‌ها یا نام آن مشخص می‌شود.
.TP
\fBdescribe-module\f1 \fIname\f1
ارائه اطلاعات درباره ماژولی که با نام آن مشخص شده است.
.SH "دستورات حجم صدا (VOLUME COMMANDS)"
.TP
\fBset-sink-volume|set-source-volume\f1 \fIindex|name\f1 \fIvolume\f1
تنظیم حجم صدای سینک (یا به ترتیب سورس) مشخص‌شده. می‌توانید سینک (یا سورس) را با نمایه آن در فهرست سینک‌ها/سورس‌ها یا با نام آن مشخص کنید. حجم صدا باید یک مقدار عددی صحیح بزرگ‌تر یا مساوی با 0 (بی‌صدا) باشد. مقدار حجم صدای 65536 (0x10000) به عنوان حجم صدای «عادی» یا همان ۱۰۰٪ در نظر گرفته می‌شود. مقادیر بزرگ‌تر از این، سیگنال صوتی را تقویت می‌کنند (همراه با اعوجاج یا بریدگی صدا / clipping).
.TP
\fBset-sink-mute|set-source-mute\f1 \fIindex|name\f1 \fIboolean\f1
بی‌صدا کردن یا لغو بی‌صدایی سینک (یا به ترتیب سورس) مشخص‌شده. می‌توانید سینک (یا سورس) را با نمایه یا نام آن مشخص کنید. مقدار بی‌صدایی 0 (با صدا) یا 1 (بی‌صدا) است.
.TP
\fBset-sink-input-volume|set-source-output-volume\f1 \fIindex\f1 \fIvolume\f1
تنظیم حجم صدای ورودی سینک (یا به ترتیب خروجی سورس) مشخص‌شده با نمایه آن. همان قوانین حجم صدا در set-sink-volume در اینجا نیز اعمال می‌شود.
.TP
\fBset-sink-input-mute|set-source-output-mute\f1 \fIindex\f1 \fIboolean\f1
بی‌صدا کردن یا لغو بی‌صدایی ورودی سینک (یا به ترتیب خروجی سورس) مشخص‌شده با نمایه آن. همان قوانین بی‌صدایی در set-sink-mute در اینجا نیز اعمال می‌شود.
.SH "دستورات پیکربندی (CONFIGURATION COMMANDS)"
.TP
\fBset-default-sink|set-default-source\f1 \fIindex|name\f1
تنظیم یک سینک (یا به ترتیب سورس) به عنوان پیش‌فرض. می‌توانید سینک (یا سورس) را با نمایه آن در فهرست یا با نام آن مشخص کنید. از نام ویژه \@NONE@ برای لغو سینک یا سورس پیش‌فرض تعیین‌شده توسط کاربر استفاده کنید. در این حالت، پالس‌آدیو به انتخاب پیش‌فرض بر اساس اولویت بازخواهد گشت.
.PP
توجه داشته باشید که پیش‌فرض‌ها ممکن است توسط ماژول‌های سیاست‌گذاری گوناگون یا پیکربندی‌های استریم خاص بازنویسی شوند.
.TP
\fBset-card-profile\f1 \fIindex|name\f1 \fIprofile-name\f1
تغییر نمایه کاربری (profile) یک کارت صدا.
.TP
\fBset-sink-port|set-source-port\f1 \fIindex|name\f1 \fIport-name\f1
تغییر درگاه (port) یک سینک (یا به ترتیب سورس).
.TP
\fBset-port-latency-offset\f1 \fIcard-index|card-name\f1 \fIport-name\f1 \fIoffset\f1
تغییر افست تأخیر یک درگاه متعلق به کارت مشخص‌شده.
.TP
\fBsuspend-sink|suspend-source\f1 \fIname|index\f1 \fItrue|false\f1
تعلیق یا از سرگیری سینک یا سورس مشخص‌شده (که می‌تواند با نام یا نمایه تعیین شود)، بسته به اینکه مقدار true (تعلیق) یا false (از سرگیری) به عنوان آخرین آرگومان ارسال شده باشد. تعلیق یک سینک تمام پخش‌ها را متوقف می‌کند و تعلیق یک سورس تمام ضبط‌ها را متوقف می‌سازد. بسته به ماژولی که سینک یا سورس را پیاده‌سازی می‌کند، این کار ممکن است منجر به بسته شدن دستگاه زیربنایی شود و آن را برای استفاده سایر برنامه‌ها آزاد کند. رفتار دقیق بستگی به ماژول دارد.
.TP
\fBsuspend\f1 \fIboolean\f1
تعلیق تمام سینک‌ها و سورس‌ها.
.SH "انتقال استریم‌ها (MOVING STREAMS)"
.TP
\fBmove-sink-input|move-source-output\f1 \fIindex\f1 \fIsink-index|sink-name\f1
انتقال ورودی سینک (یا به ترتیب خروجی سورس) به سینک (یا به ترتیب سورس) دیگر.
.SH "فهرست‌های ویژگی (PROPERTY LISTS)"
.TP
\fBupdate-sink-proplist|update-source-proplist\f1 \fIindex|name\f1 \fIproperties\f1
به‌روزرسانی ویژگی‌های سینک (یا به ترتیب سورس) مشخص‌شده با نام یا نمایه. ویژگی‌ها به عنوان مثال به صورت device.description="My Preferred Name" مشخص می‌شوند.
.TP
\fBupdate-sink-input-proplist|update-source-output-proplist\f1 \fIindex\f1 \fIproperties\f1
به‌روزرسانی ویژگی‌های ورودی سینک (یا به ترتیب خروجی سورس) مشخص‌شده با نمایه. ویژگی‌ها مانند بالا مشخص می‌شوند.
.SH "حافظه پنهان نمونه‌ها (SAMPLE CACHE)"
.TP
\fBlist-samples\f1
فهرست کردن محتویات حافظه پنهان نمونه‌ها.
.TP
\fBplay-sample\f1 \fIname\f1 \fIsink-index|sink-name\f1
پخش یک ورودی حافظه پنهان نمونه در یک سینک.
.TP
\fBremove-sample\f1 \fIname\f1
حذف یک ورودی از حافظه پنهان نمونه‌ها.
.TP
\fBload-sample\f1 \fIname\f1 \fIfilename\f1
بارگذاری یک فایل صوتی در حافظه پنهان نمونه‌ها.
.TP
\fBload-sample-lazy\f1 \fIname\f1 \fIfilename\f1
ایجاد یک ورودی جدید در حافظه پنهان نمونه‌ها، بدون بارگذاری فوری آن. نمونه تنها زمانی بارگذاری می‌شود که برای نخستین بار استفاده شود. پس از مدتی بیکاری (idle time)، مجدداً حافظه آن آزاد می‌شود.
.TP
\fBload-sample-dir-lazy\f1 \fIpath\f1
بارگذاری تمام ورودی‌های موجود در دایرکتوری مشخص‌شده به صورت تنبل (lazy) در حافظه پنهان نمونه‌ها. یک عبارت تطبیق الگو (مانند *.wav) می‌تواند به انتهای مسیر دایرکتوری افزوده شود.
.SH "متوقف‌سازی کلاینت‌ها/استریم‌ها (KILLING CLIENTS/STREAMS)"
.TP
\fBkill-client\f1 \fIindex\f1
قطع اجباری ارتباط یک کلاینت از سرور. هیچ محافظتی در برابر اتصال مجدد فوری کلاینت وجود ندارد.
.TP
\fBkill-sink-input|kill-source-output\f1 \fIindex\f1
قطع اجباری یک ورودی سینک (یا به ترتیب خروجی سورس) از سرور. این عمل باعث حذف کلاینت مالک یا سایر استریم‌های بازشده توسط همان کلاینت از سرور نمی‌شود.
.SH "دستورات ثبت گزارش (LOG COMMANDS)"
.TP
\fBset-log-level\f1 \fInumeric-level\f1
تغییر سطح ثبت گزارش (log level).
.TP
\fBset-log-meta\f1 \fIboolean\f1
نمایش مکان کد منبع در پیام‌های گزارش.
.TP
\fBset-log-target\f1 \fItarget\f1
تغییر مقصد ثبت گزارش (null, auto, journal, syslog, stderr, file:PATH, newfile:PATH).
.TP
\fBset-log-time\f1 \fIboolean\f1
نمایش برچسب زمان (timestamp) در پیام‌های گزارش.
.TP
\fBset-log-backtrace\f1 \fInum-frames\f1
نمایش ردگیری پشته (backtrace) در پیام‌های گزارش.
.SH "دستورات گوناگون (MISCELLANEOUS COMMANDS)"
.TP
\fBplay-file\f1 \fIfilename\f1 \fIsink-index|sink-name\f1
پخش یک فایل صوتی در یک سینک.
.TP
\fBdump\f1
برون‌ریزی پیکربندی فعلی دیمن در قالب دستورات خط فرمان.
.TP
\fBdump-volumes\f1
اشکال‌زدایی: نمایش وضعیت فعلی تمام حجم‌های صدا.
.TP
\fBshared\f1
اشکال‌زدایی: نمایش ویژگی‌های مشترک.
.TP
\fBsend-message\f1 \fIrecipient\f1 \fImessage\f1 \fImessage_parameters\f1
ارسال یک پیام به شیء گیرنده مشخص‌شده. در صورت نیاز می‌توان یک رشته اضافی حاوی پارامترهای پیام مشخص کرد. یک رشته به عنوان پاسخ به پیام برگردانده می‌شود. برای مشاهده پیام‌های موجود به نشانی https://cgit.freedesktop.org/pulseaudio/pulseaudio/tree/doc/messaging_api.txt مراجعه کنید.
.TP
\fBexit\f1
پایان دادن به فعالیت دیمن. اگر می‌خواهید اتصال خط فرمان را قطع کنید («خروج از حساب / log out»)، می‌توانید از کلید ترکیبی ctrl+d استفاده نمایید.
.SH "دستورات متا (META COMMANDS)"
علاوه بر دستورات شرح‌داده‌شده در بالا، چند دایرکتیو متا توسط مفسر خط فرمان پشتیبانی می‌شوند.
.TP
\fB.include\f1 \fIfilename|folder\f1
اجرای دستورات از فایل اسکریپت مشخص‌شده یا از تمام فایل‌های *.pa موجود در پوشه.
.TP
\fB.fail\f1 and \fB.nofail\f1
فعال‌سازی (یا به ترتیب غیرفعال‌سازی) توقف اجرای اسکریپت جاری در صورت شکست دستورات بعدی. این قابلیت در صورت استفاده در خط فرمان تعاملی نادیده گرفته می‌شود.
.TP
\fB.ifexists\f1 \fIfilename\f1
اجرای بلوک بعدی دستورات تنها در صورتی که فایل مشخص‌شده وجود داشته باشد. معمولاً \fIfilename\f1 به یک ماژول اشاره دارد. مسیرهای نسبی با در نظر گرفتن دایرکتوری ماژول‌ها به عنوان مبنا تحلیل می‌شوند. با استفاده از مسیر مطلق، می‌توان وجود سایر فایل‌ها را نیز بررسی کرد.
.TP
\fB.else\f1 and \fB.endif\f1
یک بلوک از دستورات توسط دستور متای \fB.else\f1 یا \fB.endif\f1 محدود می‌شود. تودرتوسازی دستورات شرطی پشتیبانی نمی‌شود.
.SH "نویسندگان (AUTHORS)"
توسعه‌دهندگان پالس‌آدیو <pulseaudio-discuss (at) lists (dot) freedesktop (dot) org>؛ پالس‌آدیو در \fBhttp://pulseaudio.org\f1 در دسترس است
.SH "همچنین ببینید (SEE ALSO)"
\fBdefault.pa(5)\f1, \fBpacmd(1)\f1, \fBpulseaudio(1)\f1