O que é o formato de ficheiro POD?
Um arquivo .pod é um arquivo de documentação para a linguagem de programação Perl. Os arquivos POD usam uma sintaxe de marcação especial para melhor legibilidade e funcionalidade. A sintaxe é muito básica e altamente padronizada - não há opção para alterar o tamanho ou a cor da fonte, adicionar imagens ou tabelas. Isso permite que os arquivos .pod sejam facilmente convertidos para outros formatos, como HTML, TeX, Markdown e XML. Os arquivos .pod podem ser lidos interativamente com a ferramenta perldoc.
*Plain Old Documentation* é uma linguagem de marcação muito conveniente, adequada para criar arquivos de documentação de software claros e sucintos. A maior parte da documentação para módulos e distribuições Perl publicada no CPAN é escrita neste formato.
Além de aparecerem como arquivos .pod independentes, a documentação POD pode ser incorporada diretamente dentro de arquivos de código-fonte .pl e .pm entre as linhas de marcação =pod e =cut - o interpretador Perl simplesmente ignora essas seções durante a compilação. O POD define três tipos de parágrafos: parágrafos de comando começando com = (como =head1, =over, =item, =back, =cut), parágrafos literais (recuados com espaços em branco) e parágrafos de texto comuns com códigos de formatação inline como B<>, I<>, C<> e L<>. A codificação de caracteres é declarada com =encoding utf-8.
Documentos POD podem ser facilmente convertidos em manuais de ajuda do sistema (man pages) usando pod2man, em HTML com pod2html ou em texto simples com pod2text.
Segurança e proteção
RISCO: LOWUm arquivo Perl POD genuíno é texto simples sem código executável, portanto é seguro abri-lo em qualquer editor. Duas precauções: (1) se um .pod for na verdade um arquivo de jogo da Terminal Reality, ele é binário - não tente «consertá-lo» como texto; abra-o com um extrator específico para o jogo. (2) O POD incorporado reside dentro do código-fonte Perl .pl/.pm - a documentação é inerte, mas o código Perl ao redor é um programa; execute apenas scripts em que você confia.
Detalhes do formato
em resumo- Arquivo de jogo Terminal Reality POD - Um arquivo de ativos de jogo compactado (.pod) usado por títulos do motor Terminal Reality (ex: BloodRayne, FaceOff); um arquivo binário, não documentação.
- Arquivo de mídia de Podcast - Alguns aplicativos/feeds rotulam episódios de áudio baixados como .pod; na prática, são áudios MP3/AAC, não um formato distinto.
- VMware / virtualização e dados diversos - Algumas ferramentas usam .pod para seus próprios dados (ex: arquivos de dados portáteis/compactados); sem relação com a documentação Perl.
Programas que abrem arquivos POD
Detalhes técnicos
especificação profunda| Tipo de formato | Linguagem de marcação leve de texto simples |
| Tipos de parágrafo | Comando (=head1, =over, =item, =cut), literal (linhas recuadas) e texto comum |
| Marcadores de comando | Linhas começando com «=» na coluna 1 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Códigos de formatação inline | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> para negrito, itálico, código, links, entidades, sem quebra, entrada de índice e efeito zero |
| Declaração de codificação | =encoding seguido por um nome de charset IANA (ex: utf-8) colocado no primeiro parágrafo de comando |
| Tipo MIME | text/x-pod (primário); text/plain também aceito |
| Incorporação no código-fonte | Pode ser colocado dentro de arquivos .pl / .pm entre =pod e =cut; o compilador Perl ignora esses blocos em tempo de execução |
| Ferramentas de conversão | pod2man (man pages), pod2html (HTML), pod2text (texto simples), pod2latex (LaTeX) - todos acompanham o Perl ou estão disponíveis no CPAN |
| Visualizador interativo | perldoc lê POD de módulos Perl instalados ou arquivos .pod independentes |
| Tamanho típico do arquivo | 1 KB - 200 KB |
| Suporte de plataforma | Multiplataforma - onde quer que o Perl seja executado (Linux, macOS, Windows, *BSD) |
| Identificação do arquivo | Sem bytes mágicos binários; identificado por parágrafos de «=comando» (=head1, =pod, etc.) começando na coluna 1 |
| Extensões de código associadas | .pl (scripts), .pm (módulos), .t (arquivos de teste) |
| Desenvolvedor | Larry Wall e a equipe principal do Perl (Perl Foundation) |
| Escopo da documentação | Usado para documentação de módulos, descrições de scripts, tutoriais e FAQs em todo o ecossistema Perl |
| Lançado | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Versão mais recente | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Padrão aberto | Sim · livre de royalties |
| Especificação | perldoc.perl.org |
Conversões de POD
Perguntas e Respostas da Comunidade
perguntado por usuáriosAinda não há perguntas - seja o primeiro a perguntar sobre arquivos POD.