.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Pod::Perldoc::ToText 3perl" .TH Pod::Perldoc::ToText 3perl 2024-05-30 "perl v5.38.2" "Perl Programmers Reference Guide" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Pod::Perldoc::ToText \- let Perldoc render Pod as plaintext .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& perldoc \-o text Some::Modulename .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This is a "plug-in" class that allows Perldoc to use Pod::Text as a formatter class. .PP It supports the following options, which are explained in Pod::Text: alt, indent, loose, quotes, sentence, width .PP For example: .PP .Vb 1 \& perldoc \-o text \-w indent:5 Some::Modulename .Ve .SH CAVEAT .IX Header "CAVEAT" This module may change to use a different text formatter class in the future, and this may change what options are supported. .SH "SEE ALSO" .IX Header "SEE ALSO" Pod::Text, Pod::Perldoc .SH "COPYRIGHT AND DISCLAIMERS" .IX Header "COPYRIGHT AND DISCLAIMERS" Copyright (c) 2002 Sean M. Burke. All rights reserved. .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. .SH AUTHOR .IX Header "AUTHOR" Current maintainer: Mark Allen \f(CW\*(C`\*(C'\fR .PP Past contributions from: brian d foy \f(CW\*(C`\*(C'\fR Adriano R. Ferreira \f(CW\*(C`\*(C'\fR, Sean M. Burke \f(CW\*(C`\*(C'\fR