GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  POD2MARKDOWN (1)

.ds Aq ’

NAME

pod2markdown - Convert POD text to Markdown

CONTENTS

VERSION

version 3.005

SYNOPSIS



    # parse STDIN, print to STDOUT
    $ pod2markdown < POD_File > Markdown_File

    # parse file, print to STDOUT
    $ pod2markdown input.pod

    # parse file, print to file
    $ pod2markdown input.pod output.mkdn

    # parse STDIN, print to file
    $ pod2markdown - output.mkdn



DESCRIPTION

This program uses Pod::Markdown to convert POD into Markdown sources.

UTF-8 is the default output encoding if no encoding options are specified (see OPTIONS).

It accepts two optional arguments:
o input pod file (defaults to STDIN)
o output markdown file (defaults to STDOUT)

OPTIONS

--html-encode-chars A list of characters to encode as HTML entities. Pass a regexp character class, or 1 to mean control chars, high-bit chars, and <&>".

See html_encode_chars in Pod::Markdown for more information.

--match-encoding (-m) Use the same =encoding as the input pod for the output file.
--output-encoding (-e) Specify the encoding for the output file.
--utf8 (-u) Alias for -e UTF-8.

SEE ALSO

This program is strongly based on pod2mdwn from Module::Build::IkiWiki.

AUTHORS

o Marcel Gruenauer <marcel@cpan.org>
o Victor Moral <victor@taquiones.net>
o Ryan C. Thompson <rct at thompsonclan d0t org>
o Aristotle Pagaltzis <pagaltzis@gmx.de>
o Randy Stauner <rwstauner@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Randy Stauner.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 1 |  Main Index


perl v5.20.3 POD2MARKDOWN (1) 2016-03-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.