RI(1)                1 (ruby programmer's reference guide)               RI(1)

نام (NAME)
     ri – رابط خط فرمان برای مرجع API روبی

خلاصه دستور (SYNOPSIS)
     ri [-ahilTv] [-d DIRNAME] [-f FORMAT] [-w WIDTH] [--[no-]pager]
     [--server[=PORT]] [--[no-]list-doc-dirs] [--no-standard-docs]
     [--[no-]{system|site|gems|home}] [--[no-]profile] [--dump=CACHE] [name
     ...]

توضیحات (DESCRIPTION)
     ri یک رابط خط فرمان برای مرجع API زبان Ruby است.  می‌توانید با استفاده از
     ri مرجع API کلاس‌ها و متدها را جستجو کرده و مطالعه کنید.

     ri بخشی از Ruby است.

     name می‌تواند یکی از موارد زیر باشد:

           Class | Module | Module::Class  
           Class::method | Class#method | Class.method | method  
           gem_name: | gem_name:README | gem_name:History  
           ruby: | ruby:NEWS | ruby:globals  

     تمام نام‌های کلاس‌ها را می‌توان به کوتاه‌ترین شکل غیرمبهم آن‌ها خلاصه کرد.
     اگر نامی مبهم باشد، تمام گزینه‌های معتبر فهرست خواهند شد.

     یک ‘.’ با متدهای کلاس یا نمونه (instance) مطابقت دارد، در حالی که #method
     تنها با متدهای نمونه و ::method تنها با متدهای کلاس مطابقت می‌یابد.

     فایل‌های README و دیگر فایل‌ها را می‌توان با قرار دادن نام gem حاوی آن‌ها به
     عنوان پیشوند نمایش داد. اگر بعد از نام gem یک ‘:’ قرار گیرد، تمام فایل‌های
     موجود در آن gem نمایش داده خواهند شد.  پسوند نام فایل در صورتی که ابهامی
     وجود نداشته باشد می‌تواند حذف شود.

     برای نمونه:

           ri Fil
           ri File
           ri File.new
           ri zip
           ri rdoc:README

     توجه داشته باشید که ممکن است برای نام‌های متدی که شامل علائم نگارشی هستند،
     استفاده از نقل‌قول (quoting) یا گریز (escaping) در پوسته لازم باشد:

           ri 'Array.[]'
           ri compact\!

     برای مشاهده دایرکتوری‌های پیش‌فرضی که ri در آن‌ها جستجو می‌کند، دستور زیر را
     اجرا کنید:

           ri --list-doc-dirs

     مشخص کردن گزینه‌های --system, --site, --home, --gems, یا --doc-dir جستجوی
     ri را تنها به دایرکتوری‌های مشخص‌شده محدود می‌کند.

     گزینه‌های ri را می‌توان در متغیر محیطی RI تعیین کرد.

     صفحه‌بندی‌کننده (pager) برنامه ri را می‌توان با متغیر محیطی RI_PAGER یا
     متغیر محیطی PAGER تنظیم کرد.

گزینه‌ها (OPTIONS)
     -i
     --[no-]interactive
                    در حالت تعاملی می‌توانید به طور مکرر متدها را با استفاده از
                    تکمیل خودکار جستجو کنید.

     -a
     --[no-]all     نمایش تمام مستندات مربوط به یک کلاس یا ماژول.

     -l
     --[no-]list    فهرست کردن کلاس‌هایی که ri از آن‌ها مطلع است.

     --[no-]pager   ارسال خروجی به یک صفحه‌بندی‌کننده (pager)، به جای ارسال
                    مستقیم به stdout.

     -T             مترادف با --no-pager.

     -w WIDTH
     --width=WIDTH  تنظیم عرض خروجی.

     --server[=PORT]
                    اجرای سرور RDoc روی درگاه مشخص‌شده.  درگاه پیش‌فرض 8214 است.

     -f FORMAT
     --format=FORMAT
                    استفاده از قالب‌بند (formatter) انتخاب‌شده.  قالب‌بند پیش‌فرض
                    برای خروجی صفحه‌بندی‌شده bs و در غیر این صورت ansi است.
                    قالب‌بندهای معتبر عبارتند از: ansi, bs, markdown, rdoc.

     -h
     --help         نمایش راهنما و خروج.

     -v
     --version      چاپ اطلاعات نسخه و خروج.

     گزینه‌های منبع داده:

     --[no-]list-doc-dirs
                    فهرست کردن دایرکتوری‌هایی که ri مستندات را از آن‌ها تأمین
                    می‌کند در stdout و خروج.

     -d DIRNAME
     --doc-dir=DIRNAME
                    فهرستی از دایرکتوری‌ها علاوه بر دایرکتوری‌های استاندارد که
                    مستندات از آن‌ها تأمین می‌شود. می‌تواند تکرار شود.

     --no-standard-docs
                    مستندات کتابخانه استاندارد Ruby، site_lib ، gemهای نصب‌شده،
                    یا ~/.rdoc شامل نشود.  همراه با --doc-dir استفاده شود.

     --[no-]system  شامل کردن مستندات از کتابخانه استاندارد Ruby. پیش‌فرض true
                    است.

     --[no-]site    شامل کردن مستندات از کتابخانه‌های نصب‌شده در site_lib.
                    پیش‌فرض true است.

     --[no-]gems    شامل کردن مستندات از RubyGems. پیش‌فرض true است.

     --[no-]home    شامل کردن مستندات ذخیره‌شده در ~/.rdoc.  پیش‌فرض true است.

     گزینه‌های اشکال‌زدایی:

     --[no-]profile
                    اجرا همراه با پروفایلر Ruby.

     --dump=CACHE   تخلیه (dump) داده‌ها از حافظه کش یا فایل داده ri.

محیط (ENVIRONMENT)
     RI           گزینه‌هایی که به ابتدای گزینه‌های مشخص‌شده در خط فرمان اضافه
                  می‌شوند.

     RI_PAGER
     PAGER        برنامه صفحه‌بندی‌کننده (pager) مورد استفاده برای نمایش.

     HOME
     USERPROFILE
     HOMEPATH     مسیر دایرکتوری خانگی کاربر.

فایل‌ها (FILES)
     ~/.rdoc      مسیر داده‌های ri در دایرکتوری خانگی کاربر.

همچنین ببینید (SEE ALSO)
     ruby(1), rdoc(1), gem(1)

گزارش باگ‌ها (BUGS)
     •   آسیب‌پذیری‌های امنیتی باید از طریق ایمیل به security@ruby-lang.org
         گزارش شوند. مشکلات گزارش‌شده پس از رفع شدن، منتشر خواهند شد.

     •   دیگر باگ‌ها و درخواست‌های قابلیت جدید را می‌توان از طریق سامانه ردیابی
         مسائل Ruby (https://bugs.ruby-lang.org) گزارش کرد. آسیب‌پذیری‌های
         امنیتی را از طریق این سامانه گزارش نکنید چرا که بلافاصله آسیب‌پذیری‌ها
         را به طور عمومی منتشر می‌کند.

نویسندگان (AUTHORS)
     نوشته‌شده توسط Dave Thomas ⟨dave@pragmaticprogrammer.com⟩.

UNIX                            April 20, 2017                            UNIX