perldoc - Online sa Cloud

PROGRAMA:

NAME

perldoc - Hanapin ang Perl na dokumentasyon sa Pod na format.

SINOPSIS

perldoc [-h] [-D] [-t] [-u] [-m] [-l] [-F]
[-i] [-V] [-T] [-r]
[-d destination_file]
[-o formatname]
[-M FormatterClassName]
[-w formatteroption:value]
[-n nroff-kapalit]
[-X]
[-L language_code]
PageName|ModuleName|ProgramName|URL

Halimbawa:

perldoc -f BuiltinFunction

perldoc -L ito -f BuiltinFunction

perldoc -q FAQ Keyword

perldoc -L fr -q FAQ Keyword

perldoc -v PerlVariable

perldoc -a PerlAPI

Tingnan sa ibaba para sa higit pang paglalarawan ng mga switch.

DESCRIPTION

perldoc naghahanap ng isang piraso ng dokumentasyon sa .pod na format na naka-embed sa perl
installation tree o sa isang perl script, at ipinapakita ito sa pamamagitan ng "groff -man | $PAGER". (Sa
karagdagan, kung tumatakbo sa ilalim ng HP-UX, "col -x" ang gagamitin.) Pangunahing ginagamit ito para sa
dokumentasyon para sa perl library modules.

Maaaring mayroon ding mga man page na naka-install ang iyong system para sa mga module na iyon, kung saan maaari mo
malamang gamitin lang ang lalaki(1) utos.

Kung naghahanap ka ng talaan ng mga nilalaman sa dokumentasyon ng Perl library modules, tingnan
ang perltoc page.

Opsyon

-h Nagpi-print ng brief hmensahe ng elp.

-D Dinilalarawan ang paghahanap para sa item sa detail.

-t Ipakita ang mga doc gamit ang plain text converter, sa halip na nroff. Ito ay maaaring mas mabilis, ngunit ito
malamang hindi magiging maganda.

-u Laktawan ang totoong Pod formatting, at ipakita lang ang raw Pod source (Unformatted)

-m module
Ipakita ang buong module: parehong code at hindi na-format na dokumentasyon ng pod. Ito ay maaaring
kapaki-pakinabang kung ang mga doc ay hindi nagpapaliwanag ng isang function sa detalyeng kailangan mo, at gusto mo
direktang suriin ang code; Hahanapin ng perldoc ang file para sa iyo at ibigay lang ito
para ipakita.

-l Ipakita saly ang pangalan ng file ng module na natagpuan.

-F Isaalang-alang ang mga argumento bilang mga pangalan ng file; walang gagawing paghahanap sa mga direktoryo.

-f perlfunc
Ang -f opsyon na sinusundan ng pangalan ng isang perl built-in na function ay kukuha ng
dokumentasyon ng function na ito mula sa perlfunc.

Halimbawa:

perldoc -f sprintf

-q perlfaq-search-regexp
Ang -q ang pagpipilian ay tumatagal ng isang regular na expression bilang isang argumento. Hahanapin nito ang qusyon
heading sa perlfaq[1-9] at i-print ang mga entry na tumutugma sa regular na expression.

Halimbawa:

perldoc -q shuffle

-a perlapifunc
Ang -a opsyon na sinusundan ng pangalan ng isang perl api function ay kukuha ng
dokumentasyon ng function na ito mula sa perlapi.

Halimbawa:

perldoc -isang bagongHV

-v perlvar
Ang -v opsyon na sinusundan ng pangalan ng isang Perl predefined variable ay kukuha ng
dokumentasyon ng variable na ito mula sa perlvar.

Halimbawa:

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

-T Tinutukoy nito na ang output ay hindi ipapadala sa isang pager, ngunit ipapadala
direkta sa STDOUT.

-d destination-filename
Tinutukoy nito na ang output ay hindi ipapadala sa isang pager o sa STDOUT, ngunit ito ay
upang mai-save sa tinukoy na filename. Halimbawa: "perldoc -oLaTeX -dtextwrapdocs.tex
Text::I-wrap"

