.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "autodia 3pm" .TH autodia 3pm "2022-11-02" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" autodia \- a perl script using the Autodia modules to create UML Class Diagrams or documents. from code or other data sources. .SH "INTRODUCTION" .IX Header "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 \s-1XML\s0 to simple \s-1HTML\s0 and separates the logic of the application from the presentation of the results. .PP AutoDia is written in perl and defaults to the perl handler and file extension matching unless a language is specified using the \-l switch. .PP AutoDia requires Template Toolkit and Perl 5. Some handlers and templates may require additional software, for example the Java \s-1SDK\s0 for the java handler. .PP 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. .PP Helpful information, links and news can be found at the autodia website \- http://www.aarontrevena.co.uk/opensource/autodia/ .SH "USAGE" .IX Header "USAGE" .ie n .IP """autodia ([\-i filename [\-p path] ] or [\-d directory [\-r] ]) [options]""" 4 .el .IP "\f(CWautodia ([\-i filename [\-p path] ] or [\-d directory [\-r] ]) [options]\fR" 4 .IX Item "autodia ([-i filename [-p path] ] or [-d directory [-r] ]) [options]" .PD 0 .ie n .IP """autodia \-i filename : use filename as input""" 4 .el .IP "\f(CWautodia \-i filename : use filename as input\fR" 4 .IX Item "autodia -i filename : use filename as input" .ie n .IP """autodia \-i \*(Aqfilea fileb filec\*(Aq : use filea, fileb and filec as input""" 4 .el .IP "\f(CWautodia \-i \*(Aqfilea fileb filec\*(Aq : use filea, fileb and filec as input\fR" 4 .IX Item "autodia -i filea fileb filec : use filea, fileb and filec as input" .ie n .IP """autodia \-i filename \-p .. : use ../filename as input file""" 4 .el .IP "\f(CWautodia \-i filename \-p .. : use ../filename as input file\fR" 4 .IX Item "autodia -i filename -p .. : use ../filename as input file" .ie n .IP """autodia \-d directoryname : use *.pl/pm in directoryname as input files""" 4 .el .IP "\f(CWautodia \-d directoryname : use *.pl/pm in directoryname as input files\fR" 4 .IX Item "autodia -d directoryname : use *.pl/pm in directoryname as input files" .ie n .IP """autodia \-d \*(Aqfoo bar quz\*(Aq : use *pl/pm in directories foo, bar and quz as input files""" 4 .el .IP "\f(CWautodia \-d \*(Aqfoo bar quz\*(Aq : use *pl/pm in directories foo, bar and quz as input files\fR" 4 .IX Item "autodia -d foo bar quz : use *pl/pm in directories foo, bar and quz as input files" .ie n .IP """autodia \-d directory \-r : use *pl/pm in directory and its subdirectories as input files""" 4 .el .IP "\f(CWautodia \-d directory \-r : use *pl/pm in directory and its subdirectories as input files\fR" 4 .IX Item "autodia -d directory -r : use *pl/pm in directory and its subdirectories as input files" .ie n .IP """autodia \-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""" 4 .el .IP "\f(CWautodia \-d directory \-F : use files in directory but only one file per diagram\fR =item \f(CWautodia.pl \-d directory \-C : use files in directory but skip CVS directories\fR" 4 .IX Item "autodia -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" .ie n .IP """autodia \-o outfile.xml : use outfile.xml as output file (otherwise uses autodial.out.dia)""" 4 .el .IP "\f(CWautodia \-o outfile.xml : use outfile.xml as output file (otherwise uses autodial.out.dia)\fR" 4 .IX Item "autodia -o outfile.xml : use outfile.xml as output file (otherwise uses autodial.out.dia)" .ie n .IP """autodia \-O : output to stdout""" 4 .el .IP "\f(CWautodia \-O : output to stdout\fR" 4 .IX Item "autodia -O : output to stdout" .ie n .IP """autodia \-l language : parse source as language (ie: C) and look for appropriate filename extensions if also \-d""" 4 .el .IP "\f(CWautodia \-l language : parse source as language (ie: C) and look for appropriate filename extensions if also \-d\fR" 4 .IX Item "autodia -l language : parse source as language (ie: C) and look for appropriate filename extensions if also -d" .ie n .IP """autodia \-t templatefile : use templatefile as template (otherwise uses template.xml)""" 4 .el .IP "\f(CWautodia \-t templatefile : use templatefile as template (otherwise uses template.xml)\fR" 4 .IX Item "autodia -t templatefile : use templatefile as template (otherwise uses template.xml)" .ie n .IP """autodia \-l DBI \-i ""mysql:test:localhost"" \-U username \-P password : use test database on localhost with username and password as username and password""" 4 .el .IP "\f(CWautodia \-l DBI \-i ``mysql:test:localhost'' \-U username \-P password : use test database on localhost with username and password as username and password\fR" 4 .IX Item "autodia -l DBI -i ""mysql:test:localhost"" -U username -P password : use test database on localhost with username and password as username and password" .ie n .IP """autodia \-l Mason \-i ""/index.html"" \-p comp_root \-G \*(Aq\e$c\*(Aq : use HTML::Mason to fetch /index.html from comp_root and show all components in reach. \-G corresponds to allow_globals.""" 4 .el .IP "\f(CWautodia \-l Mason \-i ``/index.html'' \-p comp_root \-G \*(Aq\e$c\*(Aq : use HTML::Mason to fetch /index.html from comp_root and show all components in reach. \-G corresponds to allow_globals.\fR" 4 .IX Item "autodia -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." .ie n .IP """autodia \-z : output via graphviz""" 4 .el .IP "\f(CWautodia \-z : output via graphviz\fR" 4 .IX Item "autodia -z : output via graphviz" .ie n .IP """autodia \-Z : output via springgraph""" 4 .el .IP "\f(CWautodia \-Z : output via springgraph\fR" 4 .IX Item "autodia -Z : output via springgraph" .ie n .IP """autodia \-v : output via VCG """ 4 .el .IP "\f(CWautodia \-v : output via VCG \fR" 4 .IX Item "autodia -v : output via VCG " .ie n .IP """autodia \-s skipfile : exclude files or packagenames matching those listed in file""" 4 .el .IP "\f(CWautodia \-s skipfile : exclude files or packagenames matching those listed in file\fR" 4 .IX Item "autodia -s skipfile : exclude files or packagenames matching those listed in file" .IP "c" 4 .IX Item "c" .ie n .IP """autodia \-K : do not display packages that are not part of input""" 4 .el .IP "\f(CWautodia \-K : do not display packages that are not part of input\fR" 4 .IX Item "autodia -K : do not display packages that are not part of input" .ie n .IP """autodia \-k : do not display superclasses that are not part of input""" 4 .el .IP "\f(CWautodia \-k : do not display superclasses that are not part of input\fR" 4 .IX Item "autodia -k : do not display superclasses that are not part of input" .ie n .IP """autodia \-H : show only Public/Visible methods""" 4 .el .IP "\f(CWautodia \-H : show only Public/Visible methods\fR" 4 .IX Item "autodia -H : show only Public/Visible methods" .ie n .IP """autodia \-m : show only Class methods""" 4 .el .IP "\f(CWautodia \-m : show only Class methods\fR" 4 .IX Item "autodia -m : show only Class methods" .ie n .IP """autodia \-M : do not show Class Methods""" 4 .el .IP "\f(CWautodia \-M : do not show Class Methods\fR" 4 .IX Item "autodia -M : do not show Class Methods" .ie n .IP """autodia \-a : show only Class Attributes""" 4 .el .IP "\f(CWautodia \-a : show only Class Attributes\fR" 4 .IX Item "autodia -a : show only Class Attributes" .ie n .IP """autodia \-A : do not show Class Attributes""" 4 .el .IP "\f(CWautodia \-A : do not show Class Attributes\fR" 4 .IX Item "autodia -A : do not show Class Attributes" .ie n .IP """autodia \-S : silent mode, no output to stdout except with \-O""" 4 .el .IP "\f(CWautodia \-S : silent mode, no output to stdout except with \-O\fR" 4 .IX Item "autodia -S : silent mode, no output to stdout except with -O" .ie n .IP """autodia \-h : display this help message""" 4 .el .IP "\f(CWautodia \-h : display this help message\fR" 4 .IX Item "autodia -h : display this help message" .ie n .IP """autodia \-V : display version and copyright message""" 4 .el .IP "\f(CWautodia \-V : display version and copyright message\fR" 4 .IX Item "autodia -V : display version and copyright message"