RDtool 0.6.5

RDってなに?

RDはRubyにおけるPOD(Plain Old Documentation)のようなものです。 RDtoolはRDのフォーマッタであり、RDをHTMLなどに変換できます。

何が変わった?

インストールの方法

RDtoolはRaccのver.1.0.0以降が必要です。先にRaccをインストールしてください。 OptionParserのver.0.7以降も必要です。

その後で、

  1. ruby rdtoolconf.rb

  2. 必要ならMakefileをチェックし、修正します。

  3. make all

  4. 必要なら、su

  5. make install

  6. utils/rdswap.rb, utils/rd-mode.elを使いたいならば それらを手でインストールします。

  7. make cleanすると中間ファイルとかが削除されます。

Raccやstrscan拡張ライブラリがインストールできない場合には、

  1. ruby rdtoolconf.rb

  2. 必要ならsu

  3. make install-nonext

この場合にもOptionParserは必要です。

どうやって使うか。

基本的には、こんな感じ。

% rd2 rdfile.rd > outputfile

フォーマットライブラリを指定したい時は、こう。

% rd2 -r library rdfile.rd > outputfile

rd2 --help でオプションの詳細がでます。

rd2はホームディレクトリにある".rd2rc"というファイルを読み込みます。 これはRubyスクリプトです。

RDの書き方

doc/rd-draft.rdを読んでください。

バグ報告

バグを見付けた時は、次のアドレスまでメールしてください。 <URL:mailto:toshirok@yb3.so-net.ne.jp>

ライセンス

RDtoolはRuby's LicenseかGPLの下で使用/配布/改造してください。 RDtoolのパッケージにはTosh以外の人が著作権を持つファイルが含まれています。 それらのファイルについての配布条件はファイル自体に書かれたライセンスの下で 行ってください。