.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "bin::download-entities 3" .TH bin::download-entities 3 "2015-08-17" "perl v5.12.5" "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" download\-entities \- download and parse XML Entity definitions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& $ perl download\-entities.pl \-i # interactive \& $ perl download\-entities.pl > output\-file.pm \& $ perl download\-entities.pl output\-file.pm \& \& # instead of http://www.w3.org/2003/entities/iso9573\-2003/ \& $ perl download\-entities.pl http://my.server.com/entities.html .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This script downloads the definitions of \s-1XML\s0 entities from http://www.w3.org/2003/entities/iso9573\-2003/ or from whatever address you give it as an argument. The argument should be an \s-1URL\s0 (that LWP::UserAgent::get can access) pointing to a document with (absolute or relative) references to files ending with the \&\f(CW\*(C`.ent\*(C'\fR suffix. These files are expected to be \s-1DTD\s0's with lines like .PP .Vb 1 \& .Ve .PP The script parses these files and prints the perl module to the standard output. If you wish, you can give \*(L"file\*(R" as another argument to the script and it will then print it to \*(L"file\*(R". You can also specify the output file in the environment variable \&\f(CW\*(C`OUTPUT_FILE\*(C'\fR. .PP The index and the output file are distinguished by the presence of \*(L"://\*(R" substring. If you want to use a locally stored index file (the one with the \&.ent references), you can access it by saying .PP .Vb 1 \& perl download.pl file:///path/to/index.html .Ve .PP Note that the script currently distinguishes between relative and absolute paths by looking at whether the href contains a \*(L"://\*(R" substring. This can lead to crashes when the links look like href=\*(L"/path/file.ent\*(R". .PP Also, the script assumes the links have exactly the format \&\fIhref=\*(L"...\*(R"\fR \- with double quotes. .SS "Interactive download" .IX Subsection "Interactive download" In case you run into problems downloading the documents, you can try to run the script with the \f(CW\*(C`\-i\*(C'\fR or \f(CW\*(C`\-\-interactive\*(C'\fR option. This will let you skip downloads or enter alternative URLs for individual documents. .PP The interactive mode is also triggered when the \f(CW\*(C`INTERACTIVE\*(C'\fR environment variable is set to a true value (in Perl sense). .SS "Options" .IX Subsection "Options" Beside the \f(CW\*(C`\-\-interactive\*(C'\fR option, this script also accepts the \f(CW\*(C`\-\-timeout\*(C'\fR option. It specifies the timeout for LWP::UserAgent in seconds when downloading. The same is controlled by the \f(CW\*(C`DOWNLOAD_TIMEOUT\*(C'\fR environment variable. The defaule (180s) timeout is used when not specified. .PP .Vb 6 \& # 10 seconds timeout \- croak on failure \& perl download\-entities.pl \-\-timeout 10 > XML/Entities/Data.pm \& # 5 seconds timeout \- croak on failure \& DOWNLOAD_TIMEOUT=5 perl download\-entities.pl > XML/Entities/Data.pm \& # 1 second timeout \- ask on failure \& perl download\-entities.pl \-\-interactive \-\-timeout 1 > XML/Entities/Data.pm .Ve .SS "Dependencies" .IX Subsection "Dependencies" This script has dependencies that the \f(CW\*(C`XML::Entities\*(C'\fR module does not and are therefore not mentioned in the \s-1META\s0.yml file. These are \f(CW\*(C`LWP::UserAgent\*(C'\fR, \&\f(CW\*(C`File::Basename\*(C'\fR and \f(CW\*(C`Fatal\*(C'\fR. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2010 Jan Oldrich Kruza . All rights reserved. .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.