NAME
    String::PodQuote - Quote special characters that might be interpreted by
    a POD parser

VERSION
    This document describes version 0.001 of String::PodQuote (from Perl
    distribution String-PodQuote), released on 2019-12-15.

SYNOPSIS
     use String::PodQuote qw(pod_quote);

     print pod_quote("Compare using Perl's <=> operator");

    will output:

     Compare using Perl's E<lt>=> operator.

    Another example:

     print pod_quote("=, an equal sign (=) at the beginning of string");

    will output:

     E<61>, an equal sign (=) at the beginning of string

DESCRIPTION
    If you want to put a piece of plaintext into a POD document to be
    displayed as-is when rendered as POD, you will need to quote special
    characters that might be interpreted by a POD parser. This module
    provides the "pod_quote" routine to do that.

    (Alternatively, you can indent each line of the text so it will be
    rendered verbatim in the POD).

FUNCTIONS
  pod_quote
    Usage:

     $quoted = pod_quote([ \%opts, ] $text);

    Quote special characters that might be interpreted by a POD parser.
    Basically the equivalent of HTML::Entities's "encode_entities" when
    outputting to HTML, or String::ShellQuote's "shell_quote" when passing a
    string to shell.

    Will do the following:

    *   Escape "<" into E<lt>

    *   Escape "=" at the start of string or line into E<61<gt>

    *   Escape Space or Tab at the start of string or line into E<32> or
        E<9>, respectively.

    Caveats:

    *   Newlines will not be rendered exactly; it will follow POD's rules

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/String-PodQuote>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-String-PodQuote>.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=String-PodQuote>

    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.

SEE ALSO
    perlpod

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2019 by perlancar@cpan.org.

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