.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CLUSH.CONF" 5 "2026-07-16" "1.10.1" "ClusterShell User Manual"
.SH "نام (NAME)"
clush.conf \- پرونده پیکربندی برای clush
.SH "توضیحات (DESCRIPTION)"
.sp
پرونده‌های پیکربندی \fBclush\fP(1) در قالب ConfigParser پایتون هستند.
.SS "مکان‌ها (Locations)"
.sp
دستور \fBclush\fP(1) گزینه‌های پیکربندی را از منابع زیر، به ترتیب اولویت نزولی به دست می‌آورد:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
گزینه‌های خط فرمان
.IP 2. 3
\fI$CLUSTERSHELL_CFGDIR/clush.conf\fP (فقط زمانی استفاده می‌شود که $CLUSTERSHELL_CFGDIR تعریف شده باشد)
.IP 3. 3
پرونده پیکربندی کاربر (\fI$XDG_CONFIG_HOME/clustershell/clush.conf\fP، به طور پیش‌فرض \fI$HOME/.config/clustershell/clush.conf\fP)
.IP 4. 3
محیط مجازی پایتون (\fI{sys.prefix}/etc/clustershell/clush.conf\fP)
.IP 5. 3
نصب محلی کاربر با pip (\fI$HOME/.local/etc/clustershell/clush.conf\fP)
.IP 6. 3
پرونده پیکربندی سراسری سیستم (\fI/etc/clustershell/clush.conf\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
برای هر پارامتر، اولین مقدار دریافت‌شده استفاده خواهد شد.
.sp
پرونده پیکربندی دارای قالبی به سبک RFC 822 شامل یک بخش اصلی است:
.INDENT 0.0
.TP
.B Main
تعریف گزینه‌های برنامه
.UNINDENT
.SS [Main]
.sp
پارامترهای پیکربندی بخش \fBMain\fP در زیر توضیح داده شده‌اند.
.INDENT 0.0
.TP
.B fanout
اندازه پنجره لغزان (fanout) دستورات فعال برای \fBclush\fP\&. این \fIfanout\fP برای جلوگیری از اتصالات همزمان بیش از حد و حفظ منابع در میزبان‌های مبدا استفاده می‌شود. در حالت درختی (tree mode)، مقدار یکسانی از \fIfanout\fP در گره اصلی (head node) و در هر درگاه (gateway) استفاده می‌شود (مقدار \fIfanout\fP منتشر می‌شود). یعنی اگر مقدار \fIfanout\fP در گره اصلی \fB16\fP باشد، هر درگاه به طور همزمان حداکثر \fB16\fP اتصال به گره‌های هدف خود برقرار می‌کند.
.TP
.B confdir
فهرست اختیاری از مسیرهای دایرکتوری که clush باید در آن‌ها به دنبال پرونده‌های \fI\&.conf\fP بگردد؛ پرونده‌هایی که حالت‌های اجرا را تعریف می‌کنند و سپس می‌توانند با \fB\-\-mode\fP فعال شوند. تمام تنظیمات دیگر پرونده پیکربندی clush که در اینجا تعریف شده‌اند ممکن است در یک حالت اجرا بازنویسی شوند. نام هر بخش حالت باید دارای پیشوند \(dqmode:\(dq باشد تا بخشی که یک حالت را تعریف می‌کند به وضوح مشخص شود. حالت‌های تکراری در این پرونده‌ها مجاز نیستند. پرونده‌های پیکربندی که برای کاربر فعلی قابل خواندن نباشند نادیده گرفته می‌شوند. متغیر \fI$CFGDIR\fP با مسیر دایرکتوری پیکربندی با بالاترین اولویت یافت‌شده (جایی که clush.conf قرار دارد) جایگزین می‌شود. مقدار پیش‌فرض confdir هم پیکربندی سراسری سیستم و هم هرگونه پیکربندی نصب‌شده کاربر را (به لطف \fI$CFGDIR\fP) فعال می‌کند. مسیرهای تکراری دایرکتوری نادیده گرفته می‌شوند.
.TP
.B connect_timeout
مهلت زمانی بر حسب ثانیه برای برقراری اتصال. این پارامتر به ssh ارسال می‌شود. اگر روی \fI0\fP تنظیم شود، هیچ مهلت زمانی در نظر گرفته نمی‌شود.
.TP
.B command_prefix
پیشوند دستور. معمولاً برای حالت‌های اجرای خاص استفاده می‌شود، به عنوان مثال برای پیاده‌سازی پشتیبانی از \fBsudo\fP(8).
.TP
.B command_timeout
مهلت زمانی بر حسب ثانیه برای تکمیل یک دستور پس از برقراری اتصال. این پارامتر به ssh ارسال می‌شود. علاوه بر این، کتابخانه ClusterShell تضمین می‌کند که هر دستوری در مدت زمان کمتر از ( connect_timeout + command_timeout ) به پایان برسد. اگر روی \fI0\fP تنظیم شود، هیچ مهلت زمانی در نظر گرفته نمی‌شود.
.TP
.B color
دستور \fBclush\fP می‌تواند از متغیرهای محیطی NO_COLOR، CLICOLOR و CLICOLOR_FORCE استفاده کند. NO_COLOR بر CLICOLOR_FORCE اولویت دارد که آن نیز بر CLICOLOR اولویت دارد. هنگامی که این گزینه در پرونده پیکربندی تنظیم شده باشد، متغیرهای محیطی تنها با آرگومان \fIauto\fP در نظر گرفته می‌شوند. \fBcolor\fP مشخص می‌کند که آیا از رنگ‌های ANSI برای احاطه کردن پیشوند/هدر گره یا nodeset با دنباله‌های فرار جهت نمایش رنگی آن‌ها در ترمینال استفاده شود یا خیر. آرگومان‌های معتبر عبارتند از \fBnever\fP، \fBalways\fP یا \fBauto\fP (که اگر خروجی یا خطای استاندارد به یک ترمینال اشاره داشته باشند از رنگ استفاده می‌کند). رنگ‌ها روی [34m (متن آبی پیش‌زمینه) برای خروجی استاندارد (stdout) و [31m (متن قرمز پیش‌زمینه) برای خطای استاندارد (stderr) تنظیم شده‌اند و قابل تغییر نیستند.
.TP
.B fd_max
حداکثر تعداد توصیف‌کننده‌های پرونده (file descriptors) باز مجاز به ازای هر فرآیند clush (محدودیت نرم منابع برای پرونده‌های باز). این محدودیت هرگز نمی‌تواند از محدودیت سیستمی (سخت) تجاوز کند. محدودیت‌های \fIfd_max\fP (نرم) و سیستمی (سخت) باید به اندازه کافی بالا باشند تا \fBclush\fP اجرا شود، هرچند مقادیر آن‌ها به مقدار \fIfanout\fP شما بستگی دارد.
.TP
.B history_size
تنظیم حداکثر تعداد ورودی‌های تاریخچه ذخیره‌شده در فهرست تاریخچه GNU readline. مقادیر منفی نشان‌دهنده اندازه نامحدود برای پرونده تاریخچه هستند.
.TP
.B node_count
آیا \fBclush\fP باید اطلاعات اضافی (تعداد گره‌ها) را در هدر بافر نمایش دهد؟ (\fIyes\fP/\fIno\fP)
.TP
.B maxrc
آیا \fBclush\fP باید بزرگ‌ترین کد بازگشتی دستورات را بازگرداند؟ (yes/no)
.TP
.B password_prompt
فعال‌سازی درخواست رمز عبور و ارسال رمز عبور به ورودی استاندارد (stdin)؟ (yes/no) معمولاً برای حالت‌های اجرای خاص استفاده می‌شود، مثلاً برای پیاده‌سازی پشتیبانی تعاملی از \fBsudo\fP(8).
.TP
.B verbosity
تنظیم سطح پرگویی (verbosity): \fI0\fP (بی‌صدا)، \fI1\fP (پیش‌فرض)، \fI2\fP (مفصل) یا بیشتر (اشکال‌زدایی).
.TP
.B ssh_user
تنظیم نام کاربر ssh برای اتصال از راه دور (پیش‌فرض این است که مقداری مشخص نشود).
.TP
.B ssh_path
تنظیم مسیر باینری ssh برای اتصال از راه دور (پیش‌فرض \fIssh\fP است).
.TP
.B ssh_options
تنظیم گزینه‌های اضافی برای ارسال به دستور اصلی ssh.
.TP
.B scp_path
تنظیم مسیر باینری scp برای کپی از راه دور (پیش‌فرض \fIscp\fP است).
.TP
.B scp_options
تنظیم گزینه‌های اضافی برای ارسال به دستور اصلی scp. در صورت عدم تعیین، به جای آن از ssh_options استفاده می‌شود.
.TP
.B rsh_path
تنظیم مسیر باینری rsh برای اتصال از راه دور (پیش‌فرض \fIrsh\fP است). با تغییر این مقدار به راحتی می‌توانید از mrsh یا krsh استفاده کنید.
.TP
.B rcp_path
مشابه rsh_path برای دستور rcp (پیش‌فرض \fIrcp\fP است).
.TP
.B rsh_options
تنظیم گزینه‌های اضافی برای ارسال به دستور اصلی rsh/rcp.
.UNINDENT
.SS "حالت‌های اجرا (Run modes)"
.sp
از نسخه 1.9، clush از حالت‌های اجرا (run modes) پشتیبانی می‌کند که تنظیمات ویژه \fBclush.conf\fP(5) با یک نام مشخص هستند. دو حالت اجرا در پرونده‌های پیکربندی نمونه ارائه شده‌اند که می‌توان آن‌ها را کپی و ویرایش کرد. آن‌ها احراز هویت مبتنی بر رمز عبور را با \fBsshpass\fP(1) و پشتیبانی تعاملی از \fBsudo\fP(8) با رمز عبور پیاده‌سازی می‌کنند.
.sp
برای استفاده از یک حالت اجرا با \fBclush \-\-mode\fP، یک پرونده پیکربندی در یکی از دایرکتوری‌های \fIconfdir\fP در \fBclush.conf\fP(5) (معمولاً \fBclush.conf.d\fP) نصب کنید. تنها پرونده‌های پیکربندی که به \fI\&.conf\fP ختم می‌شوند بررسی می‌شوند. اگر کاربری که \fBclush\fP(1) را اجرا می‌کند دسترسی خواندن به پرونده پیکربندی را نداشته باشد، آن پرونده نادیده گرفته می‌شود. هنگامی که \fB\-\-mode\fP مشخص شده باشد، می‌توانید با فعال کردن حالت اشکال‌زدایی (\fB\-d\fP)، تمام حالت‌های اجرای موجود برای کاربر جاری را نمایش دهید.
.SH "مثال‌ها (EXAMPLES)"
.sp
پرونده پیکربندی ساده.
.SS \fIclush.conf\fP
.nf
[Main]
fanout: 128
connect_timeout: 15
command_timeout: 0
history_size: 100
color: auto
fd_max: 10240
maxrc: no
node_count: yes
confdir: /etc/clustershell/clush.conf.d

.fi
.sp
.SH "فایل‌ها (FILES)"
.INDENT 0.0
.TP
.B \fI$CLUSTERSHELL_CFGDIR/clush.conf\fP
پرونده پیکربندی سراسری clush. اگر $CLUSTERSHELL_CFGDIR تعریف نشده باشد، به جای آن از \fI/etc/clustershell/clush.conf\fP استفاده می‌شود.
.TP
.B \fI$XDG_CONFIG_HOME/clustershell/clush.conf\fP
پرونده پیکربندی کاربر برای clush. اگر $XDG_CONFIG_HOME تعریف نشده باشد، به جای آن از \fI$HOME/.config/clustershell/clush.conf\fP استفاده می‌شود.
.TP
.B \fI{sys.prefix}/etc/clustershell/clush.conf\fP
پرونده پیکربندی هنگامی که ClusterShell در یک محیط مجازی پایتون نصب شده باشد.
.TP
.B \fI$HOME/.local/etc/clustershell/clush.conf\fP
پرونده پیکربندی محلی کاربر برای clush (نصب پیش‌فرض برای pip \-\-user)
.TP
.B \fI~/.clush.conf\fP
پرونده پیکربندی منسوخ‌شده کاربر برای clush (از نسخه 1.9 به بعد دیگر خوانده نمی‌شود).
.UNINDENT
.SH "تاریخچه (HISTORY)"
.sp
از نسخه 1.3 در ClusterShell، بخش \fBExternal\fP از \fIclush.conf\fP حذف شده است. دستورات خارجی که خروجی آن‌ها توسط \fBclush\fP استفاده می‌شد (\-a, \-g, \-X) اکنون توسط خود کتابخانه مدیریت شده و در \fBgroups.conf\fP(5) تعریف می‌شوند.
.SH "همچنین ببینید (SEE ALSO)"
.sp
\fBclush\fP(1), \fBgroups.conf\fP(5), \fBsshpass\fP(1), \fBsudo\fP(8).
.sp
\fI\%https://clustershell.readthedocs.io\fP
.sp
Python ConfigParser
.sp
\fI\%https://docs.python.org/3/library/configparser.html\fP
.SH "نویسنده (AUTHOR)"
Stephane Thiell
.SH "حق نشر (COPYRIGHT)"
GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
.\" Generated by docutils manpage writer.
.