{ "mode": "perldoc", "parameter": "Pod::Simple::HTMLBatch", "section": "", "url": "https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTMLBatch/json", "generated": "2026-06-03T17:15:36Z", "synopsis": "perl -MPod::Simple::HTMLBatch -e 'Pod::Simple::HTMLBatch::go' in out", "sections": { "NAME": { "content": "Pod::Simple::HTMLBatch - convert several Pod files to several HTML files\n", "subsections": [] }, "SYNOPSIS": { "content": "perl -MPod::Simple::HTMLBatch -e 'Pod::Simple::HTMLBatch::go' in out\n", "subsections": [] }, "DESCRIPTION": { "content": "This module is used for running batch-conversions of a lot of HTML documents\n\nThis class is NOT a subclass of Pod::Simple::HTML (nor of bad old Pod::Html) -- although it uses\nPod::Simple::HTML for doing the conversion of each document.\n\nThe normal use of this class is like so:\n\nuse Pod::Simple::HTMLBatch;\nmy $batchconv = Pod::Simple::HTMLBatch->new;\n$batchconv->someoption( somevalue );\n$batchconv->someotheroption( someothervalue );\n$batchconv->batchconvert( \\@searchdirs, $outputdir );\n\nFROM THE COMMAND LINE\nNote that this class also provides (but does not export) the function\nPod::Simple::HTMLBatch::go. This is basically just a shortcut for\n\"Pod::Simple::HTMLBatch->batchconvert(@ARGV)\". It's meant to be handy for calling from the\ncommand line.\n\nHowever, the shortcut requires that you specify exactly two command-line arguments, \"indirs\" and\n\"outdir\".\n\nExample:\n\n% mkdir outhtml\n% perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go @INC outhtml\n(to convert the pod from Perl's @INC\nfiles under the directory ./outhtml)\n\n(Note that the command line there contains a literal atsign-I-N-C. This is handled as a special\ncase by batchconvert, in order to save you having to enter the odd-looking \"\" as the first\ncommand-line parameter when you mean \"just use whatever's in @INC\".)\n\nExample:\n\n% mkdir ../seekrut\n% chmod og-rx ../seekrut\n% perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go . ../seekrut\n(to convert the pod under the current dir into HTML\nfiles under the directory ./seekrut)\n\nExample:\n\n% perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go happydocs .\n(to convert all pod from happydocs into the current directory)\n", "subsections": [] }, "MAIN METHODS": { "content": "$batchconv = Pod::Simple::HTMLBatch->new;\nThis creates a new batch converter. The method doesn't take parameters. To change the\nconverter's attributes, use the \"ACCESSOR METHODS\"\" in \" below.\n\n$batchconv->batchconvert( *indirs*, *outdir* );\nThis searches the directories given in *indirs* and writes HTML files for each of these to a\ncorresponding directory in *outdir*. The directory *outdir* must exist.\n\n$batchconv->batchconvert( undef , ...);\n$batchconv->batchconvert( q{@INC}, ...);\nThese two values for *indirs* specify that the normal Perl @INC\n\n$batchconv->batchconvert( \\@dirs , ...);\nThis specifies that the input directories are the items in the arrayref \"\\@dirs\".\n\n$batchconv->batchconvert( \"somedir\" , ...);\nThis specifies that the director \"somedir\" is the input. (This can be an absolute or\nrelative path, it doesn't matter.)\n\nA common value you might want would be just \".\" for the current directory:\n\n$batchconv->batchconvert( \".\" , ...);\n\n$batchconv->batchconvert( 'somedir:someother:also' , ...);\nThis specifies that you want the dirs \"somedir\", \"someother\", and \"also\" scanned, just as if\nyou'd passed the arrayref \"[qw( somedir someother also)]\". Note that a \":\"-separator is\nnormal under Unix, but Under MSWin, you'll need 'somedir;someother;also' instead, since the\npathsep on MSWin is \";\" instead of \":\". (And *that* is because \":\" often comes up in paths,\nlike \"c:/perl/lib\".)\n\n(Exactly what separator character should be used, is gotten from\n$Config::Config{'pathsep'}, via the Config module.)\n\n$batchconv->batchconvert( ... , undef );\nThis specifies that you want the HTML output to go into the current directory.\n\n(Note that a missing or undefined value means a different thing in the first slot than in\nthe second. That's so that \"batchconvert()\" with no arguments (or undef arguments) means\n\"go from @INC, into the current directory.)\n\n$batchconv->batchconvert( ... , 'somedir' );\nThis specifies that you want the HTML output to go into the directory 'somedir'. (This can\nbe an absolute or relative path, it doesn't matter.)\n\nNote that you can also call \"batchconvert\" as a class method, like so:\n\nPod::Simple::HTMLBatch->batchconvert( ... );\n\nThat is just short for this:\n\nPod::Simple::HTMLBatch-> new-> batchconvert(...);\n\nThat is, it runs a conversion with default options, for whatever inputdirs and output dir you\nspecify.\n\nACCESSOR METHODS\nThe following are all accessor methods -- that is, they don't do anything on their own, but just\nalter the contents of the conversion object, which comprises the options for this particular\nbatch conversion.\n\nWe show the \"put\" form of the accessors below (i.e., the syntax you use for setting the accessor\nto a specific value). But you can also call each method with no parameters to get its current\nvalue. For example, \"$self->contentsfile()\" returns the current value of the contentsfile\nattribute.\n\n$batchconv->verbose( *nonnegativeinteger* );\nThis controls how verbose to be during batch conversion, as far as notes to STDOUT (or\nwhatever is \"select\"'d) about how the conversion is going. If 0, no progress information is\nprinted. If 1 (the default value), some progress information is printed. Higher values print\nmore information.\n\n$batchconv->index( *true-or-false* );\nThis controls whether or not each HTML page is liable to have a little table of contents at\nthe top (which we call an \"index\" for historical reasons). This is true by default.\n\n$batchconv->contentsfile( *filename* );\nIf set, should be the name of a file (in the output directory) to write the HTML index to.\nThe default value is \"index.html\". If you set this to a false value, no contents file will\nbe written.\n\n$batchconv->contentspagestart( *HTMLstring* );\nThis specifies what string should be put at the beginning of the contents page. The default\nis a string more or less like this:\n\n\nPerl Documentation\n\n

Perl Documentation

\n\n$batchconv->contentspageend( *HTMLstring* );\nThis specifies what string should be put at the end of the contents page. The default is a\nstring more or less like this:\n\n

Generated by\nPod::Simple::HTMLBatch v3.01 under Perl v5.008\n
At Fri May 14 22:26:42 2004 GMT,\nwhich is Fri May 14 14:26:42 2004 local time.

\n\n$batchconv->addcss( $url );\nTODO\n\n$batchconv->addjavascript( $url );\nTODO\n\n$batchconv->cssflurry( *true-or-false* );\nIf true (the default value), we autogenerate some CSS files in the output directory, and set\nour HTML files to use those. TODO: continue\n\n$batchconv->javascriptflurry( *true-or-false* );\nIf true (the default value), we autogenerate a JavaScript in the output directory, and set\nour HTML files to use it. Currently, the JavaScript is used only to get the browser to\nremember what stylesheet it prefers. TODO: continue\n\n$batchconv->nocontentslinks( *true-or-false* );\nTODO\n\n$batchconv->htmlrenderclass( *classname* );\nThis sets what class is used for rendering the files. The default is \"Pod::Simple::HTML\". If\nyou set it to something else, it should probably be a subclass of Pod::Simple::HTML, and you\nshould \"require\" or \"use\" that class so that's it's loaded before Pod::Simple::HTMLBatch\ntries loading it.\n\n$batchconv->searchclass( *classname* );\nThis sets what class is used for searching for the files. The default is\n\"Pod::Simple::Search\". If you set it to something else, it should probably be a subclass of\nPod::Simple::Search, and you should \"require\" or \"use\" that class so that's it's loaded\nbefore Pod::Simple::HTMLBatch tries loading it.\n", "subsections": [] }, "NOTES ON CUSTOMIZATION": { "content": "TODO\n\ncall addcss($someurl) to add stylesheet as alternate\ncall addcss($someurl,1) to add as primary stylesheet\n\ncall addjavascript\n\nsubclass Pod::Simple::HTML and set $batchconv->htmlrenderclass to\nthat classname\nand maybe override\n$page->batchmodepageobjectinit($self, $module, $infile, $outfile, $depth)\nor maybe override\n$batchconv->batchmodepageobjectinit($page, $module, $infile, $outfile, $depth)\nsubclass Pod::Simple::Search and set $batchconv->searchclass to\nthat classname\n", "subsections": [] }, "SEE ALSO": { "content": "Pod::Simple, Pod::Simple::HTMLBatch, perlpod, perlpodspec\n", "subsections": [] }, "SUPPORT": { "content": "Questions or discussion about POD and Pod::Simple should be sent to the pod-people@perl.org mail\nlist. Send an empty email to pod-people-subscribe@perl.org to subscribe.\n\nThis module is managed in an open GitHub repository, .\nFeel free to fork and contribute, or to clone and\nsend patches!\n\nPatches against Pod::Simple are welcome. Please send bug reports to\n.\n", "subsections": [] }, "COPYRIGHT AND DISCLAIMERS": { "content": "Copyright (c) 2002 Sean M. Burke.\n\nThis library is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n\nThis program is distributed in the hope that it will be useful, but without any warranty;\nwithout even the implied warranty of merchantability or fitness for a particular purpose.\n", "subsections": [] }, "AUTHOR": { "content": "Pod::Simple was created by Sean M. Burke . But don't bother him, he's retired.\n\nPod::Simple is maintained by:\n\n* Allison Randal \"allison@perl.org\"\n\n* Hans Dieter Pearcey \"hdp@cpan.org\"\n\n* David E. Wheeler \"dwheeler@cpan.org\"\n", "subsections": [] } }, "summary": "Pod::Simple::HTMLBatch - convert several Pod files to several HTML files", "flags": [], "examples": [], "see_also": [] }