.\" 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.pm \- The configuration and Utility perl module for AutoDia. .SH "VERSION" .IX Header "VERSION" 2.14 .SH "DESCRIPTION" .IX Header "DESCRIPTION" 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. .PP Helpful information, links and news can be found at the autodia website \- http://www.aarontrevena.co.uk/opensource/autodia/ .SH "METHODS" .IX Header "METHODS" .IP "getHandlers =item getPattern =item setConfig" 4 .IX Item "getHandlers =item getPattern =item setConfig" .SH "Configuring AutoDia via Autodia.pm" .IX Header "Configuring AutoDia via Autodia.pm" To add handlers or languages edit this file. .IP "To add a handler/parser" 4 .IX Item "To add a handler/parser" Add the language or name of the parser and the name of the module to the \f(CW%handlers\fR hash in the getHandlers function. .Sp for example : .Sp \&\*(L"perl\*(R" => 'HandlerPerl', .Sp Documentation on writing your own handler can be found in the HandlerPerl and Handler perl modules .IP "To add a new language or file extension or file matching patter" 4 .IX Item "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 \f(CW%patterns\fR in the get_patterns function. .Sp for example : .Sp \&\*(L"perl\*(R" => \e%perl, .Sp Create a hash of its properties that will be pointed to by the above hashref .Sp for example : .Sp my \f(CW%perl\fR = ( regex => '\ew+\e.p[ml]$', wildcards => [ \*(L"pl\*(R", \*(L"pm\*(R", ], ); .SH "USAGE" .IX Header "USAGE" use the autodia script to run autodia. .IP "autodia ([\-i filename [\-p path] ] or [\-d directory [\-r] ]) [options]" 4 .IX Item "autodia ([-i filename [-p path] ] or [-d directory [-r] ]) [options]" .PD 0 .IP "autodia \-i filename : use filename as input" 4 .IX Item "autodia -i filename : use filename as input" .IP "autodia \-i 'filea fileb filec' : use filea, fileb and filec as input" 4 .IX Item "autodia -i 'filea fileb filec' : use filea, fileb and filec as input" .IP "autodia \-i filename \-p .. : use ../filename as input file" 4 .IX Item "autodia -i filename -p .. : use ../filename as input file" .IP "autodia \-d directoryname : use *.pl/pm in directoryname as input files" 4 .IX Item "autodia -d directoryname : use *.pl/pm in directoryname as input files" .IP "autodia \-d 'foo bar quz' : use *pl/pm in directories foo, bar and quz as input files" 4 .IX Item "autodia -d 'foo bar quz' : use *pl/pm in directories foo, bar and quz as input files" .IP "autodia \-d directory \-r : use *pl/pm in directory and its subdirectories as input files" 4 .IX Item "autodia -d directory -r : use *pl/pm in directory and its subdirectories as input files" .IP "autodia \-o outfile.xml : use outfile.xml as output file (otherwise uses autodial.out.xml)" 4 .IX Item "autodia -o outfile.xml : use outfile.xml as output file (otherwise uses autodial.out.xml)" .IP "autodia \-m [file|directory] : use multiple output files split by file or directory (creates an autodia-files directory containing files)" 4 .IX Item "autodia -m [file|directory] : use multiple output files split by file or directory (creates an autodia-files directory containing files)" .IP "autodia \-O : output to stdout" 4 .IX Item "autodia -O : output to stdout" .IP "autodia \-l language : parse source as language (ie: C) and look for appropriate filename extensions if also \-d" 4 .IX Item "autodia -l language : parse source as language (ie: C) and look for appropriate filename extensions if also -d" .IP "autodia \-t templatefile : use templatefile as template (otherwise uses template.xml)" 4 .IX Item "autodia -t templatefile : use templatefile as template (otherwise uses template.xml)" .IP "autodia \-S : silent mode, no output to stdout except with \-O" 4 .IX Item "autodia -S : silent mode, no output to stdout except with -O" .IP "autodia \-h : display this help message" 4 .IX Item "autodia -h : display this help message" .PD .SH "AUTHOR" .IX Header "AUTHOR" Aaron Trevena, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2001 \- 2007 by Aaron Trevena .PP 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.