Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages
Autodia(3) User Contributed Perl Documentation Autodia(3) - The configuration and Utility perl module for AutoDia.


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 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.
Helpful information, links and news can be found at the autodia website -

getHandlers =item getPattern =item setConfig

To add handlers or languages edit this file.
To add a handler/parser
Add the language or name of the parser and the name of the module to the %handlers hash in the getHandlers function.
for example :
"perl" => 'HandlerPerl',
Documentation on writing your own handler can be found in the HandlerPerl and Handler perl modules
To add a new language or file extension or file matching patter
Add the name of the pattern and a hashreference to its properties to %patterns in the get_patterns function.
for example :
"perl" => \%perl,
Create a hash of its properties that will be pointed to by the above hashref
for example :
my %perl = (
regex => '\w+\.p[ml]$',
wildcards => [
"pl", "pm",

use the script to run autodia. ([-i filename [-p path] ] or [-d directory [-r] ]) [options] -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 -o outfile.xml : use outfile.xml as output file (otherwise uses autodial.out.xml) -m [file|directory] : use multiple output files split by file or directory (creates an autodia-files directory containing files) -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) -S : silent mode, no output to stdout except with -O -h : display this help message

Aaron Trevena, <>

Copyright (C) 2001 - 2007 by Aaron Trevena
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.1 or, at your option, any later version of Perl 5 you may have available.
2011-05-25 perl v5.28.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.