README.rd.ja

# RDtool 0.6.11

## RDってなに？

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

## 何が変わった？

HISTORYを見てください。

## インストールの方法

以下のライブラリが必要です。

- Racc 1.3 or later. -- Ruby's yacc *1
- strscan. (Raccのアーカイブに含まれます。) -- レキサ用拡張ライブラリ *2
- OptionParser 0.8 or later. -- コマンドラインオプションのパーサ *3
- forwadable -- 委譲を扱うためのライブラリ *4

Windows用のRaccのバイナリアーカイブは下の中田さんのサイトに置いてあり ます。

- <URL:http://www.geocities.co.jp/SiliconValley-Bay/4076/archive/>

その後で、

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`すると中間ファイルとかが削除されます。

## どうやって使うか。

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

    % 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以外の人が著作権を持つファイルが含まれています。 それらのファイルについての配布条件はファイル自体に書かれたライセンスの下で 行ってください。

*1 <URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=Racc>
*2 <URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=strscan>
*3 <URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=OptionParser>
*4 <URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=forwardable>