POD2THREAD(1p)

📦 version 3.01, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 pod2thread — the manual, but make it make sense 💖

okay bestie, so this is pod2thread(1p), living under the User Contributed Perl Documentation umbrella (iykyk, that's the fancy corner of the man pages where the cool Perl kids hang out). Let's get into it 🫶

✨ NAME ✨

pod2thread — literally converts POD data into the HTML macro language called thread. that's the whole job. slay 💅

🌸 SYNOPSIS 🌸

pod2thread [-chn] [-s style] [-t title]
    [input [output]]

look at her. small. efficient. main character energy ✨

🦋 DESCRIPTION 🦋

so pod2thread is a front-end for Pod::Thread. she doesn't do the heavy lifting herself — nope — she hands your stuff off to that module, and that module generates thread source from POD source. teamwork, periodt 🎀

input is the file she reads for POD source. and no, the POD doesn't have to be alone — it can be embedded in code, she'll find it 💜

if input isn't given, it defaults to STDIN. classic.

output, if you give it, is the file where the thread output gets written. if output isn't given, the output goes to STDOUT. simple as that 🍓

💅 OPTIONS 💅

  • -c, --contents — generate a table of contents as the first section of the resulting thread file, with links to each top-level heading. cute little map at the top, obsessed 🗺️
  • -n, --navbar — generate a navigation bar at the top of the resulting thread file, with links to each top-level heading. also links, also top-of-page, just a different vibe ✨
  • -h, --help — print out usage information and exit. the "help me bestie" button 🫶
  • -s style, --style=style — in the generated thread source, include a reference to the style sheet style. and listen: if you don't pass this option, **no style sheet reference will be included. none. zero. so if you want the glow-up, you gotta ask for it 💖
  • *-t *title, --title=title — use title as the title of the page instead of looking for a NAME section in the POD document. so she doesn't have to go hunting for your name, you just hand it over. iconic 👑

😭 DIAGNOSTICS 😭

if pod2thread fails with errors, go check out Pod::Thread and Pod::Simple for info about what those errors might mean. she's not gatekeeping, she's just forwarding you to the right group chat 💀

internally, she can also produce this one diagnostic:

Unknown option: %s

(F) An unknown command line option was given.

and on top of that, other Getopt::Long error messages may show up from invalid command-line options. so if it's yelling and it's not on this list, that's probably where it came from 🙈

💜 AUTHOR 💜

Russ Allbery <rra@cpan.org>

Copyright 2002, 2013, 2021 Russ Allbery <rra@cpan.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

okay that whole block is the legal bit and you should not skip it — it's giving "read the terms", and fr fr it matters 💀

🌈 SEE ALSO 🌈

Pod::Simple, Pod::Thread

this program is part of the Pod-Thread distribution. the current version of Pod-Thread is available from CPAN, or directly from its web site at <https://www.eyrie.org/~eagle/software/pod-thread/>. go get her ⭐

and that's the whole page, bestie 💖 this one came from perl v5.32.1, dated 2021-12-26, filed under POD2THREAD(1p). mwah, go convert some POD 🌸🧚‍♀️

📦 where this page comes from