← man/system_admin
●ri — man ri — 80×24
ugur@toprak:~/man/system_admin$man ri
Bölüm 1 Sistem Yönetimi

ri

Ruby API referansı ön ucu

Sözdizimi

     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 ...]

Açıklama

ri, Ruby API referansı için komut satırı tabanlı bir ön uçtur. ri ile sınıflar ve yöntemler için API referansını arayabilir ve okuyabilirsiniz.

ri, Ruby'nin bir parçasıdır.

name şunlar olabilir:

Class | Module | Module::Class Class::method | Class#method | Class.method | method gem_name: | gem_name:README | gem_name:History

Tüm sınıf adları, en az belirsizlik içeren biçimlerine kısaltılabilir. Eğer bir ad belirsiz ise (birden fazla seçenekle eşleşiyorsa), geçerli tüm seçenekler listelenir.

‘.’ işareti hem sınıf hem de örnek (instance) yöntemleriyle eşleşirken, #method yalnızca örnek yöntemleriyle ve ::method yalnızca sınıf yöntemleriyle eşleşir.

README ve diğer dosyalar, bulundukları gem adı başa eklenerek görüntülenebilir. Gem adından sonra bir ‘:’ işareti gelirse, gem içindeki tüm dosyalar gösterilir. Dosya uzantısı belirsizlik oluşturmadığı durumlarda atlanabilir.

Örneğin:

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

Noktalama işaretleri içeren yöntem adları için kabuk tırnak işaretleri (quoting) veya kaçış karakterleri (escaping) kullanılması gerekebileceğini unutmayın:

ri 'Array.[]' ri compact!

ri'nin arayacağı varsayılan dizinleri görmek için şu komutu çalıştırın:

ri --list-doc-dirs

--system, --site, --home, --gems veya --doc-dir seçeneklerini belirtmek, ri'yi yalnızca belirtilen dizinleri arayacak şekilde sınırlar.

ri seçenekleri RI ortam değişkeninde ayarlanabilir.

ri sayfalayıcısı (pager) RI_PAGER ortam değişkeni veya PAGER ortam değişkeni ile ayarlanabilir.

Seçenekler

-i --[no-]interactive Etkileşimli (interactive) modda, otomatik tamamlama ile yöntemleri (methods) tekrar tekrar arayabilirsiniz.

-a

  • --[no-]all: Bir sınıf veya modül için tüm belgeleri gösterir.

-l

  • --[no-]list: ri'nin bildiği sınıfları listeler.

  • --[no-]pager: Çıktıyı doğrudan standart çıktıya (stdout) göndermek yerine bir sayfalayıcıya (pager) gönderir.

  • -T: --no-pager seçeneğinin eş anlamlısıdır.

-w WIDTH

  • --width=WIDTH: Çıktının genişliğini ayarlar.

--server[=PORT] RDoc sunucusunu belirtilen bağlantı noktasında (port) çalıştırır. Varsayılan bağlantı noktası 8214'tür.

-f FORMAT --format=FORMAT Seçilen biçimlendiriciyi (formatter) kullanır. Varsayılan biçimlendirici, sayfalanmış çıktı için bs, aksi takdirde ansi'dir. Geçerli biçimlendiriciler şunlardır: ansi, bs, markdown, rdoc.

-h

  • --help: Yardımı gösterir ve çıkar.

-v

  • --version: Sürüm bilgisini yazdırır ve çıkar.

Veri kaynağı seçenekleri:

--[no-]list-doc-dirs ri'nin belge kaynağı olarak kullanacağı dizinleri standart çıktıda (stdout) listeler ve çıkar.

-d DIRNAME --doc-dir=DIRNAME Standart dizinlere ek olarak belge kaynağı olarak kullanılacak dizinlerin listesi. Tekrarlanabilir.

--no-standard-docs Ruby standart kütüphanesinden, site_lib'den, kurulu gem'lerden veya ~/.rdoc dizininden belgeleri dahil etmez. --doc-dir ile birlikte kullanın.

  • --[no-]system: Ruby'nin standart kütüphanesinden belgeleri dahil eder. Varsayılan değer true (doğru) şeklindedir.

  • --[no-]site: site_lib dizininde yüklü kütüphanelerden belgeleri dahil eder. Varsayılan değer true şeklindedir.

  • --[no-]gems: RubyGems'ten belgeleri dahil eder. Varsayılan değer true şeklindedir.

  • --[no-]home: ~/.rdoc dizininde saklanan belgeleri dahil eder. Varsayılan değer true şeklindedir.

Hata ayıklama seçenekleri:

--[no-]profile Ruby profiler (performans analizcisi) ile çalıştırır.

  • --dump=CACHE: Bir ri önbelleğinden veya veri dosyasından verileri döker (dump).

Ortam

RI Komut satırında belirtilen seçeneklerin önüne eklenecek seçenekler.

RI_PAGER PAGER Görüntüleme için kullanılacak sayfalayıcı (pager) programı.

HOME USERPROFILE HOMEPATH Kullanıcının ana dizinine giden yol.

Dosyalar

~/.rdoc Kullanıcının ana dizinindeki ri verileri için yol.

Ayrıca Bakınız

ruby(1), rdoc(1), gem(1)

Hata Bildirimi

• Güvenlik açıkları, security@ruby-lang.org adresine e-posta gönderilerek bildirilmelidir. Bildirilen sorunlar düzeltildikten sonra yayınlanacaktır.

• Diğer hatalar ve özellik talepleri, Ruby Sorun Takip Sistemi (https://bugs.ruby-lang.org/) aracılığıyla bildirilebilir. Bu sistem açıkları hemen yayınladığı için güvenlik açıklarını bu sistem üzerinden bildirmeyin.

Yazarlar

Dave Thomas ⟨dave@pragmaticprogrammer.com⟩ tarafından yazılmıştır.

UNIX 20 Nisan 2017 UNIX