1POD2README(1) User Contributed Perl Documentation POD2README(1)
2
3
4
6 pod2readme - Intelligently generate a README file from POD
7
9 pod2readme [-cfho] [long options...] input-file [output-file] [target]
10
11 Intelligently generate a README file from POD
12
13 -t --target target type (default: 'readme')
14 -f --format output format (default: 'text')
15 -b --backup backup output file
16 -o --output output filename (default based on target)
17 -c --stdout output to stdout (console)
18 -F --force only update if files are changed
19 -h --help print usage and exit
20
22 pod2readme -f markdown lib/MyApp.pm
23
25 This utility will use Pod::Readme to extract a README file from a POD
26 document.
27
28 It works by extracting and filtering the POD, and then calling the
29 appropriate filter program to convert the POD to another format.
30
32 "--backup"
33 By default, "pod2readme" will back up the output file. To disable this,
34 use the "--no-backup" option.
35
36 "--output"
37 Specifies the name of the output file. If omitted, it will use the
38 second command line argument, or default to the "--target" plus the
39 corresponding extention of the "--format".
40
41 For all intents, the default is README.
42
43 If a format other than "text" is chosen, then the appropriate extention
44 will be added, e.g. for "markdown", the default output file is
45 README.md.
46
47 "--target"
48 The target of the filter, which defaults to "readme".
49
50 "--format"
51 The output format, which defaults to "text".
52
53 Other supposed formats are "html", "latex", "man", "markdown", "pod",
54 "rtf", and "xhtml".
55
56 "--stdout"
57 If enabled, it will output to the console instead of "--output".
58
59 "--force"
60 By default, the README will be generated if the source files have been
61 changed. Using "--force" will force the file to be updated.
62
63 Note: POD format files will always be updated.
64
65 "--help"
66 Prints the usage and exits.
67
69 pod2text, pod2markdown.
70
71
72
73perl v5.28.0 2014-11-07 POD2README(1)