.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "README 3pm" .TH README 3pm "2014-12-09" "perl v5.20.2" "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" Pod::Readme \- Intelligently generate a README file from POD .SH "VERSION" .IX Header "VERSION" v1.1.2 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In a module's \s-1POD:\s0 .PP .Vb 1 \& =head1 NAME \& \& MyApp \- my nifty app \& \& =for readme plugin version \& \& =head1 DESCRIPTION \& \& This is a nifty app. \& \& =begin :readme \& \& =for readme plugin requires \& \& =head1 INSTALLATION \& \& ... \& \& =end :readme \& \& =for readme stop \& \& =head1 METHODS \& \& ... .Ve .PP Then from the command-line: .PP .Vb 1 \& pod2readme lib/MyModule.pm README .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module filters \s-1POD\s0 to generate a \fI\s-1README\s0\fR file, by using \s-1POD\s0 commands to specify which parts are included or excluded from the \&\fI\s-1README\s0\fR file. .PP See the Pod::Readme documentation for more details on the \s-1POD\s0 syntax that this module recognizes. .PP See pod2readme for command-line usage. .SH "INSTALLATION" .IX Header "INSTALLATION" See How to install \s-1CPAN\s0 modules . .SS "Required Modules" .IX Subsection "Required Modules" This distribution requires Perl v5.10.1. .PP This distribution requires the following modules: .IP "\(bu" 4 Class::Method::Modifiers (version 2.00) .IP "\(bu" 4 CPAN::Changes (version 0.30) .IP "\(bu" 4 CPAN::Meta .IP "\(bu" 4 File::Slurp .IP "\(bu" 4 Getopt::Long::Descriptive .IP "\(bu" 4 IO::String .IP "\(bu" 4 Moo (version 1.004005) .IP "\(bu" 4 Moo::Role .IP "\(bu" 4 MooX::HandlesVia .IP "\(bu" 4 namespace::autoclean .IP "\(bu" 4 Path::Tiny (version 0.018) .IP "\(bu" 4 Role::Tiny .IP "\(bu" 4 Test::Deep .IP "\(bu" 4 Test::Exception .IP "\(bu" 4 Try::Tiny .IP "\(bu" 4 Type::Tiny .IP "\(bu" 4 Types::Standard .PP This distribution recommends the following modules: .IP "\(bu" 4 Pod::Man .IP "\(bu" 4 Pod::Markdown .IP "\(bu" 4 Pod::Simple::LaTeX .IP "\(bu" 4 Type::Tiny::XS .SH "RECENT CHANGES" .IX Header "RECENT CHANGES" .SS "Bug Fixes" .IX Subsection "Bug Fixes" .IP "\(bu" 4 Regex in changes plugin fixed to work with Perl 5.21 deprecated syntax [khwilliamson]. .PP See the \fIChanges\fR file for a longer revision history. .SH "CAVEATS" .IX Header "CAVEATS" This module is intended to be used by module authors for their own modules. It is not recommended for generating \fI\s-1README\s0\fR files from arbitrary Perl modules from untrusted sources. .SH "SEE ALSO" .IX Header "SEE ALSO" See perlpod, perlpodspec and podlators. .SH "AUTHORS" .IX Header "AUTHORS" The original version was by Robert Rothenberg until 2010, when maintenance was taken over by David Precious . .PP In 2014, Robert Rothenberg rewrote the module to use filtering instead of subclassing a \s-1POD\s0 parser. .SS "Acknowledgements" .IX Subsection "Acknowledgements" Thanks to people who gave feedback and suggestions to posts about the rewrite of this module on . .SS "Suggestions, Bug Reporting and Contributing" .IX Subsection "Suggestions, Bug Reporting and Contributing" This module is developed on GitHub at .SH "LICENSE" .IX Header "LICENSE" Copyright (c) 2005\-2014 Robert Rothenberg. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.