++ed by:
SALVA MISHIN

2 PAUSE users
4 non-PAUSE users.

Enrique Nell
and 1 contributors

NAME

perldoc - Consultar la documentación de Perl en formato Pod.

SINOPSIS

    perldoc [-h] [-D] [-t] [-u] [-m] [-l] [-F]
        [-i] [-V] [-T] [-r]
        [-d archivo_destino]
        [-o nombreformato]
        [-M NombreClaseFormateador]
        [-w opciónformateador:valor]
        [-n sustituto-nroff]
        [-X]
        [-L código_idioma]
        NombrePágina|NombreMódulo|NombrePrograma|DirecciónURL

Ejemplos:

    perldoc -f I<función predefinida>

    perldoc -L it -f I<función predefinida>

    perldoc -q I<palabra clave de perlfaq>

    perldoc -L fr -q I<palabra clave de perlfaq>

    perldoc -v I<variable de Perl>

    perldoc -a I<API de Perl>

A continuación se muestra una descripción más detallada de los modificadores.

DESCRIPCIÓN

perldoc busca un elemento de documentación con formato .pod incluido en el árbol de instalación de perl o en un script perl, y ejecuta groff -man | $PAGER para mostrarlo (en HP-UX se usa además col -x). Este programa se usa principalmente para consultar la documentación de los módulos de biblioteca de perl.

Es posible que también estén instaladas en el sistema páginas de manual para esos módulos, en cuyo caso es probable que desee usar simplemente el comando man(1).

En la página perltoc encontrará una tabla de contenido de la documentación de los módulos de biblioteca de Perl.

OPCIONES

-h

Imprime en pantalla un breve mensaje de ayuda ("h" viene de la palabra inglesa help).

-D

Describe de manera detallada la búsqueda de un elemento.

-t

Muestra los documentos con un conversor de texto simple, en lugar de nroff. Puede que sea más rápido, pero es probable que el aspecto del resultado sea peor.

-u

Omite el formato pod real y solo muestra el código pod sin formato ("u" viene de la palabra inglesa Unformatted)

-m módulo

Muestra el módulo completo: tanto el código como la documentación pod sin formato. Esto puede resultar útil si en la documentación no se explica una función con el nivel de detalle necesario y desea inspeccionar el código directamente; perldoc buscará el archivo y se lo mostrará.

-l

Muestra sólo el nombre de archivo del módulo encontrado.

-F

Especifica que los argumentos son nombres de archivos; no se realizan búsquedas en directorios.

-f perlfunc

La opción -f seguida del nombre de una función predefinida de perl extrae de perlfunc la documentación de la función.

Ejemplo:

      perldoc -f sprintf
-q regexp-búsqueda-perlfaq

La opción -q consume una expresión regular como argumento. Busca en los encabezados de las preguntas ("q" viene de la palabra inglesa question) de perlfaq[1-9] e imprime en pantalla las entradas compatibles con la expresión regular.

Ejemplo:

     perldoc -q shuffle
-a perlapifunc

La opción -a seguida del nombre de una función de la API de perl extrae la documentación de esta función de perlapi.

Ejemplo:

     perldoc -a newHV
-v perlvar

La opción -v seguida del nombre de una variable predefinida de Perl extrae de perlvar la documentación de la variable.

Ejemplos:

     perldoc -v '$"'
     perldoc -v @+
     perldoc -v DATA
-T

Especifica que la salida no se enviará a un paginador; se enviará directamente a STDOUT.

-d archivo-destino

Especifica que la salida no se enviará a un paginador ni a STDOUT; se guardará en un archivo con el nombre especificado. Ejemplo: perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap

-o formato-salida

Especifica que perldoc debe intentar usar una clase de formato pod para el formato de salida indicado. Por ejemplo: -oman. En realidad es un encapsulador del modificador -M; si se usa -onombre_formato, solo busca una clase que se pueda cargar agregando ese nombre de formato (con distintas combinaciones de mayúsculas y minúsculas) al final de distintos prefijos de nombre de clase.

Por ejemplo, -oLaTeX prueba todas las clases siguientes: Pod::Perldoc::ToLaTeX Pod::Perldoc::Tolatex Pod::Perldoc::ToLatex Pod::Perldoc::ToLATEX Pod::Simple::LaTeX Pod::Simple::latex Pod::Simple::Latex Pod::Simple::LATEX Pod::LaTeX Pod::latex Pod::Latex Pod::LATEX.

-M nombre_módulo

Permite especificar el módulo que se desea usar para aplicar formato al código pod. La clase debe proporcionar al menos un método parse_from_file. Por ejemplo: perldoc -MPod::Perldoc::ToChecker.

Puede especificar varias clases separándolas con comas o signos de punto y coma (por ejemplo, -MTk::SuperPod;Tk::Pod).

-w opción:valor o -w opción

