[ruby-list:29481] Re: rd2man について

清水@biglobeです。

2001年5月2日02時01分 のメールで
Tosh さんは書きました。
> Toshです。
> 
> rd2manは僕はあまり使っていないのでわからないところが多いのですが、
> *要求が把握できれば*修正しようと思います。
> 
> # もう一つ重要な条件は*Toshがroffわかれば*。

実は私はroffが全くわからず、これまで、manなど書いたこともなかったので
すが、「rd2を使えばroffが判らずともmanが書ける」、と思って書き始めて、
逆にroffの勉強をしてしまいました。ですから、環境依存の思い込みもあると
思います。

>> ・((<リンク>))が無視される。(別マニュアルへの参照は強調するのが普通の
>> よう)。
> 
> これは、RDの((<リンク>))って同一ファイル内での参照になるので、ちょっと
> 違うような。((<リンク/>))で別マニュアルへの参照にするならわかりますけど。

おっしゃる通りでした。今調べたらmanに対する、URI表記は、
man:command
man:command(section)

らしいので(Linuxのuri(7)、非公認ということですが)

((<URI:man:command(1)>))
((<URL:man:command(1)>))

とかで参照するのが正しいでしょうか。
これなら、apply_to_RefToURL を修正するべきですね(URLになりますが)、

    def apply_to_RefToURL(element, content)
      content=content.join
      if content=~/^<URL:man:([^\(]*)(\(\d\))?>$/
         %[\\fB#{$1}\\fP#{$2}]
      else
         content
      end
    end

こんな感じでいかがでしょうか。

>> ・全体に空行が多く出力されがちで冗長に見える(私の感覚には)。
> 
> これが今一よくわからないので例がほしいです。

たとえば、
=begin
 :  -o 
    オプションの説明

 :  -a
    オプションの説明
=end
の場合、出力は、
.TP
.fi
.B
\-o 

オプションの説明


.TP
.fi
.B
\-a

オプションの説明

と、"説明\n"の改行に加えて、DescList後の改行(join("\n")が付けた改行)と
DescListItemが前につけた改行とが2行空行になってしまい、さらにnroffを通
しますと、.TPが改行を一つ入れるので計3行空いてしまいます。

手元のLinuxの man1/a* で見てみますと
 空行なし、.TP派と
 空行 .TP 派
がいるようですが、
 空行空行.TP派
はいません。

manの場合空行は段落の切れめの空行以外はほとんど必要ないようです。

私のpatchでは空行は減りますが、TextBlockの後の.PP、とHeadlineの.SHが続
くので、両方が改行を産んでしまい、

 名前
        manual - 短い説明


 書式

と2行空いてしまうのが惜しい所です。

よろしくお願いします。

-- 
         清水 卓([e-mail])