*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->IRIX man pages -> pod2html (1)              
Title
Content
Arch
Section
 

Contents


POD2HTML(1)							   POD2HTML(1)


NAME    [Toc]    [Back]

     pod2html -	convert	.pod files to .html files

SYNOPSIS    [Toc]    [Back]

	 pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name>
		  --podpath=<name>:...:<name> --podroot=<name>
		  --libpods=<name>:...:<name> --recurse	--norecurse --verbose
		  --index --noindex --title=<name>

DESCRIPTION    [Toc]    [Back]

     Converts files from pod format (see the perlpod manpage) to HTML format.

ARGUMENTS    [Toc]    [Back]

     pod2html takes the	following arguments:

     help

	   --help

	 Displays the usage message.

     htmlroot

	   --htmlroot=name

	 Sets the base URL for the HTML	files.	When cross-references are
	 made, the HTML	root is	prepended to the URL.

     infile

	   --infile=name

	 Specify the pod file to convert.  Input is taken from STDIN if	no
	 infile	is specified.

     outfile

	   --outfile=name

	 Specify the HTML file to create.  Output goes to STDOUT if no outfile
	 is specified.

     podroot

	   --podroot=name

	 Specify the base directory for	finding	library	pods.

     podpath

	   --podpath=name:...:name



									Page 1






POD2HTML(1)							   POD2HTML(1)



	 Specify which subdirectories of the podroot contain pod files whose
	 HTML converted	forms can be linked-to in cross-references.

     libpods

	   --libpods=name:...:name

	 List of page names (eg, "perlfunc") which contain linkable =items.

     netscape

	   --netscape

	 Use Netscape HTML directives when applicable.

     nonetscape

	   --nonetscape

	 Do not	use Netscape HTML directives (default).

     index

	   --index

	 Generate an index at the top of the HTML file (default	behaviour).

     noindex

	   --noindex

	 Do not	generate an index at the top of	the HTML file.

     recurse

	   --recurse

	 Recurse into subdirectories specified in podpath (default behaviour).

     norecurse

	   --norecurse

	 Do not	recurse	into subdirectories specified in podpath.

     title

	   --title=title

	 Specify the title of the resulting HTML file.





									Page 2






POD2HTML(1)							   POD2HTML(1)



     verbose

	   --verbose

	 Display progress messages.

AUTHOR    [Toc]    [Back]

     Tom Christiansen, <tchrist@perl.com>.

BUGS    [Toc]    [Back]

     See the Pod::Html manpage for a list of known bugs	in the translator.

SEE ALSO    [Toc]    [Back]

      
      
     the perlpod manpage, the Pod::HTML	manpage

COPYRIGHT    [Toc]    [Back]

     This program is distributed under the Artistic License.


									PPPPaaaaggggeeee 3333
[ Back ]
 Similar pages
Name OS Title
Pod::Html IRIX module to convert pod files to HTML
znew OpenBSD convert compressed files to gzipped files
h2ph Linux convert .h C header files to .ph Perl header files
h2ph OpenBSD convert .h C header files to .ph Perl header files
h2ph IRIX convert .h C header files to .ph Perl header files
named-bootconf FreeBSD convert name server configuration files
pr Linux convert text files for printing
h2xs OpenBSD convert .h C header files to Perl extensions
h2xs Linux convert .h C header files to Perl extensions
ConvertLayout IRIX convert old desktop layout files to new format
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service