Permite especificar una opción con ("w" viene de la palabra inglesa with) la que desea llamar al formateador. Por ejemplo, -w textsize:15 llamará a $formatter->textsize(15) en el objeto formateador antes de que se use para aplicar formato al objeto. Para que esto funcione, la clase de formateador debe proporcionar este método y el valor pasado debe ser válido (si textsize espera un entero y se especifica -w textsize:big, lo más seguro es que se produzca un error).

Puede usar -w nombre_opción (sin un valor) como una forma abreviada de -w nombre_opción:TRUE. Esto puede ser útil para características que se activan o desactivan, como por ejemplo -w page_numbering.

Puede usar un signo "=" en lugar del signo ":"; por ejemplo, -w textsize=15. Esto puede resultar más (o menos) cómodo según la shell que se use.

-X

Usa un índice si existe. La opción -X busca en el archivo $Config{archlib}/pod.idx una entrada cuyo nombre base coincida con el nombre especificado en la línea de comandos. El archivo pod.idx debe contener nombres de archivo completos (uno por línea).

-L código_idioma

Este modificador permite especificar el código de idioma para obtener la traducción del documento en el idioma deseado. Si el paquete POD2::<código_idioma> no está instalado en el sistema, se ignorará el modificador. Todos los paquetes de traducción de la documentación se encuentran en el espacio de nombres POD2::. Si desea saber cómo puede crear nuevos paquetes de documentación localizados (POD2::*) e integrarlos en Pod::Perldoc, vea POD2::ES (o POD2::IT, POD2::FR).

NombrePágina|NombreMódulo|NombrePrograma|DirecciónURL

El elemento que desea buscar. Los módulos anidados, como File::Basename, se pueden especificar mediante File::Basename o File/Basename. También puede especificar un nombre descriptivo de una página, como perlfunc. Para direcciones URL, actualmente solo se admite HTTP y HTTPS.

En el caso de nombres sencillos, como 'foo', si la búsqueda normal no encuentra una página coincidente, se realiza también una búsqueda con el prefijo "perl". Por ejemplo, "perldoc intro" es suficiente para encontrar y mostrar "perlintro.pod".

-n algún_formateador

Especifique el sustituto de groff

-r

Búsqueda recursiva.

-i

No se distinguen mayúsculas de minúsculas.

-V

Muestra la versión de perldoc que se ejecuta actualmente.

SEGURIDAD

Como perldoc no usa comprobaciones de seguridad y se sabe que tiene vulnerabilidades, cuando se ejecuta como superusuario intentará ceder privilegios estableciendo los identificadores efectivo y real en la cuenta nobody o nouser, o en -2 si dichas cuentas no están disponibles. Si no puede renunciar a los privilegios, no se ejecutará.

ENTORNO

Se consumen todos los modificadores de la variable de entorno PERLDOC antes que los argumentos de línea de comandos.

Algunos valores útiles para PERLDOC son -oterm, -otext, -ortf, -oxml, etc., en función de los módulos disponibles; o bien, se puede especificar exactamente la clase de formateador con -MPod::Perldoc::ToTerm o similar.

perldoc también busca en los directorios especificados por las variables de entorno PERL5LIB (o PERLLIB si PERL5LIB no está definida) y PATH (esta última hace que esté disponible la documentación pod incluida en ejecutables, como perldoc).

En directorios en los que existen Makefile.PL o Build.PL, perldoc agregará . y lib al principio de la ruta de búsqueda. También agregará blib si su cuenta no es la del superusuario. Esto es muy útil cuando se trabaja en un directorio de compilación y se desea leer la documentación actual aunque esté instalada una versión anterior del módulo.

perldoc usará (por orden de preferencia) el paginador definido en PERLDOC_PAGER, MANPAGER o PAGER antes de intentar localizar un paginador (no se usará MANPAGER si se configuró perldoc para mostrar texto simple o texto sin formato).

Al ejecutar perldoc en modo -m (muestra el código fuente del módulo), intentará utilizar el paginador establecido en PERLDOC_SRC_PAGER. Una práctica opción de configuración para este comando permite especificar su editor favorito; por ejemplo, /usr/bin/nano. (Sobre gustos no hay nada escrito).

Un valor útil para PERLDOC_PAGER es less -+C -E.

Si se establece como valor de PERLDOCDEBUG un entero positivo, perldoc emitirá una salida aún más descriptiva que la que proporciona el modificador -D; cuanto mayor sea el número, más información emitirá.

CAMBIOS

Hasta la versión 3.14_05 se usaba el modificador -v para producir mensajes detallados del funcionamiento de perldoc; ahora esta opción se habilita mediante -D.

VEA TAMBIÉN

perlpod, Pod::Perldoc

AUTOR

Mantenedor actual: Mark Allen <mallen@cpan.org>

Anteriormente contribuyeron a este documento: brian d foy <bdfoy@cpan.org>, Adriano R. Ferreira <ferreira@cpan.org>, Sean M. Burke <sburke@cpan.org>, Kenneth Albanowski <kjahds@kjahds.com>, Andy Dougherty <doughera@lafcol.lafayette.edu> y muchos otros.

TRADUCTORES

  • Joaquín Ferrero (Tech Lead)

  • Enrique Nell (Language Lead)