Pod::Text(3pm)

💖 NAME 💖

okay so bestie, we're looking at the manual page for Pod::Text(3pm) and the star of the show is Tk::Pod::Text — a Pod browser widget, no cap 🎀

---

✨ SYNOPSIS ✨

    use Tk::Pod::Text;

    $pod = $parent->Scrolled("PodText",
                             -file       => $file,
                             -scrollbars => "osoe",
                            );

    $file = $pod->cget('-path');   # ?? the name path is confusing :-(

yes the comment about -path being confusing is in the original and honestly? valid 😭 we're keeping it, character for character, periodt.

---

🦋 DESCRIPTION 🦋

Tk::Pod::Text is a readonly text widget. It displays Pod documentation. That's it, that's the vibe. It's giving "I show docs, I don't let you touch them" 💅

---

🌸 OPTIONS 🌸

• -file — the named (pod) file that's gonna get displayed. your main character file 📄
• -path — returns the expanded path of the Pod that's currently showing. you can ONLY use this with the "cget" method, bestie, don't try anything else. ✨
• -poddone — a callback that gets called once parsing and displaying of the Pod is done. your lil "we're finished!!" alarm 🎉
• -wrap — sets the wrap mode. the default is "word".
• -scrollbars — where the scrollbars live. see also Tk::Scrolled. by default the vertical scrollbar is on the right on Windows systems and on the left on X11 systems. lowkey chaotic of them but okay 💀

heads up: it is not necessary and usually will do the wrong thing if you put a Tk::Pod::Text widget into a Scrolled component. so like... don't 🙈

Other options are propagated to the embedded Tk::More widget. they just get passed along, slay 🫶

---

🌈 ENVIRONMENT 🌈

• TKPODDEBUG — turn debugging mode on if it's set to a true value. 🐛
• TKPODPRINT — use the specified program for printing the current pod. if the string contains a %s, then filename substitution is used; otherwise the filename of the Pod document is just appended to the value of "TKPODPRINT". here's a silly lil example to send the Pod to a web browser:

    env TKPODPRINT="pod2html %s > %s.html; galeon %s.html" tkpod ...

• TKPODEDITOR — use the specified program for editing the current pod. if "TKPODEDITOR" is not specified then the first defined value of "XEDITOR", "VISUAL", or "EDITOR" is used on Unix. as a last fallback, "ptked" or "vi" are used, depending on platform and existance of a terminal. (yes, "existance" — we're quoting the original, don't come for me 😭)
• TKPODMANVIEWER — use the specified program as the manpage viewer. the manpage viewer should accept a manpage URL ("man://"manpage(section)). alternatively the special viewer "internal" may be used. as fallback, the default GNOME and/or KDE manpage viewer will be called. iconic behavior honestly 👑

---

👑 SEE ALSO 👑

Tk::More Tk::Pod Tk::Pod::SimpleBridge Tk::Pod::Styles Tk::Pod::Search Tk::Pod::Search_db perlpod tkpod perlindex

---

💀 KNOWN BUGS 💀

See TODO file of Tk-Pod distribution. (it's giving "we know, we know, it's on the list" 💅)

---

🧚 POD TO VERIFY PodText WIDGET 🧚

For PodText see Tk::Pod::Text.

A "fixed width" font.

Text in slant italics.

A <=for> paragraph is hidden between here

and there.

A file: /usr/local/bin/perl. A variable $a without markup.

boofar is in S<>.

Indexed items are not supported in Tk::Pod.

Zero-effect formatting.

German umlauts:

auml: ä ä, Auml: Ä Ä, ouml: ö ö, Ouml: Ö Ö, Uuml: ü ü, Uuml: Ü Ü, sz: ß ß.

Unicode outside Latin1 range: € (euro sign).

Pod with umlaut: ExtUtils::MakeMaker.

Details: perlpod or perl, perlfunc.

External links: <http://www.cpan.org> (URL), URL with link text <http://www.cpan.org>, perl (man page), Berliner Fernsehturm <geo:52.520685,13.409461> (geo: URL)

Links to local sections: a section (SYNOPSIS), an item (-file, currently wrong), a working item (auml).

Links to external sections: a section (DESCRIPTION in perl.pod), an item (Uncuddled elses in perlstyle.pod).

Here some code in a as is paragraph

    use Tk;
    my $mw = MainWindow->new;
    ...
    MainLoop
    __END__

Fonts: "fixed", bold, italics, normal, or file /path/to/a/file

Mixed Fonts: "bold-fixed", bold-italics

Non-breakable text: The quick brown fox jumps over the lazy fox.

Modern Pod constructs (multiple <>): italic, "fixed with embedded < and >".

Itemize with numbers:

1. First
2. Second
3. Thirs

Itemize with bullets:

• First
• Second
• Thirs

---

⭐ TESTING HEAD1 ⭐

🌟 TESTING HEAD2 🌟

💜 TESTING HEAD3 💜

🎀 TESTING HEAD4 🎀

Other Pod docu: Tk::Font, Tk::BrowseEntry (not underlined, but double-clickable in Tk::Pod)

---

🫶 AUTHOR 🫶

Nick Ing-Simmons <nick@ni-s.u-net.com>

Current maintainer is Slaven Rezić <slaven@rezic.de>.

Copyright (c) 1998 Nick Ing-Simmons. Copyright (c) 2015 Slaven Rezic. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

and that's the whole thing bestie!! this page came to you via perl v5.34.0, dated 2022-06-28, and it IS Pod::Text(3pm) 💖✨ go forth and browse some Pod, you absolute legend 🦋👑