NAME

autodia.pl - a perl script using the Autodia modules to create UML Class Diagrams or documents. from code or other data sources.

INTRODUCTION

AutoDia takes source files as input and using a handler parses them to create documentation through templates. The handlers allow AutoDia to parse any language by providing a handler and registering in in autodia.pm. The templates allow the output to be heavily customised from Dia XML to simple HTML and seperates the logic of the application from the presentation of the results.

AutoDia is written in perl and defaults to the perl handler and file extension matching unless a language is specified using the -l switch.

AutoDia requires Template Toolkit and Perl 5. Some handlers and templates may require additional software, for example the Java SDK for the java handler.

AutoDia can use GraphViz to generate layout coordinates, and can produce di-graphs (notation for directional graphs) in dot (plain or canonical) and vcg, as well as Dia xml.

Helpful information, links and news can be found at the autodia website - http://www.aarontrevena.co.uk/opensource/autodia/

USAGE

autodia.pl ([-i filename [-p path] ] or [-d directory [-r] ]) [options]

autodia.pl -i filename : use filename as input

autodia.pl -i 'filea fileb filec' : use filea, fileb and filec as input

autodia.pl -i filename -p .. : use ../filename as input file

autodia.pl -d directoryname : use *.pl/pm in directoryname as input files

autodia.pl -d 'foo bar quz' : use *pl/pm in directories foo, bar and quz as input files

autodia.pl -d directory -r : use *pl/pm in directory and its subdirectories as input files

autodia.pl -d directory -F : use files in directory but only one file per diagram =item autodia.pl -d directory -C : use files in directory but skip CVS directories

autodia.pl -o outfile.xml : use outfile.xml as output file (otherwise uses autodial.out.dia)

autodia.pl -O : output to stdout

autodia.pl -l language : parse source as language (ie: C) and look for appropriate filename extensions if also -d

autodia.pl -t templatefile : use templatefile as template (otherwise uses template.xml)

autodia.pl -l DBI -i "mysql:test:localhost" -U username -P password : use test database on localhost with username and password as username and password

autodia.pl -l Mason -i "/index.html" -p comp_root -G '\$c' : use HTML::Mason to fetch /index.html from comp_root and show all components in reach. -G corresponds to allow_globals.

autodia.pl -z : output via graphviz

autodia.pl -Z : output via springgraph

autodia.pl -v : output via VCG

autodia.pl -s skipfile : exclude files or packagenames matching those listed in file

c<autodia.pl -D : ignore dependancies (ie do not process or display dependancies)>

autodia.pl -K : do not display packages that are not part of input

autodia.pl -k : do not display superclasses that are not part of input

autodia.pl -H : show only Public/Visible methods

autodia.pl -m : show only Class methods

autodia.pl -M : do not show Class Methods

autodia.pl -a : show only Class Attributes

autodia.pl -A : do not show Class Attributes

autodia.pl -S : silent mode, no output to stdout except with -O

autodia.pl -h : display this help message

autodia.pl -V : display version and copyright message