---
name: "pod2usage"
section: "1p"
platform: "linux"
package: "pdl"
version: "1.99988-5"
release: "Debian 2.1 (Slink)"
platforms: ["linux"]
url: "https://new.carta.tech/pod2usage/1p"
---

# pod2usage(1p)

print usage messages from embedded pod docs in files

## NAME

pod2usage - print usage messages from embedded pod docs in files

## SYNOPSIS

- **pod2usage**

  \[**-help**\] \[**-man**\] \[**-exit** *exitval*\] \[**-output** *outfile*\] \[**-verbose** *level*\] *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:

  ```
      1 : print SYNOPSIS only
      2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
      3 : print the entire manpage (similar to running pod2text)
  ```

- *file*

  The pathname of a file containing pod documentation to be output in usage mesage format (defaults to standard input).

## DESCRIPTION

**pod2usage** will read the given input file looking for pod documentation and will print the corresponding usage message. If no input file is specifed than standard input is read.

**pod2usage** invokes the **pod2usage()** function in the **PDL::Pod::Usage** module. Please see the `pod2usage()` entry in the *PDL::Pod::Usage* manpage.

## SEE ALSO

the *PDL::Pod::Usage* manpage, the *[pod2text(1)](/pod2text/1.md)* manpage

## AUTHOR

Brad Appleton \<Brad\_Appleton-GBDA001@email.mot.com\>

Based on code for **[pod2text(1)](/pod2text/1.md)** written by Tom Christiansen \<tchrist@mox.perl.com\>