Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pod2docbook(1p) [debian man page]

POD2DOCBOOK(1p) 					User Contributed Perl Documentation					   POD2DOCBOOK(1p)

NAME
pod2docbook - Convert POD data to DocBook SGML SYNOPSIS
pod2docbook [--help] [--doctype=article|chapter|section|refentry] [--title=title] [--spaces=# spaces per indent level] [--fix-double-quotes] [--no-header] [--base-id=idstring] [infile [outfile]] DESCRIPTION
pod2docbook converts files from pod format (see perlpod) to DocBook 4.2 SGML (see <http://www.docbook.org/>). The program itself is merely a driver for the Pod::2::DocBook class; if you're interested in details of pod-to-SGML translation see Pod::2::DocBook. OPTIONS AND ARGUMENTS
[--help] Print usage and exit. [--doctype=article|chapter|section|refentry] Specifies the document type for the output file; the default is section. [--title=title] Specifies the document title. The default is infile, if it is supplied, or empty string otherwise. [--spaces=# spaces per indent level] Specifies the number of spaces per indent level in the SGML output; the default is 2. [--fix-double-quotes] Replace pairs of double quotes in regular paragraphs with <quote> and </quote> (see Pod::2::DocBook for details). [--no-header] Omit the DOCTYPE line from the output. infile The name of the file from which to read pod source; if not supplied, STDIN is used for input. outfile The name of the file to which to write SGML; if not supplied, STDOUT is used for output. [--base-id=idstring] The root element of the --doctype will have the idstring set for attribute id. The default is an input file name "cleaned up" to conform with XML restriction for characteds used in id strings. (SEE http://www.w3.org/TR/2000/REC-xml-20001006#NT-Name <http://www.w3.org/TR/2000/REC-xml-20001006#NT-Name>) SEE ALSO
pod2docbook, perlpod, Pod::DocBook, SVN repo - https://cle.sk/repos/pub/cpan/Pod-2-DocBook/ <https://cle.sk/repos/pub/cpan/Pod-2-DocBook/>, http://www.ohloh.net/projects/pod-2-docbook <http://www.ohloh.net/projects/pod-2-docbook>, doc/ + examples/pod2docbook-docbook/ for Pod::2::DocBook DocBook documentation DocBook related links: <http://www.docbook.org/>, <http://www.sagehill.net/docbookxsl/>, http://developers.cogentrts.com/cogent/prepdoc/pd-axfrequentlyuseddocbooktags.html <http://developers.cogentrts.com/cogent/prepdoc/pd- axfrequentlyuseddocbooktags.html> AUTHOR
Alligator Descartes <descarte@symbolstone.org> wrote a module called Pod::2::DocBook, which was later maintained by Jan Iven <jan.iven@cern.ch>. That module was based on the original pod2html by Tom Christiansen <tchrist@mox.perl.com>. Nandu Shah <nandu@zvolve.com> wrote Pod::DocBook, which is unrelated to the previous module (even though they both perform the same function). (http://search.cpan.org/~nandu/Pod-DocBook-1.2/ <http://search.cpan.org/~nandu/Pod-DocBook-1.2/>) Jozef Kutej <jkutej@cpan.org> renamed the module to Pod::2::DocBook because Nandus version was buried in the CPAN archive as an "UNAUTHORIZED RELEASE". COPYRIGHT
Copyright 2004, Nandu Shah <nandu@zvolve.com> Copyright 2008, Jozef Kutej <jkutej@cpan.org> This library is free software; you may redistribute it and/or modify it under the same terms as Perl itself perl v5.12.3 2011-05-28 POD2DOCBOOK(1p)

Check Out this Related Man Page

POM2(1) 						User Contributed Perl Documentation						   POM2(1)

NAME
pom2 - convert POD to Text, HTML, etc., with Pod::POM SYNOPSIS
pom2 text MyFile.pm > MyFile.txt pom2 html MyFile.pm > MyFile.html pom2 pod MyFile.pm > Myfile.pod pom2 format [options] MyFile.pm > Myfile.xyz DESCRIPTION
This script uses "Pod::POM" to convert a Pod document into text, HTML, back into Pod (e.g. to normalise a document to fix any markup errors), or any other format for which you have a view module. If the viewer is not one of the viewers bundled with "Pod::POM", the script searches for an installed "Pod::POM::View" module that matches the specified format. For example if you have "Pod::POM::View::DocBook" installed then you could say: pod2 docbook MyFile.pm > MyFile.xml If any options other than "--help" are specified then they are passed to the constructor method of the view class. For example: pod2 docbook --root=chapter --titlecasing MyFile.pm > MyFile.xml would convert the Pod document to a DocBook chapter document with the titlecasing option enabled. Note that any string prefixed by ""--"" is taken as a valid option and passed to the constructor; if no value is specified then a value of 1 is passed in. AUTHOR
Andy Wardley <abw@kfs.org> extended by Andrew Ford <A.Ford@ford-mason.co.uk> VERSION
This is version 0.3 of pom2. COPYRIGHT
Copyright (C) 2000, 2001 Andy Wardley. All Rights Reserved. Copyright (C) 2009 Andrew Ford. All Rights Reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. SEE ALSO
For further information please see Pod::POM. perl v5.12.1 2009-03-19 POM2(1)
Man Page