Pod::Perldoc::ToTerm(3pm) Perl Programmers Reference Guide Pod::Perldoc::ToTerm(3pm)

# [NAME](#NAME)

Pod::Perldoc::ToTerm - render Pod with terminal escapes

# [SYNOPSIS](#SYNOPSIS)

```
  perldoc -o term Some::Modulename
```

# [DESCRIPTION](#DESCRIPTION)

This is a "plug-in" class that allows Perldoc to use Pod::Text as a formatter class.

It supports the following options, which are explained in Pod::Text: alt, indent, loose, quotes, sentence, width

For example:

```
  perldoc -o term -w indent:5 Some::Modulename
```

# [PAGER FORMATTING](#PAGER_FORMATTING)

Depending on the platform, and because this class emits terminal escapes it will attempt to set the "-R" flag on your pager by injecting the flag into your environment variable for "less" or "more".

On Windows and DOS, this class will not modify any environment variables.

# [CAVEAT](#CAVEAT)

This module may change to use a different text formatter class in the future, and this may change what options are supported.

# [SEE ALSO](#SEE_ALSO)

Pod::Text, Pod::Text::Termcap, Pod::Perldoc

# [COPYRIGHT AND DISCLAIMERS](#COPYRIGHT_AND_DISCLAIMERS)

Copyright (c) 2017 Mark Allen.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

# [AUTHOR](#AUTHOR)

Mark Allen "<mallen@cpan.org>"

2026-10-26 perl v5.44.0

---

Document: Pod::Perldoc::ToTerm(3pm) from perl 5.44.0-r3 (Chainguard OS)
Source: https://github.com/Perl/perl5.git