| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "Pod::Text::Overstrike 3perl" |
| 58 |
.TH Pod::Text::Overstrike 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
Pod::Text::Overstrike \- Convert POD data to formatted overstrike text |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
.Vb 2 |
| 68 |
\& use Pod::Text::Overstrike; |
| 69 |
\& my $parser = Pod::Text::Overstrike\->new (sentence => 0, width => 78); |
| 70 |
\& |
| 71 |
\& # Read POD from STDIN and write to STDOUT. |
| 72 |
\& $parser\->parse_from_filehandle; |
| 73 |
\& |
| 74 |
\& # Read POD from file.pod and write to file.txt. |
| 75 |
\& $parser\->parse_from_file (\*(Aqfile.pod\*(Aq, \*(Aqfile.txt\*(Aq); |
| 76 |
.Ve |
| 77 |
.SH DESCRIPTION |
| 78 |
.IX Header "DESCRIPTION" |
| 79 |
Pod::Text::Overstrike is a simple subclass of Pod::Text that highlights |
| 80 |
output text using overstrike sequences, in a manner similar to nroff. |
| 81 |
Characters in bold text are overstruck (character, backspace, character) |
| 82 |
and characters in underlined text are converted to overstruck underscores |
| 83 |
(underscore, backspace, character). This format was originally designed |
| 84 |
for hard-copy terminals and/or line printers, yet is readable on soft-copy |
| 85 |
(CRT) terminals. |
| 86 |
.PP |
| 87 |
Overstruck text is best viewed by page-at-a-time programs that take |
| 88 |
advantage of the terminal's \fBstand-out\fR and \fIunderline\fR capabilities, such |
| 89 |
as the less program on Unix. |
| 90 |
.PP |
| 91 |
Apart from the overstrike, it in all ways functions like Pod::Text. See |
| 92 |
Pod::Text for details and available options. |
| 93 |
.SH BUGS |
| 94 |
.IX Header "BUGS" |
| 95 |
Currently, the outermost formatting instruction wins, so for example |
| 96 |
underlined text inside a region of bold text is displayed as simply bold. |
| 97 |
There may be some better approach possible. |
| 98 |
.SH COMPATIBILITY |
| 99 |
.IX Header "COMPATIBILITY" |
| 100 |
Pod::Text::Overstrike 1.01 (based on Pod::Parser) was the first version of |
| 101 |
this module included with Perl, in Perl 5.6.1. |
| 102 |
.PP |
| 103 |
The current API based on Pod::Simple was added in Pod::Text::Overstrike |
| 104 |
2.00, included in Perl 5.9.3. |
| 105 |
.PP |
| 106 |
Several problems with wrapping and line length were fixed as recently as |
| 107 |
Pod::Text::Overstrike 2.04, included in Perl 5.11.5. |
| 108 |
.PP |
| 109 |
This module inherits its API and most behavior from Pod::Text, so the details |
| 110 |
in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and Pod::Text::Overstrike |
| 111 |
have had the same module version since 4.00, included in Perl 5.23.7. (They |
| 112 |
unfortunately diverge in confusing ways prior to that.) |
| 113 |
.SH AUTHOR |
| 114 |
.IX Header "AUTHOR" |
| 115 |
Originally written by Joe Smith <[email protected]>, using the framework |
| 116 |
created by Russ Allbery <[email protected]>. Subsequently updated by Russ Allbery. |
| 117 |
.SH "COPYRIGHT AND LICENSE" |
| 118 |
.IX Header "COPYRIGHT AND LICENSE" |
| 119 |
Copyright 2000 by Joe Smith <[email protected]> |
| 120 |
.PP |
| 121 |
Copyright 2001, 2004, 2008, 2014, 2018\-2019, 2022 by Russ Allbery <[email protected]> |
| 122 |
.PP |
| 123 |
This program is free software; you may redistribute it and/or modify it |
| 124 |
under the same terms as Perl itself. |
| 125 |
.SH "SEE ALSO" |
| 126 |
.IX Header "SEE ALSO" |
| 127 |
Pod::Text, Pod::Simple |
| 128 |
.PP |
| 129 |
The current version of this module is always available from its web site at |
| 130 |
<https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the |
| 131 |
Perl core distribution as of 5.6.0. |