POD2USAGE(1)

📦 version 2.03, in opensuse-leap 16.0

🫶 pod2usage(1) 🫶

Okay bestie, this is POD2USAGE(1) from User Contributed Perl Documentation — the page for pod2usage, aka the little icon that prints usage messages from embedded pod docs in files. 💖 No cap, this one is lowkey useful.

🌸 NAME 🌸

pod2usage — print usage messages from embedded pod docs in files. ✨

🦋 SYNOPSIS 🦋

The whole vibe is literally:

pod2usage   [-help] [-man] [-exit exitval] [-output outfile] [-verbose
                   level] [-pathlist dirlist] [-formatter module] [-utf8] file

💅 OPTIONS AND ARGUMENTS 💅

  • -help — print a brief help message and exit. 🫶
  • -man — print this command's manual page and exit. 👑
  • -exit exitval — the exit status value to return. 🚪
  • -output outfile — the output file to print to. If the special names "-" or ">&1" or ">&STDOUT" are used, then standard output is used. If ">&2" or ">&STDERR" is used, then standard error is used. 🎀
  • -verbose level — the desired level of verbosity to use. The levels are exactly:
1 : print SYNOPSIS only
2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
3 : print the entire manpage (similar to running pod2text)
  • -pathlist dirlist — specifies one or more directories to search for the input file if it was not supplied with an absolute path. Each directory path in the given list should be separated by a ':' on Unix (';' on MSWin32 and DOS). 🌈
  • -formatter module — which text formatter to use. Default is Pod::Text, or for very old Perl versions Pod::PlainText. An alternative would be e.g. Pod::Text::Termcap. 🧚
  • -utf8 — this option assumes that the formatter (see above) understands the option "utf8". It turns on generation of utf8 output. 💜
  • file — the pathname of a file containing pod documentation to be output in usage message format. If omitted, standard input is read — but the output is then formatted with Pod::Text only — unless a specific formatter has been specified with -formatter. 🍓

🌟 DESCRIPTION 🌟

pod2usage will read the given input file looking for pod documentation and will print the corresponding usage message. If no input file is specified, then standard input is read. 📖✨

pod2usage invokes the pod2usage() function in the Pod::Usage module. Please see "pod2usage()" in Pod::Usage. 👀💖

🔥 SEE ALSO 🔥

Go peek at Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap, and perldoc. 💫

🎀 AUTHOR 🎀

Please report bugs using <http://rt.cpan.org>. 🐞

  • Brad Appleton <bradapp@enteract.com> 💌
  • Based on code for pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com> 🌸

💖 Big sparkly sign-off, bestie: this page is from source/version perl v5.42.0, dated 2022-05-22, and the footer literally says POD2USAGE(1). Byeee! 💅✨

📦 where this page comes from