|
 |
2e8135 |
'\" t
|
|
|
2e8135 |
.\" Title: sdoc
|
|
|
2e8135 |
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
|
|
2e8135 |
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|
|
2e8135 |
.\" Date: 08/06/2013
|
|
|
2e8135 |
.\" Manual: \ \&
|
|
|
2e8135 |
.\" Source: \ \&
|
|
|
2e8135 |
.\" Language: English
|
|
|
2e8135 |
.\"
|
|
|
2e8135 |
.TH "SDOC" "1" "08/06/2013" "\ \&" "\ \&"
|
|
|
2e8135 |
.\" -----------------------------------------------------------------
|
|
|
2e8135 |
.\" * Define some portability stuff
|
|
|
2e8135 |
.\" -----------------------------------------------------------------
|
|
|
2e8135 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
2e8135 |
.\" http://bugs.debian.org/507673
|
|
|
2e8135 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
|
2e8135 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
2e8135 |
.ie \n(.g .ds Aq \(aq
|
|
|
2e8135 |
.el .ds Aq '
|
|
|
2e8135 |
.\" -----------------------------------------------------------------
|
|
|
2e8135 |
.\" * set default formatting
|
|
|
2e8135 |
.\" -----------------------------------------------------------------
|
|
|
2e8135 |
.\" disable hyphenation
|
|
|
2e8135 |
.nh
|
|
|
2e8135 |
.\" disable justification (adjust text to left margin only)
|
|
|
2e8135 |
.ad l
|
|
|
2e8135 |
.\" -----------------------------------------------------------------
|
|
|
2e8135 |
.\" * MAIN CONTENT STARTS HERE *
|
|
|
2e8135 |
.\" -----------------------------------------------------------------
|
|
|
2e8135 |
.SH "NAME"
|
|
|
2e8135 |
sdoc \- RDoc generator to build searchable HTML documentation for Ruby code
|
|
|
2e8135 |
.SH "SYNOPSIS"
|
|
|
2e8135 |
.sp
|
|
|
2e8135 |
\fBsdoc\fR [\fIOPTIONS\fR] \fIPROJECTDIR\fR
|
|
|
2e8135 |
.SH "DESCRIPTION"
|
|
|
2e8135 |
.sp
|
|
|
2e8135 |
SDoc is simply a wrapper for the rdoc command line tool\&. See "sdoc \-\-help" for more details\&. \fI\-\-fmt\fR is set to shtml by default\&. The default template \fI\-T\fR is shtml, but you can also use the direct template\&.
|
|
|
2e8135 |
.sp
|
|
|
2e8135 |
Example:
|
|
|
2e8135 |
.sp
|
|
|
2e8135 |
sdoc \-o doc/rails \-T direct rails
|
|
|
2e8135 |
.SH "OPTIONS"
|
|
|
2e8135 |
.sp
|
|
|
2e8135 |
See "sdoc \-\-help" to see all the available options\&.
|