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

NAME

6       pod2github - Convert POD text to Github flavored markdown
7

VERSION

9       version 1.000
10

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

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

SEE ALSO

55       This program is pretty much a straight copy of pod2markdown, which is
56       in turn strongly based on "pod2mdwn" from Module::Build::IkiWiki.
57

AUTHOR

59       Stefan G. <minimal@cpan.org>
60

CREDITS

62       This software is based on work by:
63
64       ·   Marcel Gruenauer <marcel@cpan.org>
65
66       ·   Victor Moral <victor@taquiones.net>
67
68       ·   Ryan C. Thompson <rct at thompsonclan d0t org>
69
70       ·   Aristotle Pagaltzis <pagaltzis@gmx.de>
71
72       ·   Randy Stauner <rwstauner@cpan.org>
73

75       This is free software; you can redistribute it and/or modify it under
76       the same terms as the Perl 5 programming language system itself.
77
78
79
80perl v5.30.1                      2020-01-30                     POD2GITHUB(1)
Impressum