diff options
Diffstat (limited to 'upstream/archlinux/man3/Pod::Perldoc::ToTerm.3perl')
| -rw-r--r-- | upstream/archlinux/man3/Pod::Perldoc::ToTerm.3perl | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/Pod::Perldoc::ToTerm.3perl b/upstream/archlinux/man3/Pod::Perldoc::ToTerm.3perl new file mode 100644 index 00000000..12ffb81e --- /dev/null +++ b/upstream/archlinux/man3/Pod::Perldoc::ToTerm.3perl @@ -0,0 +1,108 @@ +.\" -*- 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::ToTerm 3perl" +.TH Pod::Perldoc::ToTerm 3perl 2024-02-11 "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::ToTerm \- render Pod with terminal escapes +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& perldoc \-o term 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 term \-w indent:5 Some::Modulename +.Ve +.SH "PAGER FORMATTING" +.IX Header "PAGER FORMATTING" +Depending on the platform, and because this class emits terminal escapes it +will attempt to set the \f(CW\*(C`\-R\*(C'\fR flag on your pager by injecting the flag into +your environment variable for \f(CW\*(C`less\*(C'\fR or \f(CW\*(C`more\*(C'\fR. +.PP +On Windows and DOS, this class will not modify any environment variables. +.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::Text::Termcap, Pod::Perldoc +.SH "COPYRIGHT AND DISCLAIMERS" +.IX Header "COPYRIGHT AND DISCLAIMERS" +Copyright (c) 2017 Mark Allen. +.PP +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. +.PP +See http://dev.perl.org/licenses/ for more information. +.SH AUTHOR +.IX Header "AUTHOR" +Mark Allen \f(CW\*(C`<mallen@cpan.org>\*(C'\fR |