2009-03-10 16 views
2

help2man ve txt2man ile '--help' çıktısını kullanarak man sayfaları üretmeyi seviyorum. Ruby'nin RDoc sistemi çok kullanışlıdır, ancak RDoc :: kullanımını tam olarak istediğim şekilde yapılandıramıyorum. Aşağıda örnek bir senaryo var:=== olmadan bölümleri tanımlayabilirim RDoc :: usage()?

#!/usr/bin/env ruby 
# 
# === Name 
# 
# foobar - Example command for StackOverflow question 
# 
# === Synopsis 
# 
# Usage: foobar [--help] 
# 
# === Options 
# 
# --help  This help message 

require 'rdoc/usage' 

RDoc::usage('name', 'synopsis', 'options') 

senaryonun çıktı şuna benzer:

Name 
    foobar - Example command for StackOverflow question 

Synopsis 
    Usage: foobar [--help] 

Options 
    --help  This help message 

Ama gerçekten benim kullanım çıkışı için "Ad" ve "Özet" başlıklarını önlemek istiyoruz, ama hala bir erkek sayfasının çıktısı için bölümler olarak işaretleyin.

': section:' işaretinin kullanılması, RDoc :: Rdoc için çalışır, ancak RDoc :: kullanımı için çalışmaz. Üstbilgileri basmadan use.rb bölümlerini işaretlemek için açık bir yol var mı?

cevap

1

RDoc::usage_no_exit için kaynak koduna bakın;

  1. (özel biçimlendirici sınıfını belirterek dahil) farklı biçimlendirme seçeneklerini uygulamak ENV['RI'] ayarlayın veya
  2. varsayılan RI :: TextFormatter en display_heading yeniden tanımla: İki arzu yyou neyi başarmak için onun bağırsaklarına çengel yolları var (ve/veya diğer yöntemler) (değil) başlıklar görüntülemek veya

    require 'rdoc/usage' 
    require 'rdoc/ri/ri_formatter' 
    
    module RI 
        class TextFormatter 
        def display_heading 
         # nop 
        end 
        end 
    end 
    
    RDoc::usage('name') 
    
+0

başka ne Hey o kadar, bu iyi bir cevap. Teşekkürler! – guns