.\"	$NetBSD: editrc.5,v 1.34 2022/12/06 00:59:20 uwe Exp $
.\"
.\" Copyright (c) 1997-2000 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This file was contributed to The NetBSD Foundation by Luke Mewburn.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd May 22, 2016
.Dt EDITRC 5
.Os
.Sh "نام (NAME)"
.Nm editrc
.Nd پرونده پیکربندی برای کتابخانه editline
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm
.Sh "توضیحات (DESCRIPTION)"
پرونده
.Nm
تنظیمات گوناگونی را تعریف می‌کند که توسط کتابخانه
.Xr editline 3
به کار می‌روند.
.Pp
قالب هر خط به صورت زیر است:
.Pp
.D1 Oo Ar prog Ns Ic \&: Oc Ns Ar command Oo Ar arg ... Oc
.Pp
.Ar command
یکی از دستورات توکار
.Xr editline 3
است.
برای اطلاعات بیشتر به
.Sx "دستورات ویرایش (EDITLINE COMMANDS)"
مراجعه کنید.
.Pp
.Ar prog
رشته نام برنامه‌ای است که یک برنامه هنگام فراخوانی
.Xr el_init 3
جهت راه‌اندازی
.Xr editline 3
تعریف می‌کند، که معمولاً
.Va argv Ns Li [0]
است.
دستور
.Ar command
برای هر برنامه‌ای که با
.Ar prog
مطابقت داشته باشد اجرا خواهد شد.
.Pp
.Ar prog
همچنین می‌تواند یک عبارت باقاعده به سبک
.Xr regex 3
باشد، که در این صورت
.Ar command
برای هر برنامه‌ای که با آن عبارت باقاعده مطابقت داشته باشد اجرا خواهد شد.
.Pp
اگر
.Ar prog
مشخص نشده باشد،
.Ar command
برای همه برنامه‌ها اجرا می‌شود.
.Sh "دستورات ویرایش (EDITLINE COMMANDS)"
کتابخانه
.Nm editline
دارای چندین دستور توکار است که بر شیوه عملکرد توابع ویرایش خط و تاریخچه تأثیر می‌گذارند.
این دستورات بر پایه دستورات توکار همنام موجود در پوسته
.Xr tcsh 1
هستند.
.Pp
دستورات توکار زیر در دسترس هستند:
.Bl -tag -width 4n
.It Ic bind Oo Fl aeklrsv Oc Op Ar key Op Ar command
بدون گزینه‌ها و آرگومان‌ها، تمامی کلیدها و ماکروهای مقیدشده، و دستور ویرایشگر یا رشته ورودی را که هر کدام به آن مقید شده‌اند، فهرست می‌کند.
اگر تنها
.Ar key
مشخص شده باشد، نگاشت مربوط به آن کلید یا ماکرو را نمایش می‌دهد.
اگر
.Ar key command
مشخص شده باشد، دستور ویرایشگر
.Ar command
را به آن کلید یا ماکرو مقید می‌کند.
.Pp
گزینه‌ها به شرح زیر هستند:
.Bl -tag -width 4n
.It Fl a
فهرست کردن یا تغییر نگاشت کلیدها در نقشه کلید جایگزین (حالت فرمان) در حالت
.Xr vi 1 .
.It Fl e
مقید کردن تمامی کلیدها به نگاشت‌های استاندارد شبیه به
.Tn GNU
Emacs.
.It Fl k
.Ar key
به عنوان نام نمادین کلید جهت‌نما تفسیر می‌شود، که می‌تواند یکی از موارد
.Ic up ,
.Ic down ,
.Ic left
یا
.Ic right
باشد.
.It Fl l
فهرست کردن تمامی دستورات ویرایشگر به همراه شرح کوتاهی از هر یک.
.It Fl r
حذف نگاشت کلید یا ماکروی
.Ar key .
.It Fl s
تعریف یک ماکروی صفحه‌کلید به جای نگاشت کلید یا ماکروی دستور:
.Ar command
به عنوان یک رشته لفظی در نظر گرفته می‌شود و هر زمان که
.Ar key
فشرده شود، به صف ورودی افزوده می‌گردد.
کلیدها و ماکروهای مقیدشده در
.Ar command
خود مجدداً تفسیر می‌شوند، و این روند تا ده سطح تفسیر ادامه می‌یابد.
.It Fl v
مقید کردن تمامی کلیدها به نگاشت‌های استاندارد شبیه به
.Xr vi 1 .
.El
.Pp
صفحه راهنمای
.Xr editline 7
تمام دستورات ویرایشگر را مستندسازی کرده و شامل اطلاعات بیشتری درباره ماکروها و صف ورودی است.
.Pp
.Ar key
و
.Ar command
می‌توانند شامل نویسه‌های کنترلی به شکل
.Sq Ic ^ Ns Ar character
.Po
مانند
.Ql ^A
.Pc
و دنباله‌های گریز با بک‌اسلش زیر باشند:
.Pp
.Bl -tag -compact -offset indent -width Ic
.It Ic \ea
زنگ (Bell)
.It Ic \eb
پس‌بر (Backspace)
.It Ic \ee
گریز (Escape)
.It Ic \ef
برگه جدید (Formfeed)
.It Ic \en
خط جدید (Newline)
.It Ic \er
بازگشت به ابتدای سطر (Carriage return)
.It Ic \et
تب افقی (Horizontal tab)
.It Ic \ev
تب عمودی (Vertical tab)
.Sm off
.It Ic \e Ar nnn
.Sm on
نویسه
.Tn ASCII
متناظر با عدد هشت‌هشتی
.Ar nnn .
.El
.Pp
.Ql \e
معنای ویژه نویسه بعدی را (در صورت وجود)، به‌ویژه
.Ql \e
و
.Ql ^
باطل می‌کند.
.It Ic echotc Oo Fl sv Oc Ar arg Ar ...
بررسی قابلیت‌های ترمینال مشخص‌شده در
.Ar arg .
اگر
.Ar arg
یکی از موارد
.Ql baud ,
.Ql cols ,
.Ql lines ,
.Ql rows ,
.Ql meta
یا
.Ql tabs
باشد، مقدار آن قابلیت چاپ می‌شود، که در آن
.Dq yes
یا
.Dq no
نشان‌دهنده دارا بودن یا نبودن آن قابلیت توسط ترمینال است.
.Pp
.Fl s
به جای ایجاد خطا، برای قابلیت‌های ناموجود یک رشته خالی برمی‌گرداند.
.Fl v
باعث نمایش پیام‌ها با جزئیات کامل (حالت پرگو) می‌شود.
.It Ic edit Op Li on No | Li off
فعال یا غیرفعال کردن قابلیت‌های
.Nm editline
در یک برنامه.
.It Ic history Li list No | Li size Ar n No | Li unique Ar n
دستور
.Ql list
تمامی مدخل‌های تاریخچه را فهرست می‌کند.
دستور
.Ql size
اندازه تاریخچه را روی
.Ar n
مدخل تنظیم می‌کند.
دستور
.Ql unique
مشخص می‌کند که آیا تاریخچه باید مدخل‌های تکراری را نگه دارد یا خیر.
اگر
.Ar n
غیرصفر باشد، تنها مدخل‌های یکتا در تاریخچه نگهداری می‌شوند.
اگر
.Ar n
صفر باشد، تمامی مدخل‌ها نگهداری می‌شوند (حالت پیش‌فرض).
.It Ic settc Ar cap Ar val
تنظیم قابلیت ترمینال
.Ar cap
روی
.Ar val ,
همان‌طور که در
.Xr termcap 5
تعریف شده است.
هیچ بررسی اعتباری روی آن انجام نمی‌شود.
.It Ic setty Oo Fl a Oc Oo Fl d Oc Oo Fl q Oc Oo Fl x Oc Oo Ic \&+ Ns Ar mode Oc \
Oo Fl Ar mode Oc Oo Ar mode Oc Oo Ar char\| Ns Ic = Ns Ar c Oc
کنترل این‌که
.Nm
اجازه تغییر کدام حالت‌های tty را به کاربر نمی‌دهد.
.Fl d ,
.Fl q
یا
.Fl x
به
.Ic setty
مشخص می‌کند که به ترتیب روی مجموعه حالت‌های tty مربوط به
.Sq edit ,
.Sq quote
یا
.Sq execute
عمل کند؛ حالت پیش‌فرض
.Fl x
است.
.Pp
بدون آرگومان‌های دیگر،
.Ic setty
حالت‌هایی از مجموعه انتخاب‌شده را که به صورت فعال
.Po
.Ic + Ns Ar mode
.Pc
یا غیرفعال
.Po
.Fl Ns Ar mode
.Pc
ثابت شده‌اند، فهرست می‌کند.
.Fl a
تمامی حالت‌های tty را در مجموعه انتخاب‌شده بدون در نظر گرفتن وضعیت تنظیمات، فهرست می‌کند.
همراه با
.Ic + Ns Ar mode ,
.Fl Ns Ar mode
یا
.Ar mode ,
حالت
.Ar mode
را در مجموعه انتخاب‌شده روی فعال یا غیرفعال ثابت می‌کند و یا کنترل
.Ar mode
را برمی‌دارد.
.Pp
همچنین می‌توان از
.Ic setty
برای تنظیم نویسه‌های tty به مقادیر مشخص با استفاده از
.Ar char\| Ns Ic = Ns Ar value
استفاده کرد.
اگر
.Ar value
خالی باشد،
نویسه روی
.Dv _POSIX_VDISABLE
تنظیم می‌شود.
.It Ic telltc
فهرست کردن مقادیر تمامی قابلیت‌های ترمینال (ببینید
.Xr termcap 5 ) .
.El
.Sh "محیط (ENVIRONMENT)"
.Bl -tag -width Ev
.It Ev EDITRC
نام پرونده پیکربندی پیش‌فرض برای کتابخانه
.Xr editline 3 .
.El
.Sh "فایلها (FILES)"
.Bl -tag -width Pa
.It Pa ~/.editrc
آخرین گزینه پرونده پیکربندی کاربر برای کتابخانه
.Xr editline 3
در صورتی که هیچ پرونده دیگری مشخص نشده باشد.
.El
.Sh "همچنین ببینید (SEE ALSO)"
.Xr editline 3 ,
.Xr regex 3 ,
.Xr termcap 5 ,
.Xr editline 7
.Sh "نویسندگان (AUTHORS)"
.An -nosplit
کتابخانه
.Nm editline
توسط
.An Christos Zoulas
نوشته شده است، و این راهنما توسط
.An Luke Mewburn
با الهام‌گیری از برخی بخش‌های
.Xr tcsh 1
به نگارش درآمده است.