Pod::Perldoc::ToTerm(3p)

Pod::Perldoc::ToTerm3p

Render pod with terminal escapes

Usage

  perldoc -o term Some::Modulename

Overview

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

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

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

Releases

28 releases since OpenBSD 5.4; the text changed 19 times.

  1. 5.4–5.5
  2. 5.6
  3. 5.7
  4. 5.8–5.9
  5. 6.0
  6. 6.1
  7. 6.2
  8. 6.3–6.4
  9. 6.5
  10. 6.6
  11. 6.7
  12. 6.8
  13. 6.9–7.2
  14. 7.3
  15. 7.4
  16. 7.5
  17. 7.6
  18. 7.7–7.8
  19. 7.9
  20. 8.0

Author

Mark Allen "<[email protected]>"

From man 8.0-current-20261101 in OpenBSD 8.0-current (2026-11-01). Parsed by carta from the page's man source.