.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "metaf2xml::XML 3pm" .TH metaf2xml::XML 3pm "2007-09-11" "metaf2xml 1.29" "User Contributed Perl Documentation" .SH "NAME" metaf2xml::XML \-\- write data of METAR, TAF, and/or SYNOP messages to an XML file .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 5 \& use metaf2xml::XML; \& metaf2xml::XML::startXML(\e%opts,\e@versions); \& metaf2xml::XML::printReport(\e%report); \& ... \& metaf2xml::XML::finishXML(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .Vb 1 \& Note: This manual is valid for version 1.29 of metaf2xml. .Ve .PP This module writes the data of \s-1METAR\s0, \s-1TAF\s0, and/or \s-1SYNOP\s0 messages to an \s-1XML\s0 file. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" The modules \f(CW\*(C`IO::File\*(C'\fR and \f(CW\*(C`XML::Writer\*(C'\fR are required. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .Sh "startXML(\e%opts,\e@versions)" .IX Subsection "startXML(%opts,@versions)" This function opens the \s-1XML\s0 file and writes the necessary meta data into it. .PP The following arguments are expected: .ie n .IP """opts""" 4 .el .IP "\f(CWopts\fR" 4 .IX Item "opts" Reference to hash of options. The following keys of the hash are recognised: .RS 4 .ie n .IP """x""\fR, with value \fB" 4 .el .IP "\f(CWx\fR, with value \fB\fR" 4 .IX Item "x, with value " print parsed content of message as \s-1XML\s0 to .ie n .IP """X""" 4 .el .IP "\f(CWX\fR" 4 .IX Item "X" with option \fBx\fR, produce complete \s-1XML\s0 file, not just data .ie n .IP """D""" 4 .el .IP "\f(CWD\fR" 4 .IX Item "D" with option \fBX\fR, add \s-1DOCTYPE\s0, reference to \s-1DTD\s0 .ie n .IP """S""\fR, with value \fB" 4 .el .IP "\f(CWS\fR, with value \fB\fR" 4 .IX Item "S, with value " with option \fBX\fR, add reference to stylesheet .ie n .IP """O""\fR, with value \fB" 4 .el .IP "\f(CWO\fR, with value \fB\fR" 4 .IX Item "O, with value " with option \fBS\fR, add (a space separated list of the options passed to metaf2xml.pl) to \s-1XML\s0 file .RE .RS 4 .RE .ie n .IP """versions""" 4 .el .IP "\f(CWversions\fR" 4 .IX Item "versions" Reference to array of version strings. They are written to the \s-1XML\s0 file if the option \f(CW\*(C`X\*(C'\fR is given. .Sh "printReport(\e%report)" .IX Subsection "printReport(%report)" This function writes the content of \f(CW\*(C`report\*(C'\fR to the \s-1XML\s0 file. The data for each message will be enclosed in a tag \f(CW\*(C`, \f(CW\*(C`, or \&\f(CW\*(C`. The function can be invoked repeatedly. \&\fIstartXML()\fR must have been invoked already. \&\fIfinishXML()\fR must be invoked to complete the \s-1XML\s0 file. .PP The following argument is expected: .ie n .IP """report""" 4 .el .IP "\f(CWreport\fR" 4 .IX Item "report" reference to hash of data to be written to the file .Sh "\fIfinishXML()\fP" .IX Subsection "finishXML()" This function must be invoked to complete the writing to the \s-1XML\s0 file. \&\fIstartXML()\fR must have been invoked already. .PP No arguments are expected. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBmetaf2xml::parser\fR(3pm), \&\fBmetaf2xml\fR(1), \&\fBmetaf\fR(1), .PP .SH "COPYRIGHT, LICENSE, DISCLAIMER" .IX Header "COPYRIGHT, LICENSE, DISCLAIMER" copyright (c) 2006\-2007 metaf2xml @ .PP This program is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \&\s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program; if not, write to the Free Software Foundation, 59 Temple Place, Suite 330, Boston, \s-1MA\s0 02111\-1307, \s-1USA\s0