-o output-formatname
Tinutukoy nito na gusto mong subukan ni Perldoc ang paggamit ng klase ng Pod-formatting para sa
format ng output na iyong tinukoy. Halimbawa: "-oman". Ito ay talagang isang
wrapper sa paligid ng "-M" switch; gamit ang "-oformatname" naghahanap lang ng loadable class
sa pamamagitan ng pagdaragdag ng pangalan ng format na iyon (na may iba't ibang capitalization) sa dulo ng iba
mga prefix ng classname.

Halimbawa, kasalukuyang sinusubukan ng "-oLaTeX" ang lahat ng sumusunod na klase:
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 pangalan ng module
Tinutukoy nito ang module na gusto mong subukang gamitin para sa pag-format ng pod. Ang
class ay dapat magbigay ng hindi bababa sa isang "parse_from_file" na paraan. Halimbawa: "perldoc
-MPod::Perldoc::ToChecker".

Maaari mong tukuyin ang ilang mga klase upang subukan sa pamamagitan ng pagsali sa kanila ng mga kuwit o semicolon, bilang
sa "-MTk::SuperPod;Tk::Pod".

-w pagpipilian: halaga or -w opsyon
Tinutukoy nito ang isang opsyon para tawagan ang formatter with. Halimbawa, "-w ​​textsize:15"
tatawagin ang "$formatter->laki ng teksto(15)" sa object ng formatter bago ito nakasanayan
i-format ang bagay. Upang ito ay maging wasto, ang klase ng formatter ay dapat magbigay ng ganoong a
paraan, at ang halaga na iyong ipinasa ay dapat na wasto. (Kaya kung inaasahan ng "textsize" ang isang
integer, at gagawin mo ang "-w textsize:big", asahan ang problema.)

Maaari mong gamitin ang "-w optionname" (nang walang value) bilang shorthand para sa "-w optionname:TOTOO".
Ito ay malamang na kapaki-pakinabang sa mga kaso ng on/off na mga feature tulad ng: "-w page_numbering".

Maaari kang gumamit ng "=" sa halip na ":", gaya ng: "-w textsize=15". Ito ay maaaring higit pa
(o mas mababa) maginhawa, depende sa kung anong shell ang iyong ginagamit.

-X Gumamit ng index kung ito ay naroroon. Ang -X ang opsyon ay naghahanap ng entry na ang basename
tumutugma sa pangalang ibinigay sa command line sa file na "$Config{archlib}/pod.idx".
Ang pod.idx Ang file ay dapat maglaman ng ganap na kwalipikadong mga filename, isa bawat linya.

-L wika_code
Ito ay nagpapahintulot sa isa na tukuyin ang wika code para sa nais na pagsasalin ng wika. Kung
ang "POD2:: "Ang package ay hindi naka-install sa iyong system, ang switch ay
hindi pinansin. Ang lahat ng magagamit na mga pakete ng pagsasalin ay makikita sa ilalim ng "POD2::"
namespace. Tingnan ang POD2::IT (o POD2::FR) para makita kung paano gumawa ng bagong localized na "POD2::*"
mga pakete ng dokumentasyon at isama ang mga ito sa Pod::Perldoc.

PageName|ModuleName|ProgramName|URL
Ang item na gusto mong hanapin. Ang mga nested na module (gaya ng "File::Basename") ay
tinukoy bilang "File::Basename" o "File/Basename". Maaari ka ring magbigay ng a
mapaglarawang pangalan ng isang pahina, gaya ng "perlfunc". Para sa mga URL, ang HTTP at HTTPS ay ang
tanging uri na kasalukuyang sinusuportahan.

Para sa mga simpleng pangalan tulad ng 'foo', kapag nabigo ang normal na paghahanap na makahanap ng katugmang pahina, a
Ang paghahanap na may prefix na "perl" ay sinubukan din. Kaya sapat na ang "perldoc intro" para
hanapin/i-render ang "perlintro.pod".

-n ilang-formatter
Tukuyin ang kapalit para sa groff

-r Paulit-ulit na paghahanap.

-i Huwag pansinin ang kaso.

-V Ipinapakita ang bersyon ng perldoc na iyong pinapatakbo.

SEGURIDAD

dahil sa perldoc ay hindi tumatakbo nang maayos na may bahid, at kilala na may mga isyu sa seguridad, kapag
tumakbo bilang superuser susubukan nitong i-drop ang mga pribilehiyo sa pamamagitan ng pagtatakda ng epektibo at totoo
Mga ID sa account ni nobody o nouser, o -2 kung hindi available. Kung hindi nito kayang bitawan ito
mga pribilehiyo, hindi ito tatakbo.

Kapaligiran

Gagamitin ang anumang switch sa environment variable na "PERLDOC" bago ang command line
argumento.

Kasama sa mga kapaki-pakinabang na halaga para sa "PERLDOC" ang "-oterm", "-otext", "-ortf", "-oxml", at iba pa,
depende sa kung anong mga module ang mayroon ka; o maaaring tukuyin ang klase ng formatter
eksakto sa "-MPod::Perldoc::ToTerm" o katulad nito.

Hinahanap din ng "perldoc" ang mga direktoryo na tinukoy ng "PERL5LIB" (o "PERLLIB" kung
Ang "PERL5LIB" ay hindi tinukoy) at "PATH" na mga variable ng kapaligiran. (Ang huli ay ganoon
Ang mga naka-embed na pod para sa mga executable, gaya ng "perldoc" mismo, ay available.)

Sa mga direktoryo kung saan umiiral ang "Makefile.PL" o "Build.PL," ang "perldoc" ay magdaragdag ng "." at
"lib" muna sa landas ng paghahanap nito, at hangga't hindi ikaw ang superuser ay magdaragdag ng "blib"
masyadong. Ito ay talagang kapaki-pakinabang kung nagtatrabaho ka sa loob ng isang direktoryo ng build at gusto mo
basahin ang mga doc kahit na mayroon kang bersyon ng isang module na dati nang naka-install.

Gagamitin ng "perldoc", ayon sa kagustuhan, ang pager na tinukoy sa "PERLDOC_PAGER",
"MANPAGER", o "PAGER" bago subukang maghanap ng pager nang mag-isa. ("MANPAGER" ay hindi ginagamit
kung sinabihan ang "perldoc" na magpakita ng plain text o unformatted pod.)

Kapag gumagamit ng perldoc sa "-m" mode nito (display module source code), susubukan ng "perldoc"
para gamitin ang pager set sa "PERLDOC_SRC_PAGER". Ang isang kapaki-pakinabang na setting para sa command na ito ay ang iyong
paboritong editor tulad ng sa "/usr/bin/nano". (Huwag mo akong husgahan.)

Ang isang kapaki-pakinabang na value para sa "PERLDOC_PAGER" ay "mas mababa -+C -E".

Ang pagkakaroon ng PERLDOCDEBUG na nakatakda sa isang positibong integer ay gagawing mas deskriptibo ang perldoc
output kaysa sa "-D" switch na ginagawa; mas mataas ang bilang, mas marami itong ibinubuga.

PAGBABAGO

Hanggang 3.14_05, ang switch -v ay ginamit upang makabuo ng mga pandiwang mensahe ng perldoc pagpapatakbo,
na ngayon ay pinagana ng -D.

Gumamit ng perldoc online gamit ang mga serbisyo ng onworks.net