¿Qué es el formato de archivo POD?
Un archivo .pod es un archivo de documentación para el lenguaje de programación Perl. Los archivos POD utilizan una sintaxis de marcado especial para una mejor legibilidad y funcionalidad. La sintaxis es muy básica y está altamente estandarizada: no hay opción para cambiar el tamaño o color de la fuente, añadir imágenes o tablas. Esto permite que los archivos .pod se conviertan fácilmente a otros formatos como HTML, TeX, Markdown y XML. Los archivos .pod se pueden leer de forma interactiva con la herramienta perldoc.
*Plain Old Documentation* es un lenguaje de marcado muy conveniente, adecuado para crear archivos de documentación de software claros y sucintos. La mayor parte de la documentación para los módulos y distribuciones de Perl publicados en CPAN está escrita en este formato.
Además de aparecer como archivos .pod independientes, la documentación POD puede incrustarse directamente dentro de los archivos fuente .pl y .pm entre las líneas de marcado =pod y =cut; el intérprete de Perl simplemente ignora esas secciones durante la compilación. POD define tres tipos de párrafos: párrafos de comando que comienzan con = (como =head1, =over, =item, =back, =cut), párrafos literales (con sangría de espacios en blanco) y párrafos de texto ordinario con códigos de formato en línea como B<>, I<>, C<> y L<>. La codificación de caracteres se declara con =encoding utf-8.
Los documentos POD se pueden convertir fácilmente en manuales de ayuda del sistema (páginas man) usando pod2man, en HTML con pod2html o en texto plano con pod2text.
Seguridad y protección
RIESGO: LOWUn archivo POD de Perl auténtico es texto plano sin código ejecutable, por lo que es seguro abrirlo en cualquier editor. Dos advertencias: (1) si un .pod es en realidad un archivo de juego de Terminal Reality, es binario; no intente «arreglarlo» como texto, ábralo con un extractor específico para juegos. (2) El POD incrustado vive dentro del código fuente Perl .pl/.pm; la documentación es inerte, pero el código Perl circundante es un programa; ejecute solo scripts en los que confíe.
Detalles del formato
en pocas palabras- Archivo de juego POD de Terminal Reality - Un archivo de activos de juego empaquetado (.pod) utilizado por títulos con el motor Terminal Reality (ej. BloodRayne, FaceOff); es un archivo binario, no documentación.
- Archivo multimedia de Podcast - Algunas aplicaciones/feeds etiquetan los episodios de audio descargados como .pod; en la práctica son audio MP3/AAC, no un formato distinto.
- VMware / virtualización y datos diversos - Algunas herramientas usan .pod para sus propios datos (ej. archivos de datos portátiles/empaquetados); no relacionado con la documentación de Perl.
Programas que abren archivos POD
Detalles técnicos
especificación profunda| Tipo de formato | Lenguaje de marcado ligero de texto plano |
| Tipos de párrafo | Comando (=head1, =over, =item, =cut), literal (líneas con sangría) y texto ordinario |
| Marcadores de comando | Líneas que comienzan con «=» en la columna 1: =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| Códigos de formato en línea | B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> para negrita, cursiva, código, enlaces, entidades, sin salto, entrada de índice y sin efecto |
| Declaración de codificación | =encoding seguido de un nombre de juego de caracteres IANA (ej. utf-8) colocado en el primer párrafo de comando |
| Tipo MIME | text/x-pod (primario); text/plain también aceptado |
| Incrustación en código fuente | Puede colocarse dentro de archivos .pl / .pm entre =pod y =cut; el compilador de Perl ignora esos bloques en tiempo de ejecución |
| Herramientas de conversión | pod2man (páginas man), pod2html (HTML), pod2text (texto plano), pod2latex (LaTeX); todas se distribuyen con Perl o están disponibles en CPAN |
| Visor interactivo | perldoc lee POD de módulos Perl instalados o archivos .pod independientes |
| Tamaño de archivo típico | 1 KB - 200 KB |
| Soporte de plataforma | Multiplataforma: dondequiera que se ejecute Perl (Linux, macOS, Windows, *BSD) |
| Identificación del archivo | Sin bytes mágicos binarios; identificado por párrafos de «=comando» (=head1, =pod, etc.) que comienzan en la columna 1 |
| Extensiones de fuente asociadas | .pl (scripts), .pm (módulos), .t (archivos de prueba) |
| Desarrollador | Larry Wall y el equipo principal de Perl (Perl Foundation) |
| Alcance de la documentación | Utilizado para documentación de módulos, descripciones de scripts, tutoriales y preguntas frecuentes en todo el ecosistema de Perl |
| Lanzado | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| Última versión | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| Estándar abierto | Sí · libre de regalías |
| Especificación | perldoc.perl.org |
Conversiones de POD
Preguntas y respuestas de la comunidad
preguntado por usuariosAún no hay preguntas; sea el primero en preguntar sobre los archivos POD.