POM2(1p)

πŸ“¦
version 2.01 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’… POM2 β€” the pod glow-up machine πŸ’…

okay bestie, welcome to pom2, which lives in section 1p of the manual (Perl, user-contributed, iconic behaviour). This is the little script that takes a POD document and turns it into Text, HTML, back-into-Pod, or literally any other format you have a view module for, using Pod::POM. no cap. πŸ¦‹


✨ SYNOPSIS ✨

like, just tell it a format and a file:

pom2 text MyFile.pm > MyFile.txt
pom2 html MyFile.pm > MyFile.html
pom2 pod  MyFile.pm > Myfile.pod

pom2 format [options] MyFile.pm > Myfile.xyz

see how the last one is the general shape? format is the vibe you want, then [options], then your file. πŸŽ€


🌸 DESCRIPTION 🌸

This script uses Pod::POM to convert a Pod document into text, HTML, back into Pod (yes, back into Pod β€” that's the move when you wanna normalise a document and fix any markup errors 🩹), or any other format for which you have a view module. it's giving versatility. ✨

If the viewer is not one of the viewers bundled with Pod::POM, the script goes looking for an installed Pod::POM::View module that matches the format you asked for. so like, if you have Pod::POM::View::DocBook installed, then bestie you can literally say:

pod2 docbook MyFile.pm > MyFile.xml

and it'll just work. πŸ‘‘

Now here's the tea β˜•: if you pass any options other than --help, they get passed straight to the constructor method of the view class. for example:

pod2 docbook --root=chapter --titlecasing MyFile.pm > MyFile.xml

would convert the Pod document to a DocBook chapter document, with the titlecasing option switched on. πŸŽ€

🚨 heads up: any string prefixed by "--" is taken as a valid option and passed to the constructor. and if you don't give it a value? it passes in a value of 1. that's it. that's the rule. iykyk.

🫢 AUTHOR 🫢

  • Andy Wardley <abw@kfs.org>
  • extended by Andrew Ford <A.Ford@ford-mason.co.uk>

⭐ VERSION ⭐

This is version 0.3 of pom2. periodt. πŸ’…


Copyright (C) 2000, 2001 Andy Wardley. All Rights Reserved.

Copyright (C) 2009 Andrew Ford. All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. slay. 🌈


πŸ‘‘ SEE ALSO πŸ‘‘

For further information please see Pod::POM. go read it bestie, it's iconic. πŸ’–


and that's the whole page, mwah πŸ’‹ β€” brought to you by perl v5.36.0, dated 2022-11-20, filed under POM2(1p). drink water, back up your files, and go convert some Pod. πŸ§šπŸ’œ

πŸ“¦ where this page comes from