Debian Codegraph @

upstream/mageia-cauldron/man3pm/Pod::Text::Overstrike.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Text::Overstrike 3pm"
61 .TH Pod::Text::Overstrike 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Text::Overstrike \- Convert POD data to formatted overstrike text
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use Pod::Text::Overstrike;
72 \& my $parser = Pod::Text::Overstrike\->new (sentence => 0, width => 78);
73 \&
74 \& # Read POD from STDIN and write to STDOUT.
75 \& $parser\->parse_from_filehandle;
76 \&
77 \& # Read POD from file.pod and write to file.txt.
78 \& $parser\->parse_from_file (\*(Aqfile.pod\*(Aq, \*(Aqfile.txt\*(Aq);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 Pod::Text::Overstrike is a simple subclass of Pod::Text that highlights
83 output text using overstrike sequences, in a manner similar to nroff.
84 Characters in bold text are overstruck (character, backspace, character)
85 and characters in underlined text are converted to overstruck underscores
86 (underscore, backspace, character). This format was originally designed
87 for hard\-copy terminals and/or line printers, yet is readable on soft\-copy
88 (CRT) terminals.
89 .PP
90 Overstruck text is best viewed by page\-at\-a\-time programs that take
91 advantage of the terminal\*(Aqs \fBstand\-out\fR and \fIunderline\fR capabilities, such
92 as the less program on Unix.
93 .PP
94 Apart from the overstrike, it in all ways functions like Pod::Text. See
95 Pod::Text for details and available options.
96 .SH BUGS
97 .IX Header "BUGS"
98 Currently, the outermost formatting instruction wins, so for example
99 underlined text inside a region of bold text is displayed as simply bold.
100 There may be some better approach possible.
101 .SH COMPATIBILITY
102 .IX Header "COMPATIBILITY"
103 Pod::Text::Overstrike 1.01 (based on Pod::Parser) was the first version of
104 this module included with Perl, in Perl 5.6.1.
105 .PP
106 The current API based on Pod::Simple was added in Pod::Text::Overstrike
107 2.00, included in Perl 5.9.3.
108 .PP
109 Several problems with wrapping and line length were fixed as recently as
110 Pod::Text::Overstrike 6.0.0.
111 .PP
112 This module inherits its API and most behavior from Pod::Text, so the details
113 in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and Pod::Text::Overstrike
114 have had the same module version since 4.00, included in Perl 5.23.7. (They
115 unfortunately diverge in confusing ways prior to that.)
116 .SH CAVEATS
117 .IX Header "CAVEATS"
118 Line wrapping is done only at ASCII spaces and tabs, rather than using a
119 correct Unicode\-aware line wrapping algorithm.
120 .SH AUTHOR
121 .IX Header "AUTHOR"
122 Originally written by Joe Smith <[email protected]>, using the framework
123 created by Russ Allbery <[email protected]>. Subsequently updated by Russ Allbery.
124 .SH "COPYRIGHT AND LICENSE"
125 .IX Header "COPYRIGHT AND LICENSE"
126 Copyright 2000 Joe Smith <[email protected]>
127 .PP
128 Copyright 2001, 2004, 2008, 2014, 2018\-2019, 2022, 2024 Russ Allbery
129 <[email protected]>
130 .PP
131 This program is free software; you may redistribute it and/or modify it
132 under the same terms as Perl itself.
133 .SH "SEE ALSO"
134 .IX Header "SEE ALSO"
135 Pod::Text, Pod::Simple
136 .PP
137 The current version of this module is always available from its web site at
138 <https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
139 Perl core distribution as of 5.6.0.