/ 
App-pod2gfm-v1.0.1
/ pod2gfm

NAME

pod2gfm - convert POD to GitHub Flavored Markdown

SYNOPSIS

pod2gfm [OPTION]... [INFILE]... [OUTFILE]...

Options:

-a, --auto                   write to a file named INFILE.md
-e, --file-extension=EXT     use EXT as extension (--auto)
    --no-strip-ext           do not remove extension (--auto)
-t, --target-directory=DIR   convert all files into DIR (--auto)
    --force                  overwrite existing files
    --hl-language=LANG       set default LANG for syntax highlighting
    --man-url-prefix=URL     set man page URL for L<> codes
    --perldoc-url-prefix=URL set perldoc URL for L<> codes
-h, --help                   show this help and exit
-v, --version                show version info and exit

Examples:

$ pod2gfm                   # Convert STDIN, print to STDOUT
$ pod2gfm - file.md         # "       STDIN, print to OUTFILE
$ pod2gfm file.pod          # "       INFILE, print to STDOUT
$ pod2gfm file.pod file.md  # "       INFILE, print to OUTFILE
$ pod2gfm file.pod -a       # Ditto

# Convert multiple files (pairs)
$ pod2gfm \
    foo.pod foo.md \
    bar.pod bar.md

# Convert all files
$ pod2gfm -a foo.pod bar.pod baz.pod

If no INFILE is given or INFILE is -, read standard input.

If no OUTFILE is given, write to standard output (unless --auto is set).

DESCRIPTION

pod2gfm is a command-line utility based on pod2markdown for Pod::Markdown::Githubert, a subclass of Pod::Markdown that adds GitHub-specific features like fenced code blocks (```) with language tags for syntax highlighting.

See "DESCRIPTION" in Pod::Markdown::Githubert for details.

OPTIONS

-a, --auto

Write to a file named after INFILE with a .md extension instead of OUTFILE.

Note that any .pod, .pm, or .pl suffix is removed before appending .md (unless --no-strip-ext is set).

-e, --file-extension=EXT

If --auto is set, use EXT as extension suffix.

--no-strip-ext

If --auto is set, do not remove any .pod, .pm, or .pl suffix from INFILE.

--target-directory=DIR

If --auto is set, convert all files into DIR.

--force

Overwrite existing files silently.

--hl-language=LANG

Set the default LANG for syntax highlighting in code blocks. See "hl_language" in Pod::Markdown::Githubert.

--man-url-prefix=URL

Alter the man page URLs that are created from L<> codes. Default: http://man.he.net/man.

See "man_url_prefix" in Pod::Markdown.

--perldoc-url-prefix=URL

Alter the perldoc URLs that are created from L<> codes. Default: metacpan.

See "perldoc_url_prefix" in Pod::Markdown.

-h, --help

Display a summary of options and exit.

-v, --version

Display the pod2gfm version number and exit.

COMPLETION

To enable tab completion in bash, put the script in the PATH and run this in the shell or add it to a bash startup file (e.g. /etc/bash.bashrc or ~/.bashrc):

complete -C pod2gfm pod2gfm

EXIT STATUS

0  success
1  general failure
2  command-line usage error

BUGS

Report bugs at https://github.com/author/App-pod2gfm/issues.

AUTHOR

ryoskzypu <ryoskzypu@proton.me>

SEE ALSO

These are similar utilities but they try to guess the language syntax for the fenced code blocks, unlike Pod::Markdown::Githubert (which lets you specify a language in POD).

COPYRIGHT

Copyright © 2026 ryoskzypu

MIT-0 License. See LICENSE for details.