Vad är filformatet POD?
En .pod-fil är en dokumentationsfil för programmeringsspråket Perl. POD-filer använder en speciell markeringssyntax för bättre läsbarhet och funktionalitet. Syntaxen är mycket grundläggande och högt standardiserad - det finns inget alternativ för att ändra typsnitt eller färg, lägga till bilder eller tabeller. Detta gör att .pod-filer enkelt kan konverteras till andra format som HTML, TeX, Markdown och XML. .pod-filer kan läsas interaktivt med verktyget perldoc.
*Plain Old Documentation* är ett mycket praktiskt markeringsspråk som lämpar sig för att skapa tydliga och kortfattade dokumentationsfiler för programvara. Den mesta dokumentationen för Perl-moduler och distributioner som publiceras på CPAN är skriven i detta format.
Förutom att förekomma som fristående .pod-filer kan POD-dokumentation bäddas in direkt i källkodsfiler för .pl och .pm mellan markeringsraderna =pod och =cut - Perl-tolken ignorerar helt enkelt dessa avsnitt under kompilering. POD definierar tre styckestyper: kommandostycken som börjar med = (såsom =head1, =over, =item, =back, =cut), ordagranna stycken (indragna med blanksteg) och vanliga textstycken med inbäddade formateringskoder som B<>, I<>, C<> och L<>. Teckenkodning deklareras med =encoding utf-8.
POD-dokument kan enkelt konverteras till systemmanualer (man-sidor) med pod2man, till HTML med pod2html eller till vanlig text med pod2text.
Säkerhet & trygghet
RISK: LOWEn äkta Perl POD-fil är vanlig text utan exekverbar kod, så den är säker att öppna i valfri redigerare. Två varningar: (1) om en .pod faktiskt är ett Terminal Reality-spelarkiv är den binär - försök inte „laga” den som text; öppna den med en spelspecifik extraherare. (2) Inbäddad POD finns inuti .pl/.pm Perl-källkod - dokumentationen är inaktiv, men den omgivande Perl-koden är ett program; kör endast skript du litar på.
Formatdetaljer
i ett nötskal- Terminal Reality POD spelarkiv - Ett packat arkiv för speltillgångar (.pod) som används av titlar med Terminal Reality-motorn (t.ex. BloodRayne, FaceOff); ett binärt arkiv, inte dokumentation.
- Podcast-mediefil - Vissa appar/flöden märker nedladdade ljudavsnitt med .pod; i praktiken är dessa MP3/AAC-ljud, inte ett separat format.
- VMware / virtualisering & diverse data - Ett fåtal verktyg använder .pod för sin egen data (t.ex. portabla/packade datafiler); orelaterat till Perl-dokumentation.
Program som öppnar POD-filer
Windows3 apps
Notepad
Öppen källkod Öppna .pod för att läsa/redigera råmarkeringen; installera ett POD/perldoc-tillägg eller använd Perls verktygskedja för att rendera den. 
Strawberry Perl (perldoc / pod2html)
Öppen källkod Kör „perldoc file.pod” för att läsa den formaterad, eller „pod2html file.pod > file.html” för att rendera till en webbsida. 
Visual Studio Code
Gratis Öppna .pod som text; ett Perl-tillägg lägger till syntaxmarkering och förhandsgranskning för POD. 
macOS2 apps
perldoc (built-in Perl)
Öppen källkod macOS levereras med Perl: „perldoc file.pod” renderar den; „pod2html”/„pod2man” konverterar den. 
Linux2 apps
perldoc / pod2man / pod2html
Öppen källkod „perldoc file.pod” för att läsa; „pod2man file.pod | man -l -” för en man-sida; „pod2html” för HTML.
gedit / any text editor
Öppen källkod Öppna .pod som vanlig text för att visa eller redigera den råa POD-markeringen. Tekniska detaljer
djup specifikation| Formattyp | Textbaserat lättviktigt markeringsspråk |
| Styckestyper | Kommando (=head1, =over, =item, =cut), ordagrant (indragna rader) och vanlig text |
| Kommandomarkörer | Rader som börjar med „=” i kolumn 1 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Inbäddade formateringskoder | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> för fetstil, kursiv, kod, länkar, entiteter, radbrytningsförbud, indexpost och nolleffekt |
| Deklaration av kodning | =encoding följt av ett IANA-teckenuppsättningsnamn (t.ex. utf-8) placerat i det första kommandostycket |
| MIME-typ | text/x-pod (primär); text/plain accepteras också |
| Inbäddning i källkod | Kan placeras inuti .pl / .pm-filer mellan =pod och =cut; Perl-kompilatorn ignorerar dessa block vid körning |
| Konverteringsverktyg | pod2man (man-sidor), pod2html (HTML), pod2text (vanlig text), pod2latex (LaTeX) - alla levereras med Perl eller finns på CPAN |
| Interaktiv visare | perldoc läser POD från installerade Perl-moduler eller fristående .pod-filer |
| Typisk filstorlek | 1 KB - 200 KB |
| Plattformssupport | Plattformsoberoende - överallt där Perl körs (Linux, macOS, Windows, *BSD) |
| Filidentifiering | Inga binära magic bytes; identifieras av „=command”-stycken (=head1, =pod, etc.) som börjar i kolumn 1 |
| Associerade källkodsändelser | .pl (skript), .pm (moduler), .t (testfiler) |
| Utvecklare | Larry Wall och Perls kärnteam (Perl Foundation) |
| Dokumentationsomfång | Används för modulbeskrivningar, skriptbeskrivningar, handledningar och FAQ:er i hela Perls ekosystem |
| Släppt | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Senaste version | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Öppen standard | Ja · royaltyfri |
| Specifikation | perldoc.perl.org |
POD-konverteringar
Frågor & svar
frågat av användareInga frågor än - bli den första att fråga om POD-filer.
