1POD2MARKDOWN(1)       User Contributed Perl Documentation      POD2MARKDOWN(1)
2
3
4

NAME

6       pod2markdown - Convert POD text to Markdown
7

VERSION

9       version 3.300
10

SYNOPSIS

12           # parse STDIN, print to STDOUT
13           $ pod2markdown < POD_File > Markdown_File
14
15           # parse file, print to STDOUT
16           $ pod2markdown input.pod
17
18           # parse file, print to file
19           $ pod2markdown input.pod output.mkdn
20
21           # parse STDIN, print to file
22           $ pod2markdown - output.mkdn
23

DESCRIPTION

25       This program uses Pod::Markdown to convert POD into Markdown sources.
26
27       UTF-8 is the default output encoding if no encoding options are
28       specified (see "OPTIONS").
29
30       It accepts two optional arguments:
31
32       •   input pod file (defaults to "STDIN")
33
34       •   output markdown file (defaults to "STDOUT")
35

OPTIONS

37       --html-encode-chars
38           A list of characters to encode as HTML entities.  Pass a regexp
39           character class, or 1 to mean control chars, high-bit chars, and
40           "<&>"'".
41
42           See "html_encode_chars" in Pod::Markdown for more information.
43
44       --match-encoding (-m)
45           Use the same "=encoding" as the input pod for the output file.
46
47       --output-encoding (-e)
48           Specify the encoding for the output file.
49
50       --utf8 (-u)
51           Alias for "-e UTF-8".
52

SEE ALSO

54       This program is strongly based on "pod2mdwn" from
55       Module::Build::IkiWiki.
56

AUTHORS

58       •   Marcel Gruenauer <marcel@cpan.org>
59
60       •   Victor Moral <victor@taquiones.net>
61
62       •   Ryan C. Thompson <rct at thompsonclan d0t org>
63
64       •   Aristotle Pagaltzis <pagaltzis@gmx.de>
65
66       •   Randy Stauner <rwstauner@cpan.org>
67

69       This software is copyright (c) 2011 by Randy Stauner.
70
71       This is free software; you can redistribute it and/or modify it under
72       the same terms as the Perl 5 programming language system itself.
73
74
75
76perl v5.38.0                      2023-07-21                   POD2MARKDOWN(1)
Impressum