pod2lyx
A pod to LyX format converter.
SYNOPSIS
pod2lyx [options] inputfile [outfile]
Options:
-help prints a brief help screen.
-helplong prints more help.
-man prints the full documentation
-textclass="textclass" Set the LyX textclass to use.
-title="title" Set the LyX title to use.
-noindex Do not include a index in the LyX file.
-tabstop=8 Set the Verbatium text tabstop.
-verbatimspace Set flag to add a line after a verbatim
text block.
-indexbreak Place a page break after the index.
-footnote Place a foot note on the title page indicating
the source for the document.
OPTIONS
- -help
-
Print a brief help message and exit.
- -helplong
-
Prints a little more detailed help.
- -man
-
Prints the manual page and exits. NOTE: you may want to use a pager when you use this option. Example
"pod2lyx -man | less"
. - -textclass="textclass"
-
Use this option to set the LyX document or textclass to use for the generated LyX document. Currently only the article class is supported.
- -title="title"
-
Use this option to over ride the default title assigned to the generated LyX document. Currently the default title is the file name or class name of the pod file.
- -noindex
-
Use this option to turn off the creation of a index in the LyX file.
- -tabstop=8
-
Set the tabstop to use when translating tabstops embeded in verbatium text. According to perlpod the tabstop should be 8 but I have found that this is not the case. Most of the files I've come accross have the tabstop set to 4 so that is what pod2lyx uses by default.
- -verbatimspace
-
Set a flag to indicate that a extra line should be placed after a verbatim text block. The default behavior is to not put a space after the block. But in some cases the output will look better if a extra line is output.
- -indexbreak
-
This will case a page break to be placed after the index. The default behavior is to not place a page break after the index. I personaly find having a page break after the index to be nice thats why I added the option.
- -footnote
-
By default the title page will contain a foot note indicating the source used to generate the LyX file. Using this option will remove the footnote from the title page.
DESCRIPTION
pod2lyx will read a pod file and convert that file into a native LyX document. The pod file can be a file only containing pod documentation or it can be a perl program or module with embeded pod documentation. It will search your perl @INC
path to find the pod documentation if need be to find the document.
AUTHOR
Richard D. Jackson richardj@1gig.net
ACKNOWLEDGEMENTS
I would like to thank Amir Karger for suppling me with a pod to lyx converter he did a while back. His example code helped allot while working on this.