.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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" '' . ds C` . ds C' '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 >0, 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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "POD2PDF 1p" .TH POD2PDF 1p "2021-05-23" "perl v5.32.1" "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" pod2pdf \- converts Pod to PDF format .SH "DESCRIPTION" .IX Header "DESCRIPTION" pod2pdf converts documents written in Perl's \s-1POD\s0 (Plain Old Documentation) format to \s-1PDF\s0 files. .SS "Usage" .IX Subsection "Usage" .Vb 1 \& pod2pdf [options] input.pod >output.pdf .Ve .PP If no input filename is specified, pod2pdf will read from \s-1STDIN,\s0 e.g. .PP .Vb 1 \& perldoc \-u File::Find | pod2pdf [options] >File\-Find.pdf .Ve .SS "Options" .IX Subsection "Options" pod2pdf accepts the following command-line options: .ie n .IP """\-\-output\-file""" 4 .el .IP "\f(CW\-\-output\-file\fR" 4 .IX Item "--output-file" Sets the output filename for the generated \s-1PDF\s0 file. By default pod2pdf will output to \s-1STDOUT.\s0 .ie n .IP """\-\-page\-size""" 4 .el .IP "\f(CW\-\-page\-size\fR" 4 .IX Item "--page-size" Sets the page size to be used in the \s-1PDF\s0 file, can be set to any of the standard paper sizes (A4, A5, Letter, etc). Defaults to A4. .ie n .IP """\-\-page\-orientation""" 4 .el .IP "\f(CW\-\-page\-orientation\fR" 4 .IX Item "--page-orientation" Controls if pages are produces in landscape or portrait format. Defaults to 'portrait'. .ie n .IP """\-\-page\-width"", ""\-\-page\-height""" 4 .el .IP "\f(CW\-\-page\-width\fR, \f(CW\-\-page\-height\fR" 4 .IX Item "--page-width, --page-height" Sets the width and height of the generated pages in points (for using non-standard paper sizes). .ie n .IP """\-\-left\-margin"", ""\-\-right\-margin"", ""\-\-top\-margin"", ""\-\-bottom\-margin""" 4 .el .IP "\f(CW\-\-left\-margin\fR, \f(CW\-\-right\-margin\fR, \f(CW\-\-top\-margin\fR, \f(CW\-\-bottom\-margin\fR" 4 .IX Item "--left-margin, --right-margin, --top-margin, --bottom-margin" Allows each of the page margins (top, bottom, left, and right) to be individually set in points. .ie n .IP """\-\-margins""" 4 .el .IP "\f(CW\-\-margins\fR" 4 .IX Item "--margins" Sets all page margins to the same size (specified in points). .ie n .IP """\-\-header"", ""\-\-noheader""" 4 .el .IP "\f(CW\-\-header\fR, \f(CW\-\-noheader\fR" 4 .IX Item "--header, --noheader" Controls if a header (containing the page title, and optional timestamp and icon) will be included on each page. Defaults to on, so use \f(CW\*(C`\-\-noheader\*(C'\fR to disable. .ie n .IP """\-\-title""" 4 .el .IP "\f(CW\-\-title\fR" 4 .IX Item "--title" Sets the page title (defaults to the input filename). .ie n .IP """\-\-timestamp""" 4 .el .IP "\f(CW\-\-timestamp\fR" 4 .IX Item "--timestamp" Boolean option \- if set, includes the 'last modified' timestamp of the input file in the page header. .ie n .IP """\-\-icon""" 4 .el .IP "\f(CW\-\-icon\fR" 4 .IX Item "--icon" Filename of an icon to be displayed in the top left corner of each page. .ie n .IP """\-\-icon\-scale""" 4 .el .IP "\f(CW\-\-icon\-scale\fR" 4 .IX Item "--icon-scale" Scaling value for the header icon (defaults to 0.25). .ie n .IP """\-\-footer"", ""\-\-nofooter""" 4 .el .IP "\f(CW\-\-footer\fR, \f(CW\-\-nofooter\fR" 4 .IX Item "--footer, --nofooter" Controls if a footer (containg the current page number and optional text string) will be included on each page. By default the footer will be included, so use \&\f(CW\*(C`\-\-nofooter\*(C'\fR to disable. .ie n .IP """\-\-footer\-text""" 4 .el .IP "\f(CW\-\-footer\-text\fR" 4 .IX Item "--footer-text" Sets an optional footer text string that will be included in the bottom left corner of each page. .ie n .IP """\-\-outlines""" 4 .el .IP "\f(CW\-\-outlines\fR" 4 .IX Item "--outlines" Adds outlines (bookmarks) to pdf according to headings (=head1, =head2, ...). .ie n .IP """\-\-version""" 4 .el .IP "\f(CW\-\-version\fR" 4 .IX Item "--version" Prints version number and exits. .SS "Configuration files" .IX Subsection "Configuration files" Sets of command-line options may be saved into configuration files. .PP A configuration file contains options in the same format as used by pod2pdf on the command-line, with one option given on each line of the file, e.g. .PP .Vb 2 \& \-\-page\-size A5 \& \-\-page\-orientation landscape .Ve .PP To use a config file, invoke pod2pdf with the option \f(CW\*(C`@/path/to/configfile.conf\*(C'\fR. .PP For example, if you wanted to always include a company logo, timestamp, and copyright notice in your \s-1PDF\s0 files, create a file \fImycompany.conf\fR containing the following: .PP .Vb 3 \& \-\-icon "/path/to/your/logo.png" \& \-\-footer\-text "Copyright 2007 MyCompany Limited" \& \-\-timestamp .Ve .PP Then invoke pod2pdf as: .PP .Vb 1 \& pod2pdf @/path/to/mycompany.conf input.pod >output.pdf .Ve .PP If you create a config file called \fIpod2pdf.conf\fR and place this in the same directory as the pod2pdf script, it will be loaded as the default configuration. .SH "POD ENTENSIONS" .IX Header "POD ENTENSIONS" As well as the standard \s-1POD\s0 commands (see perlpodspec), pod2pdf supports the following extensions to the \s-1POD\s0 format: .ie n .IP """=ff""" 4 .el .IP "\f(CW=ff\fR" 4 .IX Item "=ff" The \f(CW\*(C`=ff\*(C'\fR command inserts a page bread (form feed) into the document. .ie n .IP """O<...>""" 4 .el .IP "\f(CWO<...>\fR" 4 .IX Item "O<...>" The \f(CW\*(C`O<...>\*(C'\fR formatting code inserts an external object (file) into the document. This is primarily intended for embedding images, e.g. .Sp .Vb 1 \& O .Ve .Sp to insert diagrams, etc into documentation. .Sp pod2pdf supports the file types \s-1JPG, GIF, TIFF, PNG,\s0 and \s-1PNM\s0 for embedded objects. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" pod2pdf requires the following modules to be installed: .IP "\s-1PDF::API2\s0" 4 .IX Item "PDF::API2" .PD 0 .IP "Pod::Escapes" 4 .IX Item "Pod::Escapes" .IP "Getopt::ArgvFile" 4 .IX Item "Getopt::ArgvFile" .PD .PP Additionally to use images, the modules File::Type and Image::Size must be installed, and to specify alternative page sizes the Paper::Specs module is required. .SH "SEE ALSO" .IX Header "SEE ALSO" The pod2pdf homepage: .PP For more information about \s-1POD,\s0 read the perlpod manpage or see the \s-1POD\s0 page on the Perl 5 Wiki (). .SH "COPYRIGHT and LICENSE" .IX Header "COPYRIGHT and LICENSE" Copyright (C) 2007 Jon Allen (\s-1JJ\s0) .PP This software is licensed under the terms of the Artistic License version 2.0. .PP For full license details, please read the file \fIartistic\-2_0.txt\fR included with this distribution, or see .