tmdoc − maintenance document producer for Ruby software
|
tmdoc [−i INPUT_DIR] [−o OUTPUT_DIR] [−t TITLE] [−e TAB_WIDTH] [−c] [−a] [−v VERB_LEVEL] [−s SENS_LEVEL] [−l LOG_FILE] [−h] [−v] SOURCE_FILE... |
TmDoc automatically genarate DocBook document from given SOURCE_FILEs.
The generated DocBook document is written to many files: “tmdoc.*.docbook” under directory: OUTPUT_DIR. In these DocBook files, top−level file's name is “tmdoc.home.docbook”.
[−i INPUT_DIR], [−−input−dir INPUT_DIR]
The directory where source files are located on. Default is current directory.
[−o OUTPUT_DIR], [−−output−dir OUTPUT_DIR]
The directory where generated document files will be written into. Default is “./dbook”.
NOTE: This directory must already exist and be writable.
[−t TITLE], [−−title TITLE]
Title of the document.
[−e TAB_WIDTH], [−−tab−width TAB_WIDTH]
Tab width of source code. Default value is 8. See also below [−c] option.
[−c], [−−[no−]show−code]
Show source code on the generated document.
[−−[no−]show−module−siblings]
Show sibling information of module structure on the generated document.
[−−[no−]show−class−siblings]
Show sibling information of class inheritance hierarcy on the generated document.
[−a], [−−show−all]
Enable all [−−show−XXX] options.
[−−[no−]sort−by−name]
Sort chapter sequence by module or class name order. Default is disable.
[−v VERB_LEVEL], [−−verbose−level VERB_LEVEL]
If the level of occured event is lower equal than given VERB_LEVEL, then show message of the event on standard error. The VERB_LEVEL is indentifier, one of: debug, progress, info, notice, warn, error, fatal. The debug level is a highest level and most verbose. The fatal error level is a lowest level and silent. Default is progress.
[−−quiet]
Silent mode. Same as [−−verbose−level fatal].
[−s SENS_LEVEL], [−−sensitive−level SENS_LEVEL]
If the level of occured event is lower equal than given SENS_LEVEL, then stop processing and make abnormal−end. The SENS_LEVEL is indentifier, one of: notice, warn, error, fatal. The notice level is a highest level and most sensitive. The fatal error level is a lowest level and insensitive. Default is fatal.
[−l LOG_FILE], [−−log−file LOG_FILE]
The file name that messages of occured event will be written to.
NOTE: Logging facility doesn't get effect [−v VERB_LEVEL] or [−s SENS_LEVEL] opton.
[−h], [−−help]
Print the help message.
[−−version]
Print the version.
0
Normal end.
1
Command argument error.
2
Output(I/O) error.
3
Sensitivity abort. See [−s SENS_LEVEL] option.
Below example is a most basic usage of TmDoc in UNIX environment.
(1) Create output directory
$ mkdir dbook
(2) Run TmDoc command
$ tmdoc foo.rb
(3) Convert the generated DocBook files to HTML format
$ xsltproc
−−xinclude $DOCBOOK_XSL_DIR/html/docbook.xsl \
> dbook/tmdoc.home.docbook > foo.html
Additional information about TmDoc may be found on TmDoc project's home page [1] .
Ruby's Licence
takomachan <takomachan@gmail.com>
Author.
Copyright © 2011-2012
|
1. |
TmDoc project’s home page |
http://www.h6.dion.ne.jp/~machan/tmdoc/