From fc22b3d6507c6745911b9dfcc68f1e665ae13dbc Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 15 Apr 2024 21:43:11 +0200 Subject: Adding upstream version 4.22.0. Signed-off-by: Daniel Baumann --- .../mageia-cauldron/man3pm/Pod::Simple::RTF.3pm | 188 +++++++++++++++++++++ 1 file changed, 188 insertions(+) create mode 100644 upstream/mageia-cauldron/man3pm/Pod::Simple::RTF.3pm (limited to 'upstream/mageia-cauldron/man3pm/Pod::Simple::RTF.3pm') diff --git a/upstream/mageia-cauldron/man3pm/Pod::Simple::RTF.3pm b/upstream/mageia-cauldron/man3pm/Pod::Simple::RTF.3pm new file mode 100644 index 00000000..6ca31b98 --- /dev/null +++ b/upstream/mageia-cauldron/man3pm/Pod::Simple::RTF.3pm @@ -0,0 +1,188 @@ +.\" -*- 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::Simple::RTF 3pm" +.TH Pod::Simple::RTF 3pm 2023-11-28 "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::Simple::RTF \-\- format Pod as RTF +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 3 +\& perl \-MPod::Simple::RTF \-e \e +\& "exit Pod::Simple::RTF\->filter(shift)\->any_errata_seen" \e +\& thingy.pod > thingy.rtf +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +This class is a formatter that takes Pod and renders it as RTF, good for +viewing/printing in MSWord, WordPad/write.exe, TextEdit, etc. +.PP +This is a subclass of Pod::Simple and inherits all its methods. +.SH "FORMAT CONTROL ATTRIBUTES" +.IX Header "FORMAT CONTROL ATTRIBUTES" +You can set these attributes on the parser object before you +call \f(CW\*(C`parse_file\*(C'\fR (or a similar method) on it: +.ie n .IP "$parser\->head1_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.el .IP "\f(CW$parser\fR\->head1_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.IX Item "$parser->head1_halfpoint_size( halfpoint_integer );" +.PD 0 +.ie n .IP "$parser\->head2_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.el .IP "\f(CW$parser\fR\->head2_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.IX Item "$parser->head2_halfpoint_size( halfpoint_integer );" +.ie n .IP "$parser\->head3_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.el .IP "\f(CW$parser\fR\->head3_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.IX Item "$parser->head3_halfpoint_size( halfpoint_integer );" +.ie n .IP "$parser\->head4_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.el .IP "\f(CW$parser\fR\->head4_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.IX Item "$parser->head4_halfpoint_size( halfpoint_integer );" +.PD +These methods set the size (in half-points, like 52 for 26\-point) +that these heading levels will appear as. +.ie n .IP "$parser\->codeblock_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.el .IP "\f(CW$parser\fR\->codeblock_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.IX Item "$parser->codeblock_halfpoint_size( halfpoint_integer );" +This method sets the size (in half-points, like 21 for 10.5\-point) +that codeblocks ("verbatim sections") will appear as. +.ie n .IP "$parser\->header_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.el .IP "\f(CW$parser\fR\->header_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.IX Item "$parser->header_halfpoint_size( halfpoint_integer );" +This method sets the size (in half-points, like 15 for 7.5\-point) +that the header on each page will appear in. The header +is usually just "\fImodulename\fR p. \fIpagenumber\fR". +.ie n .IP "$parser\->normal_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.el .IP "\f(CW$parser\fR\->normal_halfpoint_size( \fIhalfpoint_integer\fR );" 4 +.IX Item "$parser->normal_halfpoint_size( halfpoint_integer );" +This method sets the size (in half-points, like 26 for 13\-point) +that normal paragraphic text will appear in. +.ie n .IP "$parser\->no_proofing_exemptions( \fItrue_or_false\fR );" 4 +.el .IP "\f(CW$parser\fR\->no_proofing_exemptions( \fItrue_or_false\fR );" 4 +.IX Item "$parser->no_proofing_exemptions( true_or_false );" +Set this value to true if you don't want the formatter to try +putting a hidden code on all Perl symbols (as best as it can +notice them) that labels them as being not in English, and +so not worth spellchecking. +.ie n .IP "$parser\->doc_lang( \fImicrosoft_decimal_language_code\fR )" 4 +.el .IP "\f(CW$parser\fR\->doc_lang( \fImicrosoft_decimal_language_code\fR )" 4 +.IX Item "$parser->doc_lang( microsoft_decimal_language_code )" +This sets the language code to tag this document as being in. By +default, it is currently the value of the environment variable +\&\f(CW\*(C`RTFDEFLANG\*(C'\fR, or if that's not set, then the value +1033 (for US English). +.Sp +Setting this appropriately is useful if you want to use the RTF +to spellcheck, and/or if you want it to hyphenate right. +.Sp +Here are some notable values: +.Sp +.Vb 12 +\& 1033 US English +\& 2057 UK English +\& 3081 Australia English +\& 4105 Canada English +\& 1034 Spain Spanish +\& 2058 Mexico Spanish +\& 1031 Germany German +\& 1036 France French +\& 3084 Canada French +\& 1035 Finnish +\& 1044 Norwegian (Bokmal) +\& 2068 Norwegian (Nynorsk) +.Ve +.PP +If you are particularly interested in customizing this module's output +even more, see the source and/or write to me. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +Pod::Simple, RTF::Writer, RTF::Cookbook, RTF::Document, +RTF::Generator +.SH SUPPORT +.IX Header "SUPPORT" +Questions or discussion about POD and Pod::Simple should be sent to the +pod\-people@perl.org mail list. Send an empty email to +pod\-people\-subscribe@perl.org to subscribe. +.PP +This module is managed in an open GitHub repository, +. Feel free to fork and contribute, or +to clone and send patches! +.PP +Patches against Pod::Simple are welcome. Please send bug reports to +. +.SH "COPYRIGHT AND DISCLAIMERS" +.IX Header "COPYRIGHT AND DISCLAIMERS" +Copyright (c) 2002 Sean M. Burke. +.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" +Pod::Simple was created by Sean M. Burke . +But don't bother him, he's retired. +.PP +Pod::Simple is maintained by: +.IP \(bu 4 +Allison Randal \f(CW\*(C`allison@perl.org\*(C'\fR +.IP \(bu 4 +Hans Dieter Pearcey \f(CW\*(C`hdp@cpan.org\*(C'\fR +.IP \(bu 4 +David E. Wheeler \f(CW\*(C`dwheeler@cpan.org\*(C'\fR -- cgit v1.2.3