summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/Pod::Text::Overstrike.3perl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/debian-unstable/man3/Pod::Text::Overstrike.3perl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man3/Pod::Text::Overstrike.3perl')
-rw-r--r--upstream/debian-unstable/man3/Pod::Text::Overstrike.3perl131
1 files changed, 131 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/Pod::Text::Overstrike.3perl b/upstream/debian-unstable/man3/Pod::Text::Overstrike.3perl
new file mode 100644
index 00000000..3eccc10d
--- /dev/null
+++ b/upstream/debian-unstable/man3/Pod::Text::Overstrike.3perl
@@ -0,0 +1,131 @@
+.\" -*- 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::Text::Overstrike 3perl"
+.TH Pod::Text::Overstrike 3perl 2024-01-12 "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::Text::Overstrike \- Convert POD data to formatted overstrike text
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 2
+\& use Pod::Text::Overstrike;
+\& my $parser = Pod::Text::Overstrike\->new (sentence => 0, width => 78);
+\&
+\& # Read POD from STDIN and write to STDOUT.
+\& $parser\->parse_from_filehandle;
+\&
+\& # Read POD from file.pod and write to file.txt.
+\& $parser\->parse_from_file (\*(Aqfile.pod\*(Aq, \*(Aqfile.txt\*(Aq);
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+Pod::Text::Overstrike is a simple subclass of Pod::Text that highlights
+output text using overstrike sequences, in a manner similar to nroff.
+Characters in bold text are overstruck (character, backspace, character)
+and characters in underlined text are converted to overstruck underscores
+(underscore, backspace, character). This format was originally designed
+for hard-copy terminals and/or line printers, yet is readable on soft-copy
+(CRT) terminals.
+.PP
+Overstruck text is best viewed by page-at-a-time programs that take
+advantage of the terminal's \fBstand-out\fR and \fIunderline\fR capabilities, such
+as the less program on Unix.
+.PP
+Apart from the overstrike, it in all ways functions like Pod::Text. See
+Pod::Text for details and available options.
+.SH BUGS
+.IX Header "BUGS"
+Currently, the outermost formatting instruction wins, so for example
+underlined text inside a region of bold text is displayed as simply bold.
+There may be some better approach possible.
+.SH COMPATIBILITY
+.IX Header "COMPATIBILITY"
+Pod::Text::Overstrike 1.01 (based on Pod::Parser) was the first version of
+this module included with Perl, in Perl 5.6.1.
+.PP
+The current API based on Pod::Simple was added in Pod::Text::Overstrike
+2.00, included in Perl 5.9.3.
+.PP
+Several problems with wrapping and line length were fixed as recently as
+Pod::Text::Overstrike 2.04, included in Perl 5.11.5.
+.PP
+This module inherits its API and most behavior from Pod::Text, so the details
+in "COMPATIBILITY" in Pod::Text also apply. Pod::Text and Pod::Text::Overstrike
+have had the same module version since 4.00, included in Perl 5.23.7. (They
+unfortunately diverge in confusing ways prior to that.)
+.SH AUTHOR
+.IX Header "AUTHOR"
+Originally written by Joe Smith <Joe.Smith@inwap.com>, using the framework
+created by Russ Allbery <rra@cpan.org>. Subsequently updated by Russ Allbery.
+.SH "COPYRIGHT AND LICENSE"
+.IX Header "COPYRIGHT AND LICENSE"
+Copyright 2000 by Joe Smith <Joe.Smith@inwap.com>
+.PP
+Copyright 2001, 2004, 2008, 2014, 2018\-2019, 2022 by Russ Allbery <rra@cpan.org>
+.PP
+This program is free software; you may redistribute it and/or modify it
+under the same terms as Perl itself.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+Pod::Text, Pod::Simple
+.PP
+The current version of this module is always available from its web site at
+<https://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
+Perl core distribution as of 5.6.0.