RDtool - RD formatter

RDってなに？

Fork me on GitHub

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

何が変わったの?

HISTORY ファイルを見て下さい.

インストール方法

gem を使う場合: 

% gem install rdtool

gem を使わない場合: 

% tar xvzf rdtool-(version).tar.gz
% cd rdtool-(version)
% ruby setup.rb    # or sudo ruby setup.rb

どうやって使うか。

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

% 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 を読んでください。

BTS

バグを見付けた時は、github issues に報告下さるか, Youhei SASAKI <uwabami@gfd-dennou.org> までご連絡下さい.

License

GPL-2+ or Ruby's.

ファイル毎のライセンス表記は以下の通りです: 

Files: */
  * Copyright: 2004 MoonWolf <moonwolf AT moonwolf.com>
               2011-2012 Youhei SASAKI <uwabami@gfd-dennou.org>
  * License: Ruby's License or GPL-2+
Files: lib/rd/rd2man-lib.rb
  * Copyright: 2000  WATANABE Hirofumi
               2012 Youhei SASAKI <uwabami@gfd-dennou.org>
  * License: Ruby's License or GPL-2+
Files: lib/rd/{head-filter,rd2html-ext-lib,rd2html-ext-opt}.rb
  * Copyright: 2003 Rubikitch
  * License: Ruby's License or GPL-2+
Files: bin/rdswap
  * Copyright: 1999 C.Hintze
  * License: Ruby's License or GPL-2+
Files: setup.rb
  * Copyright: 2000-2006 Minero Aoki
  * License: LGPL-2.1
Files: utils/rd-mode.el
  * Copyright: 1999 Koji Arai, Toshiro Kuwabara.
  * License: GPL-2+
Back to Top ▲