.\"Ruby is copyrighted by Yukihiro Matsumoto . .Dd April 20, 2017 .Dt RI \&1 "Ruby Programmer's Reference Guide" .Os UNIX .Sh "نام (NAME)" .Nm ri .Nd رابط خط فرمان برای مرجع API روبی .Sh "خلاصه دستور (SYNOPSIS)" .Nm .Op Fl ahilTv .Op Fl d Ar DIRNAME .Op Fl f Ar FORMAT .Op Fl w Ar WIDTH .Op Fl - Ns Oo Cm no- Oc Ns Cm pager .Op Fl -server Ns Oo = Ns Ar PORT Oc .Op Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs .Op Fl -no-standard-docs .Op Fl - Ns Oo Cm no- Oc Ns Bro Cm system Ns | Ns Cm site Ns | Ns Cm gems Ns | Ns Cm home Brc .Op Fl - Ns Oo Cm no- Oc Ns Cm profile .Op Fl -dump Ns = Ns Ar CACHE .Op Ar name ... .Sh "توضیحات (DESCRIPTION)" .Nm یک رابط خط فرمان برای مرجع API زبان Ruby است. می‌توانید با استفاده از .Nm مرجع API کلاس‌ها و متدها را جستجو کرده و مطالعه کنید. .Pp .Nm بخشی از Ruby است. .Pp .Ar name می‌تواند یکی از موارد زیر باشد: .Bl -diag -offset indent .It Class | Module | Module::Class .Pp .It Class::method | Class#method | Class.method | method .Pp .It gem_name: | gem_name:README | gem_name:History .Pp .It ruby: | ruby:NEWS | ruby:globals .El .Pp تمام نام‌های کلاس‌ها را می‌توان به کوتاه‌ترین شکل غیرمبهم آن‌ها خلاصه کرد. اگر نامی مبهم باشد، تمام گزینه‌های معتبر فهرست خواهند شد. .Pp یک .Ql \&. با متدهای کلاس یا نمونه (instance) مطابقت دارد، در حالی که #method تنها با متدهای نمونه و ::method تنها با متدهای کلاس مطابقت می‌یابد. .Pp فایل‌های README و دیگر فایل‌ها را می‌توان با قرار دادن نام gem حاوی آن‌ها به عنوان پیشوند نمایش داد. اگر بعد از نام gem یک .Ql \&: قرار گیرد، تمام فایل‌های موجود در آن gem نمایش داده خواهند شد. پسوند نام فایل در صورتی که ابهامی وجود نداشته باشد می‌تواند حذف شود. .Pp برای نمونه: .Bd -literal -offset indent ri Fil ri File ri File.new ri zip ri rdoc:README .Ed .Pp توجه داشته باشید که ممکن است برای نام‌های متدی که شامل علائم نگارشی هستند، استفاده از نقل‌قول (quoting) یا گریز (escaping) در پوسته لازم باشد: .Bd -literal -offset indent ri 'Array.[]' ri compact\e! .Ed .Pp برای مشاهده دایرکتوری‌های پیش‌فرضی که .Nm در آن‌ها جستجو می‌کند، دستور زیر را اجرا کنید: .Bd -literal -offset indent ri --list-doc-dirs .Ed .Pp مشخص کردن گزینه‌های .Fl -system , Fl -site , Fl -home , Fl -gems , یا .Fl -doc-dir جستجوی .Nm را تنها به دایرکتوری‌های مشخص‌شده محدود می‌کند. .Pp گزینه‌های .Nm را می‌توان در متغیر محیطی .Ev RI تعیین کرد. .Pp صفحه‌بندی‌کننده (pager) برنامه .Nm را می‌توان با متغیر محیطی .Ev RI_PAGER یا متغیر محیطی .Ev PAGER تنظیم کرد. .Pp .Sh "گزینه‌ها (OPTIONS)" .Bl -tag -width "1234567890123" -compact .Pp .It Fl i .It Fl - Ns Oo Cm no- Oc Ns Cm interactive در حالت تعاملی می‌توانید به طور مکرر متدها را با استفاده از تکمیل خودکار جستجو کنید. .Pp .It Fl a .It Fl - Ns Oo Cm no- Oc Ns Cm all نمایش تمام مستندات مربوط به یک کلاس یا ماژول. .Pp .It Fl l .It Fl - Ns Oo Cm no- Oc Ns Cm list فهرست کردن کلاس‌هایی که .Nm از آن‌ها مطلع است. .Pp .It Fl - Ns Oo Cm no- Oc Ns Cm pager ارسال خروجی به یک صفحه‌بندی‌کننده (pager)، به جای ارسال مستقیم به stdout. .Pp .It Fl T مترادف با .Fl -no-pager . .Pp .It Fl w Ar WIDTH .It Fl -width Ns = Ns Ar WIDTH تنظیم عرض خروجی. .Pp .It Fl -server Ns Oo = Ns Ar PORT Oc اجرای سرور RDoc روی درگاه مشخص‌شده. درگاه پیش‌فرض\~8214 است. .Pp .It Fl f Ar FORMAT .It Fl -format Ns = Ns Ar FORMAT استفاده از قالب‌بند (formatter) انتخاب‌شده. قالب‌بند پیش‌فرض برای خروجی صفحه‌بندی‌شده .Li bs و در غیر این صورت .Li ansi است. قالب‌بندهای معتبر عبارتند از: .Li ansi , Li bs , Li markdown , Li rdoc . .Pp .It Fl h .It Fl -help نمایش راهنما و خروج. .Pp .It Fl v .It Fl -version چاپ اطلاعات نسخه و خروج. .El .Pp گزینه‌های منبع داده: .Bl -tag -width "1234567890123" -compact .Pp .It Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs فهرست کردن دایرکتوری‌هایی که .Nm مستندات را از آن‌ها تأمین می‌کند در stdout و خروج. .Pp .It Fl d Ar DIRNAME .It Fl -doc-dir Ns = Ns Ar DIRNAME فهرستی از دایرکتوری‌ها علاوه بر دایرکتوری‌های استاندارد که مستندات از آن‌ها تأمین می‌شود. می‌تواند تکرار شود. .Pp .It Fl -no-standard-docs مستندات کتابخانه استاندارد Ruby، .Pa site_lib ، gemهای نصب‌شده، یا .Pa ~/.rdoc شامل نشود. همراه با .Fl -doc-dir استفاده شود. .Pp .It Fl - Ns Oo Cm no- Oc Ns Cm system شامل کردن مستندات از کتابخانه استاندارد Ruby. پیش‌فرض true است. .Pp .It Fl - Ns Oo Cm no- Oc Ns Cm site شامل کردن مستندات از کتابخانه‌های نصب‌شده در .Pa site_lib . پیش‌فرض true است. .Pp .It Fl - Ns Oo Cm no- Oc Ns Cm gems شامل کردن مستندات از RubyGems. پیش‌فرض true است. .Pp .It Fl - Ns Oo Cm no- Oc Ns Cm home شامل کردن مستندات ذخیره‌شده در .Pa ~/.rdoc . پیش‌فرض true است. .El .Pp گزینه‌های اشکال‌زدایی: .Bl -tag -width "1234567890123" -compact .Pp .It Fl - Ns Oo Cm no- Oc Ns Cm profile اجرا همراه با پروفایلر Ruby. .Pp .It Fl -dump Ns = Ns Ar CACHE تخلیه (dump) داده‌ها از حافظه کش یا فایل داده ri. .El .Pp .Sh "محیط (ENVIRONMENT)" .Bl -tag -width "USERPROFILE" -compact .Pp .It Ev RI گزینه‌هایی که به ابتدای گزینه‌های مشخص‌شده در خط فرمان اضافه می‌شوند. .Pp .It Ev RI_PAGER .It Ev PAGER برنامه صفحه‌بندی‌کننده (pager) مورد استفاده برای نمایش. .Pp .It Ev HOME .It Ev USERPROFILE .It Ev HOMEPATH مسیر دایرکتوری خانگی کاربر. .El .Pp .Sh "فایل‌ها (FILES)" .Bl -tag -width "USERPROFILE" -compact .Pp .It Pa ~/.rdoc مسیر داده‌های ri در دایرکتوری خانگی کاربر. .Pp .El .Pp .Sh "همچنین ببینید (SEE ALSO)" .Xr ruby 1 , .Xr rdoc 1 , .Xr gem 1 .Pp .Sh "گزارش باگ‌ها (BUGS)" .Bl -bullet .It آسیب‌پذیری‌های امنیتی باید از طریق ایمیل به .Mt security@ruby-lang.org گزارش شوند. مشکلات گزارش‌شده پس از رفع شدن، منتشر خواهند شد. .Pp .It دیگر باگ‌ها و درخواست‌های قابلیت جدید را می‌توان از طریق سامانه ردیابی مسائل Ruby .Pq Lk https://bugs.ruby-lang.org گزارش کرد. آسیب‌پذیری‌های امنیتی را از طریق این سامانه گزارش نکنید چرا که بلافاصله آسیب‌پذیری‌ها را به طور عمومی منتشر می‌کند. .El .Sh "نویسندگان (AUTHORS)" نوشته‌شده توسط .An Dave Thomas Aq dave@pragmaticprogrammer.com .