Wat is het POD-bestandsformaat?
Een .pod-bestand is een documentatiebestand voor de programmeertaal Perl. POD-bestanden gebruiken een speciale markup-syntaxis voor een betere leesbaarheid en functionaliteit. De syntaxis is zeer eenvoudig en sterk gestandaardiseerd - er is geen optie om de lettergrootte of kleur te wijzigen, afbeeldingen toe te voegen of tabellen te maken. Hierdoor kunnen .pod-bestanden eenvoudig worden geconverteerd naar andere formaten zoals HTML, TeX, Markdown en XML. .pod-bestanden kunnen interactief worden gelezen met de perldoc-tool.
*Plain Old Documentation* is een zeer handige markup-taal die geschikt is voor het maken van duidelijke en beknopte softwaredocumentatiebestanden. De meeste documentatie voor Perl-modules en distributies die op CPAN worden gepubliceerd, is in dit formaat geschreven.
Naast het verschijnen als zelfstandige .pod-bestanden, kan POD-documentatie rechtstreeks worden ingebed in .pl- en .pm-bronbestanden tussen =pod- en =cut-markeringsregels - de Perl-interpreter negeert die secties simpelweg tijdens de compilatie. POD definieert drie alineatypen: commando-alinea's die beginnen met = (zoals =head1, =over, =item, =back, =cut), verbatim-alinea's (ingesprongen met witruimte) en gewone tekstalinea's met inline opmaakcodes zoals B<>, I<>, C<> en L<>. De tekencodering wordt gedeclareerd met =encoding utf-8.
POD-documenten kunnen eenvoudig worden geconverteerd naar systeemhandleidingen (man-pagina's) met pod2man, naar HTML met pod2html, of naar platte tekst met pod2text.
Beveiliging & veiligheid
RISICO: LOWEen echt Perl POD-bestand is platte tekst zonder uitvoerbare code, dus het is veilig om in elke editor te openen. Twee waarschuwingen: (1) als een .pod eigenlijk een Terminal Reality game-archief is, is het binair - probeer het niet als tekst te „repareren”; open het met een gamespecifieke extractor. (2) Ingebedde POD bevindt zich in .pl/.pm Perl-broncode - de documentatie is inert, maar de omringende Perl-code is een programma; voer alleen scripts uit die u vertrouwt.
Formaatdetails
in een notendop- Terminal Reality POD game-archief - Een verpakt game-asset-archief (.pod) gebruikt door titels met de Terminal Reality-engine (bijv. BloodRayne, FaceOff); een binair archief, geen documentatie.
- Podcast-mediabestand - Sommige apps/feeds labelen gedownloade audio-afleveringen als .pod; in de praktijk zijn dit MP3/AAC-audiobestanden, geen apart formaat.
- VMware / virtualisatie & diverse gegevens - Enkele tools gebruiken .pod voor hun eigen gegevens (bijv. draagbare/verpakte gegevensbestanden); niet gerelateerd aan Perl-documentatie.
Programma's die POD-bestanden openen
Technische details
diepe specificaties| Formaattype | Platte-tekst lichtgewicht markup-taal |
| Alineatypen | Commando (=head1, =over, =item, =cut), verbatim (ingesprongen regels) en gewone tekst |
| Commando-markeringen | Regels die beginnen met „=” in kolom 1 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Inline opmaakcodes | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> voor vet, cursief, code, links, entiteiten, harde spatie, index-item en nul-effect |
| Codering-declaratie | =encoding gevolgd door een IANA-charsetnaam (bijv. utf-8) geplaatst in de eerste commando-alinea |
| MIME-type | text/x-pod (primair); text/plain wordt ook geaccepteerd |
| Inbedding in broncode | Kan in .pl / .pm bestanden worden geplaatst tussen =pod en =cut; de Perl-compiler negeert deze blokken tijdens runtime |
| Conversie-tools | pod2man (man-pagina's), pod2html (HTML), pod2text (platte tekst), pod2latex (LaTeX) - worden allemaal geleverd bij Perl of zijn beschikbaar op CPAN |
| Interactieve viewer | perldoc leest POD uit geïnstalleerde Perl-modules of zelfstandige .pod-bestanden |
| Typische bestandsgrootte | 1 KB - 200 KB |
| Platformondersteuning | Cross-platform - overal waar Perl draait (Linux, macOS, Windows, *BSD) |
| Bestandsidentificatie | Geen binaire magic bytes; geïdentificeerd door „=command”-alinea's (=head1, =pod, etc.) die beginnen in kolom 1 |
| Bijbehorende bronextensies | .pl (scripts), .pm (modules), .t (testbestanden) |
| Ontwikkelaar | Larry Wall en het Perl-kernteam (Perl Foundation) |
| Documentatiebereik | Gebruikt voor module-documentatie, scriptbeschrijvingen, tutorials en FAQ's binnen het Perl-ecosysteem |
| Uitgebracht | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Laatste versie | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Open standaard | Ja · royaltyvrij |
| Specificatie | perldoc.perl.org |
POD conversies
Community V&A
gevraagd door gebruikersNog geen vragen - wees de eerste om iets te vragen over POD-bestanden.