The Perl Toolchain Summit 2025 Needs You: You can help 馃檹 Learn more

 / 
POD2-ES-5.24.0.5
River stage zero No dependents
/ perldoc

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)