rdoc-generator-mdoc

An mdoc(7) generator for RDoc.

Usage

In Your Ruby Source Code

Add rdoc-generator-mdoc to your Gemfile:

gem "rdoc-generator-mdoc"

Specify mdoc as the formatter using the -f option when calling RDoc::RDoc#new:

require "rdoc/generator/mdoc"

RDoc::RDoc.new.document "-f mdoc"

By default, the mdoc generator will put the generated man pages in section 3-rdoc. If you want the man pages to be put in a different section, specify the section using the --section option:

RDoc::RDoc.new.document "-f mdoc --section 3-my-section"

For more information on using the RDoc::RDoc class see the official RDoc documentation.

Using the rdoc executable

Specify mdoc as the formatter using the -f option:

$ rdoc -f mdoc

By default, the mdoc generator will put the generated man pages in section 3-rdoc. If you want the man pages to be put in a different section, specify the section using the --section option:

$ rdoc -f mdoc --section 3-my-section

Copyright (c) 2014 Calle Erlandsson & thoughtbot, Inc.

Lead by Calle Erlandsson & thoughtbot, Inc.