AUTODIA(1p)

💖 AUTODIA(1p) 💖

welcome to AUTODIA(1p), bestie — straight outta the User Contributed Perl Documentation section, and yes she is that girl. ✨

---

🌸 NAME 🌸

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

(yeah the original sentence does that lil period-then-lowercase thing, we leave it, it's part of her charm 🫶)

---

🦋 INTRODUCTION 🦋

okay so here's the whole vibe, no cap. AutoDia takes source files as input and using a handler parses them to create documentation through templates. the handlers are the whole point — they allow AutoDia to parse any language by providing a handler and registering in autodia.pm. and the templates? templates allow the output to be heavily customised, from Dia XML to simple HTML, and they separate the logic of the application from the presentation of the results. it's giving architecture. it's giving separation of concerns. 👑

AutoDia is written in perl and defaults to the perl handler and file extension matching unless a language is specified using the -l switch. so like, if you don't say anything, she assumes perl. she's not being presumptuous, she's just ✨efficient✨.

AutoDia requires Template Toolkit and Perl 5. some handlers and templates may require additional software, for example the Java SDK for the java handler. so check your deps before you come for her, okay? 😭

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. literally so many formats. she contains multitudes. 🌈

helpful information, links and news can be found at the autodia website — http://www.aarontrevena.co.uk/opensource/autodia/ — go be nosy, it's free 🎀

---

💅 USAGE 💅

here's the runbook, bestie. reading it verbatim, because these are commands and we do not freestyle commands:

"autodia ([-i filename [-p path] ] or [-d directory [-r] ]) [options]"
"autodia -i filename            : use filename as input"
"autodia -i 'filea fileb filec' : use filea, fileb and filec as input"
"autodia -i filename -p ..      : use ../filename as input file"
"autodia -d directoryname       : use *.pl/pm in directoryname as input files"
"autodia -d 'foo bar quz'       : use *pl/pm in directories foo, bar and quz as input files"
"autodia -d directory -r        : use *pl/pm in directory and its subdirectories as input files"
"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"
"autodia -o outfile.xml         : use outfile.xml as output file (otherwise uses autodial.out.dia)"
"autodia -O                     : output to stdout"
"autodia -l language            : parse source as language (ie: C) and look for appropriate filename extensions if also -d"
"autodia -t templatefile        : use templatefile as template (otherwise uses template.xml)"
"autodia -l DBI -i "mysql:test:localhost" -U username -P password : use test database on localhost with username and password as username and password"
"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."
"autodia -z                     : output via graphviz"
"autodia -Z                     : output via springgraph"
"autodia -v                     : output via VCG "
"autodia -s skipfile            : exclude files or packagenames matching those listed in file"
c<autodia -D                     : ignore dependencies (ie do not process or display dependencies)>
"autodia -K                     : do not display packages that are not part of input"
"autodia -k                     : do not display superclasses that are not part of input"
"autodia -H                     : show only Public/Visible methods"
"autodia -m                     : show only Class methods"
"autodia -M                     : do not show Class Methods"
"autodia -a                     : show only Class Attributes"
"autodia -A                     : do not show Class Attributes"
"autodia -S                     : silent mode, no output to stdout except with -O"
"autodia -h                     : display this help message"
"autodia -V                     : display version and copyright message"

yes there's a stray =item and a stray c<...> in there. that's canon. we don't edit the source material, we just love her as she is 💀

and now the same tea, but decanted into cute lil sips so your brain can hold it 🍓

• autodia ([-i filename [-p path] ] or [-d directory [-r] ]) [options] — the general shape of the whole thing, the blueprint, the skeleton key.
• -i filename — use filename as input.
• -i 'filea fileb filec' — use filea, fileb and filec as input.
• -i filename -p .. — use ../filename as input file.
• -d directoryname — use *.pl/pm in directoryname as input files.
• -d 'foo bar quz' — use *pl/pm in directories foo, bar and quz as input files.
• -d directory -r — use *pl/pm in directory and its subdirectories as input files.
• -d directory -F — use files in directory but only one file per diagram.
• autodia.pl -d directory -C — use files in directory but skip CVS directories.
• -o outfile.xml — use outfile.xml as output file (otherwise uses autodial.out.dia).
• -O — output to stdout.
• -l language — parse source as language (ie: C) and look for appropriate filename extensions if also -d.
• -t templatefile — use templatefile as template (otherwise uses template.xml).
• -l DBI -i "mysql:test:localhost" -U username -P password — use test database on localhost with username and password as username and password.
• -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.
• -z — output via graphviz.
• -Z — output via springgraph.
• -v — output via VCG.
• -s skipfile — exclude files or packagenames matching those listed in file.
• -D — ignore dependencies (ie do not process or display dependencies).
• -K — do not display packages that are not part of input.
• -k — do not display superclasses that are not part of input.
• -H — show only Public/Visible methods.
• -m — show only Class methods.
• -M — do not show Class Methods.
• -a — show only Class Attributes.
• -A — do not show Class Attributes.
• -S — silent mode, no output to stdout except with -O.
• -h — display this help message.
• -V — display version and copyright message.

real talk though: -S is silent mode, so no output to stdout — except with -O. that's not a suggestion, that's the rule. 🤫

---

and that's the page, bestie!! this one's brought to you by perl v5.36.0, dated 2022-11-02 — she's been here a minute and she's still slaying. go make some UML class diagrams, you've got this 🫶💖✨