RDtool 0.6.14

RDってなに?

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

何が変わった?

HISTORYを見てください。

インストールの方法

  1. ruby rdtoolconf.rb
  2. 必要ならMakefileをチェックし、修正します。
  3. 必要なら、su
  4. make install
  5. utils/rdswap.rb, utils/rd-mode.elを使いたいならば それらを手でインストールします。
  6. make cleanすると中間ファイルとかが削除されます。

Makefileがうまく生成されない場合やmake installがエラーになる場合には rd/以下のすべてのファイルをディレクトリごとRubyのライブラリパスに, rd2を コマンドパスにコピーしてください.

どうやって使うか。

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

% rd2 rdfile.rd > outputfile

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

% rd2 -r library rdfile.rd > outputfile

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

フォーマットライブラリ依存のオプションは先にフォーマットライブラリの 指定をしてから--help。例えば、

% rd2 -r rd/rd2html-lib.rb --help

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

RDの書き方

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

バグ報告

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

ライセンス

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